Back to Devexpress

DevExpress.Dashboard.Designer Module

dashboard-js-devexpress-dot-dashboard-b24643dc.md

latest13.3 KB
Original Source

DevExpress.Dashboard.Designer Module

Classes

NameDescription
AvailableDataSourcesExtensionAn extension that provides access to a list of available data sources used to provide data to the Web Dashboard.
AvailableFontFamiliesExtensionA Web Dashboard extension that stores a font family list. This list defines typeface options available for custom styles in format rules.
BindingPanelExtensionAn extension that is the dashboard item’s Binding menu allowing you to create and modify data binding.
ChartIndicatorsExtensionAn extension that adds custom indicator types to the Trend Indicators dialog.
ConversionPanelExtensionAn extension that is the dashboard item’s Convert To menu allowing you to convert or duplicate the current item.
CreateDashboardExtensionA Web Dashboard extension that allows you to create a new dashboard.
DashboardChooseDataSourceTypePageImplements the Select data source type page of the Dashboard Data Source Wizard.
DashboardChooseOlapConnectionStringPageImplements the Choose a data connection section of the Dashboard Data Source Wizard’s page.
DashboardColorSchemeEditorExtensionA Web Dashboard extension that allows you to configure color schemes.
DashboardCurrencyEditorExtensionAn extension that is the Web Dashboard currency editor.
DashboardItemMenuExtensionA Web Dashboard extension that is a dashboard item menu.
DashboardMenuItemA dashboard menu item.
DashboardParameterEditorExtensionA Web Dashboard extension that allows you to create and edit dashboard parameters.
DashboardTitleEditorExtensionAn extension that is the Web Dashboard title editor.
DashboardToolbarGroupA toolbar group that contains dashboard toolbar items.
DashboardToolbarItemA toolbar item of a specified dashboard toolbar group.
DashboardToolboxGroupA toolbox group that contains dashboard toolbox items.
DashboardToolboxItemA toolbox item of a specified dashboard toolbox group.
DataSourceBrowserExtensionA Web Dashboard extension that is the Data Source browser.
DataSourceWizardExtensionA Web Dashboard extension that is the Data Source Wizard.
DesignerToolbarExtensionA Web Dashboard extension that allows you to display predefined and custom commands in the toolbar when the control operates in Designer mode.
FilterPanelExtensionAn extension that is the dashboard item’s Filters menu allowing you to apply filters on a dashboard item.
FormItemTemplatesContains templates for editors used in the Web Dashboard.
InteractivityPanelExtensionAn extension that is the dashboard item’s Interactivity menu containing settings that affect on interaction between various dashboard items.
LayoutOptionEditorExtensionA Web Dashboard extension that allows users to change the dashboard layout options.
MultiQueryDataSourceWizardExtensionA Web Dashboard extension that is the Multi Query Data Source Wizard.
OpenDashboardExtensionA Web Dashboard extension that allows you to open the created dashboards.
OptionsPanelExtensionAn extension that is the dashboard item’s Options menu containing specific options and settings related to the current dashboard item.
SaveDashboardExtensionA Web Dashboard extension that allows you to save the current dashboard.
TextBoxItemEditorExtensionA Web Dashboard extension that allows you to edit Text Box item content.
ToolboxExtensionThe Web Dashboard Toolbox extension that provides access to the dashboard menu and allows you to add dashboard items, as well as undo or repeat user actions.
UndoRedoExtensionA Web Dashboard extension that adds the undo/redo buttons and allows users to keep track of user actions, and cancel or repeat them.

Interfaces

NameDescription
BindingPanelExtensionOptionsProvides options for customizing the ViewerApiExtension.
ChartIndicatorsExtensionOptionsContains custom indicator type settings.
CustomizeDataItemContainerSectionsEventArgsProvides information for the BindingPanelExtensionOptions.onCustomizeDataItemContainerSections event.
CustomizeSectionsEventArgsProvides information for the OptionsPanelExtensionOptions.onCustomizeSections event.
DataSourceWizardExtensionOptionsProvides options for customizing the DataSourceWizardExtension and MultiQueryDataSourceWizardExtension.
DesignerToolbarArgsContains data for the DesignerToolbarExtensionOptions.onPreparing event.
DesignerToolbarExtensionOptionsProvides options for customizing the DesignerToolbarExtension.
DesignerToolbarItemAn item in the Designer Toolbar.
IDashboardConnectionStringDefinition
IDashboardDataSourceWizardConnectionStrings
IDashboardDataSourceWizardSettingsWhen implemented by a class, provides the Data Source Wizard’s settings for the Web Dashboard.
IDashboardDataSourceWizardState
IDashboardWizardEventArgsProvides data for the CustomizeDataSourceWizard event.
IOlapDataSourceWizardState
OptionsPanelExtensionOptions
RichEditCreatedEventArgsProvides data for the TextBoxItemEditorExtensionOptions.RichEditCreated event.
RichEditOptionsPreparedEventArgsProvides data for the TextBoxItemEditorExtensionOptions.RichEditOptionsPrepared event.
SectionOptionsProvides options for a new section in the Dashboard Item Menu and Data Item Menu.
TextBoxItemEditorExtensionOptionsProvides options for customizing the TextBoxItemEditorExtension.

Variables

NameDescription
DataSourceWizardPageIdLists the values that identify the Dashboard Data Source Wizard‘s pages.
OlapDataSourceWizardPageIdLists the values that identify the Dashboard Data Source Wizard‘s pages for OLAP data source.

Functions

NameDescription
ToDashboardDataSourceType(typeNumber)
ToDataSourceTypeNumber(dashboardType)Converts a data source type to the enumeration value’s numerical number.

Type Aliases

NameDescription
BindingPanelExtensionEventsDescribes events this extension fires.
DashboardDataSourceTypeLists values that specify the data source type available in the Dashboard Data Source Wizard.
DataSourceWizardExtensionEventsDescribes events this extension fires.
DataSourceWizardTypeLists values used to identify the wizard’s type.
DesignerToolbarExtensionEventsDescribes events this extension fires.
OptionsPanelExtensionEventsDescribes events this extension fires.
TextBoxItemEditorExtensionEvents