Wyn Enterprise provides a rich API for integrating reporting components into your web application. To embed the Report Viewer component in your project, use the Report Viewer API. It lets you view and export reports with added capabilities that include defining the locale for the viewer, specifying the Parameter panel location and show mode, modifying the default title name, and much more.

The following sections describe the module: report/types/viewer-app.

Type Aliases

• AddLocalizationErrorResult

• AddLocalizationResult

• AddLocalizationSuccessResult

• AnimationOptions

• ChartTooltipAnimationOptions

• ChartTooltipBorderStyle

• ChartTooltipFontStyle

• ChartTooltipFontWeight

• DisplayType

• Event

• EventHandler

• ExportOptions

• ExportResult

• ExportSettings

• ExportSettingsCsv

• ExportSettingsDisplayMode

• ExportSettingsDocumentCompatibilityVersion

• ExportSettingsDocx

• ExportSettingsDuplexMode

• ExportSettingsEmbedFonts

• ExportSettingsEncoding

• ExportSettingsExcel

• ExportSettingsExceldata

• ExportSettingsExtension

• ExportSettingsFileFormat

• ExportSettingsHorizontalPaddings

• ExportSettingsHtml

• ExportSettingsImage

• ExportSettingsImageInterpolation

• ExportSettingsImageType

• ExportSettingsJson

• ExportSettingsMap

• ExportSettingsOpenXmlStandard

• ExportSettingsOrientation

• ExportSettingsOutputFormat

• ExportSettingsPaperSize

• ExportSettingsPdf

• ExportSettingsPermissions

• ExportSettingsPrintLayoutMode

• ExportSettingsRenderMode

• ExportSettingsRenderingEngine

• ExportSettingsTxt

• ExportSettingsVersion

• ExportSettingsWatermarkColor

• ExportSettingsWatermarkFontFamily

• ExportSettingsXml

• ExportType

• GetLocalizationResourcesErrorResult

• GetLocalizationResourcesResult

• GetLocalizationResourcesSuccessResult

• HoverChartAnimationOptions

• HoverTableAnimationOptions

• HyperlinkOptions

• InitViewerOptions

• InitViewerOptionsBase

• InitViewerOptionsOther

• LoadChartAnimationOptions

• LocalizationResourceBundle

• OpenReportOptions

• OverridableToolbarButton

• PageViewOptions

• PanelsLocation

• ParamPanelShowMode

• Parameter

• ParameterPanelOptions

• PartialDeep

• PartialDeepViewerOptionsOther

• ReportInfo

• ReportRenderedEventArgs

• SearchOptions

• SearchResult

• SetViewModeValue

• SetZoomModeValue

• UnregisterEventHandler

• ViewMode

• Viewer

• ViewerApi

• ZoomMode

Type Aliases

AddLocalizationErrorResult

Ƭ AddLocalizationErrorResult: Object

Type of error result returned by the GrapeCity.WynReports.Viewer.addLocalization() function.

Type declaration

errorCaption: string

Error caption.

errorDetails: string[]

Error details.

type: "error"

Error result type.

AddLocalizationResult

Ƭ AddLocalizationResult: AddLocalizationSuccessResult | AddLocalizationErrorResult

Type of result returned by the GrapeCity.WynReports.Viewer.addLocalization() function.

AddLocalizationSuccessResult

Ƭ AddLocalizationSuccessResult: Object

Type of success result returned by the GrapeCity.WynReports.Viewer.addLocalization() function.

Type declaration

type: "success"

Success result type.

AnimationOptions

Ƭ AnimationOptions: Object

Describes animations that can be applied to the report view.

Type declaration

chartTooltip?: ChartTooltipAnimationOptions

Set chart tooltip style settings.

hoverChart?: HoverChartAnimationOptions

Set hover chart animation settings. By default, animation is disabled.

Example

hoverChart: { enabled: true }

hoverTable?: HoverTableAnimationOptions

Set hover table and tablix animation settings. By default, animation is disabled.

Example

hoverTable: { enabled: true }

loadChart?: LoadChartAnimationOptions

Set load chart animation settings. By default, animation is disabled.

Example

loadChart: { enabled: true }

ChartTooltipAnimationOptions

Ƭ ChartTooltipAnimationOptions: Object

Describes chart tooltip style options.

Type declaration

backgroundColor?: string

Specifies the chart tooltip background color.

• Default value: '#fff'.

• '$theme' - background color is used from theme background color.

• '$none' - background color remains unchanged.

• 'LightGray'|'#6495ed'|... - background color is used from value.

See this link for more information on colors.

Example

backgroundColor: 'LightGray'

borderColor?: string

Specifies the color of chart tooltip borders.

• Default value: '#292929'.

• '$theme' - border color is used from theme border color.

• '$none' - border color remains unchanged.

• 'LightGray'|'#6495ed'|... - border color is used from value.

See this link for more information on colors.

Example

borderColor: '#4e0000'

borderRadius?: string

Specifies the radius of the chart tooltip borders in px or pt. The value must be greater than or equal to 0 and less than 72.

