Class ElevationPath

Hierarchy (View Summary)

ControlExtended
- ElevationPath

Index

Constructors

constructor

Events

COMPUTE_ELEVATION_EVENT DRAW_END_ELEVATION_EVENT DRAW_START_ELEVATION_EVENT

Constructors

constructor

new ElevationPath(
    options: {
        active?: boolean;
        apiKey?: string;
        displayProfileOptions?: {
            apply?: Function;
            ascendingElevation?: boolean;
            currentSlope?: boolean;
            descendingElevation?: boolean;
            greaterSlope?: boolean;
            meanSlope?: boolean;
            target?: any;
            totalDistance?: boolean;
        };
        elevationPathOptions?: any;
        export?: any;
        id?: number;
        layerDescription?: { description?: string; title?: string };
        ssl?: boolean;
        stylesOptions?: {
            draw?: { finish?: any; pointer?: any; start?: any };
            marker?: any;
        };
    },
): ElevationPath
Parameters
- options: {
      active?: boolean;
      apiKey?: string;
      displayProfileOptions?: {
          apply?: Function;
          ascendingElevation?: boolean;
          currentSlope?: boolean;
          descendingElevation?: boolean;
          greaterSlope?: boolean;
          meanSlope?: boolean;
          target?: any;
          totalDistance?: boolean;
      };
      elevationPathOptions?: any;
      export?: any;
      id?: number;
      layerDescription?: { description?: string; title?: string };
      ssl?: boolean;
      stylesOptions?: {
          draw?: { finish?: any; pointer?: any; start?: any };
          marker?: any;
      };
  }
  options for function call.
  - Optionalactive?: boolean
    
    specify if control should be actived at startup. Default is false.
  - OptionalapiKey?: string
    
    API key for services call (isocurve and autocomplete services). The key "calcul" is used by default.
  - OptionaldisplayProfileOptions?: {
        apply?: Function;
        ascendingElevation?: boolean;
        currentSlope?: boolean;
        descendingElevation?: boolean;
        greaterSlope?: boolean;
        meanSlope?: boolean;
        target?: any;
        totalDistance?: boolean;
    }
    
    profile options.
    
    Optionalapply?: Function
    
    function to display profile if you want to cutomise it. By default, (DISPLAY_PROFILE_BY_DEFAULT()) is used. Helper functions to use with D3 (DISPLAY_PROFILE_LIB_D3()) or AmCharts (DISPLAY_PROFILE_LIB_AMCHARTS()) frameworks are also provided. You may also provide your own function.
    
    OptionalascendingElevation?: boolean
    
    display the ascending elevation into the graph
    
    OptionalcurrentSlope?: boolean
    
    display current slope value on profile mouseover
    
    OptionaldescendingElevation?: boolean
    
    display the descending elevation into the graph
    
    OptionalgreaterSlope?: boolean
    
    display the greater slope into the graph
    
    OptionalmeanSlope?: boolean
    
    display the mean slope into the graph
    
    Optionaltarget?: any
    
    DOM container to use to display the profile.
    
    OptionaltotalDistance?: boolean
    
    display the total distance of the path
  - OptionalelevationPathOptions?: any
    
    elevation path service options. See Gp.Services.getAltitude() for available options
  - Optionalexport?: any
    
    Specify if button "Export" is displayed. For the use of the options of the "Export" control, see packages/Controls/Export/Export.default
  - Optionalid?: number
    
    Ability to add an identifier on the widget (advanced option)
  - OptionallayerDescription?: { description?: string; title?: string }
    
    Layer informations to be displayed in LayerSwitcher widget (only if a LayerSwitcher is also added to the map)
    
    Optionaldescription?: string
    
    Layer description to be displayed in LayerSwitcher
    
    Optionaltitle?: string
    
    Layer title to be displayed in LayerSwitcher
  - Optionalssl?: boolean
    
    use of ssl or not (default true, service requested using https protocol)
  - OptionalstylesOptions?: { draw?: { finish?: any; pointer?: any; start?: any }; marker?: any }
    
    styles management
    
    Optionaldraw?: { finish?: any; pointer?: any; start?: any }
    
    styles used when drawing. Specified with following properties.
    
    Optionalfinish?: any
    
    Line Style when finished drawing. Specified with an ol.style.Stroke object.
    
    Optionalpointer?: any
    
    Style for mouse pointer when drawing the line. Specified with an ol.style.Image subclass object.
    
    Optionalstart?: any
    
    Line Style when drawing. Specified with an ol.style.Stroke object.
    
    Optionalmarker?: any
    
    styles management of marker displayed on map when the user follows the elevation path. Specified with an ol.style.Image subclass object
