new geo.featureLayer(arg){geo.featureLayer}
Layer to draw points, lines, and polygons on the map The polydata layer provide mechanisms to create and draw geometrical shapes such as points, lines, and polygons.
| Name | Type | Description |
|---|---|---|
arg |
geo.layer.spec |
optional
Specification for the new layer. |
Returns:
| Type | Description |
|---|---|
| geo.featureLayer |
Extends
Members
-
inherited idle
-
Getter for the idle state. Read only.
Properties:
Name Type Description idleboolean trueif the object is idle (onIdlewould call a handler immediately). -
inherited protectednewLayerId
-
Gets a new id number for a layer.
-
innerm_this
-
private
Methods
-
Get/Set whether or not the layer is active. An active layer will receive native mouse when the layer is on top. Non-active layers will never receive native mouse events.
Name Type Description argboolean optional If specified, the new
activevalue.Returns:
Type Description boolean | this -
inherited addChild(child){this}
-
Add a child (or an array of children) to the object.
Name Type Description childgeo.object | Array.<geo.object> A child object or array of child objects.
Returns:
Type Description this -
addFeature(feature){this}
-
Add a feature to the layer if it is not already present.
Name Type Description featureobject the feature to add.
Returns:
Type Description this -
inherited addPromise(promise){this}
-
Add the promise here and also propagate up the scene tree.
Name Type Description promisePromise A promise object.
Returns:
Type Description this -
Get or set the attribution html content that will displayed with the layer. By default, nothing will be displayed. Note, this content is not html escaped, so care should be taken when rendering user provided content.
Name Type Description argstring nullable An html fragment
Returns:
Type Description string | this Chainable as a setter -
Get the setting of autoshareRenderer.
Returns:
Type Description boolean | string -
Get canvas of the layer.
Returns:
Type Description HTMLCanvasElement The canvas element associated with the layer. -
inherited children(){Array.<geo.object>}
-
Get an array of the child objects.
Returns:
Type Description Array.<geo.object> A copy of the array of child objects. -
clear(){this}
-
Clear all features in layer.
Returns:
Type Description this -
createFeature(featureName, arg){geo.feature}
-
Create a feature by name.
Name Type Description featureNamestring The name of the feature to create.
argobject Properties for the new feature.
Returns:
Type Description geo.feature The created feature. -
inherited dataTime(){geo.timestamp}
-
Return last time data got changed.
Returns:
Type Description geo.timestamp The data time. -
deleteFeature(feature){this}
-
Delete feature.
Name Type Description featuregeo.feature The feature to delete.
Returns:
Type Description this -
draw(){this}
-
Draw. If the layer is visible, call the parent class's draw function and the renderer's render function.
Returns:
Type Description this -
features(val){Array.<geo.feature>|this}
-
Get/Set drawables.
Name Type Description valArray.<geo.feature> optional A list of features, or unspecified to return the current feature list. If a list is provided, features are added or removed as needed.
Returns:
Type Description Array.<geo.feature> | this The current features associated with the layer or the current layer. -
inherited fromLocal(input){geo.geoPosition}
-
Transform coordinates from a local coordinate system to world coordinates.
Name Type Description inputgeo.geoPosition Renderer coordinates.
Returns:
Type Description geo.geoPosition World coordinates. -
gcsFeatures(val){string|this}
-
Get or set the gcs for all features. For features, the default is usually the map's ingcs.
Name Type Description valstring optional nullable If
undefined, return the current gcs. Ifnull, use the map's interface gcs. Otherwise, set a new value for the gcs. When getting the current gcs, if not all features have the same gcs,undefinedwill be returned.Returns:
Type Description string | this A string used by geo.transform. If the map interface gcs is in use, that value will be returned. If the gcs is set, return the current class instance. -
Report if an event handler is bound to this object.
Name Type Description eventstring | Array.<string> An event or list of events to check.
handlerfunction optional A function that might be bound. If
undefined, this will reporttrueif there is any handler for the specified event.Returns:
Type Description boolean true if any of the specified events are bound to the specified handler. -
Remove handlers from one event or an array of events. If no event is provided all handlers will be removed.
Name Type Description eventstring | Array.<string> optional An event or a list of events from
geo.eventor defined by the user, orundefinedto remove all events (in which caseargis ignored).argfunction | Array.<function()> optional nullable A function or array of functions to remove from the events or a falsy value to remove all handlers from the events.
Returns:
Type Description this -
Bind an event handler to this object.
Name Type Description eventstring An event from
geo.eventor a user-defined value.handlerfunction A function that is called when
eventis triggered. The function is passed ageo.eventobject.Returns:
Type Description this -
Bind an event handler to this object that will fire once and then deregister itself.
Name Type Description eventstring An event from
geo.eventor a user-defined value.handlerfunction A function that is called when
eventis triggered. The function is passed ageo.eventobject.Returns:
Type Description function The actual bound handler. This is a wrapper around the handler that was passed to the function. -
inherited geoTrigger(event, args, childrenOnly){this}
-
Trigger an event (or events) on this object and call all handlers.
Name Type Description eventstring The event to trigger.
argsobject Arbitrary argument to pass to the handler.
childrenOnlyboolean optional If truthy, only propagate down the tree.
Returns:
Type Description this -
Return the height of the layer in pixels.
Returns:
Type Description number The height of the parent map in pixels. -
Get/Set id of the layer.
Name Type Description valstring | null optional If
null, generate a new layer id. Otherwise, if specified, the new id of the layer.Returns:
Type Description string | this -
Get/Set if the layer has been initialized.
Name Type Description valboolean optional If specified, update the initialized value. Otherwise, return the current instance.
Returns:
Type Description boolean | this Either the initialized value or this. -
Get the map associated with this layer.
Returns:
Type Description geo.map The map associated with the layer. -
inherited modified(){this}
-
Update the timestamp to the next global timestamp value.
Returns:
Type Description this -
Bring the layer below the given number of layers. This will rotate the current z-indices for this and the previous
nlayers.Name Type Default Description nnumber 1 optional The number of positions to move.
Returns:
Type Description this -
Bring the layer to the bottom of the map layers.
Returns:
Type Description this -
Bring the layer to the top of the map layers.
Returns:
Type Description this -
Bring the layer above the given number of layers. This will rotate the current z-indices for this and the next
nlayers.Name Type Default Description nnumber 1 optional The number of positions to move.
Returns:
Type Description this -
Get/Set name of the layer.
Name Type Description valstring optional If specified, the new name of the layer.
Returns:
Type Description string | this -
Get root node of the layer.
Returns:
Type Description HTMLDivElement -
Bind a handler that will be called one time when all internal promises are resolved. If there are no outstanding promises, this is invoked synchronously.
Name Type Description handlerfunction A function taking no arguments.
Returns:
Type Description this -
Get or set the current layer opacity. The opacity is in the range [0-1]. An opacity of 0 is not the same as setting
visible(false), as interactions can still occur with the layer.Name Type Description opacitynumber optional If specified, set the opacity. Otherwise, return the opacity.
Returns:
Type Description number | this The current opacity or the current layer. -
inherited parent(arg){this|geo.sceneObject}
-
Get/set parent of the object.
Name Type Description arggeo.sceneObject optional The new parant or
undefinedto get the current parent.Returns:
Type Description this | geo.sceneObject -
inherited removeChild(child){this}
-
Remove a child (or array of children) from the object.
Name Type Description childgeo.object | Array.<geo.object> A child object or array of child objects.
Returns:
Type Description this -
removeFeature(feature){this}
-
Remove a feature without destroying it.
Name Type Description featuregeo.feature The feature to remove.
Returns:
Type Description this -
inherited removePromise(promise){this}
-
Remove the promise here and also propagate up the scene tree.
Name Type Description promisePromise A promise object.
Returns:
Type Description this -
inherited renderer(){geo.renderer}
-
Get the renderer for the layer.
Returns:
Type Description geo.renderer The renderer associated with the layer or nullif there is no renderer. -
Get the name of the renderer.
Returns:
Type Description string -
selectionAPI(val){boolean|this}
-
Get/Set selectionAPI of the layer.
Name Type Description valboolean optional If specified change the selectionAPI state of the layer, otherwise return the current state.
Returns:
Type Description boolean | this The selectionAPI state or the current layer. -
Get whether or not the layer is sticky (navigates with the map).
Returns:
Type Description boolean -
inherited timestamp(){number}
-
Get time.
Returns:
Type Description number The timestamp. This is 0 if the timestamp has never been modified. -
inherited toLocal(input){geo.geoPosition}
-
Transform coordinates from world coordinates into a local coordinate system specific to the underlying renderer. This method is exposed to allow direct access the rendering context, but otherwise should not be called directly. The default implementation is the identity operator.
Name Type Description inputgeo.geoPosition World coordinates.
Returns:
Type Description geo.geoPosition Renderer coordinates. -
inherited updateTime(){geo.timestamp}
-
Return the modified time for the last update that did something.
Returns:
Type Description geo.timestamp The update time. -
visible(val){boolean|this}
-
Get/Set visibility of the layer.
Name Type Description valboolean optional If specified, change the visibility, otherwise return it.
Returns:
Type Description boolean | this The current visibility or the layer. -
Return the width of the layer in pixels.
Returns:
Type Description number The width of the parent map in pixels. -
Get or set the z-index of the layer. The z-index controls the display order of the layers in much the same way as the CSS z-index property.
Name Type Description zIndexnumber optional The new z-index, or undefined to return the current z-index.
allowDuplicateboolean optional When setting the z index, if this is truthy, allow other layers to have the same z-index. Otherwise, ensure that other layers have distinct z-indices from this one.
Returns:
Type Description number | this