Default value: '3px'.

Example

borderRadius: '1pt'

borderSize?: string

Specifies the size of the chart tooltip borders. The value must be greater than 0 and less than 10.

Default value: '1px'.

Example

borderSize: '1pt'

borderStyle?: ChartTooltipBorderStyle

Specifies the style of the chart tooltip borders.

Default value: 'Solid'.

Example

borderStyle: 'Dotted'

enabled?: boolean

Enable chart tooltip. If this value is set to false, the chart tooltip will not be displayed.

Default value: true.

Example

enabled: false

fontFamily?: string

Specifies the font family used in the chart tooltip. If fontFamily is not specified explicitly here, the default font family is used.

Example

fontFamily: 'Times New Roman'

fontSize?: string

Specifies the size of the font used in the chart tooltip. Font size can be set in px or pt. Font size value has to be greater than 6 and must not exceed 72.

Default value: '12px'.

Example

fontSize: '10pt'

fontStyle?: ChartTooltipFontStyle

Specifies the font style used in the chart tooltip. Default value: 'Normal'.

Example

fontStyle: 'Italic'

fontWeight?: ChartTooltipFontWeight

Specifies the font weight used in the chart tooltip. Default value: 'Normal'.

Example

fontWeight: 'Bold'

textColor?: string

Specifies the chart tooltip text color.

• Default value: '#333'.

• '$theme' - text color is used from theme text color.

• '$none' - text color remains unchanged.

• 'LightGray'|'#6495ed'|... - text color is used from value.

See this link for more information on colors.

Example

textColor: 'DarkGray'

ChartTooltipBorderStyle

Ƭ ChartTooltipBorderStyle: "None" | "Dotted" | "Dashed" | "Solid" | "Double" | "Groove" | "Ridge" | "Inset" | "Outset"

Describes all possible values for chart tooltip borderStyle option.

ChartTooltipFontStyle

Ƭ ChartTooltipFontStyle: "Normal" | "Italic"

Describes all possible values for chart tooltip fontStyle option.

ChartTooltipFontWeight

Ƭ ChartTooltipFontWeight: "Lighter" | "Thin" | "ExtraLight" | "Light" | "Normal" | "Medium" | "SemiBold" | "Bold" | "ExtraBold" | "Heavy" | "Bolder"

Describes all possible values for chart tooltip fontWeight option.

DisplayType

Ƭ DisplayType: "Page" | "Galley"

All supported display types.

Event

Ƭ Event<TArgs>: Object

Event listener.

Type parameters

Type declaration

register: (eventHandler: EventHandler<TArgs>) => UnregisterEventHandler

Registers a new event handler.

EventHandler

Ƭ EventHandler<TArgs>: (args: TArgs) => void

Type parameters

Type declaration

▸ (args): void

Event handler.

Parameters

Returns

void

ExportOptions

Ƭ ExportOptions<T>: Object

Describes the export options.

Type parameters

Type declaration

settings?: ExportSettings<T>

Specifies the export settings available for RenderingExtensions.

Example

settings: { Title: '1997 Annual Report' }

ExportResult

Ƭ ExportResult: Object

Describes the export result.

Type declaration

file: Blob

The exported report file.

filename?: string

The filename of the report.

ExportSettings

Ƭ ExportSettings<T>: ExportSettingsMap[T]

Type parameters

ExportSettingsCsv

Ƭ ExportSettingsCsv: Object

Type declaration

AddTimestamp?: boolean

ColumnsDelimiter?: string

DateTimeFormat?: string

Encoding?: ExportSettingsEncoding

Extension?: ExportSettingsExtension

FilenameTemplate?: string

NoHeader?: boolean

NumericFormat?: string

QuotationSymbol?: string

RowsDelimiter?: string

ExportSettingsDisplayMode

Ƭ ExportSettingsDisplayMode: "None" | "Outlines" | "Thumbs" | "FullScreen"

ExportSettingsDocumentCompatibilityVersion

Ƭ ExportSettingsDocumentCompatibilityVersion: "Word2007" | "Word2010" | "Word2013"

ExportSettingsDocx

Ƭ ExportSettingsDocx: Object

Type declaration

AddTimestamp?: boolean

Author?: string

Categories?: string

CompanyName?: string

DocumentCompatibilityVersion?: ExportSettingsDocumentCompatibilityVersion

DpiX?: number

DpiY?: number

FilenameTemplate?: string

Orientation?: ExportSettingsOrientation

PaperSize?: ExportSettingsPaperSize

Password?: string

ReadOnlyRecommended?: boolean

TOCAutoUpdate?: boolean

Title?: string

WritePassword?: string

ExportSettingsDuplexMode

Ƭ ExportSettingsDuplexMode: "Simplex" | "DuplexFlipLongEdge" | "DuplexFlipShortEdge"

ExportSettingsEmbedFonts

Ƭ ExportSettingsEmbedFonts: "Partial" | "All" | "None"

ExportSettingsEncoding

