Class: GeoPointsCesiumPolygonConnector

GeoPointsCesiumPolygonConnector()

This connector keeps a CesiumVectorData model in sync with the points in a GeoPoints collection. This connector will listen for changes to the GeoPoints collection and update the cesiumModel a polygon with vertices created from the points in the collection.

Constructor

new GeoPointsCesiumPolygonConnector()

Since:
  • 2.27.0
Source:

Extends

Members

type :string

The type of Backbone.Model this is.
Type:
  • string
Overrides:
Default Value:
  • "GeoPointsCesiumPolygonConnector"
Source:

Methods

addPolygon() → {Cesium.Entity}

Create a Cesium.Polygon entity and add it to the layer.
Source:
Returns:
The Cesium.Polygon entity that was added to the CesiumVectorData model.
Type
Cesium.Entity

connect()

Listen for changes to the Points collection and update the CesiumVectorData model with point entities.
Inherited From:
Source:

defaults() → {Object}

Extends the default Backbone.Model.defaults() function to specify default attributes for the GeoPointsCesiumPolygonConnector model.
Properties:
Name Type Description
polygon Cesium.Entity The polygon entity that has vertices created from the points in the collection.
Overrides:
Source:
Returns:
The default attributes
Type
Object

disconnect()

Stop listening for changes to the Points collection.
Inherited From:
Source:

handleCollectionChange()

Reset the positions of the polygon vertices to the current points in the GeoPoints collection.
Overrides:
Source:

initialize(attrs)

Initialize the model.
Parameters:
Name Type Attributes Description
attrs Object The attributes for this model.
attributes.geoPoints GeoPoints | Array <optional>
The GeoPoints collection to use for this connector or an array of JSON attributes to create a new GeoPoints collection. If not provided, a new empty GeoPoints collection will be created.
attributes.layer CesiumVectorData | Object <optional>
The CesiumVectorData CesiumVectorData model to use for this connector or a JSON object with options to create a model. If not provided, a new layer will be created.
Inherited From:
Source:

setGeoPoints(pointsopt) → {GeoPoints}

Set or create and set the GeoPoints collection for this connector.
Parameters:
Name Type Attributes Description
points GeoPoints | Object <optional>
The GeoPoints collection to use for this connector or an array of JSON attributes to create points.
Inherited From:
Source:
Returns:
The GeoPoints collection for this connector.
Type
GeoPoints

setLayer(layeropt) → {CesiumVectorData}

Set or create and set the CesiumVectorData model for this connector.
Parameters:
Name Type Attributes Description
layer CesiumVectorData | Object <optional>
The CesiumVectorData model to use for this connector or a JSON object with options to create a new CesiumVectorData model. If not provided, a new CesiumVectorData model will be created.
Inherited From:
Source:
Returns:
The CesiumVectorData model for this connector.
Type
CesiumVectorData