/mapview
- Source
Methods
(inner) changeEnd()
The changeEnd method assigned to the mapview [this] will be triggered by the Openlayers mapview.Map moveend event.
The method assigns the current zoom level (rounded to 2 decimal) as mapview.z before checking whether the lat, lng, z hooks (url parameter) should be updated.
- Source
(inner) decorate(mapview) → {mapview}
The mapview decorator method decorates the mapview object param as a typedef mapview object.
The mapview decorator may return the async mapviewPromise method which must be awaited if svgTemplates must be loaded or syncPlugins must be executed.
| Name | Type | Description |
|---|---|---|
mapview | object | JSON params for a new mapview. |
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
mapview.host | string | <optional> | mapp.host | The host domain/path for queries. |
mapview.locale | object | The locale defintion for the mapview. | ||
locale.svgTemplates | Object | <optional> | Object of template key and src values to be loaded as svg strings. locale.svg_templates is the legacy property. | |
locale.syncPlugins | array | <optional> | An array plugins to be loaded in order. |
- Source
Decorated Mapview.
- Type:
- mapview
(async, inner) mapviewPromise(mapview) → {Promise.<mapview>}
mapviewPromise is an async method which resolves to the mapview object. The method is returned from the mapview decorator if the creation of the mapview must be awaited in order to import and execute synchronous plugin methods or load svg_templates required for synchronous feature style render methods.
| Name | Type | Description |
|---|---|---|
mapview | object |
| Name | Type | Attributes | Description |
|---|---|---|---|
mapview.locale | locale | The locale defintion for the mapview. | |
locale.plugins | array | Array of plugins to dynamically import. | |
locale.syncPlugins | array | <optional> | Array of plugins [key] to be executed in sync. |
locale.svgTemplates | array | <optional> | Array of svg_templates [objects] to be loaded. |
- Source
The async method resolves to the decorated mapview object.
- Type:
- Promise.<mapview>