report.reportViewerType

命名空间: reportViewerType

Type Aliases

AddLocalizationErrorResult

Ƭ AddLocalizationErrorResult: Object

GrapeCity.WynReports.Viewer.addLocalization() 函数返回的错误结果类型.

Type declaration

名称	类型
`errorCaption`	`string`
`errorDetails`	`string`[]
`type`	`"error"`

errorCaption: string

错误说明

errorDetails: string[]

错误详情

type: "error"

错误结果类型

AddLocalizationResult

Ƭ AddLocalizationResult: AddLocalizationSuccessResult | AddLocalizationErrorResult

GrapeCity.WynReports.Viewer.addLocalization() 函数返回的结果类型.

AddLocalizationSuccessResult

Ƭ AddLocalizationSuccessResult: Object

GrapeCity.WynReports.Viewer.addLocalization() 函数返回的成功结果类型.

Type declaration

名称	类型
`type`	`"success"`

type: "success"

成功结果类型

AnimationOptions

Ƭ AnimationOptions: Object

描述可以应用于报表视图的动画.

Type declaration

名称	类型
`chartTooltip?`	`ChartTooltipAnimationOptions`
`hoverChart?`	`HoverChartAnimationOptions`
`hoverTable?`	`HoverTableAnimationOptions`
`loadChart?`	`LoadChartAnimationOptions`

chartTooltip?: ChartTooltipAnimationOptions

设置图表工具提示样式设置。

hoverChart?: HoverChartAnimationOptions

设置悬停图表动画设置。默认值：<动画已禁用>。

示例

hoverChart: { enabled: true }

hoverTable?: HoverTableAnimationOptions

设置悬停表和 tablix 动画设置。默认值：<动画已禁用>。

示例

hoverTable: { enabled: true }

loadChart?: LoadChartAnimationOptions

设置加载图表动画设置。默认值：<动画已禁用>

示例

loadChart: { enabled: true }

ChartTooltipAnimationOptions

Ƭ ChartTooltipAnimationOptions: Object

描述图表工具提示样式选项.

Type declaration

名称	类型
`backgroundColor?`	`string`
`borderColor?`	`string`
`borderRadius?`	`string`
`borderSize?`	`string`
`borderStyle?`	`ChartTooltipBorderStyle`
`enabled?`	`boolean`
`fontFamily?`	`string`
`fontSize?`	`string`
`fontStyle?`	`ChartTooltipFontStyle`
`fontWeight?`	`ChartTooltipFontWeight`
`textColor?`	`string`

backgroundColor?: string

指定图表工具提示背景颜色。
默认值：'#fff'。
'$theme' - 背景色使用主题背景色。
'$none' - 背景颜色保持不变。
'LightGray'|'#6495ed'|... - 从值中使用背景颜色。请参阅 https://developer.mozilla.org/en-US/docs/Web/CSS/color_value

示例

backgroundColor: 'LightGray'

borderColor?: string

指定图表工具提示边框的颜色。
默认值：'#292929'。
'$theme' - 使用主题边框颜色的边框颜色。
'$none' - 边框颜色保持不变。
'LightGray'|'#6495ed'|... - 从值中使用边框颜色。请参阅 https://developer.mozilla.org/en-US/docs/Web/CSS/color_value

示例

borderColor: '#4e0000'

borderRadius?: string

以 px 或 pt 为单位指定图表工具提示边框的半径。
该值必须大于或等于 0 且小于 10。
默认值：'3px'。\

示例

borderRadius: '1pt'

borderSize?: string

指定图表工具提示边框的大小。
该值必须大于 0 且小于 10。
默认值：'1px'。\

示例

borderSize: '1pt'

borderStyle?: ChartTooltipBorderStyle

指定图表工具提示边框的样式。
默认值：“Solid”。\

示例

borderStyle: 'Dotted'

enabled?: boolean

启用图表工具提示。
如果此值设置为 false，则不会显示图表工具提示。
默认值：true。

示例

enabled: false

fontFamily?: string

指定图表工具提示中使用的字体系列。
如果 fontFamily 未在此处明确指定，则使用默认字体系列。

示例

fontFamily: 'Times New Roman'

fontSize?: string

