ConfigureQueryPage Class

Implements the Report Wizard and Data Source Wizard‘s Configure Query page.

Declaration

export class ConfigureQueryPage extends WizardPageBase<DevExpress.Analytics.Wizard.ISqlDataSourceWizardState, DevExpress.Analytics.Wizard.ISqlDataSourceWizardState>

Inherited Members

changeAlways

dispose

onChange(callback)

Inheritance

WizardPageBase<TState, TResult>

ConfigureQueryPage

constructor(_options)

Initializes a new ConfigureQueryPage class instance with specified settings.

Declaration

constructor(
    _options: DevExpress.Analytics.Wizard._DataSourceWizardOptions
)

Parameters

Name	Type
_options	_DataSourceWizardOptions

Properties

initialName Property

Declaration

initialName: string

Property Value

Type
string

placeholder Property

Declaration

placeholder: () => string

Property Value

Type
() => string

popupQueryBuilder Property

Declaration

popupQueryBuilder: DevExpress.Analytics.Wizard.Internal.QueryBuilderPopup

Property Value

Type
QueryBuilderPopup

QUERY_TEXT Property

Declaration

static QUERY_TEXT: string

Property Value

Type
string

queryControl Property

Declaration

queryControl: ko.Observable<DevExpress.Analytics.Wizard.Internal.ISqlQueryControl>

Property Value

Type
Observable<ISqlQueryControl>

queryName Property

Declaration

queryName: ko.Observable<string>

Property Value

Type
Observable<string>

queryNameCaption Property

Declaration

queryNameCaption: () => string

Property Value

Type
() => string

queryTypeItems Property

Declaration

queryTypeItems: string[]

Property Value

Type
string[]

runQueryBuilderBtnText Property

Declaration

runQueryBuilderBtnText: ko.PureComputed<any>

Property Value

Type
PureComputed<any>

selectedQueryType Property

Declaration

selectedQueryType: ko.Observable<string>

Property Value

Type
Observable<string>

SP_TEXT Property

Declaration

static SP_TEXT: string

Property Value

Type
string

Methods

canFinish Method

Gets or sets whether the Finish button is enabled on the wizard page.

Declaration

canFinish(): boolean

Returns

Type	Description
boolean	true, if the Finish button is enabled on the wizard page; otherwise, false.

canNext Method

Gets or sets whether the Next button is enabled on the wizard page.

Declaration

canNext(): boolean

Returns

Type	Description
boolean	true, if the Next button is enabled on the wizard page; otherwise, false.

commit Method

Commits settings to the local page state.

Declaration

commit(): JQuery.Promise<DevExpress.Analytics.Wizard.ISqlDataSourceWizardState, any, any>

Returns

Type
Promise<ISqlDataSourceWizardState,any,any>

initialize(state) Method

Initializes the section with the specified settings.

Declaration

initialize(
    state: DevExpress.Analytics.Wizard.ISqlDataSourceWizardState
): JQueryPromise<any>

Parameters

Name	Type	Description
state	ISqlDataSourceWizardState	The section’s state.

Returns

Type
JQueryPromise<any>

localizeQueryType(queryTypeString) Method

Declaration

localizeQueryType(
    queryTypeString: string
): string

Parameters

Name	Type
queryTypeString	string

Returns

Type
string

runQueryBuilder Method

Declaration

runQueryBuilder(): void