entry

key

The type: key entry will be displayed by the layer name in the location view.

json

{
  "type": "key"
}

The type: pin entry will create a labelled and coloured pin for the location. The value must resolve to a coordinate array matching the entry srid. The layer.srid is assumed as the default.

json

{
  "infoj": [
    {
      "type": "pin", 
      "field": "pin",
      "fieldfx": "ARRAY[ST_X(geom_p_4326), ST_Y(geom_p_4326)]"
    }
  ]
}

text

The type:text is the default entry type which will be assigned if not implicit. The edit config supports a placeholder for the input element and to define the maxlength for the input.

json

{
  "infoj": [
    {
      "type": "text", 
      "edit": {
        "placeholder": "Input placeholder text",
        "maxlength": 7
      }
    }
  ]
}

textarea

The type:textarea will provid a multiline textarea input for editing. The edit config supports a placeholder for the input element and to define the maxlength for the input.

json

{
  "infoj": [
    {
      "type": "textarea", 
      "edit": {
        "placeholder": "Input placeholder text",
        "maxlength": 7
      }
    }
  ]
}

integer

The type: integer entry will parse the value as an integer.

json

{
  "infoj": [
    {
      "field": "field_name",
      "type": "integer"
    }
  ]
}

numeric

The type: numeric will parse the value as a float. A formatterParams object can be provided to configure a toLocaleString conversion of the value for display.

Typically this will just want to be maximumFractiondigits which is the number of decimal places.

Further options can be found Here, by default the locale is set to en-GB

json

{
  "infoj": [
    {
      "field": "field_name",
      "type": "numeric", 
      "formatterParams": {
        "options": {
          "maximumFractionDigits": 5
        },
        "locale": "en-GB"
      }
    }
  ]
}

rounnd:int can be used as a shorthand for formatterParams.options.maximumFractionDigits

json

{
  "infoj": [
    {
      "field": "field_name",
      "type": "numeric",
      "round": 1
    }
  ]
}

date

type: date Adds a date infoj entry.

Database field must be of type bigint.

By default this will show as dd/mm/yyyy, hh:mm:ss.
To return just the date in format dd/mm/yyyy add the locale and options object.

json

{
  "field": "date",
  "type": "date", 
  "locale": "en-UK",
  "options": {
    "year": "numeric",
    "month": "2-digit",
    "day": "2-digit"
  }
}

datetime

type: datetime Adds a datetime infoj entry.

Database field must be of type bigint.

By default this will show as dd/mm/yyyy, hh:mm:ss.
You can control this with the locale and options object.

json

{
  "field": "date",
  "type": "datetime", 
  "locale": "en-UK",
  "options": {
    "year": "numeric",
    "month": "2-digit",
    "day": "2-digit"
  }
}

time

type: time Adds a timeinfoj entry.

Database field must be of type numeric or varchar.

json

{
  "title": "Time",
  "field": "time_field",
  "type": "time"
}

link

The type:link entry will create a node containing an icon and anchor tag (link). The default icon class is mask-icon open-in-new. The default label for the link is "Link". An URL path must be defined as entry.url. The URL parameter are constructed from the params object. The icon style can be set as inline style provided as icon_style string value.

json

{
  "label": "Link",
  "type": "link", 
  "icon_class": "mask-icon open-in-new",
  "url": "https://geolytix.com",
  "params": {
    "param": "value"
  }
}

query_button

Creates a button element in the location view which run a parameterised query. The host, query[template] and queryparams can be configured in the entry.

An array of dependents [fields] can be defined. The matching entry values will be synched after the query has been resolved.

json

{
  "label": "Snap to Postal Sector",
  "type": "query_button", 
  "query": "catchment_statistics_snap_to_postal_sector",
  "queryparams": {
    "id": true
  },
  "alert": "Query has executed!",
  "reload": true,
  "dependents": ["geom_3857", "perimeter", "area"]
}

report [legacy]

The type:report entry is a legacy configuration that will resolve without warning to a type:link.

html

type: html This will allow you to output HTML directly into the infoj field.
This is useful as we can use this to control colouring, and text-formatting of information in the infoj for that field.

json

{
  "field": "field_name",
  "type": "html", 
  "fieldfx": "CONCAT('<a href=',field,'>Hyperlink</a></span>')"
}

title

type: title This will allow you to just define a title as that infoj entry.
There is an optional css_title key that can be used to control the styling of the title.

json

{
  "title": "This is a title",
  "type": "title", 
  "css_title": "font-weight:400"
}

