Class Drawing

Hierarchy (View Summary)

Constructors

constructor

Properties

_container _drawingPanel _drawingPanelHeader _showDrawingButton collapsed description disposed draggable element eventKey labelOvl layer listable listenerKeys on once options un

Methods

addChangeListener addEventListener applyProperties changed disable dispatchEvent dispose disposeInternal exportFeatures get getContainer getExportFormat getExportName getKeys getLayer getListeners getMap getProperties getPropertiesInternal getRevision hasListener hasProperties notify onceInternal onInternal removeChangeListener removeEventListener render set setCollapsed setExportFormat setExportName setLayer setMap setPosition setProperties setTarget unInternal unset updatePosition

Events

ADD_AFTER_DRAWING_LAYER_EVENT ADD_BEFORE_DRAWING_LAYER_EVENT

Constructors

constructor

  • new Drawing(
        options: {
            collapsed?: boolean;
            draggable?: boolean;
            id?: number;
            labels?: string;
            layer?: any;
            layerDescription?: { description?: string; title?: string };
            popup?: { display?: boolean; function?: Function };
            tools: {
                display?: boolean;
                edit?: boolean;
                export?: boolean;
                holes?: boolean;
                lines?: boolean;
                measure?: boolean;
                points?: boolean;
                polygons?: boolean;
                remove?: boolean;
                text?: boolean;
                tooltip?: boolean;
            };
        },
    ): Drawing

    Parameters

    • options: {
          collapsed?: boolean;
          draggable?: boolean;
          id?: number;
          labels?: string;
          layer?: any;
          layerDescription?: { description?: string; title?: string };
          popup?: { display?: boolean; function?: Function };
          tools: {
              display?: boolean;
              edit?: boolean;
              export?: boolean;
              holes?: boolean;
              lines?: boolean;
              measure?: boolean;
              points?: boolean;
              polygons?: boolean;
              remove?: boolean;
              text?: boolean;
              tooltip?: boolean;
          };
      }

      options for function call.

      • Optionalcollapsed?: boolean

        Specify if Drawing control should be collapsed at startup. Default is true.

      • Optionaldraggable?: boolean

        Specify if widget is draggable

      • Optionalid?: number

        Ability to add an identifier on the widget (advanced option)

      • Optionallabels?: string

        Labels for Control

      • Optionallayer?: any

        Openlayers layer that will hosts created features. If none, an empty vector layer will be created.

      • 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

      • Optionalpopup?: { display?: boolean; function?: Function }

        Popup informations

        • Optionaldisplay?: boolean

          Specify if popup is displayed when create a drawing

        • Optionalfunction?: Function

          Function to display popup informations if you want to cutomise it. You may also provide your own function with params : {geomType / feature / saveFunc(message) / closeFunc()}. This function must return the DOM object of the popup content.

      • tools: {
            display?: boolean;
            edit?: boolean;
            export?: boolean;
            holes?: boolean;
            lines?: boolean;
            measure?: boolean;
            points?: boolean;
            polygons?: boolean;
            remove?: boolean;
            text?: boolean;
            tooltip?: boolean;
        }

        Tools to display in the drawing toolbox. All by default.

        • Optionaldisplay?: boolean

          Display style editing tool

        • Optionaledit?: boolean

          Display editing tool

        • Optionalexport?: boolean

          Display exporting tool

        • Optionalholes?: boolean

          Display polygons with holes drawing tool

        • Optionallines?: boolean

          Display lines drawing tool

        • Optionalmeasure?: boolean

          Display measure drawing into popup info

        • Optionalpoints?: boolean

          Display points drawing tool

        • Optionalpolygons?: boolean

          Display polygons drawing tool

        • Optionalremove?: boolean

          Display feature removing tool

        • Optionaltext?: boolean

          Display text drawing tool

        • Optionaltooltip?: boolean

          Display text editing tool

    Returns Drawing

    Fires

    drawing:add:before - event triggered before an layer is added

    Fires

    drawing:add:after - event triggered after an layer is added

    Example

    var drawing = new ol.control.Drawing({
      collapsed : false,
      draggable : true,
      layerswitcher : {
         title : "Dessins",
         description : "Mes dessins..."
      },
      markersList : [{
         src : "http://api.ign.fr/api/images/api/markers/marker_01.png",
         anchor : [0.5, 1]
      }],
      defaultStyles : {},
      cursorStyle : {},
      tools : {
         points : true,
         lines : true,
         polygons :true,
         holes : true,
         text : false,
         remove : true,
         display : true,
         tooltip : true,
         export : true,
         measure : true
      },
      popup : {
         display : true,
         function : function (params) {
             var container = document.createElement("div");
             // - params.geomType;
             // - params.feature;
             // Les 2 fonctions ferment la popup avec ou sans sauvegarde des informations
             // dans les properties de la feature (key : description)
             // - params.saveFunc(message);
             // - params.closeFunc();
             return container;
         }
    });

Properties

_container

_container: HTMLElement

_drawingPanel

_drawingPanel: any

_drawingPanelHeader

_drawingPanelHeader: any

_showDrawingButton

_showDrawingButton: any

collapsed

collapsed: undefined | boolean

description

description: any

Protecteddisposed

disposed: boolean

The object has already been disposed.

draggable

draggable: undefined | boolean

element

element: HTMLElement

eventKey

eventKey: undefined | EventsKey

labelOvl

labelOvl: undefined | Overlay

layer

layer: any

listable

listable: boolean

ProtectedlistenerKeys

listenerKeys: EventsKey[]

on

on: ObjectOnSignature<EventsKey>

once

once: ObjectOnSignature<EventsKey>

options

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

disable

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

exportFeatures

  • exportFeatures(): string

    Export features of current drawing layer (KML by default).

    Returns string

    a representation of drawn features (KML, GPX or GeoJSON) or null if not possible.

get

  • get(key: string): any

    Gets a value.

    Parameters

    • key: string

      Key name.

    Returns any

    Value.

    Api

getContainer

getExportFormat

getExportName

getKeys

  • getKeys(): string[]

    Get a list of object property names.

    Returns string[]

    List of property names.

    Api

getLayer

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

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

setCollapsed

  • setCollapsed(collapsed: boolean): void

    Collapse or display control main container

    Parameters

    • collapsed: boolean

      True to collapse control, False to display it

    Returns void

setExportFormat

setExportName

setLayer

  • setLayer(vlayer: VectorLayer<VectorSource<any>, any>): void

    Sets vector layer to hosts feature.

    Parameters

    • vlayer: VectorLayer<VectorSource<any>, any>

      vector layer

    Returns void

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

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

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

Events

ADD_AFTER_DRAWING_LAYER_EVENT

ADD_AFTER_DRAWING_LAYER_EVENT: undefined | string

event triggered after an layer is added

drawing:add:after

Default Value

"drawing:add:after"

Example

Drawing.on("drawing:add:after", function (e) {
  console.log(e.layer);
})

ADD_BEFORE_DRAWING_LAYER_EVENT

ADD_BEFORE_DRAWING_LAYER_EVENT: undefined | string

event triggered before an layer is added

drawing:add:before

Default Value

"drawing:add:before"

Example

Drawing.on("drawing:add:before", function (e) {
  console.log(e.layer);
})

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
Events