Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MapView

A view object that displays and manages static map content using imagery from the Aeris Maps Platform (AMP).

A MapView instance does not support user interaction in regards to panning and zooming other support for static control elements to reload map content. If you need to support greater user interaction for map panning and zooming, use an instance of Map instead.

Hierarchy

Implements

Index

Constructors

constructor

  • Initializes a map view instance with the specified target and configuration object.

    memberof

    MapView

    Parameters

    Returns MapView

Accessors

$container

  • get $container(): any
  • DOM element associated with the map's container.

    readonly
    memberof

    MapView

    Returns any

$el

  • get $el(): any
  • Primary DOM element associated with the view.

    readonly
    memberof

    MapView

    Returns any

$map

  • get $map(): any
  • DOM element associated with the map.

    readonly
    memberof

    MapView

    Returns any

account

  • Aeris account used for the map data requests.

    readonly
    memberof

    MapView

    Returns Account

config

  • Map configuration instance managing the underlying map imagery.

    readonly
    memberof

    MapView

    Returns MapConfig

legend

  • Legend view associated with the map.

    readonly
    memberof

    MapView

    Returns LegendView

opts

  • get opts(): {}
  • Configuration options for the view.

    readonly
    memberof

    MapView

    Returns {}

    • [key: string]: any

timeline

  • Animation timeline used to control the map view's current time and animation.

    readonly
    memberof

    MapView

    Returns Timeline

Methods

animationSizeForImage

  • animationSizeForImage(animation: ImageAnimation): { height: number; width: number }

animationUrlForDate

el

  • el(selector: string): any
  • Returns the DOM element within the view's container for the specified selector.

    memberof

    MapView

    Parameters

    • selector: string

    Returns any

has

  • has(type: string): boolean
  • Returns whether the listeners are registered for the specified event name.

    memberof

    EventDispatcher

    Parameters

    • type: string

    Returns boolean

off

  • Removes a registered listener function for the specified event.

    memberof

    EventDispatcher

    Parameters

    • type: string

      Name of the event to remove the listener for.

    • callback: Function

      Handler function to remove so it won't be executed next time the event is triggered.

    • Default value scope: any = null

    Returns EventDispatcher

offAll

on

  • on(type: string, callback: Function, scope?: any, priority?: number): EventDispatcher
  • Registers a listener function to be executed each time an event occurs

    memberof

    EventDispatcher

    Parameters

    • type: string

      Name of the event to listen for. Value can contain multiple event names separated by spaces to trigger the same handler function for each event name.

    • callback: Function

      Handler function to be called when the event occurs

    • Default value scope: any = null
    • Default value priority: number = 0

    Returns EventDispatcher

once

  • once(type: string, callback: Function, scope?: any, priority?: number): EventDispatcher
  • Registers a listener function to be executed the first time an event occurs.

    memberof

    EventDispatcher

    Parameters

    • type: string

      Name of the event to listen for. Value can contain multiple event names separated by spaces to trigger the same handler function for each event name.

    • callback: Function

      Handler function to be called when the event occurs

    • Default value scope: any = null
    • Default value priority: number = 0

    Returns EventDispatcher

setLayers

  • Sets the map layers.

    The legend displayed for the specified map layers can be overridden by providing a value for the legend parameter, which can either be an array of layer codes for multiple auto-configured legends, or a single URL string for a single legend image.

    memberof

    MapView

    Parameters

    Returns void

setLegend

  • setLegend(source: string | string[]): void
  • Sets the legend type(s) or image URL to display. If a source URL is provided, then this image will be displayed regardless of which layer types exist on the map.

    memberof

    MapView

    Parameters

    • source: string | string[]

    Returns void

setMetric

  • setMetric(metric: boolean): void
  • Sets the units to display on the map view.

    memberof

    MapView

    Parameters

    • metric: boolean

    Returns void

trigger

  • Triggers the specified event so that all registered listeners will be executed with the specified parameters.

    memberof

    EventDispatcher

    Parameters

    • type: any

      Event name to trigger

    • Default value data: any = null

    Returns EventDispatcher

Generated using TypeDoc