Skip to main content

HierarchyToolDefaults

geovisto-map β€’ Readme | API

geovisto-map / HierarchyToolDefaults

Class: HierarchyToolDefaults

Class for default values of HierarchyTool.

Author​

VojtΔ›ch MalΓ½

Extends​

Implements​

Constructors​

new HierarchyToolDefaults()​

new HierarchyToolDefaults(): HierarchyToolDefaults

Returns​

HierarchyToolDefaults

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-hierarchy"

Source​

tools/hierarchy/model/internal/tool/HierarchyToolDefaults.ts:13

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(): IMapToolConfig

It returns default config if no config is given.

Returns​

IMapToolConfig

Implementation of​

IHierarchyToolDefaults.getConfig

Overrides​

MapToolDefaults.getConfig

Source​

tools/hierarchy/model/internal/tool/HierarchyToolDefaults.ts:38

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​

IHierarchyToolDefaults.getIcon

Overrides​

MapToolDefaults.getIcon

Source​

tools/hierarchy/model/internal/tool/HierarchyToolDefaults.ts:34

getId()​

getId(): string

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

Returns​

string

Implementation of​

IHierarchyToolDefaults.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​

IHierarchyToolDefaults.getLabel

Overrides​

MapToolDefaults.getLabel

Source​

tools/hierarchy/model/internal/tool/HierarchyToolDefaults.ts:30

getProps()​

getProps(): IMapObjectProps

It returns default props if no props are given.

Returns​

IMapObjectProps

Implementation of​

IHierarchyToolDefaults.getProps

Inherited from​

MapToolDefaults.getProps

Source​

model/internal/object/MapObjectDefaults.ts:18

getType()​

getType(): string

It returns a unique type string of the map object.

Returns​

string

Implementation of​

IHierarchyToolDefaults.getType

Overrides​

MapToolDefaults.getType

Source​

tools/hierarchy/model/internal/tool/HierarchyToolDefaults.ts:15

isEnabled()​

isEnabled(): boolean

By default, the tool is disabled.

Returns​

boolean

Implementation of​

IHierarchyToolDefaults.isEnabled

Overrides​

MapToolDefaults.isEnabled

Source​

tools/hierarchy/model/internal/tool/HierarchyToolDefaults.ts:22

isSingleton()​

isSingleton(): boolean

It returns a logical value whether the tool type is singleton.

Returns​

boolean

Implementation of​

IHierarchyToolDefaults.isSingleton

Overrides​

MapToolDefaults.isSingleton

Source​

tools/hierarchy/model/internal/tool/HierarchyToolDefaults.ts:26