geopf-extensions-openlayers
    Preparing search index...

    Class Territories

    Hierarchy (View Summary)

    Index
    constructor
    append auto collapsed container description disposed draggable element listable listenerKeys on once options territories uid un uploadConfig
    addChangeListener addEventListener applyProperties changed dispatchEvent dispose disposeInternal findTerritoryById get getContainer getKeys getListeners getMap getProperties getPropertiesInternal getRevision getTerritories hasListener hasProperties notify onceInternal onInternal removeChangeListener removeEventListener removeTerritories removeTerritory render set setCollapse setMap setPosition setProperties setReduce setTarget setTerritories setTerritory unInternal unset updatePosition validateTerritory

    • Parameters

      Returns Territories

      territories:loaded

      territories:change

      territories:add

      territories:remove

      territories:reset

      territories:order

      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);
      territories.on("territories:loaded", (e) => { console.log(e.data); });
      territories.on("territories:add", (e) => { console.log(e); });
      territories.on("territories:remove", (e) => { console.log(e); });
      territories.on("territories:reset", (e) => { console.log(e); });
      territories.on("territories:order", (e) => { console.log(e); });
    append: boolean | undefined
    auto: boolean | undefined

    specify if we load the list of territories by default

    collapsed: boolean | undefined
    container: HTMLElement
    description: any
    disposed: boolean

    The object has already been disposed.

    draggable: boolean | undefined
    element: HTMLElement
    listable: boolean
    listenerKeys: EventsKey[]
    on: ObjectOnSignature<EventsKey>
    once: ObjectOnSignature<EventsKey>
    options:
        | {
            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 };
            view: { active: boolean; description: string; title: string };
        }
        | undefined
    territories: any[] | undefined

    list of object territories

    {
             *   isRemoved : { Boolean },
             *   isAdded : { Boolean },
             *   domView : { HTMLelment },
             *   domEntry : { HTMLelment },
             *   initialIndex : { Number }, // index d’origine
             *   data : {
             *     id: "MTQ",
             *     title: "Martinique",
             *     description: "", 
             *     bbox: [minx, miny, maxx, maxy], 
             *     thumbnail: "data:image/png;base64,..."
             *   }
             * }
    uid: any
    un: ObjectOnSignature<void>
    uploadConfig: any

    • Parameters

      • key: string

        Key name.

      • listener: Listener

        Listener.

      Returns void

    • Parameters

      • type: string

        Type.

      • listener: Listener

        Listener.

      Returns void

    • Protected

      Apply any properties from another object without triggering events.

      Parameters

      • source: BaseObject

        The source object.

      Returns void

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

      Returns 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

      • event: string | BaseEvent

        Event object.

      Returns boolean | undefined

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

    • Clean up.

      Returns void

    • Protected

      Extension point for disposable objects.

      Returns void

    • Gets a value.

      Parameters

      • key: string

        Key name.

      Returns any

      Value.

    • Get a list of object property names.

      Returns string[]

      List of property names.

    • 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 Listener[] | undefined

      Listeners.

    • Get the map associated with this control.

      Returns Map | null

      Map.

    • Get an object of all property names and values.

      Returns NoInfer<{ [x: string]: any }>

      Object.

    • Get an object of all property names and values.

      Returns Partial<NoInfer<{ [x: string]: any }>> | null

      Object.

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

      Returns number

      Revision.

    • Parameters

      • Optionaltype: string

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

      Returns boolean

      Has listeners.

    • Returns boolean

      The object has properties.

    • Parameters

      • key: string

        Key name.

      • oldValue: any

        Old value.

      Returns void

    • Protected

      Parameters

      • type: string | string[]

        Type.

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

        Listener.

      Returns EventsKey | EventsKey[]

      Event key.

    • Protected

      Parameters

      • type: string | string[]

        Type.

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

        Listener.

      Returns EventsKey | EventsKey[]

      Event key.

    • Parameters

      • key: string

        Key name.

      • listener: Listener

        Listener.

      Returns void

    • Parameters

      • type: string

        Type.

      • listener: Listener

        Listener.

      Returns void

    • Remove a territory

      Parameters

      • territory: string

        territory id (FRA, MTQ, ...)

      • Optionalforce: boolean = false

        force removal

      Returns boolean

      • true|false
      territories.removeTerritory("MTQ"); // id du territoire

    • Renders the control.

      Parameters

      • mapEvent: MapEvent

        Map event.

      Returns void

    • Sets a value.

      Parameters

      • key: string

        Key name.

      • value: any

        Value.

      • Optionalsilent: boolean

        Update without triggering an event.

      Returns 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: Partial<NoInfer<Properties>>

        Values.

      • Optionalsilent: boolean

        Update without triggering an event.

      Returns 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

    • Add a territory

      Parameters

      • territory: Territory

        territory

      • OptionalisAdded: boolean = false

        specify if territory is added manually with "Add view" button

      Returns boolean

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

      Unlisten for a certain type of event.

      Parameters

      • type: string | string[]

        Type.

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

        Listener.

      Returns void

    • Unsets a property.

      Parameters

      • key: string

        Key name.

      • Optionalsilent: boolean

        Unset without triggering an event.

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods