JSDoc: Class: DeckGlView

Constructor

new DeckGlView(propertiesopt)

Create a View.

Parameters:

Name Type Attributes Default Description

properties

Object

{}

the properties of the view

Properties

Name	Type	Attributes	Default	Description
`container`	String			The div element to attach to
`layers`	Array.<Object>	<optional>	[]	The initial layers to add
`autoZoomOnFirstMarker`	Boolean	<optional>	false	auto zoom on the first added marker
`deckProps`	Object	<optional>	{}	the properties of the Deck object

Source:

core/ui/view/map/DeckGlView.js, line 32

Extends

MapView

Methods

(async, protected) addDrapedImageToLayer(layer, drapedImageObject)

Associate a drapedImageId to a Layer for a fast lookup

Parameters:

Name	Type	Description
`layer`	ImageDraping.props	the Layer object
`drapedImageObject`	Object	the Map drapedImage object

Overrides:

MapView#addDrapedImageToLayer

Source:

core/ui/view/map/MapView.js, line 109

(async, protected) addEllipseToLayer(layer, ellipseObject)

Associate a ellipseId to a Layer for a fast lookup

Parameters:

Name	Type	Description
`layer`	Ellipse.props	the Layer object
`ellipseObject`	Object	the Map ellipse object

Overrides:

MapView#addEllipseToLayer

Source:

core/ui/view/map/MapView.js, line 99

addLayer(layer)

Adds a layer to the view. A broadcastChannel is going to listen the new dataSources

Parameters:

Name	Type	Description
`layer`	Layer	The layer object

Overrides:

MapView#addLayer

Source:

core/ui/view/View.js, line 230

(async, protected) addMarkerToLayer(layer, markerObject)

Associate a markerId to a Layer for a fast lookup

Parameters:

Name	Type	Description
`layer`	PointMarkerLayer.props	the Layer object
`markerObject`	Object	the Map marker object

Overrides:

MapView#addMarkerToLayer

Source:

core/ui/view/map/MapView.js, line 79

(async, protected) addPolylineToLayer(layer, polylineObject)

Associate a polylineId to a Layer for a fast lookup

Parameters:

Name	Type	Description
`layer`	Polyline.props	the Layer object
`polylineObject`	Object	the Map polyline object

Overrides:

MapView#addPolylineToLayer

Source:

core/ui/view/map/MapView.js, line 89

attachTo(divId)

Attach the view to a specific div. If the view has already been attached to a div, it will be removed from its current parent and will be attached to new one. Note: the onResize() is called at the end of the process.

Parameters:

Name	Type	Description
`divId`	String	The div element to attach to

Overrides:

MapView#attachTo

Source:

core/ui/view/View.js, line 159

getDataSourcesId() → {Array.<String>}

Gets the list of the dataSource ids contained into the view.

Overrides:

MapView#getDataSourcesId

Source:

core/ui/view/View.js, line 297

Returns:

The list of dataSource ids

Type: Array.<String>

getDivId() → {String}

Gets the div id of the DOM element.

Overrides:

MapView#getDivId

Source:

core/ui/view/View.js, line 193

Returns:

The div id of the view

Type: String

(protected) getDrapedImage(layer)

Get the draped image associate to the Layer

Parameters:

Name	Type	Description
`layer`	ImageDrapingLayer.props	the Layer Object

Overrides:

MapView#getDrapedImage

Source:

core/ui/view/map/MapView.js, line 228

(protected) getEllipse(layer)

Get the ellipse associate to the Layer

Parameters:

Name	Type	Description
`layer`	Ellipse.props	the Layer Object

Overrides:

MapView#getEllipse

Source:

core/ui/view/map/MapView.js, line 204

(protected) getEllipsoids()

Get all ellpsoids contained in this view

Overrides:

MapView#getEllipsoids

Source:

core/ui/view/map/MapView.js, line 179

getId() → {String}

Gets the inner id of the view object.

Overrides:

MapView#getId

Source:

core/ui/view/View.js, line 185

Returns:

The id of the view

Type: String

getLayer(layerId) → {Layer}

Get the Layer associated to its id

Parameters:

Name	Type	Description
`layerId`	String	the id of the Layer

Overrides:

MapView#getLayer

Source:

core/ui/view/map/MapView.js, line 255

Returns:

