Class

DisplayRule

DisplayRule()

Constructor

# new DisplayRule()

Properties:
Name Type Attributes Default Description
clickable boolean <optional>
true Determines whether location will fire a click event when clicked.
icon string Icon url.
iconScale number
iconSize Object <optional>
{ width: 24, height: 24 }
iconVisible boolean <optional>
true Determines whether the icon should be displayed or not.
label string Label template.
labelZoomFrom number Minimum zoom level a label should be displayed at.
labelZoomTo number Maximum zoom level a label should be displayed at.
labelVisible boolean Determines whether the label should be displayed or not.
polygonFillColor string The fill color. See https://developer.mozilla.org/en-US/docs/Web/CSS/color_value
polygonFillOpacity number The fill opacity between 0.0 and 1.0
polygonStrokeColor string The stroke color. See https://developer.mozilla.org/en-US/docs/Web/CSS/color_value
polygonStrokeOpacity number The stroke opacity between 0.0 and 1.0
polygonStrokeWeight number The stroke width in pixels.
polygonVisible boolean <optional>
false Determines whether a polygon should be displayed or not.
polygonZoomFrom number The minimum zoom level the polygon is displayed at.
polygonZoomTo number The maximum zoom level the polygon is displayed at.
visible boolean It toggles visibility for the icon, the label, and the polygon. When set to false all elements will be hidden. When set to true only the elements which visibility already is true will be shown.
zoomFrom number The minimum zoom level the icon, the label, and the polygon is displayed at.
zoomTo number The maximum zoom level for the icon, the label, and the polygon is displayed at.
Example
{
  "clickable": true,
  "icon": "https://app.mapsindoors.com/mapsindoors/gfx/default/poi.png",
  "iconScale": null,
  "iconSize": { width: 24, height: 24 },
  "iconVisible": true
  "label": "{{name}}",
  "visible": true,
  "zoomFrom": 19,
  "zoomTo": 21,
  "labelVisible": true
  "labelZoomFrom": null,
  "labelZoomTo": null,
  "polygonFillColor": null,
  "polygonFillOpacity": null,
  "polygonStrokeColor"
  "polygonStrokeOpacity"
  "polygonStrokeWeight"
  "polygonVisible": false
  "polygonZoomFrom": null,
  "polygonZoomTo": null
}