Skip to main content
BuyLog In
Business Intelligence Dashboard
Search in…
Docs > .NET Framework API Reference > DevExpress.DashboardWeb.Scripts > ASPxClientDashboardViewer > Members
All docs
V18.2
Dashboard
Getting Started
Basic Concepts and Terminology
Common Features
Creating the Designer and Viewer Applications
Creating Dashboards
Visual Studio Integration
End-User Documentation
Localization
Redistribution and Deployment
Video Tutorials
Examples
Member Tables
.NET Framework API Reference
DevExpress.DashboardCommon
DevExpress.DashboardCommon.DataSourceWizard
DevExpress.DashboardCommon.Localization
DevExpress.DashboardCommon.ViewerData
DevExpress.DashboardWeb
DevExpress.DashboardWeb.Localization
DevExpress.DashboardWeb.Mvc
DevExpress.DashboardWeb.Mvc.Scripts
DevExpress.DashboardWeb.Scripts
ASPxClientActionAvailabilityChangedEventArgs
ASPxClientActionAvailabilityChangedEventHandler
ASPxClientDashboard
ASPxClientDashboardAction
ASPxClientDashboardActionAvailabilityChangedEventArgs
ASPxClientDashboardActionAvailabilityChangedEventHandler
ASPxClientDashboardBeforeRenderEventHandler
ASPxClientDashboardBeginUpdateEventArgs
ASPxClientDashboardBeginUpdateEventHandler
ASPxClientDashboardChangedEventArgs
ASPxClientDashboardChangedEventHandler
ASPxClientDashboardDataLoadingErrorEventArgs
ASPxClientDashboardDataLoadingErrorEventHandler
ASPxClientDashboardDrillDownPerformedEventArgs
ASPxClientDashboardDrillDownPerformedEventHandler
ASPxClientDashboardDrillUpPerformedEventArgs
ASPxClientDashboardDrillUpPerformedEventHandler
ASPxClientDashboardEndUpdateEventArgs
ASPxClientDashboardEndUpdateEventHandler
ASPxClientDashboardExportOptions
ASPxClientDashboardInitializedEventArgs
ASPxClientDashboardInitializedEventHandler
ASPxClientDashboardInitializingEventArgs
ASPxClientDashboardInitializingEventHandler
ASPxClientDashboardItemAction
ASPxClientDashboardItemBeforeWidgetDisposedEventHandler
ASPxClientDashboardItemCaptionToolbarUpdatedEventArgs
ASPxClientDashboardItemCaptionToolbarUpdatedEventHandler
ASPxClientDashboardItemClickEventArgs
ASPxClientDashboardItemClickEventHandler
ASPxClientDashboardItemData
ASPxClientDashboardItemDataAxis
ASPxClientDashboardItemDataAxisPoint
ASPxClientDashboardItemDataAxisPointTuple
ASPxClientDashboardItemDataDelta
ASPxClientDashboardItemDataDeltaValue
ASPxClientDashboardItemDataDimension
ASPxClientDashboardItemDataDimensionValue
ASPxClientDashboardItemDataMeasure
ASPxClientDashboardItemDataMeasureValue
ASPxClientDashboardItemDrillDownStateChangedEventArgs
ASPxClientDashboardItemDrillDownStateChangedEventHandler
ASPxClientDashboardItemElementCustomColorEventArgs
ASPxClientDashboardItemElementCustomColorEventHandler
ASPxClientDashboardItemEventArgs
ASPxClientDashboardItemMasterFilterStateChangedEventArgs
ASPxClientDashboardItemMasterFilterStateChangedEventHandler
ASPxClientDashboardItemRequestUnderlyingDataCompleted
ASPxClientDashboardItemRequestUnderlyingDataParameters
ASPxClientDashboardItemSelectionChangedEventArgs
ASPxClientDashboardItemSelectionChangedEventHandler
ASPxClientDashboardItemUnderlyingData
ASPxClientDashboardItemVisualInteractivityEventArgs
ASPxClientDashboardItemVisualInteractivityEventHandler
ASPxClientDashboardItemWidgetCreatedEventHandler
ASPxClientDashboardItemWidgetEventArgs
ASPxClientDashboardItemWidgetUpdatedEventHandler
ASPxClientDashboardItemWidgetUpdatingEventHandler
ASPxClientDashboardMasterFilterClearedEventArgs
ASPxClientDashboardMasterFilterClearedEventHandler
ASPxClientDashboardMasterFilterSetEventArgs
ASPxClientDashboardMasterFilterSetEventHandler
ASPxClientDashboardParameter
ASPxClientDashboardParameters
ASPxClientDashboardParameterValue
ASPxClientDashboardRangeFilterSelection
ASPxClientDashboardStateChangedEventArgs
ASPxClientDashboardStateChangedEventHandler
ASPxClientDashboardTitleToolbarUpdatedEventArgs
ASPxClientDashboardTitleToolbarUpdatedEventHandler
ASPxClientDashboardViewer
Members
Constructors
Methods
Events
ASPxClientDynamicLookUpValuesLoadedEventArgs
ASPxClientDynamicLookUpValuesLoadedEventHandler
ASPxClientItemBeginUpdateEventArgs
ASPxClientItemBeginUpdateEventHandler
ASPxClientItemEndUpdateEventArgs
ASPxClientItemEndUpdateEventHandler
ASPxClientSelectedTabPageChangedEventArgs
ASPxClientSelectedTabPageChangedEventHandler
CardExportOptions
ChartExportOptions
ChartExportSizeMode
DashboardDataAxisNames
DashboardExcelExportOptions
DashboardExcelExportOptions.DashboardSelectionMode
DashboardExportDocumentScaleMode
DashboardExportExcelFormat
DashboardExportFilterState
DashboardExportImageFormat
DashboardExportPageLayout
DashboardExportPaperKind
DashboardExportScaleMode
DashboardImageExportOptions
DashboardPdfExportOptions
DashboardSpecialValues
DashboardStateExcelExportPosition
DashboardStateExportPosition
ExcelExportFilterState
ExcelFormatOptions
ExportFontInfo
GaugeExportOptions
GridExportOptions
ImageFormatOptions
MapExportOptions
MapExportSizeMode
PieExportOptions
PivotExportOptions
RangeFilterExportOptions
RangeFilterExportSizeMode
TreemapExportOptions
TreemapExportSizeMode
DevExpress.DashboardWin
DevExpress.DashboardWin.DataSourceWizard
DevExpress.DashboardWin.Localization
DevExpress.DashboardWpf
DevExpress.DataAccess
.NET Core API Reference
JavaScript API Reference
Download CHM

