Class ButtonExport

Hierarchy

Control
- ButtonExport

Constructors

constructor

new ButtonExport(
    options: {
        callback?: Function;
        control?: any;
        description?: string;
        direction?: string;
        download?: string;
        format?: string;
        icons?: { button?: string; menu?: string };
        id?: number;
        kind?: string;
        layer?: any;
        menu?: boolean;
        menuOptions?: {
            above?: boolean;
            labelDesc?: boolean;
            labelName?: boolean;
            outside?: boolean;
            selectFormat?: boolean;
        };
        name?: string;
        target?: HTMLElement;
        title?: string;
    },
): ButtonExport
Parameters
- options: {
      callback?: Function;
      control?: any;
      description?: string;
      direction?: string;
      download?: string;
      format?: string;
      icons?: { button?: string; menu?: string };
      id?: number;
      kind?: string;
      layer?: any;
      menu?: boolean;
      menuOptions?: {
          above?: boolean;
          labelDesc?: boolean;
          labelName?: boolean;
          outside?: boolean;
          selectFormat?: boolean;
      };
      name?: string;
      target?: HTMLElement;
      title?: string;
  }
  options for function call.
  - Optionalcallback?: Function
    with a callback, the implementation is your responsibility
  - Optionalcontrol?: any
    instance of control
  - Optionaldescription?: string
    export description put into file
  - Optionaldirection?: string
    buttons and menus layout
  - Optionaldownload?: string
    triggering the download of the file
  - Optionalformat?: string
    geojson / kml / gpx
  - Optionalicons?: { button?: string; menu?: string }
    icons
    
    Optionalbutton?: string
    displays the button icon : save or export icon, or otherwise left blank if you don't want it
    
    Optionalmenu?: string
    displays the menu icon, or otherwise left blank if you don't want it
  - Optionalid?: number
    Ability to add an identifier on the widget (advanced option)
  - Optionalkind?: string
    button type : primary | secondary | tertiary
  - Optionallayer?: any
    the layer instance is retrieved from the control, but you can defined it
  - Optionalmenu?: boolean
    displays the menu
  - OptionalmenuOptions?: {
        above?: boolean;
        labelDesc?: boolean;
        labelName?: boolean;
        outside?: boolean;
        selectFormat?: boolean;
    }
    options of the menu.
    
    Optionalabove?: boolean
    displays menu above or not of the button
    
    OptionallabelDesc?: boolean
    displays the label description
    
    OptionallabelName?: boolean
    displays the label name
    
    Optionaloutside?: boolean
    displays all element outside of menu
    
    OptionalselectFormat?: boolean
    displays the select format
  - Optionalname?: string
    export name file
  - Optionaltarget?: HTMLElement
    target where the button will plug in. By default, the target is 'container-buttons-plugin' into the wikdget
  - Optionaltitle?: string
    button name
Returns ButtonExport
Fires
button:clicked
Example
```
// pluggued widget Export into control Isocurve
var iso = new ol.control.Isocurve();
map.addControl(iso);

// method : call render()
var export = new ButtonExport();
export.setDownload(true);
export.setControl(iso);
export.setTarget();
export.setName("export");
export.setFormat("geojson");
export.setDescription("Export Isochrone");
export.setTitle("Exporter");
export.setMenu(true);
export.setMenuOptions({
  outside : false,
  labelName : true,
  labelDesc : true,
  selectFormat : true
});
export.render(); // <-- direct call to render function !
export.on("button:clicked", (data) => { console.log(data); });

// method : call map.addControl()
var export = new ButtonExport();
export.setDownload(true);
export.setControl(iso);
export.setTarget();
export.setName("export");
export.setFormat("geojson");
export.setDescription("Export Isochrone");
export.setTitle("Exporter");
export.setKind("secondary");
export.setMenu(false);
export.on("button:clicked", (data) => { console.log(data); });
map.addControl(export); // <-- using the OpenLayers mechanism, don't call to render function !

// use control options instead of setters
var export = new ButtonExport({
  download : true,
  control : iso,
  target : ,
  name : "export",
  description : "Export Isochrone",
  format : "geojson",
  title : "Exporter",
  menu : false,
  callback : (content, layer) => {
     console.log(content, layer);
  }
});
map.addControl(export);

// method with passing option into the control Isocurve
var iso = new ol.control.Isocurve({ export : true });
// with control options :
var iso = new ol.control.Isocurve({ export : {
  download : false,
  name : "save-iso",
  format : "geojson",
  title : "Sauvegarde",
  menu : true
}});
```
Overrides Control.constructor
- Defined in src/packages/Controls/Export/Export.js:126

Properties

`Protected`disposed

disposed: boolean

The object has already been disposed.

`Protected`element