Ƭ ExportSettingsEncoding: "IBM037" | "IBM437" | "IBM500" | "ASMO-708" | "DOS-720" | "ibm737" | "ibm775" | "ibm850" | "ibm852" | "IBM855" | "ibm857" | "IBM00858" | "IBM860" | "ibm861" | "DOS-862" | "IBM863" | "IBM864" | "IBM865" | "cp866" | "ibm869" | "IBM870" | "windows-874" | "cp875" | "shift_jis" | "gb2312" | "ks_c_5601-1987" | "big5" | "IBM1026" | "IBM01047" | "IBM01140" | "IBM01141" | "IBM01142" | "IBM01143" | "IBM01144" | "IBM01145" | "IBM01146" | "IBM01147" | "IBM01148" | "IBM01149" | "utf-16" | "unicodeFFFE" | "windows-1250" | "windows-1251" | "Windows-1252" | "windows-1253" | "windows-1254" | "windows-1255" | "windows-1256" | "windows-1257" | "windows-1258" | "Johab" | "macintosh" | "x-mac-japanese" | "x-mac-chinesetrad" | "x-mac-korean" | "x-mac-arabic" | "x-mac-hebrew" | "x-mac-greek" | "x-mac-cyrillic" | "x-mac-chinesesimp" | "x-mac-romanian" | "x-mac-ukrainian" | "x-mac-thai" | "x-mac-ce" | "x-mac-icelandic" | "x-mac-turkish" | "x-mac-croatian" | "utf-32" | "utf-32BE" | "x-Chinese-CNS" | "x-cp20001" | "x-Chinese-Eten" | "x-cp20003" | "x-cp20004" | "x-cp20005" | "x-IA5" | "x-IA5-German" | "x-IA5-Swedish" | "x-IA5-Norwegian" | "us-ascii" | "x-cp20261" | "x-cp20269" | "IBM273" | "IBM277" | "IBM278" | "IBM280" | "IBM284" | "IBM285" | "IBM290" | "IBM297" | "IBM420" | "IBM423" | "IBM424" | "x-EBCDIC-KoreanExtended" | "IBM-Thai" | "koi8-r" | "IBM871" | "IBM880" | "IBM905" | "IBM00924" | "EUC-JP" | "x-cp20936" | "x-cp20949" | "cp1025" | "koi8-u" | "iso-8859-1" | "iso-8859-2" | "iso-8859-3" | "iso-8859-4" | "iso-8859-5" | "iso-8859-6" | "iso-8859-7" | "iso-8859-8" | "iso-8859-9" | "iso-8859-13" | "iso-8859-15" | "x-Europa" | "iso-8859-8-i" | "iso-2022-jp" | "csISO2022JP" | "iso-2022-kr" | "x-cp50227" | "euc-jp" | "EUC-CN" | "euc-kr" | "hz-gb-2312" | "GB18030" | "x-iscii-de" | "x-iscii-be" | "x-iscii-ta" | "x-iscii-te" | "x-iscii-as" | "x-iscii-or" | "x-iscii-ka" | "x-iscii-ma" | "x-iscii-gu" | "x-iscii-pa" | "utf-7" | "utf-8" | "utf-8-without-BOM"

ExportSettingsExcel

Ƭ ExportSettingsExcel: Object

Type declaration

AddTimestamp?: boolean

Author?: string

Categories?: string

EnableToggles?: boolean

FileFormat?: ExportSettingsFileFormat

FilenameTemplate?: string

MultiSheet?: boolean

Orientation?: ExportSettingsOrientation

OutputFormat?: ExportSettingsOutputFormat

Pagination?: boolean

PaperSize?: ExportSettingsPaperSize

Password?: string

ProtectedBy?: string

ReadOnlyRecommended?: boolean

SheetName?: string

Title?: string

UseCompression?: boolean

UseDefaultPalette?: boolean

WritePassword?: string

ExportSettingsExceldata

Ƭ ExportSettingsExceldata: Object

Type declaration

AddTimestamp?: boolean

AllowImages?: boolean

Author?: string

AutoRowsHeight?: boolean

Categories?: string

ColumnsDelimiter?: string

DateTimeFormat?: string

Encoding?: ExportSettingsEncoding

FileFormat?: ExportSettingsFileFormat

FilenameTemplate?: string

NoHeader?: boolean

NumericFormat?: string

OpenXmlStandard?: ExportSettingsOpenXmlStandard

QuotationSymbol?: string

RightToLeft?: boolean

RowsDelimiter?: string

Title?: string

UseCompression?: boolean

ExportSettingsExtension

Ƭ ExportSettingsExtension: "csv" | "txt"

ExportSettingsFileFormat

Ƭ ExportSettingsFileFormat: "Xlsx" | "Xls"

ExportSettingsHorizontalPaddings

Ƭ ExportSettingsHorizontalPaddings: "Adjust" | "Remove" | "Keep"

ExportSettingsHtml

Ƭ ExportSettingsHtml: Object

Type declaration

AddTimestamp?: boolean