- the corresponding layer, null otherwise

Type: Layer

getLayerId(id) → {null|String}

Gets the the Layer id from a concatenated id

Parameters:

Name	Type	Description
`id`	String	the concatenated such as layerId$markerId

Overrides:

MapView#getLayerId

Source:

core/ui/view/map/MapView.js, line 496

Returns:

the Layer id

Type: null | String

(protected) getMarker(props)

Get the markerId associate to the Layer

Parameters:

Name	Type	Description
`props`	PointMarkerLayer.props	the Layer Object

Overrides:

MapView#getMarker

Source:

core/ui/view/map/MapView.js, line 137

getMarkerId(id) → {null|String}

Gets the the Marker id from a concatenated id

Parameters:

Name	Type	Description
`id`	String	the concatenated such as layerId$markerId

Overrides:

MapView#getMarkerId

Source:

core/ui/view/map/MapView.js, line 510

Returns:

the marker id

Type: null | String

(protected) getMarkers()

Get all markers contained in this view

Overrides:

MapView#getMarkers

Source:

core/ui/view/map/MapView.js, line 148

(protected) getPolyline(layer)

Get the ellipse associate to the Layer

Parameters:

Name	Type	Description
`layer`	Ellipse.props	the Layer Object

Overrides:

MapView#getPolyline

Source:

core/ui/view/map/MapView.js, line 192

(protected) getPolylines()

Get all polylines contained in this view

Overrides:

MapView#getPolylines

Source:

core/ui/view/map/MapView.js, line 167

hide()

Hide the view

Overrides:

MapView#hide

Source:

core/ui/view/View.js, line 142

onMarkerHover(markerId, markerObject, layer, event)

Method to call onHover Layer method if exists

Parameters:

Name	Type	Description
`markerId`	String	the Layer markerId
`markerObject`	Object	the View marker object
`layer`	PointMarkerLayer	the Layer object
`event`	Object	the original Map View event

Overrides:

MapView#onMarkerHover

Source:

core/ui/view/map/MapView.js, line 485

onMarkerLeftClick(markerId, markerObject, layer, event)

Method to call onLeftClick Layer method if exists

Parameters:

Name	Type	Description
`markerId`	String	the Layer markerId
`markerObject`	Object	the View marker object
`layer`	PointMarkerLayer	the Layer object
`event`	Object	the original Map View event

Overrides:

MapView#onMarkerLeftClick

Source:

core/ui/view/map/MapView.js, line 446

onMarkerMove(markerId, markerObject, layer, event)

Method to call onMove Layer method if exists

Parameters:

Name	Type	Description
`markerId`	String	the Layer markerId
`markerObject`	Object	the View marker object
`layer`	PointMarkerLayer	the Layer object
`event`	Object	the original Map View event

Overrides:

MapView#onMarkerMove

Source:

core/ui/view/map/MapView.js, line 472

onMarkerRightClick(markerId, markerObject, layer, event)

Method to call onRightClick Layer method if exists

Parameters:

Name	Type	Description
`markerId`	String	the Layer markerId
`markerObject`	Object	the View marker object
`layer`	PointMarkerLayer	the Layer object
`event`	Object	the original Map View event

Overrides:

MapView#onMarkerRightClick

Source:

core/ui/view/map/MapView.js, line 459

removeAllFromLayer(layer)

Remove Corresponding Layer

Parameters:

Name	Type	Description
`layer`	Layer	The layer object

Overrides:

MapView#removeAllFromLayer

Source:

core/ui/view/map/MapView.js, line 291

removeAllFromLayers()

Removes all view item from the view.

Overrides:

MapView#removeAllFromLayers

Source:

core/ui/view/View.js, line 287

(protected) removeDrapedImageFromLayer(drapedImage)

Abstract method to remove a draped image from its corresponding layer. This is library dependant.

Parameters:

Name	Type	Description
`drapedImage`	Object	The Map drapedImage object

Overrides:

MapView#removeDrapedImageFromLayer

Source:

core/ui/view/map/MapView.js, line 429

removeDrapedImages(imageDraping)

Remove the drapedImage corresponding to a ImageDraping Layer

Parameters:

Name	Type	Description
`imageDraping`	ImageDraping	the layer to remove the drapedImage from

Overrides:

MapView#removeDrapedImages