ASPxClientDashboardViewer Members

A client-side equivalent of the ASPxDashboardViewer control.

Constructors

Name Description
ASPxClientDashboardViewer() Initializes a new instance of the ASPxClientDashboardViewer class with default settings.

Methods

Name Description
BeginUpdateParameters() Locks the ASPxClientDashboardParameters object until the ASPxClientDashboardViewer.EndUpdateParameters method call.
CanClearMasterFilter(String) Returns whether the specified master filter can be cleared in the current state.
CanPerformDrillDown(String) Returns whether drill down is possible in the current state of the specified dashboard item.
CanPerformDrillUp(String) Returns whether drill up is possible in the current state of the specified dashboard item.
CanSetMasterFilter(String) Returns whether the specified master filter item allows selecting one or more elements.
Cast(Object) static Converts the specified object to the current object’s type. This method is effective when you utilize the Client API IntelliSense feature provided by DevExpress.
ClearMasterFilter(String) Clears the specified master filter item.
EndUpdateParameters() Unlocks the ASPxClientDashboardParameters object after a call to the ASPxClientDashboardViewer.BeginUpdateParameters method and applies changes made to the parameter settings.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
ExportDashboardItemToExcel(String, ASPxClientDashboardExportOptions, String) Obsolete. Exports a dashboard item to an Excel file with the specified export options and writes it to the Response.
ExportDashboardItemToExcel(String, ASPxClientDashboardExportOptions) Obsolete. Exports a dashboard item to an Excel file with the specified export options and writes it to the Response.
ExportDashboardItemToExcel(String, DashboardExcelExportOptions, String) Exports a dashboard item to an Excel file with the specified export options and writes it to the Response.
ExportDashboardItemToExcel(String, DashboardExcelExportOptions) Exports a dashboard item to an Excel file with the specified export options and writes it to the Response.
ExportDashboardItemToExcel(String) Exports a dashboard item to an Excel file and writes it to the Response.
ExportDashboardItemToImage(String, ASPxClientDashboardExportOptions, String) Obsolete. Exports a dashboard item to an Image file with the specified export options and writes it to the Response.
ExportDashboardItemToImage(String, ASPxClientDashboardExportOptions) Obsolete. Exports a dashboard item to an Image file with the specified export options and writes it to the Response.
ExportDashboardItemToImage(String, DashboardImageExportOptions, String) Exports a dashboard item to an Image file with the specified export options and writes it to the Response.
ExportDashboardItemToImage(String, DashboardImageExportOptions) Exports a dashboard item to an Image file with the specified export options and writes it to the Response.
ExportDashboardItemToImage(String) Exports a dashboard item to an Image file and writes it to the Response.
ExportDashboardItemToPdf(String, ASPxClientDashboardExportOptions, String) Obsolete. Exports a dashboard item to a PDF file with the specified export options and writes it to the Response.
ExportDashboardItemToPdf(String, ASPxClientDashboardExportOptions) Obsolete. Exports a dashboard item to a PDF file with the specified export options and writes it to the Response.
ExportDashboardItemToPdf(String, DashboardPdfExportOptions, String) Exports a dashboard item to a PDF file with the specified export options and writes it to the Response.
ExportDashboardItemToPdf(String, DashboardPdfExportOptions) Exports a dashboard item to a PDF file with the specified export options and writes it to the Response.
ExportDashboardItemToPdf(String) Exports a dashboard item to a PDF file and writes it to the Response.
ExportToExcel() Exports dashboard data to the specified file in Excel format.
ExportToExcel(DashboardImageExportOptions, String) Exports dashboard data to the specified file in Excel format.
ExportToExcel(DashboardImageExportOptions) Exports dashboard data to the specified file in Excel format.
ExportToImage() Exports a dashboard to an Image file and writes it to the Response.
ExportToImage(ASPxClientDashboardExportOptions, String) Obsolete. Exports a dashboard to an Image file with the specified export options and writes it to the Response.
ExportToImage(ASPxClientDashboardExportOptions) Obsolete. Exports a dashboard to an Image file with the specified export options and writes it to the Response.
ExportToImage(DashboardImageExportOptions, String) Exports a dashboard to an Image file with the specified export options and writes it to the Response.
ExportToImage(DashboardImageExportOptions) Exports a dashboard to an Image file with the specified export options and writes it to the Response.
ExportToPdf() Exports a dashboard to a PDF file and writes it to the Response.
ExportToPdf(ASPxClientDashboardExportOptions, String) Obsolete. Exports a dashboard to a PDF file with the specified export options and writes it to the Response.
ExportToPdf(ASPxClientDashboardExportOptions) Obsolete. Exports a dashboard to a PDF file with the specified export options and writes it to the Response.
ExportToPdf(DashboardPdfExportOptions, String) Exports a dashboard to a PDF file with the specified export options and writes it to the Response.
ExportToPdf(DashboardPdfExportOptions) Exports a dashboard to a PDF file with the specified export options and writes it to the Response.
GetAvailableDrillDownValues(String) Returns axis point tuples identifying elements that can be used to perform drill-down in the specified dashboard item.
GetAvailableFilterValues(String) Returns axis point tuples identifying elements that can be selected in the current state of the master filter item.
GetAvailablePredefinedRanges(String) Returns names of the predefined ranges available for the specified Range Filter.
GetCurrentDrillDownValues(String) Returns the axis point tuple identifying the current drill-down state.
GetCurrentFilterValues(String) Returns axis point tuples identifying currently selected elements in the master filter item.
GetCurrentPredefinedRange(String) Returns the name of the currently selected predefined range.
GetCurrentRange(String) Returns the currently selected range in the specified Range Filter dashboard item.
GetCurrentSelection(String) Returns currently selected elements in the master filter item.
GetEntireRange(String) Returns the visible range for the specified Range Filter dashboard item.
GetExcelExportOptions() Allows you to obtain options related to exporting a dashboard/dashboard item to the Excel format.
GetExportOptions() Obsolete. Returns settings that specify parameters affecting how the dashboard is exported.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetHeight() Returns the dashboard height.
GetImageExportOptions() Allows you to obtain options related to exporting a dashboard/dashboard item to an image.
GetItemData(String) Returns the client data for the specified dashboard item.
GetParameters() Returns dashboard parameter settings and metadata.
GetPdfExportOptions() Allows you to obtain options related to exporting a dashboard/dashboard item to the PDF format.
GetType() Gets the Type of the current instance. Inherited from Object.
GetWidth() Returns the dashboard width.
HideExportDialog() Hides the dialog that allows end-users to export the dashboard/dashboard item.
HideParametersDialog() Closes the Dashboard Parameters dialog.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
PerformDrillDown(String, ASPxClientDashboardItemDataAxisPointTuple) Performs a drill-down for the required element.
PerformDrillDown(String, Object) Performs a drill-down for the required element by its value.
PerformDrillUp(String) Performs a drill-up for the specified dashboard item.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
ReloadData() Reloads data in the data sources.
ReloadData(ASPxClientDashboardParameter[]) Obsolete. Reloads data in the data sources.
RequestUnderlyingData(String, ASPxClientDashboardItemRequestUnderlyingDataParameters, ASPxClientDashboardItemRequestUnderlyingDataCompleted) Requests underlying data for the specified dashboard item.
SetExcelExportOptions(DashboardExcelExportOptions) Allows you to specify options related to exporting a dashboard/dashboard item to the Excel format.
SetExportOptions(ASPxClientDashboardExportOptions) Obsolete. Specifies settings that specify parameters affecting how the dashboard is exported.
SetHeight(Int32) Specifies the dashboard height.
SetImageExportOptions(DashboardImageExportOptions) Allows you to specify options related to exporting a dashboard/dashboard item to an image.
SetMasterFilter(String, ASPxClientDashboardItemDataAxisPointTuple[]) Selects the required elements in the specified master filter item.
SetMasterFilter(String, Object[][]) Selects required elements by their values in the specified master filter item.
SetPdfExportOptions(DashboardPdfExportOptions) Allows you to specify options related to exporting a dashboard/dashboard item to the PDF format.
SetPredefinedRange(String, String) Selects a predefined range in the Range Filter dashboard item.
SetRange(String, ASPxClientDashboardRangeFilterSelection) Selects the required range in the specified Range Filter dashboard item.
SetSize(Int32, Int32) Specifies the dashboard size.
SetWidth(Int32) Specifies the dashboard width.
ShowExportDashboardItemDialog(String, String) Shows the dialog that allows end-users to export the dashboard item.
ShowExportDialog(String) Shows the dialog that allows end-users to export the dashboard.
ShowParametersDialog() Invokes the Dashboard Parameters dialog.
ToString() Returns a string that represents the current object. Inherited from Object.
UpdateDashboardTitleToolbar() Fires the DashboardTitleToolbarUpdated event.
UpdateItemCaptionToolbar(String) Fires the ItemCaptionToolbarUpdated event for the specified item.

