Skip to main content

TilesLayerToolDefaults

geovisto-map • Readme | API


geovisto-map / TilesLayerToolDefaults

Class: TilesLayerToolDefaults

This class provide functions which return the default state values.

Author​

Jiri Hynek

Extends​

Implements​

Constructors​

new TilesLayerToolDefaults()​

new TilesLayerToolDefaults(): TilesLayerToolDefaults

Returns​

TilesLayerToolDefaults

Inherited from​

LayerToolDefaults.constructor

Properties​

idString?​

protected optional idString: string

Inherited from​

LayerToolDefaults.idString

Source​

model/internal/object/MapObjectDefaults.ts:13


TYPE​

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

Static tool type constant.

Overrides​

LayerToolDefaults.TYPE

Source​

tools/layers/tiles/model/internal/tool/TilesLayerToolDefaults.ts:19


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


getBaseMap()​

getBaseMap(): IMapTilesModel

It returns the preferred base map.

Returns​

IMapTilesModel

Implementation of​

ITilesLayerToolDefaults.getBaseMap

Source​

tools/layers/tiles/model/internal/tool/TilesLayerToolDefaults.ts:52


getConfig()​

getConfig(): IMapToolConfig

By defaults it returns the config with undefined props.

Returns​

IMapToolConfig

Implementation of​

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

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

ITilesLayerToolDefaults.getIcon

Overrides​

LayerToolDefaults.getIcon

Source​

tools/layers/tiles/model/internal/tool/TilesLayerToolDefaults.ts:45


getId()​

getId(): string

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

Returns​

string

Implementation of​

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

ITilesLayerToolDefaults.getLabel

Overrides​

LayerToolDefaults.getLabel

Source​

tools/layers/tiles/model/internal/tool/TilesLayerToolDefaults.ts:38


getLayerName()​

getLayerName(): string

It returns the layer name.

Returns​

string

Implementation of​

ITilesLayerToolDefaults.getLayerName

Overrides​

LayerToolDefaults.getLayerName

Source​

tools/layers/tiles/model/internal/tool/TilesLayerToolDefaults.ts:31


getProps()​

getProps(): IMapObjectProps

It returns default props if no props are given.

Returns​

IMapObjectProps

Implementation of​

ITilesLayerToolDefaults.getProps

Inherited from​

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

ITilesLayerToolDefaults.getType

Overrides​

LayerToolDefaults.getType

Source​

tools/layers/tiles/model/internal/tool/TilesLayerToolDefaults.ts:24


isEnabled()​

isEnabled(): boolean

By default, the tool is enabled.

Returns​

boolean

Implementation of​

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

ITilesLayerToolDefaults.isSingleton

Inherited from​

LayerToolDefaults.isSingleton

Source​

model/internal/tool/MapToolDefaults.ts:43