Skip to main content

IHeatLayerToolDefaults

geovisto-map • Readme | API


geovisto-map / IHeatLayerToolDefaults

Interface: IHeatLayerToolDefaults

This interface provides functions which return the default state values.

Author​

Vladimir Korencik

Extends​

Methods​

getBlurDimension()​

getBlurDimension(): IMapTypeDimension\<number, ITypeManager\<number>>

Returns​

IMapTypeDimension\<number, ITypeManager\<number>>

Source​

tools/layers/heat/model/types/tool/IHeatLayerToolDefaults.ts:36


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


getCurrentZoomDimension()​

getCurrentZoomDimension(): IMapTypeDimension\<number, ITypeManager\<number>>

Returns​

IMapTypeDimension\<number, ITypeManager\<number>>

Source​

tools/layers/heat/model/types/tool/IHeatLayerToolDefaults.ts:40


getDimensions()​

getDimensions(map?): object

It returns list of map dimensions.

Parameters​

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

Returns​

object

blur​

blur: IMapTypeDimension\<number, ITypeManager\<number>>

currentZoom​

currentZoom: IMapTypeDimension\<number, ITypeManager\<number>>

gradient​

gradient: IMapDomainDimension\<IGradient>

intensity​

intensity: IMapDomainDimension\<IMapDataDomain>

latitude​

latitude: IMapDomainDimension\<IMapDataDomain>

longitude​

longitude: IMapDomainDimension\<IMapDataDomain>

radius​

radius: IMapTypeDimension\<number, ITypeManager\<number>>

reactiveOp​

reactiveOp: IMapDomainDimension\<IMapFilterOperation>

reactiveRadius​

reactiveRadius: IMapTypeDimension\<number, ITypeManager\<number>>

reactiveZoom​

reactiveZoom: IMapTypeDimension\<number, ITypeManager\<number>>

zoom​

zoom: IMapDomainDimension\<IZoomLevel>

Overrides​

ILayerToolDefaults.getDimensions

Source​

tools/layers/heat/model/types/tool/IHeatLayerToolDefaults.ts:24


getFiltersManager()​

getFiltersManager(): IMapFilterManager

Returns​

IMapFilterManager

Source​

tools/layers/heat/model/types/tool/IHeatLayerToolDefaults.ts:22


getGradientDimension()​

getGradientDimension(): IMapDomainDimension\<IGradient>

Returns​

IMapDomainDimension\<IGradient>

Source​

tools/layers/heat/model/types/tool/IHeatLayerToolDefaults.ts:34


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


getIntensityDimension()​

getIntensityDimension(map?): IMapDomainDimension\<IMapDataDomain>

Parameters​

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

Returns​

IMapDomainDimension\<IMapDataDomain>

Source​

tools/layers/heat/model/types/tool/IHeatLayerToolDefaults.ts:30


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/heat/model/types/tool/IHeatLayerToolDefaults.ts:26


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/heat/model/types/tool/IHeatLayerToolDefaults.ts:28


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


getRadiusDimension()​

getRadiusDimension(): IMapTypeDimension\<number, ITypeManager\<number>>

Returns​

IMapTypeDimension\<number, ITypeManager\<number>>

Source​

tools/layers/heat/model/types/tool/IHeatLayerToolDefaults.ts:32


getReactiveRadiusDimension()​

getReactiveRadiusDimension(): IMapTypeDimension\<number, ITypeManager\<number>>

Returns​

IMapTypeDimension\<number, ITypeManager\<number>>

Source​

tools/layers/heat/model/types/tool/IHeatLayerToolDefaults.ts:46


getReactiveRadiusOperationDimension()​

getReactiveRadiusOperationDimension(): IMapDomainDimension\<IMapFilterOperation>

Returns​

IMapDomainDimension\<IMapFilterOperation>

Source​

tools/layers/heat/model/types/tool/IHeatLayerToolDefaults.ts:42


getReactiveRadiusZoomDimension()​

getReactiveRadiusZoomDimension(): IMapTypeDimension\<number, ITypeManager\<number>>

Returns​

IMapTypeDimension\<number, ITypeManager\<number>>

Source​

tools/layers/heat/model/types/tool/IHeatLayerToolDefaults.ts:44


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


getZoomDimension()​

getZoomDimension(): IMapDomainDimension\<IZoomLevel>

Returns​

IMapDomainDimension\<IZoomLevel>

Source​

tools/layers/heat/model/types/tool/IHeatLayerToolDefaults.ts:38


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