title |
String
|
<optional>
|
'OverlayLayer'
|
Layer title |
visible |
Boolean
|
<optional>
|
false
|
Layer initial status |
server |
String
|
|
|
URL of map server |
layerName |
String
|
|
|
Name of layer to display |
attribution |
String
|
<optional>
|
''
|
Layer data attribution |
exclusive |
Boolean
|
<optional>
|
false
|
If true, when the layer is shown, all other overlay layers are hidden |
style |
Object
|
|
|
Style configuration
Properties
| Name |
Type |
Attributes |
Default |
Description |
property |
String
|
|
|
Property that defines the style to use |
values |
Object
|
|
|
Object with possible values and their corresponding style |
minRadius |
Object
|
<optional>
|
3
|
Mininum radius to use for feature style |
maxRadius |
Object
|
<optional>
|
10
|
Maximum radius to use for feature style |
|
popup |
Array.<Object>
|
<optional>
|
|
Data to show when user clicks on a feature in the map
Properties
| Name |
Type |
Attributes |
Description |
property |
String
|
Array.<String>
|
<optional>
|
Name of field or array of fields names to show |
title |
String
|
<optional>
|
Text to show as title |
format |
function
|
<optional>
|
Function to process field or fields value |
|
opacity |
Float
|
<optional>
|
1
|
Layer opacity |
heatmap |
Object
|
<optional>
|
|
Show layer as heatmap
Properties
| Name |
Type |
Attributes |
Default |
Description |
blur |
Integer
|
<optional>
|
15
|
Blur size in pixels |
radius |
Integer
|
<optional>
|
8
|
Radius size in pixels |
gradient |
Array.<String>
|
<optional>
|
['#00f', '#0ff', '#0f0', '#ff0', '#fa0', '#f00']
|
Gradient to use |
|
properties |
String
|
Array
|
<optional>
|
|
Define feature properties to retrive from server. If not defined,
it will retrieve only properties defined in popup. |
filters |
Array.<Filter>
|
<optional>
|
|
Set of filters to apply to the layer. Overrides global dashboard filters. |
layerParams |
Object
|
<optional>
|
|
Extra params for OpenLayers Layer constructor |
sourceParams |
Object
|
<optional>
|
|
Extra params for OpenLayers Source constructor |