Class: layer

Extends

• geo.sceneObject

Type Definitions

geo.layer.createSpecgeo.layer.spec

General object specification for feature types.

Properties:

Name	Type	Argument	Default	Description
type	string	<optional>	'feature'	For feature compatibility with more than one kind of creatable layer
data	Array.<object>	<optional>	[]	The default data array to apply to each feature if none exists.
renderer	string	<optional>	'webgl'	The renderer to use.
features	Array.<geo.feature.spec>	<optional>	[]	Features to add to the layer.
id	number	<optional>		The id of the layer. Defaults to a increasing sequence.
map	geo.map	<optional>	null	Parent map of the layer.
autoshareRenderer	boolean	<optional>	true	If truthy and the renderer supports it, auto-share renderers between layers. Currently, auto-sharing can only occur for webgl renderers, and will only occur between adjacent layers than have the same opacity. Shared renderers has slightly different behavior than non-shared renderers: changing z-index may result in rerendering and be slightly slower; only one DOM canvas is used for all shared renderers. Some features have slight z-stacking differences in shared versus non-shared renderers.
canvas	HTMLElement	<optional>		If specified, use this canvas rather than a canvas associaied with the renderer directly. Renderers may not support sharing a canvas.
annotations	Array.<string> | object	<optional>		A list of annotations that will be used on this layer, used to select a renderer. Instead of a list, if this is an object, the keys are the annotation names, and the values are each a list of modes that will be used with that annotation. See featuresForAnnotations more details. This is ignored if renderer is specified.
active	boolean	<optional>	true	Truthy if the layer has the active css class and may receive native mouse events.
attribution	string	<optional>		An attribution string to display.
opacity	number	<optional>	1	The layer opacity on a scale of [0-1].
name	string	<optional>	''	A name for the layer for user convenience. If specified, this is also the id property of the containing DOM element.
selectionAPI	boolean	<optional>	true	Truthy if the layer can generate selection and other interaction events.
sticky	boolean	<optional>	true	Truthy if the layer should navigate with the map.
visible	boolean	<optional>	true	Truthy if the layer is visible.
zIndex	number	<optional>		The z-index to assign to the layer (defaults to the index of the layer inside the map).

geo.layer.specobject

Object specification for a layer.

Properties:

Name	Type	Argument	Default	Description
id	number	<optional>		The id of the layer. Defaults to a increasing sequence.
map	geo.map	<optional>	null	Parent map of the layer.
renderer	string | geo.renderer	<optional>		Renderer to associate with the layer. If not specified, either annotations or features can be used to determine the renderer. If a geo.renderer instance, the renderer is not recreated; not all renderers can be shared by multiple layers.
autoshareRenderer	boolean	<optional>	true	If truthy and the renderer supports it, auto-share renderers between layers. Currently, auto-sharing can only occur for webgl renderers, and will only occur between adjacent layers than have the same opacity. Shared renderers has slightly different behavior than non-shared renderers: changing z-index may result in rerendering and be slightly slower; only one DOM canvas is used for all shared renderers. Some features have slight z-stacking differences in shared versus non-shared renderers.
canvas	HTMLElement	<optional>		If specified, use this canvas rather than a canvas associaied with the renderer directly. Renderers may not support sharing a canvas.
annotations	Array.<string> | object	<optional>		A list of annotations that will be used on this layer, used to select a renderer. Instead of a list, if this is an object, the keys are the annotation names, and the values are each a list of modes that will be used with that annotation. See featuresForAnnotations more details. This is ignored if renderer is specified.
features	Array.<string>	<optional>		A list of features that will be used on this layer, used to select a renderer. Features are the basic feature names (e.g., 'quad'), or the feature name followed by a required capability (e.g., 'quad.image'). This is ignored if renderer or annotations is specified.
active	boolean	<optional>	true	Truthy if the layer has the active css class and may receive native mouse events.
attribution	string	<optional>		An attribution string to display.
opacity	number	<optional>	1	The layer opacity on a scale of [0-1].
name	string	<optional>	''	A name for the layer for user convenience. If specified, this is also the id property of the containing DOM element.
selectionAPI	boolean	<optional>	true	Truthy if the layer can generate selection and other interaction events.
sticky	boolean	<optional>	true	Truthy if the layer should navigate with the map.
visible	boolean	<optional>	true	Truthy if the layer is visible.
zIndex	number	<optional>		The z-index to assign to the layer (defaults to the index of the layer inside the map).

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).