EmbedImages?: boolean

EndPage?: number

FilenameTemplate?: string

Fragment?: boolean

LinkTarget?: string

OutputTOC?: boolean

RenderMode?: ExportSettingsRenderMode

RenderingEngine?: ExportSettingsRenderingEngine

StyleStream?: boolean

ExportSettingsImage

Ƭ ExportSettingsImage: Object

Type declaration

AddTimestamp?: boolean

Dither?: boolean

DpiX?: number

DpiY?: number

EndPage?: number

FilenameTemplate?: string

ImageType?: ExportSettingsImageType

Pagination?: boolean

PrintLayoutMode?: ExportSettingsPrintLayoutMode

Quality?: number

SizeToFit?: boolean

StartPage?: number

WatermarkAngle?: number

WatermarkColor?: ExportSettingsWatermarkColor

WatermarkFontBold?: boolean

WatermarkFontFamily?: ExportSettingsWatermarkFontFamily

WatermarkFontItalic?: boolean

WatermarkFontSize?: number

WatermarkFontStrikeout?: boolean

WatermarkFontUnderline?: boolean

WatermarkTitle?: string

ExportSettingsImageInterpolation

Ƭ ExportSettingsImageInterpolation: "Default" | "None"

ExportSettingsImageType

Ƭ ExportSettingsImageType: "Png" | "Jpeg" | "Gif" | "Bmp" | "Tiff"

ExportSettingsJson

Ƭ ExportSettingsJson: Object

Type declaration

AddTimestamp?: boolean

FilenameTemplate?: string

Formatted?: boolean

QuotePropertyNames?: boolean

ExportSettingsMap

Ƭ ExportSettingsMap: Object

Type declaration

csv: ExportSettingsCsv

docx: ExportSettingsDocx

excel: ExportSettingsExcel

exceldata: ExportSettingsExceldata

html: ExportSettingsHtml

image: ExportSettingsImage

json: ExportSettingsJson

pdf: ExportSettingsPdf

txt: ExportSettingsTxt

xml: ExportSettingsXml

ExportSettingsOpenXmlStandard

Ƭ ExportSettingsOpenXmlStandard: "Transitional" | "Strict"

ExportSettingsOrientation

Ƭ ExportSettingsOrientation: "Default" | "Portrait" | "Landscape"

ExportSettingsOutputFormat

Ƭ ExportSettingsOutputFormat: "Transitional" | "Strict"

ExportSettingsPaperSize

Ƭ ExportSettingsPaperSize: "Default" | "Letter" | "LetterSmall" | "Tabloid" | "Ledger" | "Legal" | "Statement" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "Folio" | "Quarto" | "Standard10x14" | "Standard11x17" | "Note" | "Number9Envelope" | "Number10Envelope" | "Number11Envelope" | "Number12Envelope" | "Number14Envelope" | "CSheet" | "DSheet" | "ESheet" | "DLEnvelope" | "C5Envelope" | "C3Envelope" | "C4Envelope" | "C6Envelope" | "C65Envelope" | "B4Envelope" | "B5Envelope" | "B6Envelope" | "ItalyEnvelope" | "MonarchEnvelope" | "PersonalEnvelope" | "USStandardFanfold" | "GermanStandardFanfold" | "GermanLegalFanfold" | "IsoB4" | "JapanesePostcard" | "Standard9x11" | "Standard10x11" | "Standard15x11" | "InviteEnvelope" | "LetterExtra" | "LegalExtra" | "TabloidExtra" | "A4Extra" | "LetterTransverse" | "A4Transverse" | "LetterExtraTransverse" | "APlus" | "BPlus" | "LetterPlus" | "A4Plus" | "A5Transverse" | "B5Transverse" | "A3Extra" | "A5Extra" | "B5Extra" | "A2" | "A3Transverse" | "A3ExtraTransverse" | "JapaneseDoublePostcard" | "A6" | "JapaneseEnvelopeKakuNumber2" | "JapaneseEnvelopeKakuNumber3" | "JapaneseEnvelopeChouNumber3" | "JapaneseEnvelopeChouNumber4" | "LetterRotated" | "A3Rotated" | "A4Rotated" | "A5Rotated" | "B4JisRotated" | "B5JisRotated" | "JapanesePostcardRotated" | "JapaneseDoublePostcardRotated" | "A6Rotated" | "JapaneseEnvelopeKakuNumber2Rotated" | "JapaneseEnvelopeKakuNumber3Rotated" | "JapaneseEnvelopeChouNumber3Rotated" | "JapaneseEnvelopeChouNumber4Rotated" | "B6Jis" | "B6JisRotated" | "Standard12x11" | "JapaneseEnvelopeYouNumber4" | "JapaneseEnvelopeYouNumber4Rotated" | "Prc16K" | "Prc32K" | "Prc32KBig" | "PrcEnvelopeNumber1" | "PrcEnvelopeNumber2" | "PrcEnvelopeNumber3" | "PrcEnvelopeNumber4" | "PrcEnvelopeNumber5" | "PrcEnvelopeNumber6" | "PrcEnvelopeNumber7" | "PrcEnvelopeNumber8" | "PrcEnvelopeNumber9" | "PrcEnvelopeNumber10" | "Prc16KRotated" | "Prc32KRotated" | "Prc32KBigRotated" | "PrcEnvelopeNumber1Rotated" | "PrcEnvelopeNumber2Rotated" | "PrcEnvelopeNumber3Rotated" | "PrcEnvelopeNumber4Rotated" | "PrcEnvelopeNumber5Rotated" | "PrcEnvelopeNumber6Rotated" | "PrcEnvelopeNumber7Rotated" | "PrcEnvelopeNumber8Rotated" | "PrcEnvelopeNumber9Rotated" | "PrcEnvelopeNumber10Rotated"

