Type Definitions

dataview

Type:
  • Object
Properties
NameTypeAttributesDescription
keystring

A unique for the dataview.

dataviewstring

The type of dataview

targetHTMLElement

Target element in which the dataview is rendered.

createfunction

Create method for library supporting the dataview type.

showfunction

Method to show a dataview in the document.

hidefunction

Method to hide a dataview in the document.

dynamicboolean<optional>

Dataview should be recreated when shown.

displayboolean<optional>

Whether the dataview should be displayed.

updatefunction<optional>

Method to update the dataview data from a query.

reloadboolean<optional>

Dataview should run update query when shown.

querystring<optional>

Query template for the dataview update method.

hoststring<optional>

Host for the update query.

queryparamsObject<optional>

Parameter for update query.

dataObject

Data to be displayed in the dataview.

setDatafunction<optional>

Method to set the data in the dataview.

labelstring<optional>

Label for a checkbox input.

chkboxHTMLElement<optional>

Input element to toggle the dataview display.

feature-style

A JSON mapp-style object.

Type:
  • Object
Properties
NameTypeAttributesDescription
svgstring<optional>

The SVG source for the icon.

typestring<optional>

The type of the icon.

iconArray | Object<optional>

The icon configuration or an array of icon configurations.

widthnumber<optional>

The width of the icon or symbol.

heightnumber<optional>

The height of the icon or symbol.

strokeColorstring<optional>

The stroke color of the line symbol.

strokeWidthnumber<optional>

The stroke width of the line symbol.

fillColorstring<optional>

The fill color of the polygon symbol.

fillOpacitynumber<optional>

The fill opacity of the polygon symbol.

infoj-entry

A infoj-entry describes a location property. Locations are configured as an array of JSON Object entries layer.infoj[].

Type:
  • Object
Properties
NameTypeAttributesDescription
keystring

A unique identifier for the entry. Will be assigned from iteration index in infoj location method if not implicit.

locationlocation

The entry location.

value*<optional>

The entry value.

fieldstring<optional>

The database field in layer table which holds the entry data.

fieldfxstring<optional>

A SQL statement to query the entry value in the location get request.

titlestring<optional>

The title to be displayed with the entry.value.

inlineboolean<optional>

Flag whether the value should be displayed inline with the title.

editobject<optional>

Edit configuration for the entry.

querystring<optional>

Query template.

queryparamsObject<optional>

Parameter for query in template.

labelstring<optional>

Label for checkbox element.

displayboolean<optional>

Entry display flag.

layer

A mapp-layer object is a decorated JSON layer object which has been added to a mapview.

Type:
  • Object
Properties
NameTypeAttributesDefaultDescription
layer.sridstring'3857'

Feature layer require a spatial reference identifier (SRID).

layer.Lobject

Openlayers Layer object.

layer.displayboolean

Whether the layer should be displayed.

layer.stylelayer-style

The mapp-layer style configuration.

layer.formatstring

The format of the layer data.

layer.clusterlayer-cluster<optional>

Point layer cluster configuration.

layer.tablestring<optional>

Table name for layer features.

layer.tablesArray<optional>

An array of tables for different zoom level.

layer.zIndexnumber<optional>

The zIndex for the layer canvas element.

layer.mapviewObject

mapview typedef object.

layer-cluster

Point layer cluster configuration.

Type:
  • Object
Properties
NameTypeAttributesDescription
distancenumber<optional>

The distance threshold [pixel] for OL source clustering.

labelstring<optional>

The field used for labeling the clusters.

resolutionnumber<optional>

The resolution parameter for PostGIS database cluster queries.

hexgridboolean<optional>

Use hexgrid clustering query for PostGIS.

layer-style

Type:
  • Object
Properties
NameTypeAttributesDescription
cacheBoolean<optional>

The feature style should be retrieved from the feature 'Styles' property.

themeobject

The current theme to be rendered.

defaultfeature-style<optional>

The default style for features.

highlightfeature-style<optional>

The style for highlighted features.

themeObject<optional>

The theme style configuration.

themesObject<optional>

Multiple theme style configurations.

hoverObject<optional>

The hover style configuration.

hoversObject<optional>

Multiple hover style configurations.

labelObject<optional>

The label style configuration.

labelsObject<optional>

Multiple label style configurations.

zoomInScalenumeric<optional>

Icon scale is multiplied with mapview zoom level.

zoomOutScalenumeric<optional>

Icon scale is divided by mapview zoom level.

locale

Object containing the details of the locale i.e. layer definitions, plugins, etc.

Type:
  • Object
Properties
NameTypeAttributesDescription
viewobject

A latitude and longitude used to determine the centre of the view

layersarray

Array of layers to display in the listview.

extentobject<optional>

Determines the size of the locale with using degrees east, west, etc.

namestring<optional>

The name of the locale.

minZoominteger<optional>

limits the minimum zoom level of the mapview.

maxZoominteger<optional>

limits the maximum zoom level of the mapview.

ScaleLinestring<optional>

sets the units for the scalebar.

gazetteerobject<optional>

Configuration options for location lookups.

rolesobject<optional>

sets the roles and deines what they have access to in the locale.

queryparamsobject<optional>

params to be assigned to layer.queryparams and entry.queryparams

locatorboolean<optional>

boolean flag for adding a locator to button column.

pluginsarray<optional>

A list of plugins to be loaded.

svg_templatesobject<optional>

A list of templates to be cached and used with module:/utils/svgSymbols

listview_recordsarray<optional>

An array for the symbol and colour being assigned to mapview.locations{}.

layerlayer<optional>

A master for all layers on the locale.

location

A decorated mapp location.

Type:
  • Object
Properties
NameTypeAttributesDefaultDescription
layerlayer

The layer from which the location data was queried.

getTemplatestring<optional>
"location_get"

Query from which to retrieve location data.

tablestring<optional>

Layer table from which to get the location data.

LayersArray

Array of Openlayer Layers (with Source) to store geometries associated with the location.

infojArray

Array of infoj-entry objects with their values populated by the location get() method.

removefunction

module:/location/decorate~remove

flyTofunction

module:/location/decorate~flyTo

viewHTMLElement

The location view displayed in the location listview in the default Mapp application view.

mapview

A mapview object has an Openlayers Map element limited to the locale configuration.

Type:
  • Object
Properties
NameTypeDescription
hoststring

The host domain/path for queries.

Mapobject

Openlayers Map element.

localeobject

The locale defintion for the mapview.

changendfunction

The changeend method is triggered by the mapview.Map moveend event.

tabview

A tabview object is an element to display tabs and their associated panels.

Type:
  • Object
Properties
NameTypeDescription
idstring

Unique id provided as object property to be assigned as data-id to the tabview.node.

nodeHTMLElement

Required HTML element to hold the tabview tabs and panel elements.

tabsHTMLElement

HTML element to hold add tab elements.

panelHTMLElement

HTML element to display the panel element of the current active tab.

addTabfunction

Method to add a tab to the tabview.