Back to Devexpress

DevExpress.Analytics.Wizard Module

xtrareports-js-devexpress-dot-analytics-60bc3548.md

latest20.9 KB
Original Source

DevExpress.Analytics.Wizard Module

Contains classes and interfaces that implement the functionality for the Report Wizard and Data Source Wizard.

Classes

NameDescription
BaseWizardA base class for classes that implement wizard functionality.
ChooseAvailableDataSourcePage
ChooseAvailableItemPageA base class for classes that allow users to select an available item.
ChooseDataSourceTypePageImplements the Data Source Wizard’s Select Data Source Type page.
ChooseJsonConnectionPageImplements the functionality to select whether to create a new data connection or edit an existing connection.
ChooseJsonSchemaPageImplements the Select Data Fields section of the Data Source Wizard’s Specify Data Source Settings (JSON) page.
ChooseJsonSchemaPageBase<TSource, TState>
ChooseJsonSourcePageImplements the Choose JSON Data Connection section of the Report Wizard’s Specify Data Source Settings (JSON) page and the Data Source Wizard’s Specify Data Source Settings (JSON).
ChooseMongoDBCollectionPageImplements the Choose a database and its collection section of the Report Wizard’s Specify Data Source Settings (MongoDB)) page and the Data Source Wizard’s Specify Data Source Settings (MongoDB).
ChooseMongoDBDataConnectionPageImplements the Choose a data connection section of the Report Wizard’s Specify Data Source Settings (MongoDB)) page and the Data Source Wizard’s Specify Data Source Settings (MongoDB).
ChooseMongoDBSchemaPageImplements the Select data fields section of the Report Wizard’s Specify Data Source Settings (MongoDB)) page and the Data Source Wizard’s Specify Data Source Settings (MongoDB).
ChooseObjectDataSourceDataMembersPage
ChooseObjectDataSourceTypesPage
ChooseSqlConnectionPageImplements the Choose Data Connection section of the Report Wizard’s Specify Data Source Settings (Database) page and the Data Source Wizard’s Specify Data Source Settings (Database).
ConfigureMasterDetailRelationshipsPageImplements the Configure Master-Detail Relationships section of the Report Wizard’s Specify Data Source Settings (Database) page and the Data Source Wizard’s Specify Data Source Settings (Database).
ConfigureObjectDataSourceParametersPageImplements the Report Wizard and Data Source Wizard‘s Configure constructor parameters and/or method parameters page.
ConfigureQueryPageImplements the Report Wizard and Data Source Wizard‘s Configure Query page.
ConfigureQueryParametersPage
DataSourceWizardSettingsProvides the Data Source Wizard‘s settings.
FederatedMasterDetailRelationshipsPage
FederatedQueryConfigurePage
FullscreenDataSourceWizardImplements the functionality for the fullscreen Data Source Wizard.
FullscreenDataSourceWizardPageIteratorDefines the Data Source Wizard‘s page sequence.
FullscreenWizardA base class for classes that implement fullscreen wizards.
FullscreenWizardPageA base class for fullscreen pages of the Report Wizard or Data Source Wizard.
FullscreenWizardPageFactoryStores metadata for all wizard pages.
MasterDetailRelationshipsPageBase<TState, TResult>
MultiQueryConfigurePageImplements the Choose Queries section of the Report Wizard’s Specify Data Source Settings (Database) page and the Data Source Wizard’s Specify Data Source Settings (Database).
MultiQueryConfigureParametersPageImplements the Configure Query Parameters section of the Report Wizard’s Specify Data Source Settings (Database) page and the Data Source Wizard’s Specify Data Source Settings (Database).
PageFactoryStores metadata for all wizard pages.
PageIterator<T>Defines the wizard’s page sequence.
PopupWizardA base class for classes that implement popup wizards.
SelectDataSourcePage
SpecifyFederationDataSourceSettingsPageImplements the Data Source Wizard’s Specify Data Source Settings (Data Federation) page.’
SpecifyJsonConnectionPageImplements the Choose JSON Data Connection section of the Report Wizard’s Specify Data Source Settings (JSON) page and the Data Source Wizard’s Specify Data Source Settings (JSON).
SpecifyJsonDataSourceSettingsPageImplements the Data Source Wizard’s Specify Data Source Settings (JSON) page.
SpecifyMongoDBDataSourceSettingsPageImplements the Data Source Wizard’s Specify Data Source Settings (MongoDB) page.
SpecifyObjectDataSourceSettingsPageImplements the Data Source Wizard’s Specify Data Source Settings (Object) page.
SpecifySqlDataSourceSettingsPageImplements the Data Source Wizard’s Specify Data Source Settings (Database) page.
StateManagerProcesses the wizard’s global state and each page’s local state.
WizardPageBase<TState, TResult>A base class for pages of the Report Wizard or Data Source Wizard.

