Data Formats
Concepts in MapWeave are described as plain JavaScript objects whose properties configure its state.
The formats below describe the data structures used to define concepts in MapWeave.
CompassPoint"n" | "ne" | "e" | "se" | "s" | "sw" | "w" | "nw"The direction as shown on a compass.
The options for fitting the map to a provided bounding box.
bounds
optionalDefines the bounds to be shown on the map. Set the values manually or get values using the getBounds() layer methods.
padding
optionalnumberdefault: autoThe padding to apply to the map around the defined bounds in pixels. If not specified, defaults to a value equal to 1/8th of the minimum screen width or height.
time
optionalnumberdefault: 0The time of the animation in milliseconds.
The configuration for flying the map to a specific view.
bearing
optionalnumberThe bearing at the end of the fly to animation. If not set, preserves the previous viewState.
pitch
optionalnumberThe pitch at the end of the fly to animation. If not set, preserves the previous viewState.
time
optionalnumberdefault: 1000The duration of the fly to animation in milliseconds.
zoom
optionalnumberThe zoom level at the end of the fly to animation. If not set, preserves the previous viewState.
GradientRecord<number, string>An object used to specify a set of color stops that defines a color gradient. The key is a number between 0 and 1, specifying the position of the color stop. The value is a string defining the color for that position.
const colorGradient = {
0: '#30C5D2',
0.5: '#743C9E',
1: '#290F85',
};Defines longitude and latitude in degrees from the Greenwich meridian and the equator respectively. Altitude is defined as meters above sea level.
Defines a rectangle on the map by the southwest and northeast corners.
The northeast corner of the bounding rectangle.
The southwest corner of the bounding rectangle.
An object that defines longitude and latitude in degrees from the Greenwich meridian and the equator respectively.
PointerEventItemObservationsItem | NetworkItem | FeatureDefines the item in the layer targeted by pointer events.
An object describing the view of the map returned by MapWeave.
numberThe bearing (rotation) of the map, in degrees. Set to 0 for north to be top center of the view.
numberHeight of the viewport in pixels.
numberThe latitude of the center of the map.
numberThe longitude of the center of the map.
numberThe pitch (tilt) of the map, in degrees. Set to 0 to view the map directly from above.
numberWidth of the viewport in pixels.
numberThe zoom level of the map.
Defines a time interval with a start and an end.
An object to specify the view of the map.
bearing
optionalnumberThe bearing (rotation) of the map, in degrees. Set to 0 for north to be top center of the view.
latitude
optionalnumberThe latitude of the center of the map.
longitude
optionalnumberThe longitude of the center of the map.
pitch
optionalnumberThe pitch (tilt) of the map, in degrees. Set to 0 to view the map directly from above.
zoom
optionalnumberThe zoom level of the map.