Skip to main content

ITilesLayerToolDefaults

geovisto-map • Readme | API

geovisto-map / ITilesLayerToolDefaults

Interface: ITilesLayerToolDefaults

This interface declares functions which return the default state values.

Author​

Jiri Hynek

Extends​

Methods​

getBaseMap()​

getBaseMap(): IMapTilesModel

It returns the preferred base map.

Returns​

IMapTilesModel

Source​

tools/layers/tiles/model/types/tool/ITilesLayerToolDefaults.ts:17

getConfig()​

getConfig(): IMapToolConfig

It returns default config if no config is given.

Returns​

IMapToolConfig

Inherited from​

ILayerToolDefaults.getConfig

Source​

model/types/tool/IMapToolDefaults.ts:14

getDimensions()​

getDimensions(map?): ILayerToolDimensions

It returns list of map dimensions.

Parameters​

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

Returns​

ILayerToolDimensions

Inherited from​

ILayerToolDefaults.getDimensions

Source​

model/types/layer/ILayerToolDefaults.ts:20

getIcon()​

getIcon(): string

It returns the icon of the tool.

Returns​

string

Inherited from​

ILayerToolDefaults.getIcon

Source​

model/types/tool/IMapToolDefaults.ts:36

getId()​

getId(): string

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

Returns​

string

Inherited from​

ILayerToolDefaults.getId

Source​

model/types/object/IMapObjectDefaults.ts:32

getLabel()​

getLabel(): string

It returns the label of the tool.

Returns​

string

Inherited from​

ILayerToolDefaults.getLabel

Source​

model/types/tool/IMapToolDefaults.ts:31

getLayerName()​

getLayerName(): string

It returns the layer name.

Returns​

string

Inherited from​

ILayerToolDefaults.getLayerName

Source​

model/types/layer/ILayerToolDefaults.ts:15

getProps()​

getProps(): IMapObjectProps

It returns default props if no props are given.

Returns​

IMapObjectProps

Inherited from​

ILayerToolDefaults.getProps

Source​

model/types/object/IMapObjectDefaults.ts:17

getType()​

getType(): string

It returns a unique type string of the map object.

Returns​

string

Inherited from​

ILayerToolDefaults.getType

Source​

model/types/object/IMapObjectDefaults.ts:27

isEnabled()​

isEnabled(): boolean

By default, the tool is enabled.

Returns​

boolean

Inherited from​

ILayerToolDefaults.isEnabled

Source​

model/types/tool/IMapToolDefaults.ts:26

isSingleton()​

isSingleton(): boolean

It returns a logical value whether the tool type is singleton.

Returns​

boolean

Inherited from​

ILayerToolDefaults.isSingleton

Source​

model/types/tool/IMapToolDefaults.ts:19