Class Legends

Hierarchy (View Summary)

ControlExtended
- Legends

Constructors

constructor

new Legends(options?: LegendsOptions): Legends
Parameters
- Optionaloptions: LegendsOptions
  options
Returns Legends
Fires
legends:add

Fires
legends:remove

Fires
legends:modify
Example
```
var legends = new ol.control.Legends();
map.addControl(legends);
```
Overrides ControlExtended.constructor
- Defined in src/packages/Controls/Legends/Legends.js:53

Properties

auto

auto: undefined | boolean

{Boolean} specify if control add layers auto

collapsed

collapsed: undefined | boolean

{Boolean} specify if control is collapsed (true) or not (false)

description

description: any

`Protected`disposed

disposed: boolean

The object has already been disposed.

draggable

draggable: undefined | boolean

{Boolean} specify if control is draggable (true) or not (false)

element

element: HTMLElement

legends

legends: undefined | any[]

listable

listable: boolean

`Protected`listenerKeys

listenerKeys: EventsKey[]

on

on: ObjectOnSignature<EventsKey>

once

once: ObjectOnSignature<EventsKey>

options

options:
| undefined
| { auto: boolean; collapsed: boolean; draggable: boolean; panel: boolean }

uid

uid: any

un

un: ObjectOnSignature<void>

Methods

add

add(layer: Layer<Source, LayerRenderer<any>>): boolean
Add a legend from a layer
Parameters
- layer: Layer<Source, LayerRenderer<any>>
  ...
Returns boolean
- true|false
- Defined in src/packages/Controls/Legends/Legends.js:207

addChangeListener

addChangeListener(key: string, listener: Listener): void
Parameters
- key: string
  Key name.
- listener: Listener
  Listener.
Returns void
Inherited from ControlExtended.addChangeListener
- Defined in node_modules/ol/Object.d.ts:146

addEventListener

addEventListener(type: string, listener: Listener): void
Parameters
- type: string
  Type.
- listener: Listener
  Listener.
Returns void
Inherited from ControlExtended.addEventListener
- Defined in node_modules/ol/events/Target.d.ts:50

adds

adds(layers: Layer<Source, LayerRenderer<any>>[]): void
Add legends from layers
Parameters
- layers: Layer<Source, LayerRenderer<any>>[]
  Array of layers
Returns void
- Defined in src/packages/Controls/Legends/Legends.js:191

`Protected`applyProperties

applyProperties(source: BaseObject): void
Protected
Apply any properties from another object without triggering events.
Parameters
- source: BaseObject
  The source object.
Returns void
Inherited from ControlExtended.applyProperties
- Defined in node_modules/ol/Object.d.ts:175

changed

changed(): void
Increases the revision counter and dispatches a 'change' event.

Returns void
Api
Inherited from ControlExtended.changed
- Defined in node_modules/ol/Observable.d.ts:65

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
Inherited from ControlExtended.dispatchEvent
- Defined in node_modules/ol/events/Target.d.ts:61

dispose

dispose(): void
Clean up.

Returns void
Inherited from ControlExtended.dispose
- Defined in node_modules/ol/Disposable.d.ts:19

`Protected`disposeInternal

disposeInternal(): void
Protected
Extension point for disposable objects.

Returns void
Inherited from ControlExtended.disposeInternal
- Defined in node_modules/ol/Disposable.d.ts:24

exist

exist(dom: HTMLElement): boolean
Has already a DOM legend
Parameters
- dom: HTMLElement
  ...
Returns boolean
- true|false
- Defined in src/packages/Controls/Legends/Legends.js:257

get

get(key: string): any
Gets a value.
Parameters
- key: string
  Key name.
Returns any
Value.

Api
Inherited from ControlExtended.get
- Defined in node_modules/ol/Object.d.ts:111

getContainer

getContainer(): HTMLElement
Get container

Returns HTMLElement
container
- Defined in src/packages/Controls/Legends/Legends.js:145

getKeys

getKeys(): string[]
Get a list of object property names.

Returns string[]
List of property names.

Api
Inherited from ControlExtended.getKeys
- Defined in node_modules/ol/Object.d.ts:117

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.
Inherited from ControlExtended.getListeners
- Defined in node_modules/ol/events/Target.d.ts:69

getMap

getMap(): null | Map
Get the map associated with this control.

Returns null | Map
Map.

Api
Inherited from ControlExtended.getMap
- Defined in node_modules/ol/control/Control.d.ts:92

getMetaInformations

getMetaInformations(layer: Layer<Source, LayerRenderer<any>>): any
Get all meta informations of a IGN's layer
Parameters
- layer: Layer<Source, LayerRenderer<any>>
  layer
Returns any
informations
Example
```
getLegends() :
"legends" : [
 {
    "format" : "image/jpeg",
    "url" : "https:*data.geopf.fr/annexes/ressources/legendes/LEGEND.jpg",
    "minScaleDenominator" : "200"
  }
 ],
```
- Defined in src/packages/Controls/Legends/Legends.js:169