json

The type:json entry value is a json object. The SQL field must be type json to support a json entry. The edit interface will attempt to parse a json object before allowing to store a new value in the location data at rest. .json_field with .json_key entries can be used to update individual key/values in the json field.

json

{
  "field": "json_field",
  "type": "json", 
  "edit: true
}

pills

The type:pills entry value requires an array value. The array values will be displayed as pills.

json

{
  "field": "arr_field",
  "type": "pills"
}

image

The type:image entry will show a thumbnail of an image from a cloudinary url stored as the entry.field value. If editable it is possible to delete the image or upload an image if the value is null.

A cloudinary_folder must be provided to determine the location where the images are stored.

json

{
  "field": "field_name",
  "type": "image", 
  "cloudinary_folder": "folder_name",
  "edit": true
}

A valid CLOUDINARY_URL must be in the process env in order to upload or remove images.

images

The type:images entry will be displayed as a gallery of thumbnails in the location view. The thumbnails can be previewed by clicking. An interface to upload or delete images is available with the entry.edit:true flag.

A cloudinary_folder must be provided to determine the location where the images are stored.

json

{
  "field": "field_name",
  "type": "images", 
  "cloudinary_folder": "folder_name",
  "edit": true
}

The field to store references for cloudinary resources must be defined as a text array in the layer table.

sql

images text[] DEFAULT '{}'::text[]

A valid CLOUDINARY_URL must be in the process env in order to upload or remove images.

dataview

The type: dataview allow output to a chart or table to the infoj, tabview or a HTML location within a custom view (report).

Table Infoj Dataview

A Table Dataview returns a table. This uses the Tabulator Package to do so, please refer to the documentation for table formatting options.
Further Dataview Functionality may be present in the Dataview Section.

json

{
  "label": "Table Infoj Dataview",
  "type": "dataview",
  "target": "location",
  "query": "query_name",
  "queryparams": {
    "id": true,
    "table": true,
    "filter": true
  },
  "table": {
    "layout": "fitColumns",
    "columns": [
      {
        "title": "Field",
        "field": "field"
      },
      {
        "title": "Value",
        "field": "value",
        "formatter": "toLocaleString"
      }
    ]
  }
}

Here we can provide:

label(optional) - This generates a checkbox with the name in the infoj, without the label the dataview cannot be toggled on/off.
target - This can be tabview (the tab at the bottom of the MAPP), location (the infoj), or a HTML location ('html-dataview').
The HTML location is used when we wish to draw a chart directly into a report.
SkipEntry: true(optional) - This is used when we wish to skip the drawing of the chart, this is used when we want to draw a dataview to a HTML location within a report.
queryCheck: true(optional) - This will check whether the query for the dataview returns data, and if not will disable the checkbox if one is provided, or hide the dataview from display.
display: true(optional) - This will set the dataview to automatically display, the default is false.
queryparams - This provides the parameters you wish to pass to a query.
This is typically id: true to select just information for a particular location.
You can also provide table: true which will provide the table defined on the layer. This is especially useful when using a template but defining the table for each locale within the layer.json.
This requires the SQL query to contain FROM ${table} to ensure it only returns information from the relevant table location.
You can provide filter: true which will pass the filters selected on the layer to the query. This requires WHERE true ${filter} to be added to the query.
formatter: toLocaleString- This will add thousand separators to the number (1000 becomes 1,000).

Chart Infoj Dataview

A Chart Dataview returns a chart. This uses the ChartJS Package to do so, please refer to the documentation for chart formatting options.
Further Dataview Functionality may be present in the Dataview Section.

json

{
  "label": "Chart Infoj Dataview",
  "type": "dataview",
  "display": false,
  "target": "location",
  "query": "query_name",
  "queryparams": {
    "id": true,
    "table": true,
    "filter": true
  },
  "chart": {
    "options": {
      "aspectRatio": 1.4,
      "indexAxis": "x"
    }
  }
}

Here we can provide:

label(optional) - This generates a checkbox with the name in the infoj, without the label the dataview cannot be toggled on/off.
target - This can be tabview (the tab at the bottom of the MAPP), location (the infoj), or a HTML location ('html-dataview').
The HTML location is used when we wish to draw a chart directly into a report.
SkipEntry: true(optional) - This is used when we wish to skip the drawing of the chart, this is used when we want to draw a dataview to a HTML location within a report.
queryCheck: true(optional) - This will check whether the query for the dataview returns data, and if not will disable the checkbox if one is provided, or hide the dataview from display.
display: true(optional) - This will set the dataview to automatically display, the default is false.
queryparams - This provides the parameters you wish to pass to a query.
This is typically id: true to select just information for a particular location.
You can also provide table: true which will provide the table defined on the layer. This is especially useful when using a template but defining the table for each locale within the layer.json.
This requires the SQL query to contain FROM ${table} to ensure it only returns information from the relevant table location.
You can provide filter: true which will pass the filters selected on the layer to the query. This requires WHERE true ${filter} to be added to the query.

