IMapToolDefaults

geovisto-map • Readme | API

---

geovisto-map / IMapToolDefaults

Interface: IMapToolDefaults

This interface declares functions which return the default state values.

Author

Jiri Hynek

Extends

• IMapObjectDefaults

Methods

getConfig()

getConfig(): IMapToolConfig

It returns default config if no config is given.

Returns

IMapToolConfig

Overrides

IMapObjectDefaults.getConfig

Source

model/types/tool/IMapToolDefaults.ts:14

---

getIcon()

getIcon(): string

It returns the icon of the tool.

Returns

string

Source

model/types/tool/IMapToolDefaults.ts:36

---

getId()

getId(): string

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

Returns

string

Inherited from

IMapObjectDefaults.getId

Source

model/types/object/IMapObjectDefaults.ts:32

---

getLabel()

getLabel(): string

It returns the label of the tool.

Returns

string

Source

model/types/tool/IMapToolDefaults.ts:31

---

getProps()

getProps(): IMapObjectProps

It returns default props if no props are given.

Returns

IMapObjectProps

Inherited from

IMapObjectDefaults.getProps

Source

model/types/object/IMapObjectDefaults.ts:17

---

getType()

getType(): string

It returns a unique type string of the map object.

Returns

string

Inherited from

IMapObjectDefaults.getType

Source

model/types/object/IMapObjectDefaults.ts:27

---

isEnabled()

isEnabled(): boolean

By default, the tool is enabled.

Returns

boolean

Source

model/types/tool/IMapToolDefaults.ts:26

---

isSingleton()

isSingleton(): boolean

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

Returns

boolean

Source

model/types/tool/IMapToolDefaults.ts:19