Interface SelectionTrigger

Encapsulates a selection process. This trigger is used by the ui as kind of model.

interface SelectionTrigger {
    actionId: undefined | string;
    actionOptions: Record<string, Record<string, any>>;
    active: boolean;
    replaceExistingSelection: undefined | boolean;
    searchAllSources: boolean;
    selectionFinishedNonEmpty: undefined | boolean;
    selectionIsRunning: boolean;
    sourceIds: string[];
}

Hierarchy

  • Watchable<
        {
            actionId: string
            | undefined;
            active: boolean;
            replaceExistingSelection: boolean | undefined;
            searchAllSources: boolean;
            selectionFinishedNonEmpty: boolean | undefined;
            selectionIsRunning: boolean;
            sourceIds: string[];
        },
    >
    • SelectionTrigger

Properties

actionId actionOptions active replaceExistingSelection searchAllSources selectionFinishedNonEmpty selectionIsRunning sourceIds

Properties

actionId

actionId: undefined | string

Current selected spatial input action.

actionOptions

actionOptions: Record<string, Record<string, any>>

Options to customize the selection actions.

active

active: boolean

A selection is currently active. Only if the ui sets this to true a selection action activated to perform a selection.

replaceExistingSelection

replaceExistingSelection: undefined | boolean

Flag to signal that the selection receiver should replace the last selection state (if set to true) or try to to add it (if set to false). If set to undefined the default behavior of the receiver should be used.

searchAllSources

searchAllSources: boolean

Flag if all stores should be searched. If true the sourceId list is ignored.

selectionFinishedNonEmpty

selectionFinishedNonEmpty: undefined | boolean

Flag if selection was finished successful or not. undefined if no selection is running.

selectionIsRunning

selectionIsRunning: boolean

Flag if a selection process is currently running.

sourceIds

sourceIds: string[]

Ids of stores to search.

Settings

Member Visibility

On This Page

Properties