Skip to main content

LegendToolDefaults

geovisto-map • Readme | API

geovisto-map / LegendToolDefaults

Class: LegendToolDefaults

This class provide functions which return the default state values.

Author​

Tomas Koscielniak

Extends​

Implements​

Constructors​

new LegendToolDefaults()​

new LegendToolDefaults(): LegendToolDefaults

Returns​

LegendToolDefaults

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

Static tool type constant.

Source​

tools/legend/model/internal/tool/LegendToolDefaults.ts:27

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

It returns the default config.

Returns​

ILegendToolConfig

Implementation of​

ILegendToolDefaults.getConfig

Overrides​

MapToolDefaults.getConfig

Source​

tools/legend/model/internal/tool/LegendToolDefaults.ts:17

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​

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

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

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

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

ILegendToolDefaults.getType

Overrides​

MapToolDefaults.getType

Source​

tools/legend/model/internal/tool/LegendToolDefaults.ts:32

isEnabled()​

isEnabled(): boolean

By default, the tool is enabled.

Returns​

boolean

Implementation of​

ILegendToolDefaults.isEnabled

Inherited from​

MapToolDefaults.isEnabled

Source​

model/internal/tool/MapToolDefaults.ts:50

isSingleton()​

isSingleton(): boolean

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

Returns​

boolean

Implementation of​

ILegendToolDefaults.isSingleton

Overrides​

MapToolDefaults.isSingleton

Source​

tools/legend/model/internal/tool/LegendToolDefaults.ts:39