geometry

The type type:geometry field value must be geojson. The geometry will be added to the mapview with the provided style. The location style will be assigned to the entry.style. The location.layer.srid will be assumed as projection if not implicit as entry.srid. A fieldfx function can be used to generate the required format in the location.get() request.

A draw config block can be defined in the entry root or within the edit block. Drawing will always be available if defined on the root or can be toggled with editing if defined in the edit block.

The entry will be skipped with the hideNoEdit flag set and editing disabled.

json

{
  "label": "Label",
  "field": "field_name",
  "srid": "4326",
  "fieldfx": "ST_asGeoJson(geom_4326)",
  "type": "geometry",
  "style": {
    "strokeColor": "#e65100",
    "fillColor": "#e65100",
    "strokeWidth": 2,
    "fillOpacity": 0.2
  },
  "dependents": ["pin"],
  "hideNoEdit": true,
  "edit": {
    "modify_label": "Move Site",
    "delete_label": "Delete Geometry"
    },
    "draw": {
      "polygon": true,
    }
  }
}

Vector Layer

type: vector_layer allows you to create an infoj object from a query (this is the equivalent of mvt_clone but for point data).
This infoj object will then create a tickbox and when checked will draw the points to the mapview.
You can apply thematic styling to this layer and use labels as you can with other layer formats.

zIndex (optional) - This allows control of the order of drawing.
display (optional) - When set to true the points will load automatically when you click on a location.
label - This is the label associated with the checkbox in the infoj.
query - This is a query to select only the relevant geometries.
This requires a particular format as it cannot be a src but must be a template
NOTE - You need to return the geometry in the correct format for that layer type. e.g. wkt requires ST_AsText(geom).

json

{
  "query_vector": {
    "template": "SELECT ST_AsText(geom_p_4326), thematic_field, thematic_label FROM table WHERE site_id=%{id}"
  }
}

queryparams - This is the parameters for the query.
You MUST pass reduce:true to the queryparameters.
style - The style for the points.
Note, to use label and theme/themes you must pass params.fields array containing the fields used.

json

{
  "label": "Label",
  "type": "vector_layer",
  "format": "wkt",
  "srid": "4326",
  "display": true,
  "query": "query_vector",
  "queryparams": {
    "id": true,
    "reduce": true
  },
  "params": {
    "fields": ["thematic_field", "thematic_label"]
  },
  "style": {
    "default": {
      "icon": {
        "type": "dot",
        "fillColor": "#f2fc"
      }
    },
    "label": {
      "field": "thematic_label",
      "title": "Label"
    },
    "theme": {
      "title": "Thematic",
      "type": "graduated",
      "field": "thematic_field",
      "cat_arr": [
        {
          "value": 0,
          "label": "0 to 500",
          "style": {
            "fillColor": "#f7fcf5",
            "fillOpacity": 0.5
          }
        },
        {
          "value": 500,
          "label": "500 to 750",
          "style": {
            "fillColor": "#e5f5e0",
            "fillOpacity": 0.5
          }
        }
      ]
    }
  }
}

Workspace

Layer

Location

infoj

API

provider

sign

query

user

workspace

saml

view

entry

key

pin

text

textarea

integer

numeric

date

datetime

time

link

query_button

report [legacy]

html

title

json

pills

image

images

dataview

Table Infoj Dataview

Chart Infoj Dataview

geometry

Vector Layer

Layer

Location

infoj

entry ​

key ​

pin ​

text ​

textarea ​

integer ​

numeric ​

date ​

datetime ​

time ​

link ​

query_button ​

report [legacy] ​

html ​

title ​

json ​

pills ​

image ​

images ​

dataview ​

Table Infoj Dataview ​

Chart Infoj Dataview ​

geometry ​

Vector Layer ​

entry

key

pin

text

textarea

integer

numeric

date

datetime

time

link

query_button

report [legacy]

html

title

json

pills

image

images

dataview

Table Infoj Dataview

Chart Infoj Dataview

geometry

Vector Layer