id:
string
The string identifying the layer
groupId:
null|string
The ID of the layer group that the layer belongs to.
Layers that appear at the root level in Felt will not have a group ID.
name:
string
The name of the layer can be displayed in the Legend, depending on how the layer's legend is configured in its style.
caption:
null|string
The layer's caption is shown in the legend.
description:
null|string
The layer description forms part of the layer's metadata. This is visible to users via the layer info button in the legend.
visible:
boolean
Whether the layer is visible or not.
shownInLegend:
boolean
Whether the layer is shown in the legend or not.
status:
"processing"|"completed"|"failed"|"incomplete"
The current processing status of the layer.
geometryType:
null|string
The geometry type of the layer.
Remarks
This will generally be one of:
"Point"
"Line"
"Polygon"
"Raster"
null
When the layer is processing, or it is a data-only layer, it will be null. You should expect this to be able to be any string, however, as more geometry types can be added in the future.
bounds:
null| [number,number,number,number]
The bounding box of the layer. If the layer is processing, or the bounds have otherwise not been calculated or are not available, this will be null.