指定图表工具提示中使用的字体大小。
字体大小可以 px 或 pt 为单位设置。字体大小值必须大于 6 且不得超过 34。默认值：'12px'。\

示例

fontSize: '10pt'

fontStyle?: ChartTooltipFontStyle

指定图表工具提示中使用的字体样式。
默认值：“Normal”。\

示例

fontStyle: 'Italic'

fontWeight?: ChartTooltipFontWeight

指定图表工具提示中使用的字体粗细。
默认值：“Normal”。\

示例

fontWeight: 'Bold'

textColor?: string

指定图表工具提示文本颜色。
默认值：“#333”。
'$theme' - 使用主题文本颜色中的文本颜色。
'$none' - 文本颜色保持不变。
'LightGray'|'#6495ed'|... - 使用值中的文本颜色。请参阅 https://developer.mozilla.org/en-US/docs/Web/CSS/color_value

示例

textColor: 'DarkGray'

ChartTooltipBorderStyle

描述图表工具提示 borderStyle 选项的所有可能值.

ChartTooltipFontStyle

Ƭ ChartTooltipFontStyle: "Normal" | "Italic"

描述图表工具提示 fontStyle 选项的所有可能值.

ChartTooltipFontWeight

描述图表工具提示 fontWeight 选项的所有可能值.

DisplayType

Ƭ DisplayType: "Page" | "Galley"

所有支持的显示类型.

ExportOptions

Ƭ ExportOptions<T>: Object

描述导出选项.

Type parameters

名称	类型
`T`	extends `ExportType` = `ExportType`

Type declaration

名称	类型
`settings?`	`ExportSettings`<`T`>

settings?: ExportSettings<T>

指定可用于 RenderingExtensions 的导出设置.

示例

settings: { Title: '1997 Annual Report' }

ExportResult

Ƭ ExportResult: Object

描述导出结果.

Type declaration

名称	类型
`file`	`Blob`
`filename?`	`string`

file: Blob

导出的报表文件

filename?: string

报表的文件名.

ExportSettings

Ƭ ExportSettings<T>: ExportSettingsMap[T]

Type parameters

名称	类型
`T`	extends `ExportType` = `ExportType`

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`

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"

导出PDF-显示模式 | 键名 | 描述 | | :--------- |:--------- | | None | 无 | | Outlines | 大纲 | | Thumbs | 缩略图 | | FullScreen | 全屏 |

ExportSettingsDocumentCompatibilityVersion

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

ExportSettingsDocx

Ƭ ExportSettingsDocx: Object

Type declaration

名称	类型
`AddTimestamp?`	`boolean`
`Author?`	`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`

AddTimestamp?: boolean

文件名称追加时间戳

Author?: 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"

导出PDF-双工模式 | 键名 | 描述 | | :------------------ | :------------------ | | Simplex | 单面 | | DuplexFlipLongEdge | 双面翻转长边 | | DuplexFlipShortEdge | 双面翻转短边 |

ExportSettingsEmbedFonts

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

导出PDF-嵌入字体 | 键名 | 描述 | | :------ | :------ | | 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`
`EnableToggles?`	`boolean`
`FileFormat?`	`ExportSettingsFileFormat`
`FilenameTemplate?`	`string`
`MultiSheet?`	`boolean`
`Orientation?`	`ExportSettingsOrientation`
`OutputFormat?`	`ExportSettingsOutputFormat`
`Pagination?`	`boolean`
`PaperSize?`	`ExportSettingsPaperSize`
`Password?`	`string`
`ProtectedBy?`	`string`
`ReadOnlyRecommended?`	`boolean`
`SheetName?`	`string`
`UseCompression?`	`boolean`
`UseDefaultPalette?`	`boolean`
`WritePassword?`	`string`

AddTimestamp?: boolean

文件名称追加时间戳

EnableToggles?: boolean

启用切换

FileFormat?: ExportSettingsFileFormat

文件格式

FilenameTemplate?: string

动态名称格式

MultiSheet?: boolean

多页

Orientation?: ExportSettingsOrientation

纸张方向

OutputFormat?: ExportSettingsOutputFormat

输出格式

Pagination?: boolean

分页显示

PaperSize?: ExportSettingsPaperSize

纸张大小

Password?: string

密码

ProtectedBy?: string

受保护

ReadOnlyRecommended?: boolean

