Options
All
  • Public
  • Public/Protected
  • All
Menu

Renders directions obtained from the DirectionsService.

Hierarchy

Index

Constructors

Methods

  • Adds the given listener function to the given event name. Returns an identifier for this listener that can be used with google.maps.event.removeListener.

    Parameters

    • eventName: string
    • handler: Function

    Returns MapsEventListener

  • bindTo(key: string, target: MVCObject, targetKey?: null | string, noNotify?: boolean): void
  • Binds a View to a Model.

    Parameters

    • key: string
    • target: MVCObject
    • Optional targetKey: null | string
    • Optional noNotify: boolean

    Returns void

  • get(key: string): any
  • Gets a value.

    Parameters

    • key: string

    Returns any

  • Returns the renderer's current set of directions.

    Returns null | DirectionsResult

  • getMap(): null | Map
  • Returns the map on which the DirectionsResult is rendered.

    Returns null | Map

  • getPanel(): null | HTMLElement
  • Returns the panel <div> in which the DirectionsResult is rendered.

    Returns null | HTMLElement

  • getRouteIndex(): number
  • Returns the current (zero-based) route index in use by this DirectionsRenderer object.

    Returns number

  • notify(key: string): void
  • Notify all observers of a change on this property. This notifies both objects that are bound to the object's property as well as the object that it is bound to.

    Parameters

    • key: string

    Returns void

  • set(key: string, value: any): void
  • Sets a value.

    Parameters

    • key: string
    • value: any

    Returns void

  • Set the renderer to use the result from the DirectionsService. Setting a valid set of directions in this manner will display the directions on the renderer's designated map and panel.

    Parameters

    Returns void

  • setMap(map: null | Map): void
  • This method specifies the map on which directions will be rendered. Pass null to remove the directions from the map.

    Parameters

    • map: null | Map

    Returns void

  • Change the options settings of this DirectionsRenderer after initialization.

    Parameters

    Returns void

  • setPanel(panel: null | HTMLElement): void
  • This method renders the directions in a <div>. Pass null to remove the content from the panel.

    Parameters

    • panel: null | HTMLElement

    Returns void

  • setRouteIndex(routeIndex: number): void
  • Set the (zero-based) index of the route in the DirectionsResult object to render. By default, the first route in the array will be rendered.

    Parameters

    • routeIndex: number

    Returns void

  • setValues(values?: null | object): void
  • Sets a collection of key-value pairs.

    Parameters

    • Optional values: null | object

    Returns void

  • unbind(key: string): void
  • Removes a binding. Unbinding will set the unbound property to the current value. The object will not be notified, as the value has not changed.

    Parameters

    • key: string

    Returns void

  • unbindAll(): void

Generated using TypeDoc