Returns ElevationPath
Fires
elevationpath:drawstart

Fires
elevationpath:drawend

Fires
elevationpath:compute

Fires
export:compute
Example
```
var measure = new ol.control.ElevationPath({
   export : false,
   stylesOptions : {
    draw : {
      finish : new ol.style.Stroke({
           color : "rgba(0, 0, 0, 0.5)",
           width : 2
      })
    },
   }
   displayProfileOptions : {
      apply : ol.control.ElevationPath.DISPLAY_PROFILE_RAW,
   }
});

// if you want to pluggued the control Export with options :
var measure = new ol.control.ElevationPath({
   export : {
     name : "export",
     format : "geojson",
     title : "Exporter",
     menu : false
   }
});

Exemples :
- displayProfileOptions.apply : null
- displayProfileOptions.apply : function (elevations, container, context) {  // do some stuff... }
- displayProfileOptions.apply : ol.control.ElevationPath.DISPLAY_PROFILE_{LIB_AMCHARTS | LIB_D3 | RAW}
```
Overrides ControlExtended.constructor
- Defined in src/packages/Controls/ElevationPath/ElevationPath.js:120

Properties

_container

_container: HTMLElement

_currentSketch

_currentSketch: Feature<Geometry, { [x: string]: any }> | null

_data

_data: {}

_drawStyleFinish

_drawStyleFinish: Style | null

_drawStyleStart

_drawStyleStart: Style | null

_infoContainer

_infoContainer: any

_lastSketch

_lastSketch: Feature<Geometry, { [x: string]: any }> | null

_marker

_marker: any

_markerStyle

_markerStyle: Style | null

_measureDraw

_measureDraw: Draw | null

_measureSource

_measureSource:
    | VectorSource<any>
    | VectorSource<Feature<Geometry, { [x: string]: any }>>
    | null

_measureVector

_measureVector:
    | VectorLayer<VectorSource<any>, any>
    | VectorLayer<
        | VectorSource<any>
        | VectorSource<Feature<Geometry, { [x: string]: any }>>,
        any,
    >
    | null

_panelContainer

_panelContainer: any

_pictoButton

_pictoButton: any

_profile

_profile: any

_profileContainer

_profileContainer: any

_showContainer

_showContainer: any

_timerHdlr

_timerHdlr: Timeout | null

_uid

_uid: number

_waitingContainer

_waitingContainer: any

collapsed

collapsed: boolean | undefined

description

description: any

`Protected`disposed

disposed: boolean

The object has already been disposed.

element

element: HTMLElement

listable

listable: boolean

`Protected`listenerKeys

listenerKeys: EventsKey[]

on

on: ObjectOnSignature<EventsKey>

once

once: ObjectOnSignature<EventsKey>

options

options:
    | {
        active: boolean;
        apiKey: null;
        displayProfileOptions: {
            apply: null;
            ascendingElevation: boolean;
            currentSlope: boolean;
            descendingElevation: boolean;
            greaterSlope: boolean;
            meanSlope: boolean;
            target: null;
            totalDistance: boolean;
        };
        elevationPathOptions: { outputFormat: string };
        export: boolean;
        layerDescription: { description: string; title: string };
        render: null;
        stylesOptions: { draw: null; marker: null; profile: null };
        target: null;
    }
    | undefined

un

un: ObjectOnSignature<void>

`Static`_profile

_profile: HTMLElement | undefined

`Static`DEFAULT_STYLES

DEFAULT_STYLES: {
    MARKER: Icon;
    RESULTS: {
        imageFillColor: string;
        imageRadius: number;
        imageStrokeColor: string;
        imageStrokeWidth: number;
    };
} = ...

Styles applied by default if stylesOptions property is not set.

Methods

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:145

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