getProperties

getProperties(): { [x: string]: any }
Get an object of all property names and values.

Returns { [x: string]: any }
Object.

Api
Inherited from ControlExtended.getProperties
- Defined in node_modules/ol/Object.d.ts:123

getPropertiesInternal

getPropertiesInternal(): null | { [x: string]: any }
Get an object of all property names and values.

Returns null | { [x: string]: any }
Object.
Inherited from ControlExtended.getPropertiesInternal
- Defined in node_modules/ol/Object.d.ts:130

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
Inherited from ControlExtended.getRevision
- Defined in node_modules/ol/Observable.d.ts:72

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.
Inherited from ControlExtended.hasListener
- Defined in node_modules/ol/events/Target.d.ts:75

hasProperties

hasProperties(): boolean
Returns boolean
The object has properties.
Inherited from ControlExtended.hasProperties
- Defined in node_modules/ol/Object.d.ts:136

notify

notify(key: string, oldValue: any): void
Parameters
- key: string
  Key name.
- oldValue: any
  Old value.
Returns void
Inherited from ControlExtended.notify
- Defined in node_modules/ol/Object.d.ts:141

`Protected`onceInternal

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.
Inherited from ControlExtended.onceInternal
- Defined in node_modules/ol/Observable.d.ts:86

`Protected`onInternal

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.
Inherited from ControlExtended.onInternal
- Defined in node_modules/ol/Observable.d.ts:79

remove

remove(layer: Layer<Source, LayerRenderer<any>>): boolean
Remove a legend from a layer
Parameters
- layer: Layer<Source, LayerRenderer<any>>
  ...
Returns boolean
- true|false
- Defined in src/packages/Controls/Legends/Legends.js:231

removeChangeListener

removeChangeListener(key: string, listener: Listener): void
Parameters
- key: string
  Key name.
- listener: Listener
  Listener.
Returns void
Inherited from ControlExtended.removeChangeListener
- Defined in node_modules/ol/Object.d.ts:151

removeEventListener

removeEventListener(type: string, listener: Listener): void
Parameters
- type: string
  Type.
- listener: Listener
  Listener.
Returns void
Inherited from ControlExtended.removeEventListener
- Defined in node_modules/ol/events/Target.d.ts:80

render

render(mapEvent: MapEvent): void
Renders the control.
Parameters
- mapEvent: MapEvent
  Map event.
Returns void
Api
Inherited from ControlExtended.render
- Defined in node_modules/ol/control/Control.d.ts:86

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
Inherited from ControlExtended.set
- Defined in node_modules/ol/Object.d.ts:159

setMap

setMap(map: Map): void
Overwrite OpenLayers setMap method
Parameters
- map: Map
  Map.
Returns void
Overrides ControlExtended.setMap
- Defined in src/packages/Controls/Legends/Legends.js:91

setPosition

setPosition(pos: any): void
Parameters
- pos: any
Returns void
Inherited from ControlExtended.setPosition
- Defined in src/packages/Controls/Control.js:27

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
Inherited from ControlExtended.setProperties
- Defined in node_modules/ol/Object.d.ts:167

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
Inherited from ControlExtended.setTarget
- Defined in node_modules/ol/control/Control.d.ts:111

`Protected`unInternal

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
Inherited from ControlExtended.unInternal
- Defined in node_modules/ol/Observable.d.ts:93

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
Inherited from ControlExtended.unset
- Defined in node_modules/ol/Object.d.ts:182

updatePosition

updatePosition(pos: any): void
Parameters
- pos: any
Returns void
Inherited from ControlExtended.updatePosition
- Defined in src/packages/Controls/Control.js:34

Class Legends

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Legends

Fires

Fires

Fires

Example

Properties

auto

collapsed

description

Protecteddisposed

draggable

element

legends

listable

ProtectedlistenerKeys

on

once

options

uid

un

Methods

add

Parameters

Returns boolean

addChangeListener

Parameters

Returns void

addEventListener

Parameters

Returns void

adds

Parameters

Returns void

ProtectedapplyProperties

Parameters

Returns void

changed

Returns void

Api

dispatchEvent

Parameters

Returns undefined | boolean

Api

dispose

Returns void

ProtecteddisposeInternal

Returns void

exist

Parameters

Returns boolean

get

Parameters

Returns any

Api

getContainer

Returns HTMLElement

getKeys

Returns string[]

Api

getListeners

Parameters

Returns undefined | Listener[]

getMap

Returns null | Map

Api

getMetaInformations

Parameters

Returns any

Example

getProperties

Returns { [x: string]: any }

`Protected`disposed

`Protected`listenerKeys

`Protected`applyProperties

`Protected`disposeInternal

`Protected`onceInternal

`Protected`onInternal

`Protected`unInternal