Class LayerImport

Hierarchy (View Summary)

ControlExtended
- LayerImport

Constructors

constructor

new LayerImport(
    options: {
        collapsed?: boolean;
        dragAndDropUI?: boolean;
        draggable?: boolean;
        id?: number;
        layerTypes?: any[];
        title?: string;
        vectorStyleOptions?: {
            GeoJSON?: { defaultStyle?: any };
            GPX?: { defaultStyle?: any };
            KML?: {
                defaultStyle?: any;
                extractStyles?: boolean;
                showPointNames?: boolean;
            };
            MapBox?: { defaultStyle?: any; display?: boolean; editor?: any };
        };
        webServicesOptions?: { noProxyDomains?: string[]; proxyUrl?: string };
    },
): LayerImport
Parameters
- options: {
      collapsed?: boolean;
      dragAndDropUI?: boolean;
      draggable?: boolean;
      id?: number;
      layerTypes?: any[];
      title?: string;
      vectorStyleOptions?: {
          GeoJSON?: { defaultStyle?: any };
          GPX?: { defaultStyle?: any };
          KML?: {
              defaultStyle?: any;
              extractStyles?: boolean;
              showPointNames?: boolean;
          };
          MapBox?: { defaultStyle?: any; display?: boolean; editor?: any };
      };
      webServicesOptions?: { noProxyDomains?: string[]; proxyUrl?: string };
  }
  options for function call.
  - Optionalcollapsed?: boolean
    
    Specify if LayerImport control should be collapsed at startup. Default is true.
  - OptionaldragAndDropUI?: boolean
    
    Specify if the static import form is displayed with a drag and drop area (without name input nor local/url choice). Default is false.
  - Optionaldraggable?: boolean
    
    Specify if widget is draggable
  - Optionalid?: number
    
    Ability to add an identifier on the widget (advanced option)
  - OptionallayerTypes?: any[]
    
    data types that could be imported : "KML", "GPX", "GeoJSON", "WMS", "WMTS" and "MAPBOX". Values will be displayed in the same order in widget list.
  - Optionaltitle?: string
    
    Title of the widget panel
  - OptionalvectorStyleOptions?: {
        GeoJSON?: { defaultStyle?: any };
        GPX?: { defaultStyle?: any };
        KML?: {
            defaultStyle?: any;
            extractStyles?: boolean;
            showPointNames?: boolean;
        };
        MapBox?: { defaultStyle?: any; display?: boolean; editor?: any };
    }
    
    Options for imported vector layer styling (KML, GPX, GeoJSON)
    
    OptionalGeoJSON?: { defaultStyle?: any }
    
    Options for GeoJSON layer styling
    
    OptionaldefaultStyle?: any
    
    default style to be applied to GeoJSON imports in case no style is defined. defaultStyle is an ol.style.Style object.
    
    OptionalGPX?: { defaultStyle?: any }
    
    Options for GPX layer styling
    
    OptionaldefaultStyle?: any
    
    default style to be applied to GPX imports in case no style is defined. defaultStyle is an ol.style.Style object.
    
    OptionalKML?: { defaultStyle?: any; extractStyles?: boolean; showPointNames?: boolean }
    
    Options for KML layer styling
    
    OptionaldefaultStyle?: any
    
    default style to be applied to KML imports in case no style is defined. defaultStyle is an ol.style.Style object.
    
    OptionalextractStyles?: boolean
    
    Extract styles from the KML. Default is true.
    
    OptionalshowPointNames?: boolean
    
    Show names as labels for KML placemarks which contain points. Default is true.
    
    OptionalMapBox?: { defaultStyle?: any; display?: boolean; editor?: any }
    
    Options for MapBox layer styling
    
    OptionaldefaultStyle?: any
    
    default style to be applied to MapBox imports in case no style is defined. defaultStyle is an ol.style.Style object.
    
    Optionaldisplay?: boolean
    
    display tools editor
    
    Optionaleditor?: any
    
    options for tools editor
  - OptionalwebServicesOptions?: { noProxyDomains?: string[]; proxyUrl?: string }
    
    Options to import WMS or WMTS layers
    
    OptionalnoProxyDomains?: string[]
    
    Proxy will not be used for this list of domain names. Only use if you know what you're doing.
    
    OptionalproxyUrl?: string
    
    Proxy URL to avoid cross-domain problems. Mandatory to import WMS and WMTS layer.
