Skip to main content

MapViewTemplate

This page provides generated reference documentation for the MapViewTemplate data model.

Displays a Map with zoom controls. Markers, Polygons and Polylines may be displayed and used interactively.

Overview​

PropertySummary
titleTitle of the component
devicesDetermines on wich devices the component should be available. The default value states that the component is available on all devices. If one or more devices…
childrenList of children in this container
entityFieldThis property is mandatory. Its value must be set to
autoGeneratedMarkerLatitudeFieldField for the latitude of a marker that is generated based on the data
autoGeneratedMarkerLongitudeFieldField for the longitude of a marker that is generated based on the data
autoGeneratedMarkerIconFieldEntityField providing image information, in order to replace the standard marker icon by a specific icon to be used for the generated marker of the individual…
autoGeneratedMarkerColorFieldField to give the generated marker a color. The field must provide the color code as color constant, e.g. neon.PRIORITY_HIGH_COLOR. You can also directly…
autoGeneratedMarkerPopupFieldField to give the generated marker a popup (similar to a tooltip; not available on all devices) as HTML (!) String including additional information referring…
configFieldField to specify a configuration for the map. This provides the ViewTemplate with the information what map data needs to be loaded. Content needs to be JSON…
geoJsonFeatureCollectionFieldField to provide an array of GeoJSON-FeatureCollections to create additional elements. The following GeoJSON types are supported right now:
maxDBRowSets the maximum number of data rows to be gathered from the database
hideHeaderDefines if the column headers of the grid shall be hidden.
colspanThe colspan of the element.
rowspanThe rowspan of the element.

title​

Type: String
Constraints: Verification: TITLE_LENGTH

Title of the component

devices​

Type: EDeviceType[]

Determines on wich devices the component should be available. The default value states that the component is available on all devices. If one or more devices are selected then the component is only available for those selected devices.

children​

Type: Children

List of children in this container

entityField​

Type: String

This property is mandatory. Its value must be set to\

  • #ENTITY, when the ViewTemplate uses multiple EntityFields of the Entity belonging to the View (default).\
  • a single EntityField, if the ViewTemplate uses only this one single EntityField (example: WebContentViewTemplate).
    The second option will result in a performance optimization.

autoGeneratedMarkerLatitudeField​

Type: String

Field for the latitude of a marker that is generated based on the data

autoGeneratedMarkerLongitudeField​

Type: String

Field for the longitude of a marker that is generated based on the data

autoGeneratedMarkerIconField​

Type: String

EntityField providing image information, in order to replace the standard marker icon by a specific icon to be used for the generated marker of the individual dataset. Simply choose from the icon names provided in the combobox of every property named "icon", and make sure you are using the exact spelling, e.g., "VAADIN:FACTORY". Alternatively, you may provide image data in base64 String format (but note that, in this case, property autoGeneratedMarkerColorField has no effect).

autoGeneratedMarkerColorField​

Type: String

Field to give the generated marker a color. The field must provide the color code as color constant, e.g. neon.PRIORITY_HIGH_COLOR. You can also directly provide the corresponding String, e.g., "priority-high-color" (but then make sure you are using exactly the spelling shown in the list of color codes provided by the combobox of every property named "color").

autoGeneratedMarkerPopupField​

Type: String

Field to give the generated marker a popup (similar to a tooltip; not available on all devices) as HTML (!) String including additional information referring to the location.

configField​

Type: String

Field to specify a configuration for the map. This provides the ViewTemplate with the information what map data needs to be loaded. Content needs to be JSON with the following properties:\

  • startingCenterPosition; type: Object with these properties:
    lat; type: decimal, latitude position of the starting center position\
    • lon; type: decimal, longitude position of the starting center position\
    • zoomLevel; type: integer, initial zoom level\
    • autoLocate; type: boolean, if true tries to set the center the current location of the device\
  • boundaries; type: Object with these properties:
    minZoom; type: integer, the minimal zoom that can be used\
    • maxZoom; type: integer, the maximal zoom that can be used\
  • tiles; a definition of possible map tiles (= map sources) from which the user can choose; type: Array of Objects, with each object having the following properties:
    title; type: String Display title for the User, e.g. "ADITO Road"\
    • url; type: String URL to the server that provides the tiles in the "xyz" format, with the following placeholders:
      {s} means one of the available subdomain\
      • {z} the zoom level\
      • {x} and {y} the tile coordinates\
      • {r} can be used to add "@2x" to the URL to load retina tiles\
    • attribution; type: String, HTML content for display the attribution information (e.g., copyright and sources)
      The content of the field is only loaded once.

geoJsonFeatureCollectionField​

Type: String

Field to provide an array of GeoJSON-FeatureCollections to create additional elements. The following GeoJSON types are supported right now:\

  • Point\
  • Polygon\
  • MultiPolygon\
  • LineString\
  • LinearRing
    The following custom properties are available:\
  • "ADITO-color", color constant value for the color of the element\
  • "ADITO-targetId", targetContext (contextname) and targetId (uid) can be used to provide information for a preview view onclick\
  • "ADITO-targetContext" targetContext (contextname) and targetId (uid) can be used to provide information for a preview view onclick\
  • "ADITO-icon", icon constant for an icon (only Point)\
  • "ADITO-label", title text to display (only Point)\
  • "ADITO-radius", Integer number that specifies meters to draw a circle (only Point)

maxDBRow​

Type: Integer
Constraints: Minimum: Integer.MIN_VALUE, Maximum: Integer.MAX_VALUE

Sets the maximum number of data rows to be gathered from the database

hideHeader​

Type: Boolean

Defines if the column headers of the grid shall be hidden.

colspan​

Type: Integer
Default: 1
Constraints: Minimum: 0, Maximum: Integer.MAX_VALUE

The colspan of the element.

rowspan​

Type: Integer
Default: 1
Constraints: Minimum: 0, Maximum: Integer.MAX_VALUE

The rowspan of the element.