Interfaces

NameDescription
IAfterWizardFinishEventArgsProvides data for the wizard’s afterFinish event.
IBeforeWizardFinishEventArgsProvides data for the wizard’s beforeFinish event.
IBeforeWizardInitializeEventArgs<Sender>Provides data for the wizard’s beforeInitialize event.
IBeforeWizardPageInitializeEventArgs<Sender>Provides data for the wizard’s beforePageInitialize event.
IBeforeWizardSectionInitializeEventArgs<Sender>Provides data for the fullscreen page’s beforeSectionInitialize event.
IDataSourceWizardSettingsIf implemented, provides the Data Source Wizard‘s settings.
IDataSourceWizardStateIf implemented, provides functionality for the Data Source Wizard‘s global state.
IFederationDataSourceWizardStateImplements the functionality for managing the global state of the Federation Data Source Wizard.
IFullscreenWizardPageMetadata<T>Stores metadata for a fullscreen wizard page.
IJsonDataSourceWizardStateIf implemented, provides functionality for the JSON Data Source Wizard‘s global state.
IMongoDBDataSourceWizardStateDefines the structure for storing the MongoDB Data Source Wizard’s state.
IObjectDataSourceWizardStateIf implemented, provides functionality for the Object Data Source Wizard‘s global state.
ISqlDataSourceWizardStateIf implemented, provides functionality for the SQL Data Source Wizard‘s global state.
IWizardEventArgs<Sender>Provides data for the wizard’s afterInitialize event.
IWizardEvents<Sender>The wizard’s event collection.
IWizardFullscreenPageEvents<Sender>The fullscreen page’s event collection.
IWizardPageIf implemented, provides functionality for a page of the Report Wizard or Data Source Wizard.
IWizardPageEventArgs<Sender>Provides data for the wizard’s afterPageInitialize event.
IWizardPageMetadata<T>Stores metadata for a wizard page.
IWizardSectionEventArgs<Sender>Provides data for the fullscreen page’s afterSectionInitialize event.

Enums

NameDescription
DataSourceTypeLists the data source types available in the Web Report Designer’s Wizards.

Variables

NameDescription
FederationDataSourceWizardPageId
FullscreenDataSourceWizardPageIdLists the values that identify the Fullscreen Data Source Wizard‘s pages.
FullscreenDataSourceWizardSectionIdLists the values that identify sections of the Fullscreen Data Source Wizard‘s pages.
JsonDataSourceWizardPageIdLists identifiers of page sections in the JSON Data Source Wizard.
MongoDBDataSourceWizardPageIdLists identifiers of page sections in the MongoDB Data Source Wizard.
ObjectDataSourceWizardPageIdLists the values that identify sections of the Object Data Source Wizard pages.
parameterTypeToPropertyMap
SqlDataSourceWizardPageIdLists the values that identify sections of the SQL Data Source Wizard pages.

Functions

NameDescription
AutoQueryPreloadAllows you to choose to automatically load child data items and to search by nested items in the complex nested data source.