protectednewLayerId

Gets a new id number for a layer.

Static Methods

staticgeo.layer.create(map, spec){geo.layer|null}

layer.js, line 683

Create a layer from an object. Any errors in the creation of the layer will result in returning null.

Name	Type	Description
map	geo.map	The map to add the layer to
spec	geo.layer.createSpec	The layer specification.

Returns:

Type	Description
geo.layer | null

Methods

active(arg){boolean|this}

layer.js, line 277

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 81

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

inherited addPromise(promise){this}

sceneObject.js, line 35

Override object.addPromise to propagate up the scene tree.

Name	Type	Description
promise	Promise	A promise object.

Returns:

Type	Description
this

attribution(arg){string|this}

layer.js, line 455

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

autoshareRenderer(){boolean}

layer.js, line 142

Get the setting of autoshareRenderer.

Returns:

Type	Description
boolean

canvas(){HTMLCanvasElement}

layer.js, line 369

Get canvas of the layer.

Returns:

Type	Description
HTMLCanvasElement	The canvas element associated with the layer.

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

sceneObject.js, line 112

Get an array of the child objects.

Returns:

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

dataTime(){geo.timestamp}

layer.js, line 394

Return last time data got changed.

Returns:

Type	Description
geo.timestamp	The data time.

inherited draw(arg){this}

sceneObject.js, line 123

Force redraw of a scene object, to be implemented by subclasses. Base class just calls draw of child objects.

Name	Type	Description
arg	object	Options to pass to the child draw functions.

Returns:

Type	Description
this

fromLocal(input){geo.geoPosition}

layer.js, line 442

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.

inherited geoIsOn(event, handler){boolean}

object.js, line 120

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 179

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 92

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 138

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

height(){number}

layer.js, line 599

Return the height of the layer in pixels.

Returns:

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

id(val){string|this}

layer.js, line 304

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

initialized(val){boolean|this}

layer.js, line 414

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.

map(){geo.map}

layer.js, line 334

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

moveDown(n){this}

layer.js, line 235

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

moveToBottom(){this}

layer.js, line 256

Bring the layer to the bottom of the map layers.

Returns:

Type	Description
this

moveToTop(){this}

layer.js, line 247

Bring the layer to the top of the map layers.

Returns:

Type	Description
this

moveUp(n){this}

layer.js, line 188

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

name(val){string|this}

layer.js, line 319

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

node(){div}

layer.js, line 293

Get root node of the layer.

Returns:

Type	Description
div

inherited onIdle(handler){this}

sceneObject.js, line 50

Override object.onIdle to propagate up the scene tree.

Name	Type	Description
handler	function	A function taking no arguments.

Returns:

Type	Description
this

opacity(opacity){number|this}

layer.js, line 612

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 66

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 98

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

renderer(){geo.renderer}

layer.js, line 344

Get the renderer for the layer.

Returns:

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

rendererName(){string}

layer.js, line 133

Get the name of the renderer.

Returns:

Type	Description
string

selectionAPI(val){boolean|this}

layer.js, line 491

Get/Set selectionAPI of the layer.

Name	Type	Description
val	boolean	optional If specified, set the selectionAPI state, otherwise return it.

Returns:

Type	Description
boolean | this	Either the selectionAPI state or the layer.

sticky(){boolean}

layer.js, line 265

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.

toLocal(input){geo.geoPosition}

layer.js, line 432

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.

updateTime(){geo.timestamp}

layer.js, line 403

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

Returns:

Type	Description
geo.timestamp	The update time.

visible(val){boolean|this}

layer.js, line 472

Get/Set visibility of the layer.

Name	Type	Description
val	boolean	optional If specified, change the visibility. Otherwise, get it.

Returns:

Type	Description
boolean | this	either the visibility (if getting) or the layer (if setting).

width(){number}

layer.js, line 590

Return the width of the layer in pixels.

Returns:

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

zIndex(zIndex, allowDuplicate){number|this}

layer.js, line 157

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