只读模式打开

SheetName?: string

工作表名字

UseCompression?: boolean

启用压缩

UseDefaultPalette?: boolean

使用默认调色板

WritePassword?: string

编辑密码

ExportSettingsExceldata

Ƭ ExportSettingsExceldata: Object

Type declaration

名称	类型
`AddTimestamp?`	`boolean`
`AllowImages?`	`boolean`
`AutoRowsHeight?`	`boolean`
`ColumnsDelimiter?`	`string`
`Encoding?`	`ExportSettingsEncoding`
`FileFormat?`	`ExportSettingsFileFormat`
`FilenameTemplate?`	`string`
`NoHeader?`	`boolean`
`OpenXmlStandard?`	`ExportSettingsOpenXmlStandard`
`QuotationSymbol?`	`string`
`RightToLeft?`	`boolean`
`RowsDelimiter?`	`string`
`UseCompression?`	`boolean`

AddTimestamp?: boolean

文件名称追加时间戳

AllowImages?: boolean

允许导出图片

AutoRowsHeight?: boolean

自动行高

ColumnsDelimiter?: string

列分隔符

Encoding?: ExportSettingsEncoding

编码格式

FileFormat?: ExportSettingsFileFormat

文件格式

FilenameTemplate?: string

动态名称格式

NoHeader?: boolean

文件格式

OpenXmlStandard?: ExportSettingsOpenXmlStandard

输出格式

QuotationSymbol?: string

分隔符号

RightToLeft?: boolean

从右往左

RowsDelimiter?: string

行分隔符

UseCompression?: boolean

启用压缩

ExportSettingsExtension

Ƭ ExportSettingsExtension: "csv" | "txt"

导出CSV-扩展设置 | 键名 | 描述 | | :-- | :--- | | csv | .csv | | txt | .txt |

ExportSettingsFileFormat

Ƭ ExportSettingsFileFormat: "Xlsx" | "Xls"

导出Excel-文件格式 | 键名 | 描述 | | :--- | :--- | | Xlsx | Xlsx | | Xls | Xls |

ExportSettingsHorizontalPaddings

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

导出TXT-水平间距 | 键名 | 描述 | | :----- | :----- | | 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`

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`

AddTimestamp?: boolean

文件名称追加时间戳

Dither?: boolean

导出Image设置

DpiX?: number

横向分辨率

DpiY?: number

纵向分辨率

EndPage?: number

结束页码

FilenameTemplate?: string

动态名称格式

ImageType?: ExportSettingsImageType

图片类型

Pagination?: boolean

分页

PrintLayoutMode?: ExportSettingsPrintLayoutMode

打印版面模式

Quality?: number

导出Image设置

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"

导出PDF-图片插值 | 键名 | 描述 | | :------ | :------ | | Default | 默认 | | None | 无 |

ExportSettingsImageType

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

导出Image-图片类型 | 键名 | 描述 | | :--- | :--- | | Png | PNG | | Jpeg | JPEG | | Gif | GIF | | Bmp | BMP | | Tiff | TIFF |

ExportSettingsJson

Ƭ ExportSettingsJson: Object

Type declaration

名称	类型
`AddTimestamp?`	`boolean`
`FilenameTemplate?`	`string`
`Formatted?`	`boolean`
`QuotePropertyNames?`	`boolean`

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`

csv: ExportSettingsCsv

docx: ExportSettingsDocx

excel: ExportSettingsExcel

exceldata: ExportSettingsExceldata

html: ExportSettingsHtml

image: ExportSettingsImage

json: ExportSettingsJson

pdf: ExportSettingsPdf

txt: ExportSettingsTxt

xml: ExportSettingsXml

ExportSettingsOpenXmlStandard

Ƭ ExportSettingsOpenXmlStandard: "Transitional" | "Strict"

导出-输出格式 | 键名 | 描述 | | :----------- | :----------- | | Transitional | Transitional | | Strict | Strict |

ExportSettingsOrientation

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

导出Excel-纸张方向 | 键名 | 描述 | | :-------- | :-------- | | Default | 默认 | | Portrait | 纵向 | | Landscape | 横向 |

ExportSettingsOutputFormat

Ƭ ExportSettingsOutputFormat: "Transitional" | "Strict"

导出Excel-输出格式 | 键名 | 描述 | | :----------- | :----------- | | Transitional | Transitional | | Strict | Strict |

ExportSettingsPaperSize

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`

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