ExportSettingsPdf

Ƭ ExportSettingsPdf: Object

Type declaration

AddTimestamp?: boolean

Application?: string

Author?: string

CenterWindow?: boolean

DisplayMode?: ExportSettingsDisplayMode

DisplayTitle?: boolean

DuplexMode?: ExportSettingsDuplexMode

EmbedFonts?: ExportSettingsEmbedFonts

Encrypt?: boolean

EndPage?: number

FilenameTemplate?: string

FitWindow?: boolean

HideMenubar?: boolean

HideToolbar?: boolean

HideWindowUI?: boolean

ImageInterpolation?: ExportSettingsImageInterpolation

IsPaginated?: boolean

Keywords?: string

NeverEmbedFonts?: string

NumberOfCopies?: number

OwnerPassword?: string

PaperSourceByPageSize?: boolean

Permissions?: ExportSettingsPermissions

PrintLayoutMode?: ExportSettingsPrintLayoutMode

PrintOnOpen?: boolean

PrintPageRange?: string

SizeToFit?: boolean

StartPage?: number

Subject?: string

Title?: string

Use128Bit?: boolean

UserPassword?: string

Version?: ExportSettingsVersion

WatermarkAngle?: number

WatermarkColor?: ExportSettingsWatermarkColor

WatermarkFontBold?: boolean

WatermarkFontFamily?: ExportSettingsWatermarkFontFamily

WatermarkFontItalic?: boolean

WatermarkFontSize?: number

WatermarkFontStrikeout?: boolean

WatermarkFontUnderline?: boolean

WatermarkTitle?: string

ExportSettingsPermissions

Ƭ ExportSettingsPermissions: "None" | "AllowPrint" | "AllowModifyContents" | "AllowCopy" | "AllowModifyAnnotations" | "AllowFillIn" | "AllowAccessibleReaders" | "AllowAssembly" | "Default"

ExportSettingsPrintLayoutMode

Ƭ ExportSettingsPrintLayoutMode: "OneLogicalPageOnSinglePhysicalPage" | "TwoLogicalPagesOnSinglePhysicalPage" | "FourLogicalPagesOnSinglePhysicalPage" | "EightLogicalPagesOnSinglePhysicalPage" | "BookletMode"

ExportSettingsRenderMode

Ƭ ExportSettingsRenderMode: "Galley" | "Paginated"

ExportSettingsRenderingEngine

Ƭ ExportSettingsRenderingEngine: "Html" | "Mixed"

ExportSettingsTxt

Ƭ ExportSettingsTxt: Object

Type declaration

AddTimestamp?: boolean

CharHeightInTwips?: number

CharWidthInTwips?: number

FilenameTemplate?: string

HorizontalPaddings?: ExportSettingsHorizontalPaddings

LineEnding?: string

ExportSettingsVersion

Ƭ ExportSettingsVersion: "Pdf12" | "Pdf13" | "Pdf14" | "Pdf15" | "Pdf16" | "Pdf17" | "PdfA1a" | "PdfA1b" | "PdfA2a" | "PdfA2b" | "PdfA2u" | "PdfA3a" | "PdfA3b" | "PdfA3u" | "PdfUA1"

ExportSettingsWatermarkColor