element: HTMLElement

EXPORT_ISOCHRON

EXPORT_ISOCHRON: {}

Response to the export of the isochron calculation (only for jsdoc)

Example

// GeoJSON format
{
   "type":"FeatureCollection",
   "features":[...],
   "geoportail:compute":{
      "transport":"Pieton",
      "computation":"time",
      "exclusions":[

      ],
      "direction":"departure",
      "point":[ 2.587835382718464, 48.84192678293002 ],
      "results":{
         "message":"",
         "id":"",
         "location":{
            "x":"2.587835382718464",
            "y":"48.84192678293002"
         },
         "srs":"EPSG:4326",
         "geometry":{
            "type":"Polygon",
            "coordinates":[[...]]
         },
        "time":180,
        "distance":""
     }
   }
}

See

https://ignf.github.io/geoportal-access-lib/latest/jsdoc/Gp.Services.IsoCurveResponse.html|Service

EXPORT_PROFILE

EXPORT_PROFILE: {}

Response to the export of the profile calculation (only for jsdoc)

Example

// GeoJSON format
{
 "type":"FeatureCollection",
  "features":[...],
  "geoportail:compute":{
     "greaterSlope":76,
     "meanSlope":7,
     "distancePlus":84,
     "distanceMinus":48,
     "ascendingElevation":5,
     "descendingElevation":-4,
     "altMin":"92,04",
     "altMax":"96,71",
     "distance":163,
     "unit":"m",
     "points":[
       {
           "z":95.68,
           "lon":2.5874,
           "lat":48.8419,
           "acc":2.5,
           "dist":0,
           "slope":0
        }
     ]
  }
}

See

https://ignf.github.io/geoportal-access-lib/latest/jsdoc/Gp.Services.AltiResponse.html|Service

EXPORT_ROUTE

EXPORT_ROUTE: {}

Response to the export of the route calculation (only for jsdoc)

Example

