GeovistoMap

geovisto-map • Readme | API

---

geovisto-map / GeovistoMap

Class: GeovistoMap

Representation of map wrapper which handles map layers, sidebar and other tools

Author

Jiri Hynek

Extends

• MapObject

Implements

• IMap

Constructors

new GeovistoMap()

new GeovistoMap(props): GeovistoMap

Initializes object.

Parameters

• props: IMapProps

Returns

GeovistoMap

Overrides

MapObject.constructor

Source

model/internal/map/GeovistoMap.ts:41

Methods

create()

protected create(): null | HTMLElement

This function creates Geovisto map - it creates map container, leaflet map and tools.

Returns

null | HTMLElement

Source

model/internal/map/GeovistoMap.ts:207

---

createDefaults()

createDefaults(): IMapDefaults

It creates new defaults of the object.

Returns

IMapDefaults

Overrides

MapObject.createDefaults

Source

model/internal/map/GeovistoMap.ts:62

---

createMap()

protected createMap(): Map

Creates the leaflet-based map with respect to the configuration.

Returns

Map

Source

model/internal/map/GeovistoMap.ts:253

---

createMapContainer()

protected createMapContainer(): null | HTMLElement

This function creates the map container.

Returns

null | HTMLElement

Source

model/internal/map/GeovistoMap.ts:225

---

createState()

createState(): IMapState\<IMapProps, IMapDefaults, IMapConfig>

It creates new state if the object.

Returns

IMapState\<IMapProps, IMapDefaults, IMapConfig>

Overrides

MapObject.createState

Source

model/internal/map/GeovistoMap.ts:76

---

createTools()

protected createTools(): IMapTool\<IMapToolProps, IMapToolDefaults, IMapToolState\<IMapToolProps, IMapToolDefaults, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>>, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>, IMapToolAPI>[]

This function creates map tools.

Returns

IMapTool\<IMapToolProps, IMapToolDefaults, IMapToolState\<IMapToolProps, IMapToolDefaults, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>>, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>, IMapToolAPI>[]

Source

model/internal/map/GeovistoMap.ts:282

---

draw()

draw(configManager): null | HTMLElement

The function draws a new map.

Parameters

• configManager: IMapConfigManager

Returns

null | HTMLElement

Implementation of

IMap.draw

Source

model/internal/map/GeovistoMap.ts:83

---

export()

export(): Record\<string, unknown>

It exports the serialized representation of the current state of the map.

Returns

Record\<string, unknown>

Implementation of

IMap.export

Source

model/internal/map/GeovistoMap.ts:200

---

getContainerClass()

protected getContainerClass(): string

It returns class of the map container.

Returns

string

Source

model/internal/map/GeovistoMap.ts:246

---

getContainerId()

protected getContainerId(): string

It returns ID of the map container.

Returns

string

Source

model/internal/map/GeovistoMap.ts:239

---

getDefaults()

getDefaults(): IMapDefaults

It returns object defaults as the map defaults.

Returns

IMapDefaults

Implementation of

IMap.getDefaults

Overrides

MapObject.getDefaults

Source

model/internal/map/GeovistoMap.ts:55

---

getId()

getId(): string

Help function which returns the id of the object.

Returns

string

Implementation of

IMap.getId

Inherited from

MapObject.getId

Source

model/internal/object/MapObject.ts:93

---

getMapAttribution()

protected getMapAttribution(): string

It returns the map attribution.

This function can be overriden;

Returns

string

Source

model/internal/map/GeovistoMap.ts:275

---

getProps()

getProps(): IMapProps

Help function which returns the props given by the programmer.

Returns

IMapProps

Implementation of

IMap.getProps

Overrides

MapObject.getProps

Source

model/internal/map/GeovistoMap.ts:48

---

getState()

getState(): IMapState\<IMapProps, IMapDefaults, IMapConfig>

It returns object state as the map state.

Returns

IMapState\<IMapProps, IMapDefaults, IMapConfig>

Implementation of

IMap.getState

Overrides

MapObject.getState

Source

model/internal/map/GeovistoMap.ts:69

---

getType()

getType(): string

Help function which returns the type of the object.

Returns

string

Implementation of

IMap.getType

Inherited from

MapObject.getType

Source

model/internal/object/MapObject.ts:86

---

initialize()

initialize(initProps): this

It resets the state to the initial state.

Parameters

• initProps: IMapInitProps

Returns

this

Implementation of

IMap.initialize

Overrides

MapObject.initialize

Source

model/internal/map/GeovistoMap.ts:119

---

redraw()

redraw(configManager, props?): null | HTMLElement

This function redraws the current map.

Parameters

• configManager: IMapConfigManager

• props?: IMapProps

Returns

null | HTMLElement

Implementation of

IMap.redraw

Source

model/internal/map/GeovistoMap.ts:94

---

registerToolAPI()

protected registerToolAPI(tool): null | IMapToolAPI

Help function which register a generic tool API.

Parameters

• tool: IMapTool\<IMapToolProps, IMapToolDefaults, IMapToolState\<IMapToolProps, IMapToolDefaults, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>>, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>, IMapToolAPI>

Returns

null | IMapToolAPI

Source

model/internal/map/GeovistoMap.ts:184

---

setProps()

protected setProps(props): void

It updates the props.

Parameters

• props: IMapObjectProps

Returns

void

Inherited from

MapObject.setProps

Source

model/internal/object/MapObject.ts:38

---

updateCurrentData()

updateCurrentData(data, source, animateOptions?): void

It updates current data and invokes notifies listeners.

Parameters

• data: IMapData

• source: IMapObject\<IMapObjectProps, IMapObjectDefaults\<IMapObjectProps, IMapObjectConfig>, IMapObjectState\<IMapObjectProps, IMapObjectDefaults\<IMapObjectProps, IMapObjectConfig>, IMapObjectConfig, IMapObjectInitProps\<IMapObjectConfig>>, IMapObjectConfig, IMapObjectInitProps\<IMapObjectConfig>>

of the change

• animateOptions?: IDataChangeAnimateOptions

Returns

void

Implementation of

IMap.updateCurrentData

Source

model/internal/map/GeovistoMap.ts:331

---

updateData()

updateData(dataManager): void

It updates data and notifies listeners.

Parameters

• dataManager: IMapDataManager

Returns

void

Implementation of

IMap.updateData

Source

model/internal/map/GeovistoMap.ts:297

---

updateGeoData()

updateGeoData(geoDataManager): void

It updates geo data and notifies listeners.

Parameters

• geoDataManager: IGeoDataManager

Returns

void

Implementation of

IMap.updateGeoData

Source

model/internal/map/GeovistoMap.ts:313