Type Definitions
dataview
- Object
Name | Type | Attributes | Description |
---|---|---|---|
key | string | A unique for the dataview. | |
dataview | string | The type of dataview | |
target | HTMLElement | Target element in which the dataview is rendered. | |
create | function | Create method for library supporting the dataview type. | |
show | function | Method to show a dataview in the document. | |
hide | function | Method to hide a dataview in the document. | |
dynamic | boolean | <optional> | Dataview should be recreated when shown. |
display | boolean | <optional> | Whether the dataview should be displayed. |
update | function | <optional> | Method to update the dataview data from a query. |
reload | boolean | <optional> | Dataview should run update query when shown. |
query | string | <optional> | Query template for the dataview update method. |
host | string | <optional> | Host for the update query. |
queryparams | Object | <optional> | Parameter for update query. |
data | Object | Data to be displayed in the dataview. | |
setData | function | <optional> | Method to set the data in the dataview. |
label | string | <optional> | Label for a checkbox input. |
chkbox | HTMLElement | <optional> | Input element to toggle the dataview display. |
- Source
feature-style
A JSON mapp-style object.
- Object
Name | Type | Attributes | Description |
---|---|---|---|
svg | string | <optional> | The SVG source for the icon. |
type | string | <optional> | The type of the icon. |
icon | Array | | <optional> | The icon configuration or an array of icon configurations. |
width | number | <optional> | The width of the icon or symbol. |
height | number | <optional> | The height of the icon or symbol. |
strokeColor | string | <optional> | The stroke color of the line symbol. |
strokeWidth | number | <optional> | The stroke width of the line symbol. |
fillColor | string | <optional> | The fill color of the polygon symbol. |
fillOpacity | number | <optional> | The fill opacity of the polygon symbol. |
- Source
infoj-entry
A infoj-entry describes a location property. Locations are configured as an array of JSON Object entries layer.infoj[].
- Object
Name | Type | Attributes | Description |
---|---|---|---|
key | string | A unique identifier for the entry. Will be assigned from iteration index in infoj location method if not implicit. | |
location | location | The entry location. | |
value | * | <optional> | The entry value. |
field | string | <optional> | The database field in layer table which holds the entry data. |
fieldfx | string | <optional> | A SQL statement to query the entry value in the location get request. |
title | string | <optional> | The title to be displayed with the entry.value. |
inline | boolean | <optional> | Flag whether the value should be displayed inline with the title. |
edit | object | <optional> | Edit configuration for the entry. |
query | string | <optional> | Query template. |
queryparams | Object | <optional> | Parameter for query in template. |
label | string | <optional> | Label for checkbox element. |
display | boolean | <optional> | Entry display flag. |
layer
A mapp-layer object is a decorated JSON layer object which has been added to a mapview.
- Object
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
layer.srid | string | '3857' | Feature layer require a spatial reference identifier (SRID). | |
layer.L | object | Openlayers Layer object. | ||
layer.display | boolean | Whether the layer should be displayed. | ||
layer.style | layer-style | The mapp-layer style configuration. | ||
layer.format | string | The format of the layer data. | ||
layer.cluster | layer-cluster | <optional> | Point layer cluster configuration. | |
layer.table | string | <optional> | Table name for layer features. | |
layer.tables | Array | <optional> | An array of tables for different zoom level. | |
layer.zIndex | number | <optional> | The zIndex for the layer canvas element. | |
layer.mapview | Object | mapview typedef object. |
- Source
layer-cluster
Point layer cluster configuration.
- Object
Name | Type | Attributes | Description |
---|---|---|---|
distance | number | <optional> | The distance threshold [pixel] for OL source clustering. |
label | string | <optional> | The field used for labeling the clusters. |
resolution | number | <optional> | The resolution parameter for PostGIS database cluster queries. |
hexgrid | boolean | <optional> | Use hexgrid clustering query for PostGIS. |
- Source
layer-style
- Object
Name | Type | Attributes | Description |
---|---|---|---|
cache | Boolean | <optional> | The feature style should be retrieved from the feature 'Styles' property. |
theme | object | The current theme to be rendered. | |
default | feature-style | <optional> | The default style for features. |
highlight | feature-style | <optional> | The style for highlighted features. |
theme | Object | <optional> | The theme style configuration. |
themes | Object | <optional> | Multiple theme style configurations. |
hover | Object | <optional> | The hover style configuration. |
hovers | Object | <optional> | Multiple hover style configurations. |
label | Object | <optional> | The label style configuration. |
labels | Object | <optional> | Multiple label style configurations. |
zoomInScale | numeric | <optional> | Icon scale is multiplied with mapview zoom level. |
zoomOutScale | numeric | <optional> | Icon scale is divided by mapview zoom level. |
- Source
locale
Object containing the details of the locale i.e. layer definitions, plugins, etc.
- Object
Name | Type | Attributes | Description |
---|---|---|---|
view | object | A latitude and longitude used to determine the centre of the view | |
layers | array | Array of | |
extent | object | <optional> | Determines the size of the locale with using degrees east, west, etc. |
name | string | <optional> | The name of the locale. |
minZoom | integer | <optional> | limits the minimum zoom level of the mapview. |
maxZoom | integer | <optional> | limits the maximum zoom level of the mapview. |
ScaleLine | string | <optional> | sets the units for the scalebar. |
gazetteer | object | <optional> | Configuration options for location lookups. |
roles | object | <optional> | sets the roles and deines what they have access to in the locale. |
queryparams | object | <optional> | params to be assigned to |
locator | boolean | <optional> | boolean flag for adding a locator to button column. |
plugins | array | <optional> | A list of plugins to be loaded. |
svg_templates | object | <optional> | A list of templates to be cached and used with module:/utils/svgSymbols |
listview_records | array | <optional> | An array for the symbol and colour being assigned to |
layer | layer | <optional> | A master for all layers on the locale. |
- Source
location
A decorated mapp location.
- Object
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
layer | layer | The layer from which the location data was queried. | ||
getTemplate | string | <optional> | "location_get" | Query from which to retrieve location data. |
table | string | <optional> | Layer table from which to get the location data. | |
Layers | Array | Array of Openlayer Layers (with Source) to store geometries associated with the location. | ||
infoj | Array | Array of infoj-entry objects with their values populated by the location get() method. | ||
remove | function | |||
flyTo | function | |||
view | HTMLElement | The location view displayed in the location listview in the default Mapp application view. |
- Source
mapview
A mapview object has an Openlayers Map element limited to the locale configuration.
- Object
Name | Type | Description |
---|---|---|
host | string | The host domain/path for queries. |
Map | object | Openlayers Map element. |
locale | object | The locale defintion for the mapview. |
changend | function | The changeend method is triggered by the mapview.Map moveend event. |
- Source
tabview
A tabview object is an element to display tabs and their associated panels.
- Object
Name | Type | Description |
---|---|---|
id | string | Unique id provided as object property to be assigned as data-id to the tabview.node. |
node | HTMLElement | Required HTML element to hold the tabview tabs and panel elements. |
tabs | HTMLElement | HTML element to hold add tab elements. |
panel | HTMLElement | HTML element to display the panel element of the current active tab. |
addTab | function | Method to add a tab to the tabview. |
- Source