// GeoJSON format
{
  "type":"FeatureCollection",
  "features":[...],
  "geoportail:compute":{
    "points":[ [2.588024210134887, 48.84192678293002 ] ],
    "transport":"Voiture",
    "exclusions":[...],
    "computation":"fastest",
    "results":{ <!-- Service --> }
}

See

https://ignf.github.io/geoportal-access-lib/latest/jsdoc/Gp.Services.RouteResponse.html|Service

`Protected`listenerKeys

listenerKeys: EventsKey[]

on

on: ObjectOnSignature<EventsKey>

once

once: ObjectOnSignature<EventsKey>

options

options:
    | undefined
    | {
        callback: null;
        control: null;
        description: string;
        direction: string;
        download: boolean;
        format: string;
        icons: { button: string; menu: string };
        kind: string;
        layer: null;
        menu: boolean;
        menuOptions: {
            above: boolean;
            labelDesc: boolean;
            labelName: boolean;
            outside: boolean;
            selectFormat: boolean;
        };
        name: string;
        target: null;
        title: string;
    }

uid

uid: number

un

un: ObjectOnSignature<void>

Methods

addChangeListener

addChangeListener(key: string, listener: Listener): void
Parameters
- key: string
  Key name.
- listener: Listener
  Listener.
Returns void
Inherited from Control.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 Control.addEventListener
- Defined in node_modules/ol/events/Target.d.ts:50

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

dispose

dispose(): void
Clean up.

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

`Protected`disposeInternal

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

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

get

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

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

getContainer

getContainer(): HTMLElement
Get container

Returns HTMLElement
container
- Defined in src/packages/Controls/Export/Export.js:937

getKeys

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

Returns string[]
List of property names.

Api
Inherited from Control.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 Control.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 Control.getMap
- Defined in node_modules/ol/control/Control.d.ts:92

getProperties

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

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

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

hasProperties

hasProperties(): boolean
Returns boolean
The object has properties.
Inherited from Control.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 Control.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 Control.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 Control.onInternal
- Defined in node_modules/ol/Observable.d.ts:79

removeChangeListener

removeChangeListener(key: string, listener: Listener): void
Parameters
- key: string
  Key name.
- listener: Listener
  Listener.
Returns void
Inherited from Control.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 Control.removeEventListener
- Defined in node_modules/ol/events/Target.d.ts:80

render

render(): void
Render DOM

Returns void
Overrides Control.render
- Defined in src/packages/Controls/Export/Export.js:319

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

setControl

setControl(control: any): void
...
Parameters
- control: any
  ...
Returns void
- Defined in src/packages/Controls/Export/Export.js:946

setDescription

setDescription(desc: string): void
...
Parameters
- desc: string
  ...
Returns void
- Defined in src/packages/Controls/Export/Export.js:1002

setDownload

setDownload(value: boolean): void
...
Parameters
- value: boolean
  ...
Returns void
- Defined in src/packages/Controls/Export/Export.js:1094

setFormat

setFormat(format: string): void
...
Parameters
- format: string
  ...
Returns void
- Defined in src/packages/Controls/Export/Export.js:964

setKind

setKind(type: string): void
...
Parameters
- type: string
  ...
Returns void
- Defined in src/packages/Controls/Export/Export.js:1024

setLayer

setLayer(layer: any): void
...
Parameters
- layer: any
  ...
Returns void
- Defined in src/packages/Controls/Export/Export.js:1085

setMap

setMap(map: null | Map): void
Remove the control from its current map and attach it to the new map. Pass null to just remove the control from the current map. Subclasses may set up event handlers to get notified about changes to the map here.
Parameters
- map: null | Map
  Map.
Returns void
Api
Inherited from Control.setMap
- Defined in node_modules/ol/control/Control.d.ts:101

setMenu

setMenu(active: boolean): void
...
Parameters
- active: boolean
  ...
Returns void
- Defined in src/packages/Controls/Export/Export.js:1049

setMenuOptions

setMenuOptions(opts: any): void
...
Parameters
- opts: any
  ...
Returns void
Todo
...
- Defined in src/packages/Controls/Export/Export.js:1076

setName

setName(name: string): void
...
Parameters
- name: string
  ...
Returns void
- Defined in src/packages/Controls/Export/Export.js:993

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

setTarget

setTarget(target: HTMLElement): void
...
Parameters
- target: HTMLElement
  ...
Returns void
Overrides Control.setTarget
- Defined in src/packages/Controls/Export/Export.js:955

setTitle

setTitle(title: string): void
...
Parameters
- title: string
  ...
Returns void
- Defined in src/packages/Controls/Export/Export.js:1011

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

Events

BUTTON_EXPORT_CLICKED_EVENT

BUTTON_EXPORT_CLICKED_EVENT: string

event triggered when the export is finished

button:clicked

Default Value

"button:clicked"

Example

Export.on("button:clicked", function (e) {
  console.log(e.target);
})

Class ButtonExport

Hierarchy

Index

Constructors

Properties

Methods

Events

Constructors

constructor

Parameters

Optionalcallback?: Function

Optionalcontrol?: any

Optionaldescription?: string

Optionaldirection?: string

Optionaldownload?: string

Optionalformat?: string

Optionalicons?: { button?: string; menu?: string }

Optionalbutton?: string

Optionalmenu?: string

Optionalid?: number

Optionalkind?: string

Optionallayer?: any

Optionalmenu?: boolean

OptionalmenuOptions?: { above?: boolean; labelDesc?: boolean; labelName?: boolean; outside?: boolean; selectFormat?: boolean;}

Optionalabove?: boolean

OptionallabelDesc?: boolean

OptionallabelName?: boolean

Optionaloutside?: boolean

OptionalselectFormat?: boolean

Optionalname?: string

Optionaltarget?: HTMLElement

Optionaltitle?: string

Returns ButtonExport

Fires

Example

Properties

Protecteddisposed

Protectedelement

EXPORT_ISOCHRON

Example

See

EXPORT_PROFILE

Example

See

EXPORT_ROUTE

Example

See

ProtectedlistenerKeys

on

once

options

uid

un

Methods

addChangeListener

Parameters

Returns void

addEventListener

Parameters

Returns void

ProtectedapplyProperties

Parameters

Returns void

changed

Returns void

Api

dispatchEvent

Parameters

Returns undefined | boolean

Api

dispose

Returns void

ProtecteddisposeInternal

Returns void

get

Parameters

Returns any

Api

getContainer

Returns HTMLElement

`Optional`callback?: Function

`Optional`control?: any

`Optional`description?: string

`Optional`direction?: string

`Optional`download?: string

`Optional`format?: string

`Optional`icons?: { button?: string; menu?: string }

`Optional`button?: string

`Optional`menu?: string

`Optional`id?: number

`Optional`kind?: string

`Optional`layer?: any

`Optional`menu?: boolean

`Optional`menuOptions?: {
above?: boolean;
labelDesc?: boolean;
labelName?: boolean;
outside?: boolean;
selectFormat?: boolean;
}

`Optional`above?: boolean

`Optional`labelDesc?: boolean

`Optional`labelName?: boolean

`Optional`outside?: boolean

`Optional`selectFormat?: boolean

`Optional`name?: string

`Optional`target?: HTMLElement

`Optional`title?: string

`Protected`disposed

`Protected`element

`Protected`listenerKeys

`Protected`applyProperties

`Protected`disposeInternal

`Protected`onceInternal

`Protected`onInternal