Skip to main content

SidebarToolDefaults

geovisto-mapReadme | API


geovisto-map / SidebarToolDefaults

Class: SidebarToolDefaults

This class provide functions which return the default state values.

Author

Jiri Hynek

Extends

Implements

Constructors

new SidebarToolDefaults()

new SidebarToolDefaults(): SidebarToolDefaults

Returns

SidebarToolDefaults

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

Static tool type constant.

Source

tools/sidebar/model/internal/tool/SidebarToolDefaults.ts:28


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

It returns the default config.

Returns

ISidebarToolConfig

Implementation of

ISidebarToolDefaults.getConfig

Overrides

MapToolDefaults.getConfig

Source

tools/sidebar/model/internal/tool/SidebarToolDefaults.ts:19


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

ISidebarToolDefaults.getIcon

Inherited from

MapToolDefaults.getIcon

Source

model/internal/tool/MapToolDefaults.ts:64


getId()

getId(): string

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

Returns

string

Implementation of

ISidebarToolDefaults.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

ISidebarToolDefaults.getLabel

Inherited from

MapToolDefaults.getLabel

Source

model/internal/tool/MapToolDefaults.ts:57


getProps()

getProps(): IMapObjectProps

It returns default props if no props are given.

Returns

IMapObjectProps

Implementation of

ISidebarToolDefaults.getProps

Inherited from

MapToolDefaults.getProps

Source

model/internal/object/MapObjectDefaults.ts:18


getType()

getType(): string

It returns a unique string of the tool type.

Returns

string

Implementation of

ISidebarToolDefaults.getType

Overrides

MapToolDefaults.getType

Source

tools/sidebar/model/internal/tool/SidebarToolDefaults.ts:33


isEnabled()

isEnabled(): boolean

By default, the tool is enabled.

Returns

boolean

Implementation of

ISidebarToolDefaults.isEnabled

Inherited from

MapToolDefaults.isEnabled

Source

model/internal/tool/MapToolDefaults.ts:50


isSingleton()

isSingleton(): boolean

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

Returns

boolean

Implementation of

ISidebarToolDefaults.isSingleton

Overrides

MapToolDefaults.isSingleton

Source

tools/sidebar/model/internal/tool/SidebarToolDefaults.ts:40