Skip to main content

SelectionToolDefaults

geovisto-map • Readme | API

geovisto-map / SelectionToolDefaults

Class: SelectionToolDefaults

This class provide functions which return the default state values.

Author​

Jiri Hynek

Extends​

Implements​

Constructors​

new SelectionToolDefaults()​

new SelectionToolDefaults(): SelectionToolDefaults

Returns​

SelectionToolDefaults

Inherited from​

MapToolDefaults.constructor

Properties​

idString?​

protected optional idString: string

Inherited from​

MapToolDefaults.idString

Source​

model/internal/object/MapObjectDefaults.ts:13

TYPE​

static TYPE: string = "geovisto-tool-selection"

Static tool type constant.

Source​

tools/selection/model/internal/tool/SelectionToolDefaults.ts:36

id​

static protected id: number

Inherited from​

MapToolDefaults.id

Source​

model/internal/object/MapObjectDefaults.ts:12

Methods​

generateId()​

protected generateId(): string

It returns identifier which is used when no identifier is specified.

Returns​

string

Inherited from​

MapToolDefaults.generateId

Source​

model/internal/object/MapObjectDefaults.ts:54

getConfig()​

getConfig(): ISelectionToolConfig

It returns the default config.

Returns​

ISelectionToolConfig

Implementation of​

ISelectionToolDefaults.getConfig

Overrides​

MapToolDefaults.getConfig

Source​

tools/selection/model/internal/tool/SelectionToolDefaults.ts:20

getDataManager()​

getDataManager(): IMapDataManager

It returns default map data manager.

Returns​

IMapDataManager

Inherited from​

MapToolDefaults.getDataManager

Source​

model/internal/tool/MapToolDefaults.ts:20

getGeoDataManager()​

getGeoDataManager(geoDataArray): IGeoDataManager

It returns default geo data manager.

Parameters​

• geoDataArray: undefined | IGeoData[]

Returns​

IGeoDataManager

Inherited from​

MapToolDefaults.getGeoDataManager

Source​

model/internal/tool/MapToolDefaults.ts:27

getIcon()​

getIcon(): string

It returns the icon of the tool.

Returns​

string

Implementation of​

ISelectionToolDefaults.getIcon

Overrides​

MapToolDefaults.getIcon

Source​

tools/selection/model/internal/tool/SelectionToolDefaults.ts:55

getId()​

getId(): string

It returns identifier which is used when no identifier is specified.

Returns​

string

Implementation of​

ISelectionToolDefaults.getId

Inherited from​

MapToolDefaults.getId

Source​

model/internal/object/MapObjectDefaults.ts:44

getLabel()​

getLabel(): string

It returns the label of the tool.

Returns​

string

Implementation of​

ISelectionToolDefaults.getLabel

Overrides​

MapToolDefaults.getLabel

Source​

tools/selection/model/internal/tool/SelectionToolDefaults.ts:48

getProps()​

getProps(): IMapObjectProps

It returns default props if no props are given.

Returns​

IMapObjectProps

Implementation of​

ISelectionToolDefaults.getProps

Inherited from​

MapToolDefaults.getProps

Source​

model/internal/object/MapObjectDefaults.ts:18

getSelection()​

getSelection(): null | IMapSelection

It returns default map selection.

Returns​

null | IMapSelection

Implementation of​

ISelectionToolDefaults.getSelection

Source​

tools/selection/model/internal/tool/SelectionToolDefaults.ts:62

getType()​

getType(): string

It returns a unique string of the tool type.

Returns​

string

Implementation of​

ISelectionToolDefaults.getType

Overrides​

MapToolDefaults.getType

Source​

tools/selection/model/internal/tool/SelectionToolDefaults.ts:41

isEnabled()​

isEnabled(): boolean

By default, the tool is enabled.

Returns​

boolean

Implementation of​

ISelectionToolDefaults.isEnabled

Inherited from​

MapToolDefaults.isEnabled

Source​

model/internal/tool/MapToolDefaults.ts:50

isSingleton()​

isSingleton(): boolean

Only one selection tool should be present in the Geovisto map.

Returns​

boolean

Implementation of​

ISelectionToolDefaults.isSingleton

Overrides​

MapToolDefaults.isSingleton

Source​

tools/selection/model/internal/tool/SelectionToolDefaults.ts:29