Class: featureLayer

Extends

• geo.layer

Members

inherited idle

Getter for the idle state. Read only.

Properties:

Name	Type	Description
idle	boolean	true if the object is idle (onIdle would call a handler immediately).

inherited protectednewLayerId

Gets a new id number for a layer.

innerm_this

private

Methods

inherited active(arg){boolean|this}

layer.js, line 280

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
arg	boolean	optional If specified, the new active value.

Returns:

Type	Description
boolean | this

inherited addChild(child){this}

sceneObject.js, line 64

Add a child (or an array of children) to the object.

Name	Type	Description
child	geo.object | Array.<geo.object>	A child object or array of child objects.

Returns:

Type	Description
this

addFeature(feature){this}

featureLayer.js, line 60

Add a feature to the layer if it is not already present.

Name	Type	Description
feature	object	the feature to add.

Returns:

Type	Description
this

inherited addPromise(promise){this}

sceneObject.js, line 34

Add the promise here and also propagate up the scene tree.

Name	Type	Description
promise	Promise	A promise object.

Returns:

Type	Description
this

inherited attribution(arg){string|this}

layer.js, line 458

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 renderering user provided content.

Name	Type	Description
arg	string	nullable An html fragment

Returns:

Type	Description
string | this	Chainable as a setter

inherited autoshareRenderer(){boolean|string}

layer.js, line 145

Get the setting of autoshareRenderer.

Returns:

Type	Description
boolean | string

inherited canvas(){HTMLCanvasElement}

layer.js, line 372

Get canvas of the layer.

Returns:

Type	Description
HTMLCanvasElement	The canvas element associated with the layer.

inherited children(){Array.<geo.object>}

sceneObject.js, line 95

Get an array of the child objects.

Returns:

Type	Description
Array.<geo.object>	A copy of the array of child objects.

clear(){this}

featureLayer.js, line 334

Clear all features in layer.

Returns:

Type	Description
this

createFeature(featureName, arg){geo.feature}

featureLayer.js, line 42

Create a feature by name.

Name	Type	Description
featureName	string	The name of the feature to create.
arg	object	Properties for the new feature.

Returns:

Type	Description
geo.feature	The created feature.

inherited dataTime(){geo.timestamp}

layer.js, line 397

Return last time data got changed.

Returns:

Type	Description
geo.timestamp	The data time.

deleteFeature(feature){this}

featureLayer.js, line 96

Delete feature.

Name	Type	Description
feature	geo.feature	The feature to delete.

Returns:

Type	Description
this

draw(){this}

featureLayer.js, line 264

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}

featureLayer.js, line 118

Get/Set drawables.

Name	Type	Description
val	Array.<geo.feature>	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}

layer.js, line 445

Transform coordinates from a local coordinate system to world coordinates.

Name	Type	Description
input	geo.geoPosition	Renderer coordinates.

Returns:

Type	Description
geo.geoPosition	World coordinates.

gcsFeatures(val){string|this}

featureLayer.js, line 151

Get or set the gcs for all features. For features, the default is usually the map's ingcs.

Name	Type	Description
val	string	optional nullable If undefined, return the current gcs. If null, 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, undefined will 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.

inherited geoIsOn(event, handler){boolean}

object.js, line 134

Report if an event handler is bound to this object.

Name	Type	Description
event	string | Array.<string>	An event or list of events to check.
handler	function	optional A function that might be bound. If undefined, this will report true if 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.

inherited geoOff(event, arg){this}

object.js, line 193

Remove handlers from one event or an array of events. If no event is provided all handlers will be removed.

Name	Type	Description
event	string | Array.<string>	optional An event or a list of events from geo.event or defined by the user, or undefined to remove all events (in which case arg is ignored).
arg	function | 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

inherited geoOn(event, handler){this}

object.js, line 106

Bind an event handler to this object.

Name	Type	Description
event	string	An event from geo.event or a user-defined value.
handler	function	A function that is called when event is triggered. The function is passed a geo.event object.

Returns:

Type	Description
this

inherited geoTrigger(event, args, childrenOnly){this}

sceneObject.js, line 121

Trigger an event (or events) on this object and call all handlers.

Name	Type	Description
event	string	The event to trigger.
args	object	Arbitrary argument to pass to the handler.
childrenOnly	boolean	optional If truthy, only propagate down the tree.

Returns:

Type	Description
this

inherited height(){number}

layer.js, line 602

Return the height of the layer in pixels.

Returns:

Type	Description
number	The height of the parent map in pixels.

