ObservationsLayer
The observations layer allows you to track entities as they move around the map. See the Observations Layer docs for more details.
Creates a new instance of the layer.
Parameters
- def optional
-
object The layer definition object.
data
optionalInitial data to load into this layer. Data can be changed after instantiation via layer.data().
id
optional string A unique identifier for this layer. If omitted one will be generated automatically.
options
optionalInitial options to set on this layer. Options can be changed after instantiation via layer.options() or layer.resetOptions().
visible
optional boolean Initial visibility of this layer. Visibility can be changed after instantiation via layer.visible().
Returns
ObservationsLayer
A unique id of the layer.
Gets or sets the current data for this layer.
Parameters
Returns
ObservationsLayerData
A reference to the data object it was most recently passed.
Gets the bounds of the items in the layer with the specified ids, or all items if no ids are specified. Returns null if there are no items to compute bounds for.
Parameters
Returns
LngLatBounds
Gets or sets the layer options while preserving any previously set options.
Parameters
Returns
object
An object containing all layer options and their current values.
Overrides the style properties set in ObservedEntity and Observation.
Parameters
Returns
StyleReset
A reset function that removes the style override.
Sets the provided layer options while resetting any other previously set options to default values.
Parameters
Returns
void
Gets or sets the layer visibility.
Parameters
Returns
boolean
Defines the observation of an entity at a specific place and time.
color
optional string The color of the observation.
string The id of the observed entity.
number The latitude of the observation in degrees. Should be in the range -90 to 90.
number The longitude of the observation in degrees. Should be in the range -180 to 180.
number | Date The time of the observation as a Date in local time or a millisecond number in UTC.
"observation" The type of the item.
ObservationsItem Observation | Trajectory An observation or trajectory that can appear in the ObservationsLayer.
Defines the data to load into the ObservationsLayer.
Record<string, ObservedEntity> A dictionary of observed entities, where the keys are the entity ids and the values are ObservedEntity objects.
Record<string, Observation> A dictionary of observations, where the keys are the observation ids and the values are Observation objects.
ObservationsLayerMode "individual" | "trajectory" | "auto" Defines how individual observations and trajectories are shown. If set to 'auto', the individual observations are displayed as defined in individual.autoRange and trajectories are displayed as defined in trajectory.autoRange.
Options related to the observations layer.
autoModeFadeTime
optional number
default: 500 Time in milliseconds to change between 'individual' and 'trajectory' when ObservationsLayerMode is set to 'auto'.
backgroundAlpha
optional number
default: 0.2 The alpha value to apply to observations that are not within the timeForegroundRange.
individual
optional object Options applied when observations are shown individually.
autoRange
optional object Defines the range of zoom levels where individual observations are displayed when ObservationsLayerMode is set to 'auto'.
max
optional number
default: 22 The maximum zoom level at which individual observations are displayed. Must be in the range 0 to 22 where 0 is fully zoomed out and 22 is fully zoomed in.
min
optional number
default: 14 The minimum zoom level at which individual observations are displayed. Must be in the range 0 to 22 where 0 is fully zoomed out and 22 is fully zoomed in.
minimumRadiusMeters
optional number
default: 1 Minimum radius of individual observations in meters. If set alongside radiusPixels, the option that creates the largest circle will be used.
radiusPixels
optional number
default: 2 Radius of individual observations in pixels. If set alongside minimumRadiusMeters, the option that creates the largest circle will be used.
mode
optional ObservationsLayerMode
default: 'auto' The mode of the observations layer.
timeFilterRange
optional TimeRange
default: null The time filter range. If non-null, observations will be hidden if their time is fully outside the range.
timeForegroundRange
optional TimeRange
default: null Defines the time range of the observations to be foregrounded, which emphasizes foregrounded observations by fading the rest into the background. If set, will override timeFilterRange.
trackerNodes
optional object Options applied to tracker nodes, which are associated with an entity by a shared id. See the Tracker Nodes docs for more.
currentTime
optional number | Date
default: null The time at which to place a tracker node on a trajectory as a Date in local time or a millisecond number in UTC.
networkLayerId
optional string
default: null The id of a NetworkLayer. Nodes in NetworkLayerData with an id that matches an entityId will have their position constrained to the corresponding trajectory.
trajectory
optional object Options applied when observations are shown as a trajectory. See the Trajectory docs for more.
autoRange
optional object Defines the range of zoom levels where trajectories are displayed when ObservationsLayerMode is set to 'auto'.
max
optional number
default: 22 The maximum zoom level at which trajectories are displayed. Must be in the range 0 to 22 where 0 is fully zoomed out and 22 is fully zoomed in.
min
optional number
default: 0 The minimum zoom level at which trajectories are displayed. Must be in the range 0 to 22 where 0 is fully zoomed out and 22 is fully zoomed in.
maximumInterval
optional number
default: 60000 Two observations must occur in a specified time period to be considered as part of the same trajectory. This value defines this interval, in milliseconds.
minimumWidthMeters
optional number
default: 0.5 Minimum width of trajectory lines in meters. If set alongside widthPixels, the option that creates the thickest line will be used.
opacity
optional number
default: 1 Opacity of trajectory lines. Must be in the range 0 to 1 where 0 is transparent and 1 is fully visible.
widthPixels
optional number
default: 1 Width of trajectory lines in pixels. If set alongside minimumWidthMeters, the option that creates the thickest line will be used.
Specifies the properties of an Observation that can be overridden with overrideStyle.
color
optional string The color of the observation.
Defines the entity that is observed in the ObservationsLayer. Each entity has one or more observations.
color
optional string
default: 'white' The color of the entity shown on the map.
Specifies the properties of an ObservedEntity that can be overridden with overrideStyle.
color
optional string
default: 'white' The color of the entity shown on the map.
Defines an inferred path from more than one observation of the same entity.
string The id of the entity.
The observations of the entity in time order.
"trajectory" The type of the item.