`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:172

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:74

clean

clean(remove: boolean): void
clean
Parameters
- remove: boolean
  remove layer
Returns void
- Defined in src/packages/Controls/ElevationPath/ElevationPath.js:699

dispatchEvent

dispatchEvent(event: string | BaseEvent): boolean | undefined
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.

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

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:114

getActive

getActive(): boolean
Returns true if widget is actived (drawing), false otherwise

Returns boolean
active - true or false
- Defined in src/packages/Controls/ElevationPath/ElevationPath.js:560

getContainer

getContainer(): HTMLElement
Get container

Returns HTMLElement
container
- Defined in src/packages/Controls/ElevationPath/ElevationPath.js:629

getData

getData(): any

Get elevation data

Returns any

data - elevations

Example

{
     *        type // "elevationpath"
     *        greaterSlope // pente max
     *        meanSlope  // pente moyenne
     *        distancePlus // distance cumulée positive
     *        distanceMinus // distance cumulée négative
     *        ascendingElevation // dénivelé cumulée positive
     *        descendingElevation // dénivelé cumulée négative
     *        altMin // altitude min
     *        altMax // altitude max
     *        distance // distance totale
     *        unit // unité des mesures de distance
     *        points // elevations
     *   }

getGeoJSON

getGeoJSON(): string
Get vector layer

Returns string
geojson - GeoJSON format layer
- Defined in src/packages/Controls/ElevationPath/ElevationPath.js:670

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:120

getLayer

getLayer(): VectorLayer<VectorSource<any>, any>
Get layer

Returns VectorLayer<VectorSource<any>, any>
layer
- Defined in src/packages/Controls/ElevationPath/ElevationPath.js:638

getListeners

getListeners(type: string): Listener[] | undefined
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.
Inherited from ControlExtended.getListeners
- Defined in node_modules/ol/events/Target.d.ts:69

getMap

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

Returns Map | null
Map.

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

getProperties

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

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

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

getPropertiesInternal

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

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

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:81

getStyle

getStyle(): Style
Get default style

Returns Style
style
- Defined in src/packages/Controls/ElevationPath/ElevationPath.js:691

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:135

init

init(): void
This method is public. It allows to init the control.

Returns void

Fixme
- Defined in src/packages/Controls/ElevationPath/ElevationPath.js:722

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:140

`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:95

`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:88

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:150

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:88

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:158

setActive

setActive(active: boolean): void
Actived widget drawing or not
Parameters
- active: boolean
  true / false
Returns void
- Defined in src/packages/Controls/ElevationPath/ElevationPath.js:570

setData

setData(data: any): void

Set profile data

Parameters

data: any
elevations

Returns void

Example

{
     *        greaterSlope // pente max
     *        meanSlope  // pente moyenne
     *        distancePlus // distance cumulée positive
     *        distanceMinus // distance cumulée négative
     *        ascendingElevation // dénivelé cumulée positive
     *        descendingElevation // dénivelé cumulée négative
     *        altMin // altitude min
     *        altMax // altitude max
     *        distance // distance totale
     *        unit // unité des mesures de distance
     *        points // elevations
     * }

setLayer

setLayer(layer: VectorLayer<VectorSource<any>, any>): void
Set layer
Parameters
- layer: VectorLayer<VectorSource<any>, any>
  ol.layer.Vector profil layer
Returns void
- Defined in src/packages/Controls/ElevationPath/ElevationPath.js:647

setMap

setMap(map: Map): void
Attach control to map. Overloaded ol.control.Control.setMap() method.
Parameters
- map: Map
  Map.
Returns void
Overrides ControlExtended.setMap
- Defined in src/packages/Controls/ElevationPath/ElevationPath.js:505

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: Partial<NoInfer<Properties>>, 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: Partial<NoInfer<Properties>>
  Values.
- Optionalsilent: boolean
  Update without triggering an event.
Returns void

Api
Inherited from ControlExtended.setProperties
- Defined in node_modules/ol/Object.d.ts:166

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:113

`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:102

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:179

updatePosition

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

`Static`DISPLAY_PROFILE_BY_DEFAULT

DISPLAY_PROFILE_BY_DEFAULT(
    data: any,
    container: HTMLElement,
    context: any,
): void
Display Profile function used by default : no additonal framework needed.
Parameters
- data: any
  elevations values for profile
- container: HTMLElement
  html container where to display profile
- context: any
  this control object
Returns void
- Defined in src/packages/Controls/ElevationPath/ElevationPath.js:486

`Static`DISPLAY_PROFILE_LIB_AMCHARTS

DISPLAY_PROFILE_LIB_AMCHARTS(
    data: any,
    container: HTMLElement,
    context: any,
): void
display Profile using Amcharts framework. This method needs AmCharts libraries to be loaded.
Parameters
- data: any
  collection elevations
- container: HTMLElement
  container
- context: any
  this control object
Returns void
- Defined in src/packages/Controls/ElevationPath/ElevationPath.js:423

`Static`DISPLAY_PROFILE_LIB_D3

DISPLAY_PROFILE_LIB_D3(data: any, container: HTMLElement, context: any): void
display Profile using D3 javascript framework. This method needs D3 libraries to be loaded.
Parameters
- data: any
  elevations values for profile
- container: HTMLElement
  html container where to display profile