Ƭ ExportSettingsWatermarkColor: "Transparent" | "Black" | "DarkSlateGray" | "SlateGray" | "LightSlateGray" | "DimGray" | "Gray" | "DarkGray" | "Silver" | "LightGrey" | "Gainsboro" | "WhiteSmoke" | "White" | "Snow" | "HoneyDew" | "MintCream" | "Azure" | "AliceBlue" | "GhostWhite" | "SeaShell" | "Beige" | "OldLace" | "FloralWhite" | "Ivory" | "AntiqueWhite" | "Linen" | "LavenderBlush" | "MistyRose" | "Pink" | "LightPink" | "HotPink" | "DeepPink" | "PaleVioletRed" | "MediumVioletRed" | "LightSalmon" | "Salmon" | "DarkSalmon" | "LightCoral" | "IndianRed" | "Crimson" | "FireBrick" | "DarkRed" | "Red" | "OrangeRed" | "Tomato" | "Coral" | "DarkOrange" | "Orange" | "Yellow" | "LightYellow" | "LemonChiffon" | "LightGoldenrodYellow" | "PapayaWhip" | "Moccasin" | "PeachPuff" | "PaleGoldenrod" | "Khaki" | "DarkKhaki" | "Gold" | "Cornsilk" | "BlanchedAlmond" | "Bisque" | "NavajoWhite" | "Wheat" | "BurlyWood" | "Tan" | "RosyBrown" | "SandyBrown" | "Goldenrod" | "DarkGoldenrod" | "Peru" | "Chocolate" | "SaddleBrown" | "Sienna" | "Brown" | "Maroon" | "DarkOliveGreen" | "Olive" | "OliveDrab" | "YellowGreen" | "LimeGreen" | "Lime" | "LawnGreen" | "Chartreuse" | "GreenYellow" | "SpringGreen" | "MediumSpringGreen" | "LightGreen" | "PaleGreen" | "DarkSeaGreen" | "MediumAquamarine" | "MediumSeaGreen" | "SeaGreen" | "ForestGreen" | "Green" | "DarkGreen" | "Aqua" | "Cyan" | "LightCyan" | "PaleTurquoise" | "Aquamarine" | "Turquoise" | "MediumTurquoise" | "DarkTurquoise" | "LightSeaGreen" | "CadetBlue" | "DarkCyan" | "Teal" | "LightSteelBlue" | "PowderBlue" | "LightBlue" | "SkyBlue" | "LightSkyBlue" | "DeepSkyBlue" | "DodgerBlue" | "CornflowerBlue" | "SteelBlue" | "RoyalBlue" | "Blue" | "MediumBlue" | "DarkBlue" | "Navy" | "MidnightBlue" | "Lavender" | "Thistle" | "Plum" | "Violet" | "Orchid" | "Fuchsia" | "Magenta" | "MediumOrchid" | "MediumPurple" | "BlueViolet" | "DarkViolet" | "DarkOrchid" | "DarkMagenta" | "Purple" | "Indigo" | "DarkSlateBlue" | "RebeccaPurple" | "SlateBlue" | "MediumSlateBlue"

ExportSettingsWatermarkFontFamily

Ƭ ExportSettingsWatermarkFontFamily: "Arial" | "Arial Black" | "Comic Sans MS" | "Courier New" | "Geneva" | "Georgia" | "Helvetica" | "Impact" | "Lucida Console" | "Meiryo" | "Meiryo UI" | "MingLiU" | "MingLiU-ExtB" | "MS Gothic" | "MS Mincho" | "MS PGothic" | "MS PMincho" | "MS Song" | "MS UI Gothic" | "NSimSun" | "Osaka" | "PMingLiU" | "PMingLiU-ExtB" | "SimSun" | "SimSun-ExtB" | "Song" | "Tahoma" | "Times New Roman" | "Trebuchet MS" | "Verdana" | "Yu Gothic"

ExportSettingsXml

Ƭ ExportSettingsXml: Object

Type declaration

AddTimestamp?: boolean

DefaultDateFormat?: string

FilenameTemplate?: string

Formatted?: boolean

OutputHiddenMatrixMembers?: boolean

OutputTextboxConstantValues?: boolean

WriteEmptyAttributes?: boolean

ExportType

Ƭ ExportType: "pdf" | "excel" | "exceldata" | "docx" | "csv" | "html" | "image" | "json" | "txt" | "xml"

All supported exports.

GetLocalizationResourcesErrorResult

Ƭ GetLocalizationResourcesErrorResult: Object

Type of error result returned by the GrapeCity.WynReports.Viewer.getLocalizationResources() function.

Type declaration

errorCaption: string

Error caption.

errorDetails: string[]

Error details.

type: "error"

Error result type.

GetLocalizationResourcesResult

Ƭ GetLocalizationResourcesResult: GetLocalizationResourcesSuccessResult | GetLocalizationResourcesErrorResult

Type of result returned by the GrapeCity.WynReports.Viewer.getLocalizationResources() function.

GetLocalizationResourcesSuccessResult

Ƭ GetLocalizationResourcesSuccessResult: Object

Type of success result returned by the GrapeCity.WynReports.Viewer.getLocalizationResources() function.

Type declaration

resourceBundles: LocalizationResourceBundle[] | undefined

Localization resource bundles.

type: "success"

Success result type.

HoverChartAnimationOptions

Ƭ HoverChartAnimationOptions: Object

Describes hover chart animations that can be applied to the report view.

Type declaration

enabled?: boolean

Enable hover chart animation. Default value: false.

Example

enabled: true

HoverTableAnimationOptions

Ƭ HoverTableAnimationOptions: Object

Describes hover table and tablix animations that can be applied to the report view.

Type declaration

backgroundColor?: string

Specifies the background color when hovering over the table and tablix row.

• Default value: '$theme'.

• '$theme' - background color is used from theme background color.

• '$none' - background color remains unchanged.

• 'LightGray'|'#6495ed'|... - background color is used from value.

See this link for more information on colors.

