Class Territories

Hierarchy (View Summary)

Constructors

constructor

Properties

append auto collapsed container description disposed draggable element listable listenerKeys on once options territories uid un

Methods

addChangeListener addEventListener applyProperties changed dispatchEvent dispose disposeInternal get getContainer getKeys getListeners getMap getProperties getPropertiesInternal getRevision hasListener hasProperties notify onceInternal onInternal removeChangeListener removeEventListener removeTerritories removeTerritory render set setCollapse setMap setPosition setProperties setReduce setTarget setTerritories setTerritory unInternal unset updatePosition

Constructors

constructor

  • new Territories(options: TerritoriesOptions): Territories

    Parameters

    Returns Territories

    Fires

    territories:change

    Example

    var territories = new ol.control.Territories({
      collapsed: true,
      panel: true,
      auto: true
    });
    map.addControl(territories);

    or/and

    var territories = new ol.control.Territories({});
    territories.setTerritory({id: "MTQ", title: "Martinique", description: "", bbox: [], thumbnail: "data:image/png;base64,..."});
    territories.setTerritory({id: "GLP", title: "Guadeloupe", description: "", bbox: [], thumbnail: "http://..."});
    map.addControl(territories);

Properties

append

append: undefined | boolean

auto

auto: undefined | boolean

specify if we load the list of territories by default

collapsed

collapsed: undefined | boolean

container

container: HTMLElement

description

description: any

Protecteddisposed

disposed: boolean

The object has already been disposed.

draggable

draggable: undefined | boolean

element

element: HTMLElement

listable

listable: boolean

ProtectedlistenerKeys

listenerKeys: EventsKey[]

on

on: ObjectOnSignature<EventsKey>

once

once: ObjectOnSignature<EventsKey>

options

options:
    | undefined
    | {
        auto: boolean;
        collapsed: boolean;
        draggable: boolean;
        panel: boolean;
        reduce: boolean;
        territories: never[];
        thumbnail: boolean;
        tiles: number;
        title: string;
        upload: { active: boolean; description: string; title: string };
    }

territories

territories: undefined | any[]

list of object territories

Example

{
         *   dom : { HTMLelment },
         *   data : {
         *     id: "MTQ",
         *     title: "Martinique",
         *     description: "", 
         *     bbox: [minx, miny, maxx, maxy], 
         *     thumbnail: "data:image/png;base64,..."
         *   }
         * }

uid

uid: any

un

un: ObjectOnSignature<void>

Methods

addChangeListener

  • addChangeListener(key: string, listener: Listener): void

    Parameters

    • key: string

      Key name.

    • listener: Listener

      Listener.

    Returns void

addEventListener

  • addEventListener(type: string, listener: Listener): void

    Parameters

    • type: string

      Type.

    • listener: Listener

      Listener.

    Returns void

ProtectedapplyProperties

  • applyProperties(source: BaseObject): void
    Protected

    Apply any properties from another object without triggering events.

    Parameters

    • source: BaseObject

      The source object.

    Returns void

changed

  • changed(): void

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

    Returns void

    Api

dispatchEvent

  • dispatchEvent(event: string | BaseEvent): undefined | boolean

    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

    • event: string | BaseEvent

      Event object.

    Returns undefined | boolean

    false if anyone called preventDefault on the event object or if any of the listeners returned false.

    Api

dispose

  • dispose(): void

    Clean up.

    Returns void

ProtecteddisposeInternal

  • disposeInternal(): void
    Protected

    Extension point for disposable objects.

    Returns void

get

  • get(key: string): any

    Gets a value.

    Parameters

    • key: string

      Key name.

    Returns any

    Value.

    Api

getContainer

getKeys

  • getKeys(): string[]

    Get a list of object property names.

    Returns string[]

    List of property names.

    Api

getListeners

  • getListeners(type: string): undefined | Listener[]

    Get the listeners for a specified event type. Listeners are returned in the order that they will be called in.

    Parameters

    • type: string

      Type.

    Returns undefined | Listener[]

    Listeners.

