Whether to always show this animation, meaning it will also be visible if the animation is not a future animation and the current playhead is in the future, or the animation is a future animation and the playhead is in the past.
Whether to begin playing the animation as soon as it's initialized. Default value is false.
Duration of the animation in seconds.
Whether the animation is enabled.
End delay in seconds, which is the duration of the hold time on the last frame before restarting playback at the beginning.
Start time offset in seconds relative to the current time, e.g. -5 * 3600 for five hours ago.
Whether this animation is considered a future animation.
Total number of intervals to request data for, specifically for image-related animations.
Animation identifier.
Refresh duration in seconds. This is typically only used for data-related animations that may need to reload stale data after a determined length of time.
End time offset in seconds relative to the current time, e.g. 2 * 3600 for two hours from now.
A data type that represents the configuration options for an API request.
API client configuration to use with the request.
Client access id.
Client access secret.
The API base server path.
A data type that represents the configuration options for an API data request.
Request action.
Coordinate bounds to search within.
Request endpoint (required).
A comma-delimited list of response properties for the API to return. This parameter is often used to limit the amount of data returned.
Predefined filters for limiting the results. The filter value can be a single, comma-delimited or a semicolon delimited string of filter names.
Either a Date or valid time string from
which to return results for.
Maximum number of results to return.
Location to request data for. Refer to the list of supported place values.
Applied only on the periods response property, the total number of periods to return as
an integer.
Applied only on the periods response property, used to skip over a specific number of
periods in the data set.
Applied only on the periods response property, used to sort results based on certain
fields contained within the periods.
Filters results based on certain fields and values in the dataset. Refer to the advanced queries documentation.
When requesting the closest results within a circle, the radius determines how far from the
specified location to search. A valid unit value must be included in your radius value,
e.g., 5mi, 10km, 25miles. If no unit is provided, your value is assumed to be in
meters by default.
Skips over a specific number of results in the dataset.
Sorts results based on certain fields in the dataset. Refer to the sorting documentation.
Either a Date or valid time string up to
which to return results for. When used in conjunction with from(), this value be relative
to the from value, not relative to the current time.
A data type that represents the configuration options for a grouped legend.
A data type that represents the configuration options for a grouped legend item.
A data type that represents the configuration options for an image-based animation.
A data type that represents the configuration options for a Map instance.
Aeris account to use when requesting map data and imagery.
Center coordinate to initialize the map view.
Initial layers to add to the map at initialization.
Whether map content source data should be reloaded automatically when the map bounds have changed.
Default value is true. Set this value to false to reduce data and map unit usage.
Map strategy.
The following strategy values are supported:
leaflet: Uses the Leaflet.js mapping librarymapbox: Uses the MapboxGL mapping libraryStyle overrides per layer code.
Configuration options for the map's animation timeline.
Zoom level to initialize the map view.
A lat/lon numberical value array, e.g. [37.3604, -105.1893] or [-105.1893, 37.3604].
A data type that represents metadata for an Aeris Maps (AMP) layer.
Array of Aeris account levels that are required for accessing the layer.
Layer category.
Layer code.
Layer description.
Layer identifier.
Layer update interval.
Legend source URL to use for the layer.
Array of modifier information supported by the layer.
Layer name.
List of regions covered by the layer.
Layer thumbnail URL.
Layer identifier to inherit metadata from.
A data type that represents the data objects that can be added to a map view.
Marker objects by identifier
Polygon objects
Polyline objects
A data type that represents a series of layer groups.
Base map layers.
Weather data layers.
Map overlay layers.
Weather text data layers.
A data type that represents the configuration options for a map content source instance.
Request options (for point and shape content sources only).
API action to use for the request. Default value is ApiAction.WITHIN for point content
sources and ApiAction.SEARCH for shape content sources.
Defines the request parameters to use when requesting data for the layer.
Defines the property key paths to use for the time and value information for point content sources.
Key path of the property that contains the data's time value for each object in the response.
Key path of the property that contains the data's value for each object in the response. This can also be a function that receives the model's data and returns the value to use in case additional formatting needs to occur on the value.
Style options for the layer.
The map content source type to use. If not provided, the default for the associated layer code will be used.
The following types are supported:
tile: render the layer using raster tilespoint: render the layer using map annotationsshape: render the layer using vector polygons and polylinestext: render the layer using text labelsA data type that represents the configuration options for a legend.
Whether the legend is a grouped legend.
Map layer codes associated with the legend type.
Data value range to display in the legend.
Style options.
Legend title.
Legend type code.
Units configuration.
Legend type code to inherit options from.
A data type that represents the configuration options for a legend image request.
Whether the image should be sized automatically based on its configuration.
Bar legend cell options.
Cell spacing.
Cell size.
Number of columns to restrict the legend elements to.
Image output format.
Amount of spacing between elements in x and y directions.
Data value interval for color stops.
Text label options.
Whether to render data in metric units.
Layout orientation.
Circle radius for point legends.
Data value range to include.
Output size.
Legend type code.
A data type that represents the configuration options for a legend.
Aeris account used when requesting data for dynamic legends.
Whether the view should be sized automatically based on its configuration.
Output format.
Whether data units should be output in Metric.
Output size.
Style options.
Units configuration.
Imperial unit string.
Metric unit string.
A data type that represents the possible legend image request parameters.
A data type that represents the configuration options for a legend style.
Bar legend cell styles.
Size for color cells in a bar legend.
Data value interval for which to draw cells between color stops.
Text label styles.
Text color for labels.
Font size for text labels.
Data value interval for which to display value text labels.
Position of value labels relative to the color bar (bar legends only).
Whether to display value labels in Metric units.
Layout orientation (bar legends only).
Circle radius for point-related legends.
A data type that represents the configuration options for a map view's animation.
A data type that represents the configuration options for map layers.
Base layer codes, which will be rendered at the bottom of the layer stack.
Weather data layer codes, which will be rendered above base layers but below overlay layers.
Overlay layer codes, which will be rendered above data layers.
Text layer codes, which will be rendered at the top of the layer stack.
A data type that represents the configuration options a map configuration instance.
Whether corresponding future layers should automatically be added to the map when adding a
data layer when available. Default is true.
Coordinate bounds of the visible region.
Center of the map, either as a place string or coordinate object.
Whether all layers should be combined together into a single image. This results in fewer
requests but increased map units since base and overlay layers will be requested each
time data and/or text layers change.
Default value is false.
Date and time either as a Date object or UNIX timestamp as a number (e.g. 20180601174100).
Defines the layers to display on the map grouped by category.
Whether text layers should display values in Metric units. Default is false.
Time offset either as a UNIX timestamp as a string (e.g. 20180601174100) or a relative offset as a string (e.g. -6hours).
Map size.
Aspect ratio of width-to-height. This value is used when calculating an auto
height based on the configured width.
Image height, which can either be a number or auto. If auto is used, then the image
height will be determined by the configured width and the value for factor.
Image width
Zoom level.
A data type that represents the configuration options for a map view's interface controls.
The layer-related controls to display above the map view.
The region/zoom-related controls to display along the bottom of the map view.
A data type that represents the configuration options for a map view's overlays.
Optional branding element to display over the map view.
Element can either be a static image (url) or and HTML string. If both properties are provided, the HTML string will be used. This branding element can be customized using CSS overrides as needed.
HTML string content. Takes precedence over img when both are provided.
URL for the image source.
Timestamp output format.
Map title, which will be displayed in a title bar element across the top-left of the map view. Title bar can be customized using CSS overrides as needed.
A data type that represents the configuration options for an API map request.
Coordinate bounds defining the visible region.
Output format, e.g. png or jpg.
Layer groups.
Whether text values should be output in Metric units.
Time offset for the map data.
Location the map will be centered on.
Output image size.
Type of map request, which determines the request URL format.
Zoom level.
A data type that represents the configuration options for a MapView instance.
Aeris account to use with the map view data.
Map animation configuration.
Map controls configuration.
Map configuration.
Map overlays configuration.
A data type that provides style options for marker objects on a map.
Function used to format the marker callout content based on the provided object data.
Style class name to add to the marker's DOM element.
HTML content to use when rendering the icon.
Provides the icon options for the style. If a value for html is provided, the marker will
be rendered as HTML and this value will be ignored.
The point coordinates of the tip of the icon (relative to the top-left corner).
URL to a retina sized version of the icon image. If not provided, the url icon path
will be used for retina devices.
The URL to the icon image (absolute or relative to the script path).
Size of the icon as [width, height], e.g. [20,15]
Minimum distance, in screen pixels/points, between rendered markers on the map. If not
specified or 0, then all markers will be rendered (default).
Provides the options for rendering the icon as an SVG element. If a value for html is
provided, the marker will be rendered as HTML and this value will be ignored.
The shape options.
The text style options.
Whether to automatically size the marker based on the width and height of the text.
Default is true.
Text color.
Amount of padding to insert around the text as [x, y], where x is the amount of
padding on the left and right, and y is the amount of padding on the top and
bottom.
Font size.
Font style, e.g. normal or bold.
Text value to display.
Determines the x-coordinate of the starting point of the text baseline.
Determines the y-coordinate of the starting point of the text baseline.
A data type that provides the configuration options for a tile source instance.
Style associated with the source.
A data type that represents the individual RGB color components for a color.
A data type that provides style options for raster layers on a map, such as images and tiles.
Blend mode to apply to the image.
Amount to blur the image.
Opacity of the layer on the map view.
A data type that represents a pre-defined region based on a center coordinate or coordinate bounds.
A data type that represents SVG circle configuration options.
A data type that represents SVG path configuration options.
A data type that represents SVG rectangle configuration options.
A data type that represents SVG shape configuration options.
A data type that represents SVG text configuration options.
A data type that provides the configuration options for a tile source instance.
Style associated with the source.
A data type that represents a series of ITimeValueRepresentable objects keyed by unique
identifier.
A data type that represents the configuration options for an tile-based animation.
A data type that provides the configuration options for a tile source instance.
Whether this tile source should always be visible regardless of past or future state. Default value is false.
Animation options for the tile source.
Whether animation is enabled.
Type of animation, either tile or image. Default value is tile.
A Boolean indicating whether the tile source represents future data.
Style associated with the source.
The timestamp to use for the source data, either as a Date or an Epoch time in milliseconds.
A data type that provides style options for vector objects on a map, such as text, polygons and polylines.
Style class name to add to the shape's DOM element.
The shape's fill style options.
Fill color.
Fill opacity.
A string that defines how the inside of a shape is determined.
Supports nonzero or evenodd.
Defines the shape of the path for SVG elements.
The amount to simplify the shape path on each zoom level. More smoothing means better performance and a smoother appearance, and less means more accurate representation.
This value is not supported for all mapping strategies.
The shape's stroke style options.
Stroke color.
A string that defines the stroke dash pattern.
A string that defines the distance into the dash pattern to start the dash.
A string that defines the shape to be used at the end of the stroke.
Supports butt, round, or square.
A string that defines the shape to be used at the corners of the stroke.
Supports miter, round, bevel, miter-clip, or arcs.
Stroke opacity.
Stroke width in pixels.
Returns a new string by converting the specified string to camelcase.
Returns a country collection keyed by two-letter country abbreviation.
Access a deep value inside a object. Works by passing a path like "foo.bar", also works with nested arrays like "foo[0][1].baz"
Returns a new string by converting a camelcase string to hyphenated.
Returns whether the specified color is light based on its luminance.
The value for color can either be a hex color string, #ffcc00, or an RGB object,
{ r: 100, g: 150, b: 50 }.
Returns the luminance of the specified color.
The value for color can either be a hex color string, #ffcc00, or an RGB object,
{ r: 100, g: 150, b: 50 }.
Set a deep property on nested objects.
A object
A path
Anything that can be set
Returns a states collection keyed by country (us or ca) and the two-letter state
abbreviation.
Converts the specified coordinate bounds object to a string whose values are rounded to the
nearest decimal place according to places.
Converts the specified coordinate to a string whose values are rounded to the nearest decimal
place according to places.
Returns a new string by formatting the specified string as a place name.
Converts the specified hex color string to an RGB object.
Returns a new string by capitalizing the first letter in the specified string.
Returns a new string by capitalizing the first letter of each word in the specified string.
Generated using TypeDoc
A data type that represents the configuration options for an animation.