Example

backgroundColor: 'LightGray'

enabled?: boolean

Enable hover table and tablix animations. Default value: false.

Example

enabled: true

textColor?: string

Specifies the text color on hover over the table and tablix row.

• Default value: '$theme'.

• '$theme' - text color is used from theme text color.

• '$none' - text color remains unchanged.

• 'LightGray'|'#6495ed'|... - text color is used from value.

See this link for more information on colors.

Example

textColor: 'DarkGray'

HyperlinkOptions

Ƭ HyperlinkOptions: Object

Describes hyperlink text color options.

Type declaration

hoveredTextColor?: string

Specifies the hovered hyperlink text color on urls, bookmarks, and reports.

• Default value: '#0000cc'.

• '$theme' - hovered hyperlink text color is used from theme hyperlink text color.

• '$none' - hovered hyperlink text color remains unchanged.

• 'LightGray'|'#6495ed'|... - hovered hyperlink text color is used from value.

See this link for more information on colors.

Example

hoveredTextColor: '#5f5fee'

textColor?: string

Specifies the hyperlink text color on urls, bookmarks, and reports.

• Default value: '#0000ff'.

• '$theme' - hyperlink text color is used from theme hyperlink text color.

• '$none' - hyperlink text color remains unchanged.

• 'LightGray'|'#6495ed'|... - hyperlink text color is used from value.

See this link for more information on colors.

Example

textColor: '#0000ee'

visitedTextColor?: string

Specifies the visited hyperlink text color on urls, bookmarks, and reports.

• Default value: '#800080'.

• '$theme' - visited hyperlink text color is used from theme hyperlink text color.

• '$none' - visited hyperlink text color remains unchanged.

• 'LightGray'|'#6495ed'|... - visited hyperlink text color is used from value.

See this link for more information on colors.

Example

visitedTextColor: '#551a8b'

InitViewerOptions

Ƭ InitViewerOptions: InitViewerOptionsBase & InitViewerOptionsOther

The following options can be set during initialization or at runtime while working with the Viewer.

InitViewerOptionsBase

Ƭ InitViewerOptionsBase: Object

The base primary options of the InitViewerOptions type.

Type declaration

element: string

A DOMString that specifies the element hosting the Viewer control.

Example

element: 'report-viewer-app'

locale?: string

Specifies locale used for displaying Viewer.

If locale is not specified explicitly here, the locale corresponding to the browser preferences is used.

Example

locale: 'zh'

portalUrl?: string

Wyn Portal URL.

Example

portalUrl: 'https://wyn-portal.com/'

referenceToken?: string

The reference key needed to access the Wyn API.

Example

referenceToken: '<referenceToken>'

referenceTokenKey?: string

The reference key name used in query parameters is configured in the Wyn Config file.

If referenceTokenKey is not specified, default value is 'token'.

Example

referenceTokenKey: '<referenceTokenKey>';

reportId?: string

The ID of the report to be shown by the Viewer.

Deprecated

Use

await viewer.openReport('<reportId>', [{ name: 'myString', values: ['123'] }]);

Example

reportId: '<reportId>'

reportParameters?: Parameter[]

The array of the {name, value} pairs that describe the parameter values used to run the report.

Deprecated

Use

await viewer.openReport('<reportId>', [{ name: 'myString', values: ['123'] }]);

Example

String parameters

reportParameters: [{ name: 'myString', values: ['123'] }]

Example

Float parameters

reportParameters: [{ name: 'myFloat', values: [23.4] }]

Example

Integer parameters

reportParameters: [{ name: 'myInteger', values: [345] }]

Example

DateTime parameters

reportParameters: [{ name: 'myDateTime', values: ['2020-11-13T16:47:59.000Z'] }]

Example

Date parameters

reportParameters: [{ name: 'myDate', values: ['2020-11-13T16:47:59.000Z'] }]

Example

Boolean parameters

reportParameters: [{ name: 'myBoolean', values: [true] }]

Example

Multivalue string parameters

reportParameters: [{ name: 'Country', values: ['China', 'Russia'] }]

InitViewerOptionsOther

Ƭ InitViewerOptionsOther: Object

The other secondary options of the InitViewerOptions type.

Type declaration

animation?: AnimationOptions

The report's view animation options. By default, animation is disabled.

Example

animation: { hoverTable: { enabled: true } }

availableExports?: ExportType[]

The array of export types available via Export functionality of Viewer. By default, all ExportType values are used.

Example

availableExports: ['xml', 'pdf']

disableFocusTimer?: boolean

Disables focus highlighting timer for better accessibility.

Example

disableFocusTimer: false

displayType?: DisplayType

Set up the display type. The default value is report display type.

Example

displayType: 'Galley'

hideSearch?: boolean

A flag specifying whether to hide the search panel. Default value: false.

Example

hideSearch: true

hideToolbar?: boolean

A flag specifying whether to hide the toolbars. Default value: false.

Example

hideToolbar: true

hyperlink?: HyperlinkOptions

Defines hyperlink text color settings.

