Back to Devexpress

DevExpress.Dashboard Module

dashboard-js-devexpress.md

latest20.0 KB
Original Source

DevExpress.Dashboard Module

Contains classes that are used for the Web Dashboard client-side customization.

Classes

NameDescription
AjaxRemoteServiceThe Ajax-based remote service used to communicate with the server side.
ChartContextProvides a connection between data item containers from the Values section and series from an underlying control.
CustomItemViewerA custom dashboard item.
DashboardControlA client-side JavaScript Dashboard control that allows end users to create dashboards and work with them.
DashboardExportExtensionA Web Dashboard extension that allows you to export dashboards and dashboard items.
DashboardPanelExtensionThe Dashboard Panel extension that displays a list of available dashboards and lets you switch between the designer and viewer modes.
DashboardParameterDialogExtensionA Web Dashboard extension that is the Dashboard Parameters dialog.
DashboardPrivateSettingsContains experimental settings that affect dashboard controls and their elements.
DataInspectorExtensionA Web Dashboard extension that is the Data Inspector.
DateFilterWidgetA Date Filter’s underlying widget that provides the Date Filter’s functionality.
FetchRemoteServiceThe Fetch-based remote service used to communicate with the server side.
GaugeContextProvides a connection between data item containers from the Gauges section and underlying control’s gauges.
GridContextProvides a connection between data item containers from the Columns section and an underlying control’s columns.
KeyboardNavigationExtension
LegacySettingsContains classes and members that allow you to use legacy options.
MobileLayoutExtensionA Web Dashboard extension that allows you to enable a mobile layout for phones.
NotificationControllerFor internal use.
ResourceManagerA class containing methods used to manage dashboard control static content.
UrlStateExtensionA Web Dashboard extension that displays a dashboard state in the url.
ViewerApiExtensionAn extension that allows you to customize a visual part of the Web Dashboard.

Interfaces

NameDescription
AjaxRemoteServiceOptionsProvides options for customizing the AjaxRemoteService.
CardWidgetA Card underlying widget that visualizes a Card dashboard item’s data.
CustomItemExportInfoProvides options for custom item exporting.
DashboardContainerContains information about the opened dashboard.
DashboardControlOptionsProvides options to configure the DashboardControl.
DashboardExcelExportOptionsContains options related to exporting a dashboard/dashboard item to Excel format.
DashboardExportDialogArgsProvides data for the ExportDialogShowing, ExportDialogShown, and ExportDialogHidden events.
DashboardExportExtensionOptionsProvides options for customizing the DashboardExportExtension.
DashboardImageExportOptionsContains options related to exporting a dashboard/dashboard item as an image.
DashboardInfoContains information used to identify a dashboard within the dashboard storage.
DashboardItemBaseEventArgs
DashboardItemCaptionToolbarOptionsProvides access to the dashboard item’s caption elements.
DashboardOptionChangedArgs<T>Provides access to the OptionChanged event arguments.
DashboardPanelExtensionOptionsProvides options for customizing the DashboardPanelExtension.
DashboardParameterA dashboard parameter.
DashboardParameterCollectionA collection of the DashboardParameter objects.
DashboardParameterDialogArgs
DashboardParameterDialogExtensionOptionsProvides options for customizing the DashboardParameterDialogExtension.
DashboardParameterLookUpValue
DashboardPdfExportOptionsContains options related to exporting a dashboard/dashboard item to PDF format.
DashboardTitleToolbarOptionsProvides access to the dashboard title’s elements.
DashboardTitleToolbarUpdatedEventArgsProvides data for the DashboardTitleToolbarUpdated event.
DataInspectorDialogArgsProvides data for the DialogHidden, DialogShowing, and DialogShown events.
DataInspectorExtensionOptionsProvides options for customizing the DataInspectorExtension.
DataInspectorGridArgsProvides data for the GridContentReady and GridInitialized events.
DataRequestOptionsProvides options for configuring data request mode.
DynamicLookUpValuesLoadedArgs
ExportFontInfoContains the font settings of the exported document.
FetchRemoteServiceOptionsProvides options for customizing the FetchRemoteService.
ICustomItemExtensionThe Web Dashboard’s extension that is a custom item.
IExtensionThe Web Dashboard extension.
IRemoteService<TResponse>A remote service used to communicate with the server side.
ItemActionAvailabilityChangedEventArgsProvides data for the ItemActionAvailability event.
ItemCaptionToolbarUpdatedEventArgsProvides data for the ItemCaptionToolbarUpdated event.
ItemClickEventArgsSupplies data for the ItemClick event.
ItemDrillDownStateChangedEventArgsProvides data for the ItemDrillDownState event.
ItemElementCustomColorEventArgsProvides information for the ViewerApiExtensionOptions.onItemElementCustomColor event.
ItemMasterFilterStateChangedEventArgsProvides information for the ItemMasterFilterStateChanged event.
ItemSelectionChangedEventArgsProvides data for the ItemSelectionChanged event.
ItemVisualInteractivityEventArgsProvides information for the ItemVisualInteractivity event.
ItemWidgetBaseEventArgsProvides basic data for events related to client widgets used to visualize data in dashboard items.
ItemWidgetEventArgsProvides data for events related to client widgets used to visualize data in dashboard items.
ItemWidgetOptionEventArgsProvides data for the ViewerApiExtensionOptions.onItemWidgetOptionsPrepared event.
KnockoutTemplateA template notation used to specify templates for UI component elements.
MobileLayoutExtensionOptionsProvides options for configuring the MobileLayoutExtension.
ParameterDialogContentContains options related to the Parameter dialog content.
SelectedTabPageChangedEventArgsProvides data for the SelectedTabPageChanged event.
SequenceAction
UrlStateExtensionOptionsProvides options for customizing the UrlStateExtension.
ViewerApiExtensionOptionsProvides options for customizing the ViewerApiExtension.
ViewerToolbarItemA toolbar item.
ViewerToolbarItemMenuA toolbar item’s menu.
ViewerToolbarItemTooltipA toolbar item’s tooltip.
WorkingModeSwitchingOptionsAn object that contains a dashboard layout coordinates.

