ChooseAvailableItemPage Class

A base class for classes that allow users to select an available item.

Declaration

export class ChooseAvailableItemPage extends WizardPageBase

Inherited Members

changeAlways

canFinish

commit

dispose

onChange(callback)

Inheritance

WizardPageBase<TState, TResult>

ChooseAvailableItemPage

ChooseJsonConnectionPage

ChooseMongoDBConnectionPage

ChooseAvailableDataSourcePage

ChooseAvailableDataSourcePage

constructor(items)

Creates a new instance of the ChooseAvailableItemPage class with the specified settings.

Declaration

constructor(
    items: ko.Subscribable<DevExpress.Analytics.Wizard.IConnectionStringDefinition[]>,
    canCreateNew?: boolean,
    _getJsonConnectionsCallback?: () => JQueryPromise<DevExpress.Analytics.Wizard.IConnectionStringDefinition[]>
)

Parameters

Name	Type	Description
items	Subscribable<IConnectionStringDefinition[]>
canCreateNew	boolean	Specifies whether it is possible to create new items. This value is assigned to the canCreateNew property.
_getJsonConnectionsCallback	() => JQueryPromise<IConnectionStringDefinition[]>

Properties

canCreateNew Property

Specifies whether it is possible to create new items.

Declaration

canCreateNew: ko.Observable<boolean>

Property Value

Type	Description
Observable<boolean>	true, if it possible to create new items; otherwise, false.

Remarks

This property specifies whether to display a radio group with a choice (to select an available item or create a new item).

items Property

Specifies the collection of items available on a wizard page.

Declaration

items: ko.Subscribable<DevExpress.Analytics.Wizard.IConnectionStringDefinition[]>

Property Value

Type
Subscribable<IConnectionStringDefinition[]>

selectedItems Property

Specifies the selected items.

Declaration

selectedItems: ko.ObservableArray<DevExpress.Analytics.Internal.IDataSourceInfo>

Property Value

Type	Description
ObservableArray<IDataSourceInfo>	Selected items.

Methods

canNext Method

Specifies whether the next section is available.

Declaration

canNext(): boolean

Returns

Type	Description
boolean	true, if the next section is available; otherwise, false.

initialize(state) Method

Initializes the page with the specified settings.

Declaration

initialize(
    state: any
): any

Parameters

Name	Type	Description
state	any	A page’s local state to initialize.

Returns

Type
any

onDblClick Method

Declaration

onDblClick(): void