Source:

core/ui/view/map/MapView.js, line 378

removeEllipsoids(ellipse)

Remove the ellipsoids corresponding to a EllipseLayer Layer

Parameters:

Name	Type	Description
`ellipse`	Ellipse	the layer to remove the ellipsoids from

Overrides:

MapView#removeEllipsoids

Source:

core/ui/view/map/MapView.js, line 344

removeFrustums(polyline)

Remove the frustums corresponding to a Frustum Layer

Parameters:

Name	Type	Description
`polyline`	FrustumLayer	the layer to remove the Frustum from

Overrides:

MapView#removeFrustums

Source:

core/ui/view/map/MapView.js, line 395

removeMarker(marker)

Override super method to render() at the end

Parameters:

Name	Type	Description
`marker`	Object	The Map marker object

Source:

core/ui/view/map/DeckGlView.js, line 324

(protected) removeMarkerFromLayer(marker)

Abstract method to remove a marker from its corresponding layer. This is library dependant.

Parameters:

Name	Type	Description
`marker`	Object	The Map marker object

Overrides:

MapView#removeMarkerFromLayer

Source:

core/ui/view/map/MapView.js, line 413

removeMarkers(layer)

Remove the markers corresponding to a PointMarker Layer

Parameters:

Name	Type	Description
`layer`	PointMarkerLayer	the layer to remove the markers from

Overrides:

MapView#removeMarkers

Source:

core/ui/view/map/MapView.js, line 327

(protected) removePolygonFromLayer(polygon)

Abstract method to remove a polygon from its corresponding layer. This is library dependant.

Parameters:

Name	Type	Description
`polygon`	Object	The Map polygon object

Overrides:

MapView#removePolygonFromLayer

Source:

core/ui/view/map/MapView.js, line 437

removePolygons(polygon)

Override super method to render() at the end

Parameters:

Name	Type	Description
`polygon`	Object	The Map polygon object

Source:

core/ui/view/map/DeckGlView.js, line 342

(protected) removePolylineFromLayer(polyline)

Abstract method to remove a polyline from its corresponding layer. This is library dependant.

Parameters:

Name	Type	Description
`polyline`	Object	The Map polyline object

Overrides:

MapView#removePolylineFromLayer

Source:

core/ui/view/map/MapView.js, line 421

removePolylines(polyline)

Override super method to render() at the end

Parameters:

Name	Type	Description
`polyline`	Object	The Map polyline object

Overrides:

MapView#removePolylines

Source:

core/ui/view/map/DeckGlView.js, line 333

reset()

Calls for resetting the view.

Overrides:

MapView#reset

Source:

core/ui/view/View.js, line 312

(async) setData(dataSourceId, data)

Set the data to the view. Each view has to handle the kind of the data separately.

Parameters:

Name	Type	Description
`dataSourceId`	String	The dataSource id of the source providing the data
`data`	Array.<any>	The data array to set

Overrides:

MapView#setData

Source:

core/ui/view/View.js, line 202

show(properties)

Show the view.

Parameters:

Name	Type	Description
`properties`	Object	A generic object

Overrides:

MapView#show

Source:

core/ui/view/View.js, line 209

(async) updateMarker(props)

Updates the marker associated to the layer.

Parameters:

Name	Type	Description
`props`	PointMarkerLayer.props	The layer properties allowing the update of the marker

Source:

core/ui/view/map/DeckGlView.js, line 143

(async) updatePolygon(layer)

Updates the polyline associated to the layer.

Parameters:

Name	Type	Description
`layer`	Polyline	The layer allowing the update of the polyline

Source:

core/ui/view/map/DeckGlView.js, line 264

(async) updatePolyline(layer)

Updates the polyline associated to the layer.

Parameters:

Name	Type	Description
`layer`	Polyline	The layer allowing the update of the polyline

Source:

core/ui/view/map/DeckGlView.js, line 230

Events

beforeAddingItems

This method is called before attaching any view items passed as arguments in the constructor of the view.

Parameters:

Name	Type	Description
`options`	Object	A generic object to use

Overrides:

MapView#event:beforeAddingItems

Source:

core/ui/view/View.js, line 177

onResize

Callback called when the view is resized

Overrides:

MapView#event:onResize

Source:

core/ui/view/View.js, line 150