Events

Name Description
ActionAvailabilityChanged Occurs after the available interactivity actions have changed.
BeginCallback Occurs when a callback for server-side processing is initiated.
DashboardTitleToolbarUpdated Allows you to customize a dashboard title (for instance, add custom buttons, menus, etc.).
DataLoadingError Provides the capability to handle data loading errors in the ASPxClientDashboardViewer.
DrillDownPerformed Occurs after a drill-down is performed.
DrillUpPerformed Occurs after a drill-up is performed.
EndCallback Occurs on the client side after a callback’s server-side processing has been completed.
ItemBeforeWidgetDisposed Allows you to access underlying UI/Data Visualization widgets.
ItemCaptionToolbarUpdated Allows you to customize a dashboard item’s caption (for instance, add custom buttons, menus, etc.).
ItemClick Occurs when an end-user clicks a dashboard item.
ItemElementCustomColor Allows you to color the required dashboard item elements using the specified colors.
ItemSelectionChanged Occurs after the selection within the dashboard item is changed.
ItemVisualInteractivity Allows you to provide custom visual interactivity for data-bound dashboard items that support element selection and highlighting.
ItemWidgetCreated Allows you to access underlying UI/Data Visualization widgets.
ItemWidgetUpdated Allows you to access underlying UI/Data Visualization widgets.
ItemWidgetUpdating Allows you to access underlying UI/Data Visualization widgets.
Loaded Occurs after the ASPxClientDashboardViewer is loaded.
MasterFilterCleared Occurs when an end-user clears the selection in the master filter item.
MasterFilterSet Occurs when an end-user changes the state of the master filter.
See Also