Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TileSourceOptions

A data type that provides the configuration options for a tile source instance.

Hierarchy

Index

Properties

Properties

Optional alwaysShow

alwaysShow: boolean

Whether this tile source should always be visible regardless of past or future state. Default value is false.

Optional animation

animation: TileAnimationOptions

Animation options for the tile source.

Optional data

data: { service?: MapRequest | (() => MapRequest); url?: string | ((params: any) => string) }

Configuration options for the data associated with the layer.

Type declaration

  • Optional service?: MapRequest | (() => MapRequest)

    The MapRequest instance to use when loading data for the data source. Either an instance of ApiRequest or MapRequest or configuration options to use when requesting data for the layer (for tile and vector content sources only).

  • Optional url?: string | ((params: any) => string)

    The URL string to request data from for the data source. Value may be a function that receives information about the map, such as current coordinate bounds, to format a URL string before returning.

Optional future

future: boolean

A Boolean indicating whether the tile source represents future data.

Optional id

id: string

Unique identifier for the source.

Optional offset

offset: number | string

Time offset to use for the layer's data. If an offset is defined, then the layer will only display data for that time interval regardless of the global timeline time interval and its animation will be disabled.

This property is only used for raster weather layers and can be an interval offset as a number or a time offset as a string supported by Aeris Maps (AMP). Refer to the Aeris Maps documentation at https://www.aerisweather.com/support/docs/aeris-maps/getting-started/time-offsets/

Optional style

style: RasterStyle

Style associated with the source.

time

time: Date | number

The timestamp to use for the source data, either as a Date or an Epoch time in milliseconds.

This value will be ignored if a value for offset is defined.

Generated using TypeDoc