Options
All
  • Public
  • Public/Protected
  • All
Menu

The interface for the arguments that must be supplied to the FeatureSelectorViewModel.

Hierarchy

  • FeatureSelectorArgs

Index

Properties

Optional buttons

The various buttons that should be displayed on the FeatureSelector. If not specified, then a single default button will be shown. Optional.

callback

callback: function

The callback containing information about the currently selected feature(s) as well as the button that was clicked. This callback will be fired once for each button that's clicked. The onus of dismissing/destroying the feature selector based on which button is clicked lies on the implementor.

Type declaration

Optional cssClass

cssClass: string

A css class that will be applied to the features displayed in the feature selector. Optional.

Optional errorMessage

errorMessage: string

The error message that should be displayed if a button invokes validation and no features are selected. Optional.

featureSet

featureSet: FeatureSet

The feature set containing all features to be displayed in the feature selector.

Optional noResultsTextDescription

noResultsTextDescription: string

Description for the message that is displayed when no results exist. Use this to override the default. Optional.

Optional noResultsTextHeader

noResultsTextHeader: string

Header for the message that is displayed when no results exist. Use this to override the default. Optional.

Optional onFeatureSelectorViewActivated

onFeatureSelectorViewActivated: function

An optional function that will be invoked when the feature selector view is activated. Note that any custom views must manually call this on activation. Implementors must be careful to not activate the view again when this callback is fired as that will cause an infinite loop.

Type declaration

    • (): void
    • Returns void

Optional onFeatureSelectorViewDeactivated

onFeatureSelectorViewDeactivated: function

An optional function that will be invoked when the feature selector view is deactivated. Note that any custom views must manually call this on deactivation. Implementors must be careful to not deactivate the view again when this callback is fired as that will cause an infinite loop.

Type declaration

    • (): void
    • Returns void

Optional selectionMode

selectionMode: string

The selection mode as defined by the FEATURE_SELECTOR_MODE as defined in {@link: FeatureSelectorViewMModel}. Can be one of "single", "multiple" or "extended". Optional.

Optional showFilterTextBox

showFilterTextBox: boolean

A boolean indicating whether or not to show the Filter Text Box to filter features displayed within the feature selector. Optional.

Optional showIcons

showIcons: boolean

A boolean indicating whether to show icons for the displayed features or not. Optional.

Optional showTitleInFormBody

showTitleInFormBody: boolean

Boolean indicating whether to show title in the form body. Retained for legacy reasons. Optional.

Optional simpleResultTemplate

simpleResultTemplate: boolean

A boolean indicating whether to use the simple results template or the complex result template. The complex template provides more information. Optional.

Optional viewMessage

viewMessage: string

A message that appears above the list of features displayed in the feature selector. Optional.

Optional viewTitle

viewTitle: string

The view title for the feature selector. Optional.