Returns LayerImport
Fires
layerimport:mapbox:added

Fires
layerimport:vector:added

Fires
layerimport:service:added

Fires
editor:loaded

Fires
render:success

Fires
render:failure
Example
```
var LayerImport = new ol.control.LayerImport({
     "collapsed" : false,
     "draggable" : true,
     "layerTypes" : ["KML", "GPX"],
     "webServicesOptions" : {
         "proxyUrl" : "http://localhost/proxy/php/proxy.php?url=",
         "noProxyDomains" : []
     },
     "vectorStyleOptions" : {
         "KML" : {
             extractStyles : true,
             defaultStyle : new ol.style.Style({
                 image : new ol.style.Icon({
                      src : "data:image/png;base64....",
                      size : [51, 38],
                 }),
                 stroke : new ol.style.Stroke({
                      color : "#ffffff",
                      width : 7
                 }),
                 fill : new ol.style.Fill({
                      color : "rgba(255, 183, 152, 0.2)"
                 }),
                 text : new ol.style.Text({
                     font : "16px Sans",
                     textAlign : "left",
                     fill : new ol.style.Fill({
                         color : "rgba(255, 255, 255, 1)"
                     }),
                     stroke : new ol.style.Stroke({
                         color : "rgba(0, 0, 0, 1)",
                         width : 2
                     })
                 })
             })
         },
         "GPX" : {
             defaultStyle : new ol.style.Style({
                 image : new ol.style.Icon({
                      src : "path/to/my/icon.png",
                      size : [51, 38],
                 }),
                 stroke : new ol.style.Stroke({
                      color : "#ffffff",
                      width : 7
                 })
             })
         }
     }
 });
```
Overrides ControlExtended.constructor
- Defined in src/packages/Controls/LayerImport/LayerImport.js:165

Properties

_container

_container: HTMLElement

_currentImportType

_currentImportType: any

_currentStaticImportType

_currentStaticImportType: any

_defaultGeoJSONStyle

_defaultGeoJSONStyle: Style | undefined

_defaultGPXStyle

_defaultGPXStyle: Style | undefined

_defaultKMLStyle

_defaultKMLStyle: Style | undefined

_defaultMapBoxStyle

_defaultMapBoxStyle: Style | undefined

_isCurrentImportTypeStatic

_isCurrentImportTypeStatic: boolean | undefined

_uid

_uid: any

collapsed

collapsed: boolean | undefined

contentService

contentService: any

description

description: any

`Protected`disposed

disposed: boolean

The object has already been disposed.

draggable

draggable: boolean | undefined

element

element: HTMLElement

listable

listable: boolean

`Protected`listenerKeys

listenerKeys: EventsKey[]

on

on: ObjectOnSignature<EventsKey>

once

once: ObjectOnSignature<EventsKey>

options

options:
    | {
        collapsed: boolean;
        dragAndDropUI: boolean;
        draggable: boolean;
        layerTypes: string[];
        title: string;
        vectorStyleOptions: {
            GeoJSON: { defaultStyle: {} };
            GPX: { defaultStyle: {} };
            KML: {
                defaultStyle: {};
                extractStyles: boolean;
                showPointNames: boolean;
            };
            MapBox: { defaultStyle: {}; editor: {} };
        };
        webServicesOptions: {};
    }
    | undefined

un

un: ObjectOnSignature<void>

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

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

getCollapsed

getCollapsed(): boolean
Returns true if widget is collapsed (minimized), false otherwise

Returns boolean
collapsed - true if widget is collapsed
- Defined in src/packages/Controls/LayerImport/LayerImport.js:319

getContainer

getContainer(): HTMLElement
Get container

Returns HTMLElement
container
- Defined in src/packages/Controls/LayerImport/LayerImport.js:376

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

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

getName

getName(): string
Returns layer name

Returns string
name - layer name
- Defined in src/packages/Controls/LayerImport/LayerImport.js:367

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

getServiceImportContent