使用128Bit

UserPassword?: string

用户密码

Version?: ExportSettingsVersion

版本

WatermarkAngle?: number

水印角度

WatermarkColor?: ExportSettingsWatermarkColor

水印颜色

WatermarkFontBold?: boolean

水印字体加粗

WatermarkFontFamily?: ExportSettingsWatermarkFontFamily

水印字体

WatermarkFontItalic?: boolean

水印字体斜体

WatermarkFontSize?: number

水印字体大小

WatermarkFontStrikeout?: boolean

水印字体删除线

WatermarkFontUnderline?: boolean

水印字体下滑线

WatermarkTitle?: string

水印标题

ExportSettingsPermissions

ExportSettingsPrintLayoutMode

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

ExportSettingsRenderMode

Ƭ ExportSettingsRenderMode: "Galley" | "Paginated"

导出HTML-渲染模式 | 键名 | 描述 | | :-------- | :-------- | | Galley | 不分页 | | Paginated | 分页 |

ExportSettingsRenderingEngine

Ƭ ExportSettingsRenderingEngine: "Html" | "Mixed"

导出HTML-渲染方式 | 键名 | 描述 | | :---- | :---- | | Html | Html | | Mixed | 混合模式 |

ExportSettingsTxt

Ƭ ExportSettingsTxt: Object

Type declaration

名称	类型
`AddTimestamp?`	`boolean`
`CharHeightInTwips?`	`number`
`CharWidthInTwips?`	`number`
`FilenameTemplate?`	`string`
`HorizontalPaddings?`	`ExportSettingsHorizontalPaddings`
`LineEnding?`	`string`

AddTimestamp?: boolean

文件名称追加时间戳

CharHeightInTwips?: number

图表高度

CharWidthInTwips?: number

图表宽度

FilenameTemplate?: string

动态名称格式

HorizontalPaddings?: ExportSettingsHorizontalPaddings

水平间距

LineEnding?: string

线条终点

ExportSettingsVersion

导出PDF-版本设置 | 键名 | 描述 | | :----- | :------- | | Pdf12 | PDF-1.2 | | Pdf13 | PDF-1.3 | | Pdf14 | PDF-1.4 | | Pdf15 | PDF-1.5 | | Pdf16 | PDF-1.6 | | Pdf17 | PDF-1.7 | | PdfA1a | PDF/A-1a | | PdfA1b | PDF/A-1b | | PdfA2a | PDF/A-2a | | PdfA2b | PDF/A-2b | | PdfA2u | PDF/A-2u | | PdfA3a | PDF/A-3a | | PdfA3b | PDF/A-3b | | PdfA3u | PDF/A-3u | | PdfUA1 | PDF/UA-1 |

ExportSettingsWatermarkColor

ExportSettingsWatermarkFontFamily

ExportSettingsXml

Ƭ ExportSettingsXml: Object

Type declaration

名称	类型
`AddTimestamp?`	`boolean`
`DefaultDateFormat?`	`string`
`FilenameTemplate?`	`string`
`Formatted?`	`boolean`
`OutputHiddenMatrixMembers?`	`boolean`
`OutputTextboxConstantValues?`	`boolean`
`WriteEmptyAttributes?`	`boolean`

AddTimestamp?: boolean

文件名称追加时间戳

DefaultDateFormat?: string

默认日期格式

FilenameTemplate?: string

动态名称格式

Formatted?: boolean

格式

OutputHiddenMatrixMembers?: boolean

输出隐藏成员

OutputTextboxConstantValues?: boolean

输出文本框常量值

WriteEmptyAttributes?: boolean

输出空属性

ExportType

所有支持的导出类型.

GetLocalizationResourcesErrorResult

Ƭ GetLocalizationResourcesErrorResult: Object

GrapeCity.WynReports.Viewer.getLocalizationResources() 函数返回的错误结果类型.

Type declaration

名称	类型
`errorCaption`	`string`
`errorDetails`	`string`[]
`type`	`"error"`

errorCaption: string

错误说明

errorDetails: string[]

错误详情

type: "error"

错误结果类型

GetLocalizationResourcesResult

