Class OverviewMap

Create a new control with a map acting as an overview map for an other defined map.

Param: opt_options

OverviewMap options.

Api

Hierarchy

Constructors

constructor

Methods

changed dispatchEvent get getCollapsed getCollapsible getKeys getMap getOverviewMap getProperties getRevision on once set setCollapsed setCollapsible setMap setProperties setTarget un unByKey unset render unByKey

Constructors

constructor

Methods

changed

  • changed(): void

  • Increases the revision counter and dispatches a 'change' event.

    Returns void

    Api

dispatchEvent

  • dispatchEvent(event): void

  • Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

    Parameters

    Returns void

    Function

    Api

get

  • get(key): any

  • Gets a value.

    Parameters

    • key: string

      Key name.

    Returns any

    Value.

    Api

    stable

getCollapsed

  • getCollapsed(): boolean

  • Determine if the overview map is collapsed.

    Returns boolean

    The overview map is collapsed.

    Api

    stable

getCollapsible

  • getCollapsible(): boolean

  • Return true if the overview map is collapsible, false otherwise.

    Returns boolean

    True if the widget is collapsible.

    Api

    stable

getKeys

  • getKeys(): string[]

  • Get a list of object property names.

    Returns string[]

    List of property names.

    Api

    stable

getMap

  • getMap(): Map

  • Get the map associated with this control.

    Returns Map

    Map.

    Api

    stable

getOverviewMap

  • getOverviewMap(): Map

  • Return the overview map.

    Returns Map

    Overview map.

    Api

getProperties

  • getProperties(): {
        [k: string]: any;
    }

  • Get an object of all property names and values.

    Returns {
        [k: string]: any;
    }

    Object.

    • [k: string]: any

    Api

    stable

getRevision

  • getRevision(): number

  • Get the version number for this object. Each time the object is modified, its version number will be incremented.

    Returns number

    Revision.

    Api

on

  • on(type, listener, opt_this?): Object | Object[]

  • Listen for a certain type of event.

    Parameters

    • type: string | string[]

      The event type or array of event types.

    • listener: Function

      The listener function.

    • Optional opt_this: Object

      The object to use as this in listener.

    Returns Object | Object[]

    Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

    Api

    stable

once

  • once(type, listener, opt_this?): Object | Object[]

  • Listen once for a certain type of event.

    Parameters

    • type: string | string[]

      The event type or array of event types.

    • listener: Function

      The listener function.

    • Optional opt_this: Object

      The object to use as this in listener.

    Returns Object | Object[]

    Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

    Api

    stable

set

  • set(key, value, opt_silent?): void

  • Sets a value.

    Parameters

    • key: string

      Key name.

    • value: any

      Value.

    • Optional opt_silent: boolean

      Update without triggering an event.

    Returns void

    Api

    stable

setCollapsed

  • setCollapsed(collapsed): void

  • Collapse or expand the overview map according to the passed parameter. Will not do anything if the overview map isn't collapsible or if the current collapsed state is already the one requested.

    Parameters

    • collapsed: boolean

      True if the widget is collapsed.

    Returns void

    Api

    stable

setCollapsible

  • setCollapsible(collapsible): void

  • Set whether the overview map should be collapsible.

    Parameters

    • collapsible: boolean

      True if the widget is collapsible.

    Returns void

    Api

    stable

setMap

  • setMap(map): void

  • Remove the control from its current map and attach it to the new map. Subclasses may set up event handlers to get notified about changes to the map here.

    Parameters

    Returns void

    Api

    stable

setProperties

  • setProperties(values, opt_silent?): void

  • Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

    Parameters

    • values: {
          [k: string]: any;
      }

      Values.

      • [k: string]: any
    • Optional opt_silent: boolean

      Update without triggering an event.

    Returns void

    Api

    stable

setTarget

  • setTarget(target): void

  • This function is used to set a target element for the control. It has no effect if it is called after the control has been added to the map (i.e. after setMap is called on the control). If no target is set in the options passed to the control constructor and if setTarget is not called then the control is added to the map's overlay container.

    Parameters

    • target: string | Element

      Target.

    Returns void

    Api

un

  • un(type, listener, opt_this?): void

  • Unlisten for a certain type of event.

    Parameters

    • type: string | string[]

      The event type or array of event types.

    • listener: Function

      The listener function.

    • Optional opt_this: Object

      The object which was used as this by the listener.

    Returns void

    Api

    stable

unByKey

  • unByKey(key): void

  • Removes an event listener using the key returned by on() or once(). Note that using the ol.Observable.unByKey static function is to be preferred.

    Parameters

    • key: Object | Object[]

      The key returned by on() or once() (or an array of keys).

    Returns void

    Function

    Api

    stable

unset

  • unset(key, opt_silent?): void

  • Unsets a property.

    Parameters

    • key: string

      Key name.

    • Optional opt_silent: boolean

      Unset without triggering an event.

    Returns void

    Api

    stable

Static render

  • render(mapEvent): void

  • Update the overview map element.

    Parameters

    Returns void

    Api

Static unByKey

  • unByKey(key): void

  • Removes an event listener using the key returned by on() or once().

    Parameters

    • key: Object | Object[]

      The key returned by on() or once() (or an array of keys).

    Returns void

    Api

    stable

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc