Skip to main content

DotLayerToolDefaults

geovisto-map • Readme | API


geovisto-map / DotLayerToolDefaults

Class: DotLayerToolDefaults

This class provide functions which return the default state values.

Author​

Vladimir Korencik

Extends​

Implements​

Constructors​

new DotLayerToolDefaults()​

new DotLayerToolDefaults(): DotLayerToolDefaults

Returns​

DotLayerToolDefaults

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

A unique string of the tool type.

Overrides​

LayerToolDefaults.TYPE

Source​

tools/layers/dot/model/internal/tool/DotLayerToolDefaults.ts:33


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


getCategoryColorDimension()​

getCategoryColorDimension(): IMapTypeDimension\<string, ITypeManager\<string>>

Returns​

IMapTypeDimension\<string, ITypeManager\<string>>

Implementation of​

IDotLayerToolDefaults.getCategoryColorDimension

Source​

tools/layers/dot/model/internal/tool/DotLayerToolDefaults.ts:124


getCategoryColorOperationDimension()​

getCategoryColorOperationDimension(): IMapDomainDimension\<IMapFilterOperation>

Returns​

IMapDomainDimension\<IMapFilterOperation>

Implementation of​

IDotLayerToolDefaults.getCategoryColorOperationDimension

Source​

tools/layers/dot/model/internal/tool/DotLayerToolDefaults.ts:106


getCategoryColorValueDimension()​

getCategoryColorValueDimension(): IMapTypeDimension\<string, ITypeManager\<string>>

Returns​

IMapTypeDimension\<string, ITypeManager\<string>>

Implementation of​

IDotLayerToolDefaults.getCategoryColorValueDimension

Source​

tools/layers/dot/model/internal/tool/DotLayerToolDefaults.ts:120


getCategoryDimension()​

getCategoryDimension(map?): IMapDomainDimension\<IMapDataDomain>

Parameters​

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

Returns​

IMapDomainDimension\<IMapDataDomain>

Implementation of​

IDotLayerToolDefaults.getCategoryDimension

Source​

tools/layers/dot/model/internal/tool/DotLayerToolDefaults.ts:90


getColorDimension()​

getColorDimension(): IMapTypeDimension\<string, ITypeManager\<string>>

Returns​

IMapTypeDimension\<string, ITypeManager\<string>>

Source​

tools/layers/dot/model/internal/tool/DotLayerToolDefaults.ts:98


getConfig()​

getConfig(): IMapToolConfig

By defaults it returns the config with undefined props.

Returns​

IMapToolConfig

Implementation of​

IDotLayerToolDefaults.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?): object

It returns list of map dimensions.

Parameters​

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

Returns​

object

category​

category: IMapDomainDimension\<IMapDataDomain>

categoryColor​

categoryColor: IMapTypeDimension\<string, ITypeManager\<string>>

categoryColorOp​

categoryColorOp: IMapDomainDimension\<IMapFilterOperation>

categoryColorValue​

categoryColorValue: IMapTypeDimension\<string, ITypeManager\<string>>

color​

color: IMapTypeDimension\<string, ITypeManager\<string>>

latitude​

latitude: IMapDomainDimension\<IMapDataDomain>

longitude​

longitude: IMapDomainDimension\<IMapDataDomain>

Implementation of​

IDotLayerToolDefaults.getDimensions

Overrides​

LayerToolDefaults.getDimensions

Source​

tools/layers/dot/model/internal/tool/DotLayerToolDefaults.ts:60


getFiltersManager()​

getFiltersManager(): IMapFilterManager

Returns​

IMapFilterManager

Implementation of​

IDotLayerToolDefaults.getFiltersManager

Source​

tools/layers/dot/model/internal/tool/DotLayerToolDefaults.ts:51


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​

IDotLayerToolDefaults.getIcon

Overrides​

LayerToolDefaults.getIcon

Source​

tools/layers/dot/model/internal/tool/DotLayerToolDefaults.ts:47


getId()​

getId(): string

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

Returns​

string

Implementation of​

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

IDotLayerToolDefaults.getLabel

Overrides​

LayerToolDefaults.getLabel

Source​

tools/layers/dot/model/internal/tool/DotLayerToolDefaults.ts:43


getLatitudeDimension()​

getLatitudeDimension(map?): IMapDomainDimension\<IMapDataDomain>

Parameters​

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

Returns​

IMapDomainDimension\<IMapDataDomain>

Implementation of​

IDotLayerToolDefaults.getLatitudeDimension

Source​

tools/layers/dot/model/internal/tool/DotLayerToolDefaults.ts:72


getLayerName()​

getLayerName(): string

It returns the layer name.

Returns​

string

Implementation of​

IDotLayerToolDefaults.getLayerName

Overrides​

LayerToolDefaults.getLayerName

Source​

tools/layers/dot/model/internal/tool/DotLayerToolDefaults.ts:39


getLongitudeDimension()​

getLongitudeDimension(map?): IMapDomainDimension\<IMapDataDomain>

Parameters​

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

Returns​

IMapDomainDimension\<IMapDataDomain>

Implementation of​

IDotLayerToolDefaults.getLongitudeDimension

Source​

tools/layers/dot/model/internal/tool/DotLayerToolDefaults.ts:80


getProps()​

getProps(): IMapObjectProps

It returns default props if no props are given.

Returns​

IMapObjectProps

Implementation of​

IDotLayerToolDefaults.getProps

Inherited from​

LayerToolDefaults.getProps

Source​

model/internal/object/MapObjectDefaults.ts:18


getType()​

getType(): string

It returns a unique type string of the map object.

Returns​

string

Implementation of​

IDotLayerToolDefaults.getType

Overrides​

LayerToolDefaults.getType

Source​

tools/layers/dot/model/internal/tool/DotLayerToolDefaults.ts:35


isEnabled()​

isEnabled(): boolean

By default, the tool is enabled.

Returns​

boolean

Implementation of​

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

IDotLayerToolDefaults.isSingleton

Inherited from​

LayerToolDefaults.isSingleton

Source​

model/internal/tool/MapToolDefaults.ts:43