Ƭ GetLocalizationResourcesResult: GetLocalizationResourcesSuccessResult | GetLocalizationResourcesErrorResult

GrapeCity.WynReports.Viewer.getLocalizationResources() 函数返回的结果类型.

GetLocalizationResourcesSuccessResult

Ƭ GetLocalizationResourcesSuccessResult: Object

GrapeCity.WynReports.Viewer.getLocalizationResources() 函数返回的成功结果类型.

Type declaration

名称	类型
`resourceBundles`	`LocalizationResourceBundle`[] \| `undefined`
`type`	`"success"`

resourceBundles: LocalizationResourceBundle[] | undefined

本地化资源包

type: "success"

成功结果类型

HoverChartAnimationOptions

Ƭ HoverChartAnimationOptions: Object

描述可应用于报表视图的悬停图表动画.

Type declaration

名称	类型
`enabled?`	`boolean`

enabled?: boolean

启用悬停图表动画。默认值：false.

示例

enabled: true

HoverTableAnimationOptions

Ƭ HoverTableAnimationOptions: Object

描述可应用于报表视图的悬停表和 tablix 动画.

Type declaration

名称	类型
`backgroundColor?`	`string`
`enabled?`	`boolean`
`textColor?`	`string`

backgroundColor?: string

指定悬停在表格和 Tablix 行上时的背景颜色。
默认值：'$theme'。
'$theme' - 背景色使用主题背景色。
'$none' - 背景颜色保持不变。
'LightGray'|'#6495ed'|... - 从值中使用背景颜色。请参阅 https://developer.mozilla.org/en-US/docs/Web/CSS/color_value

示例

backgroundColor: 'LightGray'

enabled?: boolean

启用悬停表和 tablix 动画。默认值：false.

示例

enabled: true

textColor?: string

指定悬停在表格和 Tablix 行上时的文本颜色。
默认值：'$theme'。
'$theme' - 使用主题文本颜色中的文本颜色。
'$none' - 文本颜色保持不变。
'LightGray'|'#6495ed'|... - 使用值中的文本颜色。请参阅 https://developer.mozilla.org/en-US/docs/Web/CSS/color_value

示例

textColor: 'DarkGray'

InitViewerOptions

Ƭ InitViewerOptions: Object

以下选项可以在初始化期间或在使用查看器运行时设置.

Type declaration

名称	类型
`animation?`	`AnimationOptions`
`availableExports?`	`ExportType`[]
`disableFocusTimer?`	`boolean`
`displayType?`	`DisplayType`
`element`	`string`
`hideSearch?`	`boolean`
`hideToolbar?`	`boolean`
`locale?`	`string`
`makeTitle?`	(`reportName`: `string`) => `string`
`pageViewOptions?`	`PageViewOptions`
`paramPanelPosition?`	`PanelsLocation`
`paramPanelShowMode?`	`ParamPanelShowMode`
`parameterPanel?`	`ParameterPanelOptions`
`portalUrl?`	`string`
`referenceToken?`	`string`
`reportId?`	`string`
`reportParameters?`	`Parameter`[]
`toolbarSize?`	`"small"` \| `"medium"` \| `"large"`
`viewMode?`	`ViewMode`
`zoomMode?`	`ZoomMode`

animation?: AnimationOptions

报表视图动画选项。默认值：<动画已禁用>。

示例

animation: { hoverTable: { enabled: true } }

availableExports?: ExportType[]

通过 Viewer 的导出功能可用的导出类型数组。默认情况下使用所有 ExportType 值。

示例

availableExports: ['xml', 'pdf']

disableFocusTimer?: boolean

禁用焦点突出显示计时器以获得更好的可访问性。

示例

disableFocusTimer: false

displayType?: DisplayType

设置显示类型。默认值为报表显示类型。

示例

displayType: 'Galley'

element: string

指定托管 Viewer 控件的元素的 DOMString。

示例

element: 'report-viewer-app'

hideSearch?: boolean

指定是否隐藏搜索面板的标志。默认值：false。

示例

hideSearch: true

hideToolbar?: boolean

指定是否隐藏工具栏的标志。默认值：false。

示例

hideToolbar: true

locale?: string

指定用于显示查看器的语言环境。如果 locale 未在此处明确指定，则使用与浏览器首选项对应的区域设置。

