ASPxClientDashboardExportOptions Class
Contains settings that specify parameters affecting how the dashboard (dashboard item) is exported.
#Declaration
declare class ASPxClientDashboardExportOptions
#Remarks
The ASPxClientDashboardExportOptions class properties allow you to specify various options when exporting the dashboard (dashboard item) using the client-side functionality of the ASPxDashboard. For instance, you can specify the layout of the exported document, the paper size, etc.
Warning
A use of ASPx
API reduces flexibility when you configure the control. The DashboardASPx
object. The control provides access to all client settings and allows you to implement complex scenarios. We recommend that you use the Dashboard
API to configure the Web Dashboard on the client. More information: Client-Side Functionality.
#Example
The following code snippet shows how to export the Chart dashboard item displayed within the ASPxDashboard using the ASPxClientDashboard.ExportDashboardItemToPdf client-side method with specific PDF-export options specified.
function(s, e) {
webDashboard.ExportDashboardItemToPdf('chartDashboardItem1', {
PaperKind: DashboardExportPaperKind.A3,
PageLayout : DashboardExportPageLayout.Landscape,
ScaleMode: DashboardExportScaleMode.UseScaleFactor,
ScaleFactor: 1.5
}
);
}
#Properties
#AutoFitPageCount Property
Obsolete. Gets or sets the number of horizontal/vertical pages that span the total width/height of a dashboard (dashboard item).
#Declaration
AutoFitPageCount: number
#Property Value
Type | Description |
---|---|
number | An integer value that specifies the number of horizontal/vertical pages that span the total width/height of a dashboard (dashboard item). |
#Remarks
The AutoFitPageCount property is in effect when the ASPxClientDashboardExportOptions.ScaleMode property is set to DashboardExportScaleMode.AutoFitToPageWidth.
#CardOptions Property
Obsolete. Provides access to options for exporting a Card dashboard item.
#Declaration
CardOptions: CardExportOptions
#Property Value
Type | Description |
---|---|
Card |
A Card |
#Remarks
The CardOptions property settings are not in effect when the entire content of the dashboard is exported.
#ChartOptions Property
Obsolete. Provides access to options for exporting a Chart dashboard item.
#Declaration
ChartOptions: ChartExportOptions
#Property Value
Type | Description |
---|---|
Chart |
A Chart |
#Remarks
The ChartOptions property settings are not in effect when the entire content of the dashboard is exported.
#ExcelOptions Property
Obsolete. Provides access to options for exporting individual dashboard items in Excel format.
#Declaration
ExcelOptions: ExcelFormatOptions
#Property Value
Type | Description |
---|---|
Excel |
An Excel |
#FilterState Property
Obsolete. Gets or sets the filter state’s location on the exported document.
#Declaration
FilterState: string
#Property Value
Type | Description |
---|---|
string | A string value returned by the Dashboard |
#GaugeOptions Property
Obsolete. Provides access to options for exporting a Gauge dashboard item.
#Declaration
GaugeOptions: GaugeExportOptions
#Property Value
Type | Description |
---|---|
Gauge |
A Gauge |
#Remarks
The GaugeOptions property settings are not in effect when the entire content of the dashboard is exported.
#GridOptions Property
Obsolete. Provides access to options for exporting a Grid dashboard item.
#Declaration
GridOptions: GridExportOptions
#Property Value
Type | Description |
---|---|
Grid |
A Grid |
#Remarks
The GridOptions property settings are not in effect when the entire content of the dashboard is exported.
#ImageOptions Property
Obsolete. Provides access to options for exporting a dashboard or individual items in Image format.
#Declaration
ImageOptions: ImageFormatOptions
#Property Value
Type | Description |
---|---|
Image |
An Image |
#MapOptions Property
Obsolete. Provides access to options for exporting map dashboard items.
#Declaration
MapOptions: MapExportOptions
#Property Value
Type | Description |
---|---|
Map |
A Map |
#Remarks
The MapOptions property settings are not in effect when the entire content of the dashboard is exported.
#PageLayout Property
Obsolete. Gets or sets the page orientation used to export a dashboard (dashboard item).
#Declaration
PageLayout: string
#Property Value
Type | Description |
---|---|
string | A string value returned by the Dashboard |
#PaperKind Property
Obsolete. Gets or sets the standard paper size.
#Declaration
PaperKind: string
#Property Value
Type | Description |
---|---|
string | A string value returned by the Dashboard |
#PieOptions Property
Obsolete. Provides access to options for exporting a Pie dashboard item.
#Declaration
PieOptions: PieExportOptions
#Property Value
Type | Description |
---|---|
Pie |
A Pie |
#Remarks
The PieOptions property settings are not in effect when the entire content of the dashboard is exported.
#PivotOptions Property
Obsolete. Provides access to options for exporting a Pivot dashboard item.
#Declaration
PivotOptions: PivotExportOptions
#Property Value
Type | Description |
---|---|
Pivot |
A Pivot |
#Remarks
The PivotOptions property settings are not in effect when the entire content of the dashboard is exported.
#RangeFilterOptions Property
Obsolete. Provides access to options for exporting a Range Filter dashboard item.
#Declaration
RangeFilterOptions: RangeFilterExportOptions
#Property Value
Type | Description |
---|---|
Range |
A Range |
#Remarks
The RangeFilterOptions property settings are not in effect when the entire content of the dashboard is exported.
#ScaleFactor Property
Obsolete. Gets or sets the scale factor (in fractions of 1) by which a dashboard (dashboard item) is scaled.
#Declaration
ScaleFactor: number
#Property Value
Type | Description |
---|---|
number | A Single value that specifies the scale factor by which a dashboard (dashboard item) is scaled. |
#Remarks
The ScaleFactor property is in effect when the ASPxClientDashboardExportOptions.ScaleMode property is set to DashboardExportScaleMode.UseScaleFactor.
#ScaleMode Property
Obsolete. Gets or sets the mode for scaling when exporting a dashboard (dashboard item).
#Declaration
ScaleMode: string
#Property Value
Type | Description |
---|---|
string | A string value returned by the Dashboard |
#Remarks
To change the size of the dashboard or split it into several pages, use the ScaleMode
property and specify the following export options depending on the selected mode:
Scale Mode | Related Property | Description |
---|---|---|
Dashboard |
ASPx |
Splits the dashboard into multiple pages and aligns it. |
Dashboard |
ASPx |
Scales the dashboard. |
Dashboard |
n/a | Changes the dashboard size to fit its content on a single page. |
Dashboard |
n/a | The dashboard size is fixed, and other dashboard scaling settings are not in effect. |
#ShowTitle Property
Obsolete. Gets or sets whether a dashboard title (or dashboard item’s caption) is included as the exported document title.
#Declaration
ShowTitle: boolean
#Property Value
Type | Description |
---|---|
boolean | A boolean value that specifies whether a dashboard title (or dashboard item’s caption) is included as the exported document title. |
#Title Property
Obsolete. Gets or sets the title of the exported document.
#Declaration
Title: string
#Property Value
Type | Description |
---|---|
string | A string value that specifies the title of the exported document. |
#TreemapOptions Property
Obsolete. Provides access to options for exporting a Treemap dashboard item.
#Declaration
TreemapOptions: TreemapExportOptions
#Property Value
Type | Description |
---|---|
Treemap |
A |
#Remarks
The TreemapOptions property settings are not in effect when the entire content of the dashboard is exported.