Skip to main content

IDotLayerToolDefaults

geovisto-map • Readme | API


geovisto-map / IDotLayerToolDefaults

Interface: IDotLayerToolDefaults

This interface provides functions which return the default state values.

Author​

Vladimir Korencik

Extends​

Methods​

getCategoryColorDimension()​

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

Returns​

IMapTypeDimension\<string, ITypeManager\<string>>

Source​

tools/layers/dot/model/types/tool/IDotLayerToolDefaults.ts:34


getCategoryColorOperationDimension()​

getCategoryColorOperationDimension(): IMapDomainDimension\<IMapFilterOperation>

Returns​

IMapDomainDimension\<IMapFilterOperation>

Source​

tools/layers/dot/model/types/tool/IDotLayerToolDefaults.ts:30


getCategoryColorValueDimension()​

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

Returns​

IMapTypeDimension\<string, ITypeManager\<string>>

Source​

tools/layers/dot/model/types/tool/IDotLayerToolDefaults.ts:32


getCategoryDimension()​

getCategoryDimension(map?): IMapDomainDimension\<IMapDataDomain>

Parameters​

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

Returns​

IMapDomainDimension\<IMapDataDomain>

Source​

tools/layers/dot/model/types/tool/IDotLayerToolDefaults.ts:28


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?): 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>

Overrides​

ILayerToolDefaults.getDimensions

Source​

tools/layers/dot/model/types/tool/IDotLayerToolDefaults.ts:22


getFiltersManager()​

getFiltersManager(): IMapFilterManager

Returns​

IMapFilterManager

Source​

tools/layers/dot/model/types/tool/IDotLayerToolDefaults.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


getLatitudeDimension()​

getLatitudeDimension(map?): IMapDomainDimension\<IMapDataDomain>

Parameters​

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

Returns​

IMapDomainDimension\<IMapDataDomain>

Source​

tools/layers/dot/model/types/tool/IDotLayerToolDefaults.ts:24


getLayerName()​

getLayerName(): string

It returns the layer name.

Returns​

string

Inherited from​

ILayerToolDefaults.getLayerName

Source​

model/types/layer/ILayerToolDefaults.ts:15


getLongitudeDimension()​

getLongitudeDimension(map?): IMapDomainDimension\<IMapDataDomain>

Parameters​

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

Returns​

IMapDomainDimension\<IMapDataDomain>

Source​

tools/layers/dot/model/types/tool/IDotLayerToolDefaults.ts:26


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