示例

locale: 'zh'

makeTitle?: (reportName: string) => string

查看器显示自定义标题。

示例

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

pageViewOptions?: PageViewOptions

定义报表页面的水平对齐方式和视图，例如网页的一部分或“纸张视图”

示例

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

paramPanelPosition?: PanelsLocation

设置参数面板位置。默认值：“Right”。

Deprecated

示例

paramPanelPosition: 'Top'

paramPanelShowMode?: ParamPanelShowMode

设置显示参数面板的规则。如果值为“Always”，则无论如何都会在文档打开事件中显示参数面板。默认值：“Default”。

Deprecated

示例

paramPanelShowMode: 'Always'

parameterPanel?: ParameterPanelOptions

定义参数面板选项.

示例

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

portalUrl?: string

Wyn 门户网址。

示例

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

referenceToken?: string

访问 Wyn API 所需的参考密钥。

示例

referenceToken: '<referenceToken>'

reportId?: string

查看器要显示的报表的 ID。

Deprecated

Use

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

示例

reportId: '<reportId>'

reportParameters?: Parameter[]

描述用于运行报表的参数值的 {name, value} 对数组。

Deprecated

Use

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

示例

String parameters

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

示例

Float parameters

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

示例

Integer parameters

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

示例

DateTime parameters

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

示例

Date parameters

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

示例

Boolean parameters

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

示例

Multivalue string parameters

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

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

定义工具栏大小。默认值：“large”。

示例

toolbarSize: 'small'

viewMode?: ViewMode

设置单页或连续页。默认值：“Single”。

示例

viewMode: 'Continuous'

zoomMode?: ZoomMode

设置缩放模式。默认值“Default”。

示例

zoomMode: 'FitToWidth'

LoadChartAnimationOptions

Ƭ LoadChartAnimationOptions: Object

描述可以应用于报表视图的加载图表动画.

Type declaration

名称	类型
`enabled?`	`boolean`

enabled?: boolean

启用加载图表动画。默认值：false.

示例

enabled: true

LocalizationResourceBundle

Ƭ LocalizationResourceBundle: Object

GetLocalizationResourcesSuccessResult.resourceBundles 数组元素的类型。

Type declaration

名称	类型
`ns`	`string`
`resources`	`Record`<`string`, `any`>

ns: string

包命名空间

resources: Record<string, any>

本地化资源

OpenReportOptions

Ƭ OpenReportOptions: Object

描述打开的报表选项.

Type declaration

名称	类型
`parameters?`	`Parameter`[]

parameters?: Parameter[]

报表参数值的数组.

示例

String parameters

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

示例

Float parameters

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

示例

Integer parameters

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

示例

DateTime parameters

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

示例

Date parameters

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

示例

Boolean parameters

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

示例

Multivalue string parameters

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

OverridableToolbarButton

Ƭ OverridableToolbarButton: "$print"

打印按钮 | Key | Description | | :-------------- | :------------------------------------------------------- | | $print | 'Print' button. |

PageViewOptions

Ƭ PageViewOptions: Object

描述页面视图选项.

Type declaration

名称	类型
`horizontalAlignment?`	`"left"` \| `"right"` \| `"center"`
`withoutPaperView?`	`boolean`

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

定义视图区域内报表页面的水平对齐方式。默认值：“center”.

示例

horizontalAlignment: 'left'

withoutPaperView?: boolean

删除“灰色”背景、阴影、纸张边框和其他造成“纸张视图”的东西。默认值：false。

示例

withoutPaperView: true

PanelsLocation

Ƭ PanelsLocation: "Top" | "Right"

所有支持的面板位置

ParamPanelShowMode

Ƭ ParamPanelShowMode: "Default" | "Always"

所有支持的参数面板显示模式

Parameter

Ƭ Parameter: Object

描述用于运行报表的参数值.

Type declaration

名称	类型
`name`	`string`
`values`	`any`[]

name: string

参数的名称.

示例

name: 'Parameter1'

values: any[]

参数的值.

示例

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

ParameterPanelOptions

Ƭ ParameterPanelOptions: Object

描述参数面板选项。

Type declaration

名称	类型
`position?`	`PanelsLocation`
`roundedControls?`	`boolean`
`showMode?`	`ParamPanelShowMode`