Example

hyperlink: { textColor: '#0000ee', visitedTextColor: '#551a8b', hoveredTextColor: '#5f5fee' }

isFullscreen?: boolean

A flag specifying whether to enable fullscreen mode. Default value: fullscreen mode value specified in the opened report.

Example

isFullscreen: true

makeTitle?: (reportName: string) => string

Makes the Viewer display the custom title.

Example

makeTitle: (reportName) => reportName + ' - Wyn Enterprise'

pageViewOptions?: PageViewOptions

Defines horizontal alignment and view for the report page, like part of the WebPage or 'paper view'.

Example

pageViewOptions: { horizontalAlignment: 'right', withoutPaperView: true }

paramPanelPosition?: PanelsLocation

Set up the parameters for panel position. Default value: 'Right'.

Deprecated

Example

paramPanelPosition: 'Top'

paramPanelShowMode?: ParamPanelShowMode

Set up a rule for showing the parameter panel. If the value is 'Always', the parameter panel is shown anyway on the document opening event. Default value: 'Default'.

Deprecated

Example

paramPanelShowMode: 'Always'

parameterPanel?: ParameterPanelOptions

Defines parameter panel options.

Example

parameterPanel: { position: 'Right', showMode: 'Always', roundedControls: true }

toolbarSize?: "small" | "medium" | "large"

Defines toolbar size. Default value: 'large'.

Example

toolbarSize: 'small'

viewMode?: ViewMode

Set up a single or continuous page. Default value: 'Single'.

Example

viewMode: 'Continuous'

zoomMode?: ZoomMode

Set up zoom mode. Default value is 'Default'.

Example

zoomMode: 'FitToWidth'

LoadChartAnimationOptions

Ƭ LoadChartAnimationOptions: Object

Describes load chart animations that can be applied to the report view.

Type declaration

enabled?: boolean

Enable load chart animation. Default value: false.

Example

enabled: true

LocalizationResourceBundle

Ƭ LocalizationResourceBundle: Object

Type of the GetLocalizationResourcesSuccessResult.resourceBundles array element.

Type declaration

ns: string

Bundle namespace.

resources: Record<string, any>

Localization resources.

OpenReportOptions

Ƭ OpenReportOptions: Object

Describes the open report options.

Type declaration

parameters?: Parameter[]

The array of the report parameters values.

Example

String parameters

parameters: [{ name: 'Country', values: ['China'] }, { name: 'Category', values: ['City'] }])

Example

Float parameters

parameters: [{ name: 'myFloat', values: [23.4] }])

Example

Integer parameters

parameters: [{ name: 'myInteger', values: [345] }])

Example

DateTime parameters

parameters: [{ name: 'myDateTime', values: ['2020-11-13T16:47:59.000Z'] }])

Example

Date parameters

parameters: [{ name: 'myDate', values: ['2020-11-13T16:47:59.000Z'] }])

Example

Boolean parameters

parameters: [{ name: 'myBoolean', values: [true] }])

Example

Multivalue string parameters

parameters: [{ name: 'Country', values: ['China', 'Russia'] }])

OverridableToolbarButton

Ƭ OverridableToolbarButton: "$print"

PageViewOptions

Ƭ PageViewOptions: Object

Describes the page view options.

Type declaration

horizontalAlignment?: "left" | "right" | "center"

Defines horizontal alignment for report pages inside the view area. Default value: 'center'.

Example

horizontalAlignment: 'left'

withoutPaperView?: boolean

Removes 'gray' backgrounds, shadows, paper borders, and other things that make 'paper view'. Default value: false.

Example

withoutPaperView: true

PanelsLocation

Ƭ PanelsLocation: "Top" | "Right"

All supported panel locations.

ParamPanelShowMode

Ƭ ParamPanelShowMode: "Default" | "Always"

All supported parameter panel show modes.

Parameter

Ƭ Parameter: Object

Describes the parameter value used to run the report.

Type declaration

name: string

The name of the parameter.

Example

name: 'Parameter1'

values: any[]

The value(s) of the parameter.

Example

values: ['a', 'b', 'c']

ParameterPanelOptions

Ƭ ParameterPanelOptions: Object

Describes parameter panel options.

Type declaration

position?: PanelsLocation

Set up the parameters for panel position. Default value: 'Right'.

roundedControls?: boolean

Enables rounded corners of the parameter panel's controls. Default value: false.

showMode?: ParamPanelShowMode

Set up a rule for showing the parameter panel. If value is 'Always', parameter panel is shown anyway on the document opening event. Default value: 'Default'.

PartialDeep

Ƭ PartialDeep<K>: { [attr in keyof K]?: K[attr] extends object ? PartialDeep<K[attr]> : K[attr] }

Generic to create a type from another type with all keys and nested keys set to optional.

Type parameters

PartialDeepViewerOptionsOther

Ƭ PartialDeepViewerOptionsOther: PartialDeep<InitViewerOptionsOther>

This type is derived from InitViewerOptionsOther but all its properties are recursively optional.