Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Routing

Hierarchy

Implements

Index

Constructors

constructor

Accessors

account

  • Aeris account associated with the module.

    readonly
    memberof

    MapSourceModule

    Returns Account

app

  • Application the module was initialized with.

    readonly
    memberof

    MapSourceModule

    Returns InteractiveMapApp

data

  • get data(): any
  • Data associated with the module.

    If the module loads remote data when added to a map, this value will return the data that was last returned by the remote request.

    readonly
    memberof

    MapSourceModule

    Returns any

dataSource

  • get dataSource(): any
  • set dataSource(value: any): void
  • Map data source created for the module.

    memberof

    MapSourceModule

    Returns any

  • Sets the module's map data source.

    memberof

    MapSourceModule

    Parameters

    • value: any

    Returns void

group

  • Parent module group the module belongs to, if any.

    memberof

    MapSourceModule

    Returns ModuleGroup

  • Sets the parent module group.

    memberof

    MapSourceModule

    Parameters

    Returns void

id

  • get id(): string
  • Returns string

map

  • Application map instance.

    readonly
    memberof

    MapSourceModule

    Returns InteractiveMap

opts

Methods

controls

  • controls(): any

dataForRoute

  • Parameters

    • Default value id: string = this.state.routeId

    Returns RouteData

has

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

    memberof

    EventDispatcher

    Parameters

    • type: string

    Returns boolean

infopanel

  • infopanel(): any

initialize

legend

  • legend(): any

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

onAdd

  • onAdd(): void
  • Called when the module's map content source has been added to the map.

    memberof

    MapSourceModule

    Returns void

onData

  • onData(results: any): void

onInit

  • onInit(): void

onMarkerClick

  • onMarkerClick(marker: any, data: any): void

onRemove

  • onRemove(): void

onShapeClick

  • onShapeClick(shape: any, data: any): void
  • Called when a polygon or polyline associated with the module's map content source is clicked on the map.

    memberof

    MapSourceModule

    Parameters

    • shape: any
    • data: any

    Returns void

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

setRoute

  • setRoute(id: string, dataType: string, source: any): void
  • Parameters

    • id: string
    • dataType: string
    • source: any

    Returns void

showInfoPanel

  • showInfoPanel(title: string, data?: any): InfoPanel
  • Shows the map info panel using the specified title and data for the configured view associated with the module.

    memberof

    MapSourceModule

    Parameters

    • title: string
    • Optional data: any

    Returns InfoPanel

source

  • source(): any

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

zoomToRoute

  • zoomToRoute(id?: string, insets?: number[]): void
  • Parameters

    • Default value id: string = this.state.routeId
    • Default value insets: number[] = this.opts.insets

    Returns void

Generated using TypeDoc