ChooseAvailableItemPage<TState, TResult> Class

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

Declaration

class ChooseAvailableItemPage extends WizardPageBase

Type Parameters

Name Description
TState

A type of the state to initialize the page (optional).

TResult

A type of the page's commit result (optional).

Implements

constructor(items)

Creates a new instance of the ChooseAvailableItemPage<TState, TResult> class with the specified settings.

Declaration

constructor(items: ko.Subscribable<any[]>, canCreateNew?: boolean)

Parameters

Name Type Description
items Subscribable<any[]>

The collection of items. This value is assigned to the items property.

canCreateNew boolean

Specifies whether it is possible to create new items. This value is assigned to the canCreateNew property.

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<any[]>

Property Value

Type Description
Subscribable<any[]>

The collection of available items.

selectedItems Property

Specifies the selected items.

Declaration

selectedItems: ko.ObservableArray<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 Description
any

A JQuery Promise object that identifies whether page initialization succeeded.