Options
All
  • Public
  • Public/Protected
  • All
Menu

The main FeatureSelectorViewModel. Use this view model for a ready to use generic feature selector which can be used out of the box to quickly select one or multiple features out of the features in a given FeatureSet and inform the user via a callback.

Hierarchy

Index

Constructors

constructor

Properties

DEFAULT_CLOSE_BUTTON_VALUE

DEFAULT_CLOSE_BUTTON_VALUE: string

DEFAULT_CSS_CLASS

DEFAULT_CSS_CLASS: string

Protected _isDestroyed

_isDestroyed: boolean

activateFeatureSelectorView

activateFeatureSelectorView: function

Type declaration

    • (): boolean
    • Returns boolean

app

bottomOffset

bottomOffset: Observable<string>

buttons

callback

callback: function

Type declaration

cssClass

cssClass: Observable<string>

ctrlPressed

ctrlPressed: boolean

deactivateFeatureSelectorView

deactivateFeatureSelectorView: function

Type declaration

    • (): boolean
    • Returns boolean

defaultButton

defaultButton: FormButton

disabledLinkCssClass

disabledLinkCssClass: Observable<string>

featureSet

featureSet: FeatureSet

features

filterSectionVisible

filterSectionVisible: Observable<boolean>

filterText

filterText: Observable<string>

id

id: string

isSingleSelectionMode

isSingleSelectionMode: boolean

libraryId

libraryId: string

message

message: Observable<string>

noResultsTextDescription

noResultsTextDescription: Observable<string>

noResultsTextHeader

noResultsTextHeader: Observable<string>

onFeatureSelectorViewActivated

onFeatureSelectorViewActivated: function

Type declaration

    • (): void
    • Returns void

onFeatureSelectorViewDeactivated

onFeatureSelectorViewDeactivated: function

Type declaration

    • (): void
    • Returns void

requiredValueErrorMessage

requiredValueErrorMessage: Observable<string>

resultTemplateComplexity

resultTemplateComplexity: any

resultsList

selectedFeatures

selectionMode

selectionMode: string

shiftPressed

shiftPressed: boolean

showFilterTextBox

showFilterTextBox: Observable<boolean>

showIcons

showIcons: boolean

showTitleInFormBody

showTitleInFormBody: Observable<boolean>

startingIndex

startingIndex: number

topOffset

topOffset: Observable<string>

viewTitle

viewTitle: Observable<string>

Methods

addButton

addFeatureToSelection

  • Parameters

    Returns void

auto

  • auto(arg0: any, arg1: any, arg2: any): void
  • Binds a handler to an Observable or to a dojo.connect. Binding to an Observable:

    ``` this.auto(someObservable, function (newValue) { });

    with explicit scope:

    this.auto(someObservable, this, function (newValue) { });

    Alternately, pass an event name as a string to use dojo.connect:

    this.auto(window, "onclick", function () { }); ```

    Parameters

    • arg0: any

      Either an Observable (for observable bindings) or a regular object (if arg1 is a string)

    • arg1: any

      If arg0 is an Observable, a function or scope object. Otherwise, an event name (to use with dojo.connect).

    • arg2: any

      If arg0 is an Observable, a function handler.

    Returns void

clearSelection

  • clearSelection(): void
  • Returns void

clearTextBox

  • clearTextBox(): void
  • Returns void

destroy

  • destroy(): void
  • Destroys the object completely

    Returns void

destroyBindings

  • destroyBindings(): void

featureClicked

filterResults

  • filterResults(text: string): void
  • Parameters

    • text: string

    Returns void

getResource

  • getResource(resourceKey: string, locale?: string): string
  • Gets a language resource from the Application's resource dictionary, given a key, and optional locale. Returns null if the resource does not exist.

    Parameters

    • resourceKey: string
    • Optional locale: string

      The locale of the resource to fetch. Defaults to the current application locale.

    Returns string

getSelectedIndices

  • getSelectedIndices(): number[]
  • Returns number[]

getTokens

  • getTokens(text: string): string[]
  • Parameters

    • text: string

    Returns string[]

hideFeatureSelector

  • hideFeatureSelector(reset?: boolean): void
  • Hides the Feature Selector. If 'reset' is true, then willl also wipe out all information contained within.

    Parameters

    • Optional reset: boolean

      An optional boolean indicating wether or not to reset the feature selector prior to hiding it.

    Returns void

initialize

isValidSelectionMode

  • isValidSelectionMode(inputMode: string): boolean
  • Parameters

    • inputMode: string

    Returns boolean

onDestroy

  • onDestroy(): void
  • Override or attach to provide custom clean-up behaviour.

    Returns void

removeFeatureFromSelection

reset

  • reset(): void
  • Resets all information in the feature selector.

    Returns void

selectAll

  • selectAll(): void
  • Returns void

selectNone

  • selectNone(): void
  • Returns void

setFeatureFocus

setupFeatureSelector

  • Sets up the Feture Selector but does not display it. Use ShowFeatureSelector to display the selector.

    Parameters

    Returns void

showError

  • showError(): void
  • Returns void

showFeatureSelector

  • Show the Feature Selector. If 'args' are defined, resets the selector and displays information in the new args object else reuses the old information.

    Parameters

    Returns void

trackCommandHandler

  • trackCommandHandler(command: any, token: any): void
  • Tracks a subscription to an {@link geocortex.framework.commands.Command}, disposing it when this object is disposed with the destroy method.

    Parameters

    • command: any
    • token: any

    Returns void

trackSubscription

  • trackSubscription(event: any, token: any): void
  • Tracks a subscription to an {@link geocortex.framework.events.Event}, disposing it when this object is disposed with the destroy method.

    Parameters

    • event: any
    • token: any

    Returns void