- context: any
  this control object
Returns void
- Defined in src/packages/Controls/ElevationPath/ElevationPath.js:446

`Static`DISPLAY_PROFILE_RAW

DISPLAY_PROFILE_RAW(data: any, container: HTMLElement, context: any): void
display Profile without graphical rendering (raw service response)
Parameters
- data: any
  elevations values for profile
- container: HTMLElement
  html container where to display profile
- context: any
  this control object
Returns void
- Defined in src/packages/Controls/ElevationPath/ElevationPath.js:469

Events

COMPUTE_ELEVATION_EVENT

COMPUTE_ELEVATION_EVENT: string | undefined

event triggered when the compute is finished

elevationpath:compute

Default Value

"elevationpath:compute"

Example

ElevationPath.on("elevationpath:compute", function (e) {
  console.log(e.target.getData());
})

DRAW_END_ELEVATION_EVENT

DRAW_END_ELEVATION_EVENT: string | undefined

event triggered at the end of drawing input

elevationpath:drawend

Default Value

"elevationpath:drawend"

DRAW_START_ELEVATION_EVENT

DRAW_START_ELEVATION_EVENT: string | undefined

event triggered at the start of drawing input

elevationpath:drawstart

Default Value

"elevationpath:drawstart"

Class ElevationPath

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Events

Constructors

constructor

Parameters

Optionalactive?: boolean

OptionalapiKey?: string

OptionaldisplayProfileOptions?: { apply?: Function; ascendingElevation?: boolean; currentSlope?: boolean; descendingElevation?: boolean; greaterSlope?: boolean; meanSlope?: boolean; target?: any; totalDistance?: boolean;}

Optionalapply?: Function

OptionalascendingElevation?: boolean

OptionalcurrentSlope?: boolean

OptionaldescendingElevation?: boolean

OptionalgreaterSlope?: boolean

OptionalmeanSlope?: boolean

Optionaltarget?: any

OptionaltotalDistance?: boolean

OptionalelevationPathOptions?: any

Optionalexport?: any

Optionalid?: number

OptionallayerDescription?: { description?: string; title?: string }

Optionaldescription?: string

Optionaltitle?: string

Optionalssl?: boolean

OptionalstylesOptions?: { draw?: { finish?: any; pointer?: any; start?: any }; marker?: any }

Optionaldraw?: { finish?: any; pointer?: any; start?: any }

Optionalfinish?: any

Optionalpointer?: any

Optionalstart?: any

Optionalmarker?: any

Returns ElevationPath

Fires

Fires

Fires

Fires

Example

Properties

_container

_currentSketch

_data

_drawStyleFinish

_drawStyleStart

_infoContainer

_lastSketch

_marker

_markerStyle

_measureDraw

_measureSource

_measureVector

_panelContainer

_pictoButton

_profile

_profileContainer

_showContainer

_timerHdlr

_uid

_waitingContainer

collapsed

description

Protecteddisposed

element

listable

ProtectedlistenerKeys

on

once

options

un

Static_profile

StaticDEFAULT_STYLES

Methods

addChangeListener

Parameters

Returns void

addEventListener

Parameters

Returns void

`Optional`active?: boolean

`Optional`apiKey?: string

`Optional`displayProfileOptions?: {
apply?: Function;
ascendingElevation?: boolean;
currentSlope?: boolean;
descendingElevation?: boolean;
greaterSlope?: boolean;
meanSlope?: boolean;
target?: any;
totalDistance?: boolean;
}

`Optional`apply?: Function

`Optional`ascendingElevation?: boolean

`Optional`currentSlope?: boolean

`Optional`descendingElevation?: boolean

`Optional`greaterSlope?: boolean

`Optional`meanSlope?: boolean

`Optional`target?: any

`Optional`totalDistance?: boolean

`Optional`elevationPathOptions?: any

`Optional`export?: any

`Optional`id?: number

`Optional`layerDescription?: { description?: string; title?: string }

`Optional`description?: string

`Optional`title?: string

`Optional`ssl?: boolean

`Optional`stylesOptions?: { draw?: { finish?: any; pointer?: any; start?: any }; marker?: any }

`Optional`draw?: { finish?: any; pointer?: any; start?: any }

`Optional`finish?: any

`Optional`pointer?: any

`Optional`start?: any

`Optional`marker?: any

`Protected`disposed

`Protected`listenerKeys

`Static`_profile

`Static`DEFAULT_STYLES

`Protected`applyProperties

`Protected`disposeInternal

`Protected`onceInternal

`Protected`onInternal