Skip to main content

ThemesToolDefaults

geovisto-map • Readme | API

geovisto-map / ThemesToolDefaults

Class: ThemesToolDefaults

This class provide functions which return the default state values.

Author​

Jiri Hynek

Extends​

Implements​

Constructors​

new ThemesToolDefaults()​

new ThemesToolDefaults(): ThemesToolDefaults

Returns​

ThemesToolDefaults

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

Static tool type constant.

Source​

tools/themes/model/internal/tool/ThemesToolDefaults.ts:45

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

It returns the default config.

Returns​

IThemesToolConfig

Implementation of​

IThemesToolDefaults.getConfig

Overrides​

MapToolDefaults.getConfig

Source​

tools/themes/model/internal/tool/ThemesToolDefaults.ts:29

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​

IThemesToolDefaults.getIcon

Overrides​

MapToolDefaults.getIcon

Source​

tools/themes/model/internal/tool/ThemesToolDefaults.ts:64

getId()​

getId(): string

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

Returns​

string

Implementation of​

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

IThemesToolDefaults.getLabel

Overrides​

MapToolDefaults.getLabel

Source​

tools/themes/model/internal/tool/ThemesToolDefaults.ts:57

getProps()​

getProps(): IMapObjectProps

It returns default props if no props are given.

Returns​

IMapObjectProps

Implementation of​

IThemesToolDefaults.getProps

Inherited from​

MapToolDefaults.getProps

Source​

model/internal/object/MapObjectDefaults.ts:18

getTheme()​

getTheme(themesManager): IMapTheme

It returns default theme.

Parameters​

• themesManager: undefined | IMapThemesManager

Returns​

IMapTheme

Implementation of​

IThemesToolDefaults.getTheme

Source​

tools/themes/model/internal/tool/ThemesToolDefaults.ts:86

getThemesManager()​

getThemesManager(): IMapThemesManager

It returns default themes manager.

Returns​

IMapThemesManager

Implementation of​

IThemesToolDefaults.getThemesManager

Source​

tools/themes/model/internal/tool/ThemesToolDefaults.ts:71

getType()​

getType(): string

It returns a unique string of the tool type.

Returns​

string

Implementation of​

IThemesToolDefaults.getType

Overrides​

MapToolDefaults.getType

Source​

tools/themes/model/internal/tool/ThemesToolDefaults.ts:50

isEnabled()​

isEnabled(): boolean

By default, the tool is enabled.

Returns​

boolean

Implementation of​

IThemesToolDefaults.isEnabled

Inherited from​

MapToolDefaults.isEnabled

Source​

model/internal/tool/MapToolDefaults.ts:50

isSingleton()​

isSingleton(): boolean

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

Returns​

boolean

Implementation of​

IThemesToolDefaults.isSingleton

Overrides​

MapToolDefaults.isSingleton

Source​

tools/themes/model/internal/tool/ThemesToolDefaults.ts:38