position?: PanelsLocation

设置参数面板位置。默认值：“Right”。

roundedControls?: boolean

启用参数面板控件的圆角。默认值：false。

showMode?: ParamPanelShowMode

设置显示参数面板的规则。如果值为“Always”，则无论如何都会在文档打开事件中显示参数面板。默认值：“Default”。

ReportInfo

Ƭ ReportInfo: Object

关于打开的报表的信息.

Type declaration

名称	类型
`displayType`	`DisplayType`
`name`	`string`

displayType: DisplayType

报表的显示类型.

name: string

报表的名称.

SearchOptions

Ƭ SearchOptions: Object

描述搜索选项.

Type declaration

名称	类型
`matchCase?`	`boolean`
`wholePhrase?`	`boolean`

matchCase?: boolean

指定搜索是否区分大小写。默认值：false.

示例

matchCase: true

wholePhrase?: boolean

指定搜索是否应查找整个短语。默认值：false.

示例

wholePhrase: true

SearchResult

Ƭ SearchResult: Object

描述搜索结果.

Type declaration

名称	类型
`DisplayText`	`string`
`PageIndex`	`number`

DisplayText: string

要显示的文本.

PageIndex: number

出现的页面的索引.

ViewMode

Ƭ ViewMode: "Single" | "Continuous"

所有支持的视图模式.

Viewer

Ƭ Viewer: Object

表示一个 Viewer 实例的类型.

Type declaration

名称	类型
`backToParent`	() => `void`
`destroy`	() => `void`
`export`	<T>(`exportType`: `T`, `options?`: `ExportOptions`<`T`>) => `Promise`<`ExportResult`>
`getCurrentPage`	() => `number`
`getPageCount`	() => `number`
`goToPage`	(`pageNumber`: `number`) => `void`
`openReport`	(`reportId`: `string`, `options?`: `OpenReportOptions`) => `Promise`<`ReportInfo`>
`overrideToolbarAction`	(`toolbarButton`: `OverridableToolbarButton`, `action`: () => `void`) => `void`
`print`	() => `Promise`<`void`>
`refresh`	() => `void`
`search`	(`searchTerm`: `string`, `options?`: `SearchOptions`) => `Promise`<`SearchResult`[]>
`toggleSidebar`	(`show?`: `boolean`) => `void`

backToParent: () => void

使查看器显示下钻报表的父报表。

示例

viewer.backToParent();

destroy: () => void

从元素中删除查看器内容。

示例

viewer.destroy();

export: <T>(exportType: T, options?: ExportOptions<T>) => Promise<ExportResult>

导出当前显示的报表。

示例

await viewer.export('pdf', { settings: { Title: '1997 Annual Report' } });

getCurrentPage: () => number

获取当前显示的页码。

示例

const currentPage = viewer.getCurrentPage();
console.log(currentPage);

getPageCount: () => number

获取当前显示的报表的页数。

示例

const pageCount = viewer.getPageCount();
console.log(pageCount);

goToPage: (pageNumber: number) => void

使查看器显示特定页面。页码从 1 开始。

示例

viewer.goToPage(1);

openReport: (reportId: string, options?: OpenReportOptions) => Promise<ReportInfo>

打开报表.

示例

const reportInfo = await viewer.openReport('<reportId>', { parameters: [{ name: 'myString', values: ['123'] }] });
console.log('The report ' + reportInfo.name + ' was successfully loaded!')

overrideToolbarAction: (toolbarButton: OverridableToolbarButton, action: () => void) => void

自定义工具栏操作。

示例

viewer.overrideToolbarAction('$print', () => { console.log('Print'); })

print: () => Promise<void>

打印当前显示的报表（如果有）。

示例

await viewer.print();

refresh: () => void

刷新报表预览.

示例

viewer.refresh();

search: (searchTerm: string, options?: SearchOptions) => Promise<SearchResult[]>

使用特定搜索选项执行特定术语的搜索。

示例

const searchResult = await viewer.search('a', { matchCase: true, wholePhrase: false });
console.log(searchResult);

toggleSidebar: (show?: boolean) => void

设置或切换侧边栏面板的可见性。

示例

Show panel

viewer.toggleSidebar(true);

示例

Hide panel

