Skip to main content

DrawingLayerToolDefaults

geovisto-map • Readme | API

geovisto-map / DrawingLayerToolDefaults

Class: DrawingLayerToolDefaults

This class provide functions which return the default state values.

Author​

Andrej Tlcina

Extends​

Implements​

  • IDrawingLayerToolDefaults

Constructors​

new DrawingLayerToolDefaults()​

new DrawingLayerToolDefaults(): DrawingLayerToolDefaults

It initializes tool defaults.

Returns​

DrawingLayerToolDefaults

Overrides​

LayerToolDefaults.constructor

Source​

tools/layers/drawing/DrawingLayerToolDefaults.ts:16

Properties​

idString?​

protected optional idString: string

Inherited from​

LayerToolDefaults.idString

Source​

model/internal/object/MapObjectDefaults.ts:13

TYPE​

static TYPE: string = "geovisto-tool-layer-drawing"

A unique string of the tool type.

Overrides​

LayerToolDefaults.TYPE

Source​

tools/layers/drawing/DrawingLayerToolDefaults.ts:12

id​

static protected id: number

Inherited from​

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

LayerToolDefaults.generateId

Source​

model/internal/object/MapObjectDefaults.ts:54

getConfig()​

getConfig(): IMapToolConfig

By defaults it returns the config with undefined props.

Returns​

IMapToolConfig

Implementation of​

IDrawingLayerToolDefaults.getConfig

Inherited from​

LayerToolDefaults.getConfig

Source​

model/internal/tool/MapToolDefaults.ts:34

getDataManager()​

getDataManager(): IMapDataManager

It returns default map data manager.

Returns​

IMapDataManager

Inherited from​

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

IDrawingLayerToolDefaults.getDimensions

Inherited from​

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

LayerToolDefaults.getGeoDataManager

Source​

model/internal/tool/MapToolDefaults.ts:27

getIcon()​

getIcon(): string

It returns the icon of the tool.

Returns​

string

Implementation of​

IDrawingLayerToolDefaults.getIcon

Overrides​

LayerToolDefaults.getIcon

Source​

tools/layers/drawing/DrawingLayerToolDefaults.ts:43

getId()​

getId(): string

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

Returns​

string

Implementation of​

IDrawingLayerToolDefaults.getId

Inherited from​

LayerToolDefaults.getId

Source​

model/internal/object/MapObjectDefaults.ts:44

getLabel()​

getLabel(): string

It returns the label of the tool.

Returns​

string

Implementation of​

IDrawingLayerToolDefaults.getLabel

Overrides​

LayerToolDefaults.getLabel

Source​

tools/layers/drawing/DrawingLayerToolDefaults.ts:36

getLayerName()​

getLayerName(): string

It returns the layer name.

Returns​

string

Implementation of​

IDrawingLayerToolDefaults.getLayerName

Overrides​

LayerToolDefaults.getLayerName

Source​

tools/layers/drawing/DrawingLayerToolDefaults.ts:29

getProps()​

getProps(): IMapObjectProps

It returns default props if no props are given.

Returns​

IMapObjectProps

Implementation of​

IDrawingLayerToolDefaults.getProps

Inherited from​

LayerToolDefaults.getProps

Source​

model/internal/object/MapObjectDefaults.ts:18

getType()​

getType(): string

A unique string of the tool type.

Returns​

string

Implementation of​

IDrawingLayerToolDefaults.getType

Overrides​

LayerToolDefaults.getType

Source​

tools/layers/drawing/DrawingLayerToolDefaults.ts:22

isEnabled()​

isEnabled(): boolean

By default, the tool is enabled.

Returns​

boolean

Implementation of​

IDrawingLayerToolDefaults.isEnabled

Inherited from​

LayerToolDefaults.isEnabled

Source​

model/internal/tool/MapToolDefaults.ts:50

isSingleton()​

isSingleton(): boolean

By default, the tool is singleton

Returns​

boolean

Implementation of​

IDrawingLayerToolDefaults.isSingleton

Inherited from​

LayerToolDefaults.isSingleton

Source​

model/internal/tool/MapToolDefaults.ts:43