report/types
The following sections describe the module: report/types.
References
Type Aliases
References
AnimationOptions
Re-exports AnimationOptions
ApplicationInfo
Re-exports ApplicationInfo
BarcodeSymbology
Re-exports BarcodeSymbology
CreateReportOptions
Re-exports CreateReportOptions
CreateReportResult
Re-exports CreateReportResult
CreateReportSuccessResult
Re-exports CreateReportSuccessResult
DataSetInfo
Re-exports DataSetInfo
DesignerApi
Re-exports DesignerApi
DesignerOptions
Re-exports DesignerOptions
DesignerOptionsBase
Re-exports DesignerOptionsBase
DesignerOptionsOther
Re-exports DesignerOptionsOther
DisplayType
Re-exports DisplayType
ExportOptions
Re-exports ExportOptions
ExportResult
Re-exports ExportResult
ExportSettings
Re-exports ExportSettings
ExportSettingsCsv
Re-exports ExportSettingsCsv
ExportSettingsDocx
Re-exports ExportSettingsDocx
ExportSettingsExcel
Re-exports ExportSettingsExcel
ExportSettingsExceldata
Re-exports ExportSettingsExceldata
ExportSettingsHtml
Re-exports ExportSettingsHtml
ExportSettingsImage
Re-exports ExportSettingsImage
ExportSettingsJson
Re-exports ExportSettingsJson
ExportSettingsMap
Re-exports ExportSettingsMap
ExportSettingsPdf
Re-exports ExportSettingsPdf
ExportSettingsTxt
Re-exports ExportSettingsTxt
ExportSettingsXml
Re-exports ExportSettingsXml
ExportType
Re-exports ExportType
HelpInfo
Re-exports HelpInfo
HoverChartAnimationOptions
Re-exports HoverChartAnimationOptions
HoverTableAnimationOptions
Re-exports HoverTableAnimationOptions
InitViewerOptions
Re-exports InitViewerOptions
InitViewerOptionsBase
Re-exports InitViewerOptionsBase
InitViewerOptionsOther
Re-exports InitViewerOptionsOther
LoadChartAnimationOptions
Re-exports LoadChartAnimationOptions
Locale
Re-exports Locale
MakeTitleOptions
Re-exports MakeTitleOptions
OnErrorOptions
Re-exports OnErrorOptions
OnSavedOptions
Re-exports OnSavedOptions
OpenReportOptions
Re-exports OpenReportOptions
OpenReportResult
Re-exports OpenReportResult
OpenReportSuccessResult
Re-exports OpenReportSuccessResult
OverridableToolbarButton
Re-exports OverridableToolbarButton
PageViewOptions
Re-exports PageViewOptions
PanelsLocation
Re-exports PanelsLocation
ParamPanelShowMode
Re-exports ParamPanelShowMode
Parameter
Re-exports Parameter
ParameterPanelOptions
Re-exports ParameterPanelOptions
ProductInfo
Re-exports ProductInfo
ReportInfo
Re-exports ReportInfo
ReportOperation
Re-exports ReportOperation
ReportOperationErrorResult
Re-exports ReportOperationErrorResult
ReportingApi
Re-exports ReportingApi
SaveReportOptions
Re-exports SaveReportOptions
SaveReportResult
Re-exports SaveReportResult
SaveReportSuccessResult
Re-exports SaveReportSuccessResult
SearchOptions
Re-exports SearchOptions
SearchResult
Re-exports SearchResult
Units
Re-exports Units
UpdateRouteOptions
Re-exports UpdateRouteOptions
ViewMode
Re-exports ViewMode
Viewer
Re-exports Viewer
ViewerApi
Re-exports ViewerApi
ViewerOpenReportOptions
Renames and re-exports OpenReportOptions
ViewerOptions
Re-exports ViewerOptions
ViewerReportInfo
Renames and re-exports ReportInfo
ZoomMode
Re-exports ZoomMode
Type Aliases
CreateReportDesignerOptions
Ƭ CreateReportDesignerOptions: commonConfig & CreateReportDesignerOptionsBase & PartialDeepDesignerOptionsOther
This type specifies the options passed to the WynIntegration.createReportDesigner() function.
CreateReportDesignerOptionsBase
Ƭ CreateReportDesignerOptionsBase: Object
This type specifies the base options from the CreateReportDesignerOptions type.
Type declaration
Name | Type |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| { |
|
|
| |
|
|
applicationTitle?: string
Set your custom application title to be displayed in designer UI instead of the predefined title.
Example
applicationTitle: 'Application Title',applicationTitleCompact?: string
Set your custom compact application title to be displayed in designer UI instead of the predefined title. It will be displayed in places where there is not enough space for a full title.
Example
applicationTitleCompact: 'App Title',isReportTemplate?: boolean
Set whether a report or a template is opened. This is relevant only when reportId is defined.
Example
isReportTemplate: true,language?: string
Set the language of the user interface, the acceptable values are: 'zh', 'en', 'en-gb', 'zh-tw', 'pl'. Also, you can specify a custom language here in case it is uploaded to the Admin portal.
Example
language: 'zh',productTitle?: string
Set your custom product title to be displayed in About dialog.
Example
productTitle: 'Product Title',productVersion?: string
Set your custom product version to be displayed in About dialog. This is relevant only when productTitle is defined.
Example
productVersion: '3.2.1',readOnly?: boolean
Set whether a report or a template is opened in the read-only mode in order to prevent saving any changes. By default, this option is disabled so saving a report or template changes is allowed.
Example
readOnly: true,reportId?: string | null
Set the report id to be opened.
Example
reportId: 'your-report-id',reportVersion?: number | null
Set the report version to be opened. If not specified, the latest version is opened. This is relevant only when reportId is defined.
Example
reportVersion: 8,reportViewer?: { disabled?: boolean ; options?: PartialDeepViewerOptionsOther }
Set the built-in viewer availability and viewer options.
reportViewer.disabled?: boolean
Set whether the built-in viewer is available in designer.
Example
disabled: true,reportViewer.options?: PartialDeepViewerOptionsOther
Set the built-in viewer options. This is relevant only when viewer is available.
Example
options: { isFullscreen: true },theme?: string
Set the Wyn UI theme to be used by designer. Predefined themes are: 'default', 'ars', 'blue', 'dark-forest', 'forest', 'green', 'light', 'minimal-blue', 'red', 'warm-light'. Also, you can specify a custom theme here in case it is uploaded to the Admin portal. If theme is not specified, the Wyn user preferences are applied.
Example
theme: 'forest',CreateReportViewerOptions
Ƭ CreateReportViewerOptions: commonConfig & CreateReportViewerOptionsBase & PartialDeepViewerOptionsOther
This type specifies the options passed to the WynIntegration.createReportViewer() function.
CreateReportViewerOptionsBase
Ƭ CreateReportViewerOptionsBase: Object
This type specifies the base options from the CreateReportViewerOptions type.
Type declaration
Name | Type |
|---|---|
|
|
|
|
| |
|
|
language?: string
Set the language of the user interface, the acceptable values: 'zh', 'en', 'en-gb', 'zh-tw', 'pl'. Also you can specify a custom language here in case it is uploaded to the Admin portal.
Example
language: 'zh',reportId?: string | null
Set the report id to be previewed.
Example
reportId: 'your-report-id',reportParameters?: Parameter[]
Set the array of name/values pairs describing parameters and their values used to preview the report. This is relevant only when reportId is defined.
Example
reportParameters: [
{ name: 'StringParameter', values: ['abc'] },
{ name: 'IntegerMultivalueParameter', values: [1, 2, 3] },
{ name: 'BooleanParameter', values: [true] },
],theme?: string
Set the Wyn UI theme to be used by viewer. Predefined themes are: 'default', 'ars', 'blue', 'dark-forest', 'forest', 'green', 'light', 'minimal-blue', 'red', 'warm-light'. Also you can specify a custom theme here in case it is uploaded to the Admin portal. If theme is not specified, the Wyn user preferences are applied.
Example
theme: 'forest',LocalizationResourceBundle
Ƭ LocalizationResourceBundle: Object
Type declaration
Name | Type |
|---|---|
|
|
|
|
ns: string
resources: Record<string, any>