viewer.toggleSidebar(false);

示例

Toggle visibility

viewer.toggleSidebar();

ViewerApi

Ƭ ViewerApi: Object

GrapeCity.WynReports.Viewer 对象的类型.

Type declaration

名称	类型
`addLocalization`	(`lng`: `string`, `resourceBundles`: `LocalizationResourceBundle`[]) => `AddLocalizationResult`
`create`	(`options`: `InitViewerOptions`) => `Viewer`
`getLocalizationResources`	(`lng`: `string`, `portalUrl`: `string`, `referenceToken?`: `string`) => `Promise`<`GetLocalizationResourcesResult`>

addLocalization: (lng: string, resourceBundles: LocalizationResourceBundle[]) => AddLocalizationResult

为报表查看器添加自定义本地化资源。
然后需要将 lng 传递给 initViewerOptions.locale 以应用添加的资源。

示例

const result = GrapeCity.WynReports.Viewer.addLocalization('zh-CN', resourceBundles);
if (result.type === 'success') initViewerOptions.locale = 'zh-CN';
else console.error([result.errorCaption, ...result.errorDetails].join('\n'));

create: (options: InitViewerOptions) => Viewer

创建并初始化查看器。

示例

const viewer = GrapeCity.WynReports.Viewer.create({
	element: 'report-viewer-app',
	portalUrl: 'http://wyn-portal.com/',
	referenceToken: '<referenceToken>',
	reportId: '<reportId>',
});

getLocalizationResources: (lng: string, portalUrl: string, referenceToken?: string) => Promise<GetLocalizationResourcesResult>

获取 Wyn API 提供的自定义本地化资源。
获取的资源用于GrapeCity.WynReports.Viewer.addLocalization()。

示例

const result = GrapeCity.WynReports.Viewer.getLocalizationResources('zh-CN', '<portalUrl>', '<referenceToken>');
if (result.type === 'success') GrapeCity.WynReports.Viewer.addLocalization('zh-CN', result.resourceBundles);
else console.error([result.errorCaption, ...result.errorDetails].join('\n'));

ZoomMode

Ƭ ZoomMode: "FitToWidth" | "FitToPage" | "Default"

所有支持的缩放模式.

report.reportViewerType

命名空间: reportViewerType

Table of contents

Type Aliases

Type Aliases

AddLocalizationErrorResult

Type declaration

AddLocalizationResult

AddLocalizationSuccessResult

Type declaration

AnimationOptions

Type declaration

ChartTooltipAnimationOptions

Type declaration

ChartTooltipBorderStyle

ChartTooltipFontStyle

ChartTooltipFontWeight

DisplayType

ExportOptions

Type parameters

Type declaration

ExportResult

Type declaration

ExportSettings

Type parameters

ExportSettingsCsv

Type declaration

ExportSettingsDisplayMode

ExportSettingsDocumentCompatibilityVersion

ExportSettingsDocx

Type declaration

ExportSettingsDuplexMode

ExportSettingsEmbedFonts

ExportSettingsEncoding

ExportSettingsExcel

Type declaration

ExportSettingsExceldata

Type declaration

ExportSettingsExtension

ExportSettingsFileFormat

ExportSettingsHorizontalPaddings

ExportSettingsHtml

Type declaration

ExportSettingsImage

Type declaration

ExportSettingsImageInterpolation

ExportSettingsImageType

ExportSettingsJson

Type declaration

ExportSettingsMap

Type declaration

ExportSettingsOpenXmlStandard

ExportSettingsOrientation

ExportSettingsOutputFormat

ExportSettingsPaperSize

ExportSettingsPdf

Type declaration

ExportSettingsPermissions

ExportSettingsPrintLayoutMode

ExportSettingsRenderMode

ExportSettingsRenderingEngine

ExportSettingsTxt

Type declaration

ExportSettingsVersion

ExportSettingsWatermarkColor

ExportSettingsWatermarkFontFamily

ExportSettingsXml

Type declaration

ExportType

GetLocalizationResourcesErrorResult

Type declaration

GetLocalizationResourcesResult

GetLocalizationResourcesSuccessResult

Type declaration

HoverChartAnimationOptions

Type declaration

HoverTableAnimationOptions

Type declaration

InitViewerOptions

Type declaration