getMap

  • getMap(): null | Map

    Get the map associated with this control.

    Returns null | Map

    Map.

    Api

getProperties

  • getProperties(): { [x: string]: any }

    Get an object of all property names and values.

    Returns { [x: string]: any }

    Object.

    Api

getPropertiesInternal

  • getPropertiesInternal(): null | { [x: string]: any }

    Get an object of all property names and values.

    Returns null | { [x: string]: any }

    Object.

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

hasListener

  • hasListener(type?: string): boolean

    Parameters

    • Optionaltype: string

      Type. If not provided, true will be returned if this event target has any listeners.

    Returns boolean

    Has listeners.

hasProperties

  • hasProperties(): boolean

    Returns boolean

    The object has properties.

notify

  • notify(key: string, oldValue: any): void

    Parameters

    • key: string

      Key name.

    • oldValue: any

      Old value.

    Returns void

ProtectedonceInternal

  • onceInternal(
        type: string | string[],
        listener: (arg0: Event | BaseEvent) => unknown,
    ): EventsKey | EventsKey[]
    Protected

    Parameters

    • type: string | string[]

      Type.

    • listener: (arg0: Event | BaseEvent) => unknown

      Listener.

    Returns EventsKey | EventsKey[]

    Event key.

ProtectedonInternal

  • onInternal(
        type: string | string[],
        listener: (arg0: Event | BaseEvent) => unknown,
    ): EventsKey | EventsKey[]
    Protected

    Parameters

    • type: string | string[]

      Type.

    • listener: (arg0: Event | BaseEvent) => unknown

      Listener.

    Returns EventsKey | EventsKey[]

    Event key.

removeChangeListener

  • removeChangeListener(key: string, listener: Listener): void

    Parameters

    • key: string

      Key name.

    • listener: Listener

      Listener.

    Returns void

removeEventListener

  • removeEventListener(type: string, listener: Listener): void

    Parameters

    • type: string

      Type.

    • listener: Listener

      Listener.

    Returns void

removeTerritories

removeTerritory

  • removeTerritory(territory: string): boolean

    Remove a territory

    Parameters

    • territory: string

      territory id (FRA, MTQ, ...)

    Returns boolean

    • true|false

    Example

    territories.removeTerritory("MTQ"); // id du territoire

render

  • render(mapEvent: MapEvent): void

    Renders the control.

    Parameters

    • mapEvent: MapEvent

      Map event.

    Returns void

    Api

set

  • set(key: string, value: any, silent?: boolean): void

    Sets a value.

    Parameters

    • key: string

      Key name.

    • value: any

      Value.

    • Optionalsilent: boolean

      Update without triggering an event.

    Returns void

    Api

setCollapse

setMap

setPosition

setProperties

  • setProperties(values: { [x: string]: any }, silent?: boolean): 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: { [x: string]: any }

      Values.

    • Optionalsilent: boolean

      Update without triggering an event.

    Returns void

    Api

setReduce

setTarget

  • setTarget(target: string | HTMLElement): 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 | HTMLElement

      Target.

    Returns void

    Api

setTerritories

setTerritory

  • setTerritory(territory: any): boolean

    Add a territory

    Parameters

    • territory: any

      territory

    Returns boolean

    • true|false

    Example

    territories.setTerritory ({
     id: "MTQ",
     title: "Martinique",
     description: "",
     bbox: [minx, miny, maxx, maxy],
     thumbnail: "data:image/png;base64,..."
    });

ProtectedunInternal

  • unInternal(
        type: string | string[],
        listener: (arg0: Event | BaseEvent) => unknown,
    ): void
    Protected

    Unlisten for a certain type of event.

    Parameters

    • type: string | string[]

      Type.

    • listener: (arg0: Event | BaseEvent) => unknown

      Listener.

    Returns void

unset

  • unset(key: string, silent?: boolean): void

    Unsets a property.

    Parameters

    • key: string

      Key name.

    • Optionalsilent: boolean

      Unset without triggering an event.

    Returns void

    Api

updatePosition

Settings

Member Visibility

On This Page

Constructors
Properties
Methods