inherited id(val){string|this}

layer.js, line 307

Get/Set id of the layer.

Name	Type	Description
val	string | null	optional If null, generate a new layer id. Otherwise, if specified, the new id of the layer.

Returns:

Type	Description
string | this

inherited initialized(val){boolean|this}

layer.js, line 417

Get/Set if the layer has been initialized.

Name	Type	Description
val	boolean	optional If specified, update the intialized value. Otherwise, return the current instance.

Returns:

Type	Description
boolean | this	Either the initialized value or this.

inherited map(){geo.map}

layer.js, line 337

Get the map associated with this layer.

Returns:

Type	Description
geo.map	The map associated with the layer.

inherited modified(){this}

timestamp.js, line 25

Update the timestamp to the next global timestamp value.

Returns:

Type	Description
this

inherited moveDown(n){this}

layer.js, line 238

Bring the layer below the given number of layers. This will rotate the current z-indices for this and the previous n layers.

Name	Type	Default	Description
n	number	1	optional The number of positions to move.

Returns:

Type	Description
this

inherited moveToBottom(){this}

layer.js, line 259

Bring the layer to the bottom of the map layers.

Returns:

Type	Description
this

inherited moveToTop(){this}

layer.js, line 250

Bring the layer to the top of the map layers.

Returns:

Type	Description
this

inherited moveUp(n){this}

layer.js, line 191

Bring the layer above the given number of layers. This will rotate the current z-indices for this and the next n layers.

Name	Type	Default	Description
n	number	1	optional The number of positions to move.

Returns:

Type	Description
this

inherited name(val){string|this}

layer.js, line 322

Get/Set name of the layer.

Name	Type	Description
val	string	optional If specified, the new name of the layer.

Returns:

Type	Description
string | this

inherited node(){div}

layer.js, line 296

Get root node of the layer.

Returns:

Type	Description
div

inherited onIdle(handler){this}

object.js, line 33

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
handler	function	A function taking no arguments.

Returns:

Type	Description
this

inherited opacity(opacity){number|this}

layer.js, line 615

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 occurr with the layer.

Name	Type	Description
opacity	number	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}

sceneObject.js, line 49

Get/set parent of the object.

Name	Type	Description
arg	geo.sceneObject	optional The new parant or undefined to get the current parent.

Returns:

Type	Description
this | geo.sceneObject

inherited removeChild(child){this}

sceneObject.js, line 81

Remove a child (or array of children) from the object.

Name	Type	Description
child	geo.object | Array.<geo.object>	A child object or array of child objects.

Returns:

Type	Description
this

removeFeature(feature){this}

featureLayer.js, line 76

Remove a feature without destroying it.

Name	Type	Description
feature	geo.feature	The feature to remove.

Returns:

Type	Description
this

inherited renderer(){geo.renderer}

layer.js, line 347

Get the renderer for the layer.

Returns:

Type	Description
geo.renderer	The renderer associated with the layer or null if there is no renderer.

inherited rendererName(){string}

layer.js, line 136

Get the name of the renderer.

Returns:

Type	Description
string

selectionAPI(val){boolean|this}

featureLayer.js, line 312

Get/Set selectionAPI of the layer.

Name	Type	Description
val	boolean	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.

inherited sticky(){boolean}

layer.js, line 268

Get whether or not the layer is sticky (navigates with the map).

Returns:

Type	Description
boolean

inherited timestamp(){number}

timestamp.js, line 37

Get time.

Returns:

Type	Description
number	The timestamp. This is 0 if the timestamp has never been modified.

inherited toLocal(input){geo.geoPosition}

layer.js, line 435

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
input	geo.geoPosition	World coordinates.

Returns:

Type	Description
geo.geoPosition	Renderer coordinates.

inherited updateTime(){geo.timestamp}

layer.js, line 406

Return the modified time for the last update that did something.

Returns:

Type	Description
geo.timestamp	The update time.

visible(val){boolean|this}

featureLayer.js, line 285

Get/Set visibility of the layer.

Name	Type	Description
val	boolean	optional If specified, change the visibility, otherwise return it.

Returns:

Type	Description
boolean | this	The current visibility or the layer.

inherited width(){number}

layer.js, line 593

Return the width of the layer in pixels.

Returns:

Type	Description
number	The width of the parent map in pixels.

inherited zIndex(zIndex, allowDuplicate){number|this}

layer.js, line 160

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
zIndex	number	optional The new z-index, or undefined to return the current z-index.
allowDuplicate	boolean	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