Skip to main content

LayerToolDefaults

geovisto-map • Readme | API

geovisto-map / LayerToolDefaults

Class: LayerToolDefaults

This class provide functions which return the default state values.

Author​

Jiri Hynek

Extends​

Implements​

Constructors​

new LayerToolDefaults()​

new LayerToolDefaults(): LayerToolDefaults

Returns​

LayerToolDefaults

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-layer-abstract"

A unique string of the tool type.

Source​

model/internal/layer/LayerToolDefaults.ts:16

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

By defaults it returns the config with undefined props.

Returns​

IMapToolConfig

Implementation of​

ILayerToolDefaults.getConfig

Inherited from​

MapToolDefaults.getConfig

Source​

model/internal/tool/MapToolDefaults.ts:34

getDataManager()​

getDataManager(): IMapDataManager

It returns default map data manager.

Returns​

IMapDataManager

Inherited from​

MapToolDefaults.getDataManager

Source​

model/internal/tool/MapToolDefaults.ts:20

getDimensions()​

getDimensions(map?): ILayerToolDimensions

It returns the default layer tool dimensions.

Parameters​

• map?: IMap\<IMapProps, IMapDefaults, IMapState\<IMapProps, IMapDefaults, IMapConfig>, IMapConfig, IMapInitProps\<IMapConfig>>

Returns​

ILayerToolDimensions

Implementation of​

ILayerToolDefaults.getDimensions

Source​

model/internal/layer/LayerToolDefaults.ts:36

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​

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

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

ILayerToolDefaults.getLabel

Inherited from​

MapToolDefaults.getLabel

Source​

model/internal/tool/MapToolDefaults.ts:57

getLayerName()​

getLayerName(): string

It returns the layer name.

Returns​

string

Implementation of​

ILayerToolDefaults.getLayerName

Source​

model/internal/layer/LayerToolDefaults.ts:28

getProps()​

getProps(): IMapObjectProps

It returns default props if no props are given.

Returns​

IMapObjectProps

Implementation of​

ILayerToolDefaults.getProps

Inherited from​

MapToolDefaults.getProps

Source​

model/internal/object/MapObjectDefaults.ts:18

getType()​

getType(): string

It returns a unique type string of the tool which is based on the layer it wraps.

Returns​

string

Implementation of​

ILayerToolDefaults.getType

Overrides​

MapToolDefaults.getType

Source​

model/internal/layer/LayerToolDefaults.ts:21

isEnabled()​

isEnabled(): boolean

By default, the tool is enabled.

Returns​

boolean

Implementation of​

ILayerToolDefaults.isEnabled

Inherited from​

MapToolDefaults.isEnabled

Source​

model/internal/tool/MapToolDefaults.ts:50

isSingleton()​

isSingleton(): boolean

By default, the tool is singleton

Returns​

boolean

Implementation of​

ILayerToolDefaults.isSingleton

Inherited from​

MapToolDefaults.isSingleton

Source​

model/internal/tool/MapToolDefaults.ts:43