getServiceImportContent(): string
Returns content of a service import (GetCapabilities)

Returns string
contentService - content service
- Defined in src/packages/Controls/LayerImport/LayerImport.js:358

getStaticImportContent

getStaticImportContent(): string
Returns content of a static import (KML, GPX or GeoJSON)

Returns string
contentStatic - content static
- Defined in src/packages/Controls/LayerImport/LayerImport.js:349

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

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

setCollapsed

setCollapsed(collapsed: boolean): void
Collapse or display widget main container
Parameters
- collapsed: boolean
  True to collapse widget, False to display it
Returns void
- Defined in src/packages/Controls/LayerImport/LayerImport.js:328

setMap

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

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

Class LayerImport

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optionalcollapsed?: boolean

OptionaldragAndDropUI?: boolean

Optionaldraggable?: boolean

Optionalid?: number

OptionallayerTypes?: any[]

Optionaltitle?: string

OptionalvectorStyleOptions?: { GeoJSON?: { defaultStyle?: any }; GPX?: { defaultStyle?: any }; KML?: { defaultStyle?: any; extractStyles?: boolean; showPointNames?: boolean; }; MapBox?: { defaultStyle?: any; display?: boolean; editor?: any };}

OptionalGeoJSON?: { defaultStyle?: any }

OptionaldefaultStyle?: any

OptionalGPX?: { defaultStyle?: any }

OptionaldefaultStyle?: any

OptionalKML?: { defaultStyle?: any; extractStyles?: boolean; showPointNames?: boolean }

OptionaldefaultStyle?: any

OptionalextractStyles?: boolean

OptionalshowPointNames?: boolean

OptionalMapBox?: { defaultStyle?: any; display?: boolean; editor?: any }

OptionaldefaultStyle?: any

Optionaldisplay?: boolean

Optionaleditor?: any

OptionalwebServicesOptions?: { noProxyDomains?: string[]; proxyUrl?: string }

OptionalnoProxyDomains?: string[]

OptionalproxyUrl?: string

Returns LayerImport

Fires

Fires

Fires

Fires

Fires

Fires

Example

Properties

_container

_currentImportType

_currentStaticImportType

_defaultGeoJSONStyle

_defaultGPXStyle

_defaultKMLStyle

_defaultMapBoxStyle

_isCurrentImportTypeStatic

_uid

collapsed

contentService

description

Protecteddisposed

draggable

element

listable

ProtectedlistenerKeys

on

once

options

un

Methods

addChangeListener

Parameters

Returns void

addEventListener

Parameters

Returns void

ProtectedapplyProperties

Parameters

Returns void

changed

Returns void

Api

dispatchEvent

Parameters

Returns boolean | undefined

Api

dispose

Returns void

`Optional`collapsed?: boolean

`Optional`dragAndDropUI?: boolean

`Optional`draggable?: boolean

`Optional`id?: number

`Optional`layerTypes?: any[]

`Optional`title?: string

`Optional`vectorStyleOptions?: {
GeoJSON?: { defaultStyle?: any };
GPX?: { defaultStyle?: any };
KML?: {
defaultStyle?: any;
extractStyles?: boolean;
showPointNames?: boolean;
};
MapBox?: { defaultStyle?: any; display?: boolean; editor?: any };
}

`Optional`GeoJSON?: { defaultStyle?: any }

`Optional`defaultStyle?: any

`Optional`GPX?: { defaultStyle?: any }

`Optional`defaultStyle?: any

`Optional`KML?: { defaultStyle?: any; extractStyles?: boolean; showPointNames?: boolean }

`Optional`defaultStyle?: any

`Optional`extractStyles?: boolean

`Optional`showPointNames?: boolean

`Optional`MapBox?: { defaultStyle?: any; display?: boolean; editor?: any }

`Optional`defaultStyle?: any

`Optional`display?: boolean

`Optional`editor?: any

`Optional`webServicesOptions?: { noProxyDomains?: string[]; proxyUrl?: string }

`Optional`noProxyDomains?: string[]

`Optional`proxyUrl?: string

`Protected`disposed

`Protected`listenerKeys

`Protected`applyProperties

`Protected`disposeInternal

`Protected`onceInternal

`Protected`onInternal