Variables

NameDescription
dashboardToolbarItemNamesLists unique names of the dashboard item caption and dashboard title elements.
defaultExtensionsA collection of the extensions used in the Designer, Viewer, and ViewerOnly modes.
designerExtensionsA collection of the extensions used in the Designer and Viewer modes.
extensionNameMap

Type Aliases

NameDescription
DashboardChartExportSizeModeLists values used to specify how a Chart dashboard item should be resized when being exported.
DashboardControlArgsProvides data for the events used to customize the Web Dashboard control.
DashboardControlEventsProvides access to the DashboardControl’s events.
DashboardExcelFormatLists values that specify the available Excel workbook formats.
DashboardExportDocumentScaleModeLists values that specify a scale mode when exporting a dashboard/dashboard item.
DashboardExportExtensionEventsDescribes events this extension fires.
DashboardExportFormatLists values that specify the available export formats.
DashboardExportImageFormatLists values that specify the available Image formats.
DashboardExportPageLayoutLists values that specify the page orientation used to export a dashboard (dashboard item).
DashboardExportPaperKindLists values that specify the type of paper for the printed document.
DashboardInitializedArgsProvides data for the DashboardInitialized event.
DashboardInitializingArgsProvides data for the DashboardInitializing event.
DashboardItemUpdateArgsProvides data for the ItemBeginUpdate and ItemEndUpdate events.
DashboardMapSizeModeLists values used to specify how a Map dashboard item should be resized when being exported.
DashboardParameterDialogExtensionEventsDescribes events this extension fires.
DashboardRangeFilterExportSizeModeLists values used to specify how a Range Filter dashboard item should be resized when being exported.
DashboardSelectionModeLists values that specify the selection mode for the Master-Filtering feature.
DashboardStateChangedArgsProvides data for the DashboardStateChanged event.
DashboardStateExcelExportPositionLists values that specify the position of the dashboard state (such as master filter or current parameter values) in the exported Excel document.
DashboardStateExportPositionLists values that specify the position of the dashboard state (such as master filter or current parameter values) in the exported document.
DashboardTreemapExportSizeModeLists constants used to specify how the Treemap dashboard item should be resized when being exported.
DashboardUpdateArgsProvides data for the DashboardBeginUpdate and DashboardEndUpdate events.
DataInspectorExtensionEventsDescribes events this extension fires.
DxElement
ErrorInfo
ExtensionCreator
ExtensionDictionary
ExtensionOptionsProvides access to the extension options.
InspectedTypeLists values used to identify the data type in the Data Inspector.
ItemDataLoadingMode
ItemDataRequestModeLists values used to specify how a dashboard control loads dashboard items’ data.
KeyEventTypeContains objects that identify a user interaction with the keyboard.
LimitVisibleDataModeLists values that specify data limitation modes.
MobileLayoutModeLists values that specify a mobile layout mode for the Web Dashboard.
RefreshItemsArgsProvides data for the refresh method.
ViewerApiExtensionEventsDescribes events this extension fires.
WorkingModeSpecifies the working mode of the Web Dashboard.