contourFeature

geo .webgl. contourFeature

new contourFeature(arg) → {geo.webgl.contourFeature}

Description:

Create a new instance of contourFeature.

Source:

webgl/contourFeature.js, line 15

Parameters:

Name	Type	Description
`arg`	geo.contourFeature.spec

Returns:

Type: geo.webgl.contourFeature

Extends

Members

idle

Description:

Getter for the idle state. Read only.

Source:

object.js, line 45

Inherited From:

geo.object#idle

Properties:

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

Getter for the idle state. Read only.

ready

Source:

feature.js, line 137

Inherited From:

geo.feature#ready

Properties:

Name	Type	Description
`ready`	boolean	`true` if this feature has been initialized, `false` if it was destroyed, `undefined` if it was created but not initialized.

Methods

actors() → {Array.<vgl.actor>}

Description:

List vgl actors.

Source:

webgl/meshColored.js, line 205

Inherited From:

geo.webgl.meshColored#actors

Returns:

The list of actors.

Type: Array.<vgl.actor>

addChild(child) → {this}

Description:

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

Source:

sceneObject.js, line 79

Inherited From:

geo.sceneObject#addChild

Parameters:

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

Returns:

Type: this

addPromise(promise) → {this}

Description:

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

Source:

sceneObject.js, line 35

Inherited From:

geo.sceneObject#addPromise

Parameters:

Name	Type	Description
`promise`	Promise	A promise object.

Returns:

Type: this

bin(valopt, actualValueopt) → {number|this}

Description:

Get/Set bin of the feature. The bin number is used to determine the order of multiple features on the same layer. It has no effect except on the webgl renderer. A negative value hides the feature without stopping interaction with it. Otherwise, features with higher bin numbers are drawn above those with lower bin numbers. If two features have the same bin number, their order relative to one another is indeterminate and may be unstable.

Source:

feature.js, line 786

Inherited From:

geo.feature#bin

Parameters:

Name	Type	Attributes	Description
`val`	number	<optional>	The new bin number. If `undefined`, return the current bin number. If `null`, the bin is dynamically computed based on order within the parent. If children are nested, this may not be what is desired.
`actualValue`	boolean	<optional>	If truthy and `val` is undefined, return the actual value of bin, rather than the dynamically computed value.

Returns:

The current bin number or a reference to this.

Type: number | this

boxSearch(lowerLeft, upperRight, optsopt, gcsopt) → {geo.feature.searchResult}

Description:

Search for features contained within a rectangular region.

Source:

feature.js, line 216

Inherited From:

geo.feature#boxSearch

Parameters:

Name Type Attributes Description

lowerLeft

geo.geoPosition

Lower-left corner.

upperRight

geo.geoPosition

Upper-right corner.

opts

object

Additional search options.

Properties

Name	Type	Attributes	Default	Description
`partial`	boolean	<optional>	`false`	If truthy, include features that are partially in the box, otherwise only include features that are fully within the region.

gcs

string | geo.transform | null

Input gcs. undefined to use the interface gcs, null to use the map gcs, or any other transform.

Returns:

An object with a list of features and feature indices that are located at the specified point.

Type: geo.feature.searchResult

buildTime(valopt) → {geo.timestamp|this}

Description:

Get/Set timestamp of last time a build happened.

Source:

feature.js, line 829

Inherited From:

geo.feature#buildTime

Parameters:

Name	Type	Attributes	Description
`val`	geo.timestamp	<optional>	The new build timestamp object or `undefined` to get the current build timestamp object.

Returns:

Type: geo.timestamp | this

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

Description:

Get an array of the child objects.

Source:

sceneObject.js, line 110

Inherited From:

geo.sceneObject#children

Returns:

A copy of the array of child objects.

Type: Array.<geo.object>

createGLMeshColored(mesh)

Description:

Create the colored mesh. The generated geometry is loaded into the various gl uniforms and buffers.

Source:

webgl/meshColored.js, line 61

Inherited From:

geo.webgl.meshColored#createGLMeshColored

Parameters:

Name	Type	Description
`mesh`	geo.meshFeature.meshColoredInfo	The mesh to draw.

data(dataopt) → {array|this}

Description:

Get/Set the data array for the feature. This is equivalent to getting or setting the data style, except that setting the data array via this method updates the data timestamp, whereas setting it via the style does not.

Source:

feature.js, line 866

Inherited From:

geo.feature#data

Parameters:

Name	Type	Attributes	Description
`data`	array	<optional>	A new data array or `undefined` to return the existing array.

Returns:

Type: array | this

dataTime(valopt) → {geo.timestamp|this}

Description:

Get/Set timestamp of data change.

Source:

feature.js, line 812

Inherited From:

geo.feature#dataTime

Parameters:

Name	Type	Attributes	Description
`val`	geo.timestamp	<optional>	The new data timestamp object or `undefined` to get the current data timestamp object.

Returns:

Type: geo.timestamp | this

dependentFeatures(argopt) → {Array.<geo.feature>|this}

Description:

Get/Set a list of dependent features. Dependent features have their visibility changed at the same time as the feature.

Source:

feature.js, line 761

Inherited From:

geo.feature#dependentFeatures

Parameters:

Name	Type	Attributes	Description
`arg`	Array.<geo.feature>	<optional>	If specified, the new list of dependent features. Otherwise, return the current list of dependent features.

Returns:

The current list of dependent features or a reference to this.

Type: Array.<geo.feature> | this

draw(arg) → {this}

Description:

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

Source:

sceneObject.js, line 121

Inherited From:

geo.sceneObject#draw

Parameters:

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

Returns:

Type: this

featureGcsToDisplay(c) → {geo.screenPosition}

Description:

Convert from the feature's gcs coordinates to display coordinates.

Source:

feature.js, line 703

Inherited From:

geo.feature#featureGcsToDisplay

Parameters:

Name	Type	Description
`c`	geo.geoPosition	The input coordinate to convert.

Returns:

Display space coordinates.

Type: geo.screenPosition

gcs(valopt, nullable) → {string|this}

Description:

Get/Set the projection of the feature.

Source:

feature.js, line 684

Inherited From:

geo.feature#gcs

Parameters:

Name	Type	Attributes	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.

Returns:

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.

Type: string | this

geoIsOn(event, handleropt) → {boolean}

Description:

Report if an event handler is bound to this object.

Source:

object.js, line 187

Inherited From:

geo.object#geoIsOn

Parameters:

Name	Type	Attributes	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:

true if any of the specified events are bound to the specified handler.

Type: boolean

geoOff(eventopt, argopt, nullable) → {this}

Description:

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

Source:

feature.js, line 994

Inherited From:

geo.feature#geoOff

Parameters:

Name	Type	Attributes	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: this

geoOn(event, handler) → {this}

Description:

Bind an event handler to this object.

Source:

feature.js, line 972

Inherited From:

geo.feature#geoOn

Parameters:

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: this

geoOnce(event, handler) → {function}

Description:

Bind an event handler to this object that will fire once and then deregister itself.

Source:

object.js, line 168

Inherited From:

geo.object#geoOnce

Parameters:

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:

The actual bound handler. This is a wrapper around the handler that was passed to the function.

Type: function

geoTrigger(event, args, childrenOnlyopt) → {this}

Description:

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

Source:

sceneObject.js, line 136

Inherited From:

geo.sceneObject#geoTrigger

Parameters:

Name	Type	Attributes	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: this

layer() → {geo.layer}

Description:

Get the layer referenced by the feature.

Source:

feature.js, line 661

Inherited From:

geo.feature#layer

Returns:

The layer associated with the feature.

Type: geo.layer

mesh(specOrPropertyopt, valueopt) → {geo.meshFeature.meshSpec|object|this}

Description:

Get/Set mesh accessor.

Source:

meshFeature.js, line 139

Inherited From:

geo.meshFeature#mesh

Parameters:

Name	Type	Attributes	Description
`specOrProperty`	string \| geo.meshFeature.meshSpec	<optional>	If `undefined`, return the current mesh specification. If a string is specified, either get or set the named mesh property. If an object is given, set or update the specification with the specified parameters.
`value`	object	<optional>	If `specOrProperty` is a string, set that property to `value`. If `undefined`, return the current value of the named property.

Returns:

The current mesh specification, the value of a named mesh property, or this mesh object.

Type: geo.meshFeature.meshSpec | object | this

mesh.get(key) → {object|function}

Description:

A uniform getter that always returns a function even for constant values. If undefined input, return all the mesh values as an object.

Source:

meshFeature.js, line 174

Inherited From:

geo.meshFeature#mesh_DOT_get

Parameters:

Name	Type	Description
`key`	string \| undefined	The name of the mesh key or `undefined` to return an object with all keys as functions.

Returns:

A function related to the key, or an object with all mesh keys, each of which is a function.

Type: object | function

modified() → {this}

Description:

Update the timestamp to the next global timestamp value.

Source:

timestamp.js, line 25

Inherited From:

geo.timestamp#modified

Returns:

Type: this

mouseOverOrderHighestIndex(evt)

Description:

If the selectionAPI is on, then setting this.geoOn(geo.event.feature.mouseover_order, this.mouseOverOrderHighestIndex) will make it so that the mouseon events prefer the highest index feature.

Source:

feature.js, line 919

Inherited From:

geo.feature#mouseOverOrderHighestIndex

Parameters:

Name	Type	Description
`evt`	geo.event	The event; this should be triggered from `geo.event.feature.mouseover_order`.

onIdle(handler) → {this}

Description:

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.

Source:

object.js, line 36

Inherited From:

geo.object#onIdle

Parameters:

Name	Type	Description
`handler`	function	A function taking no arguments.

Returns:

Type: this

parent(argopt) → {this|geo.sceneObject}

Description:

Get/set parent of the object.

Source:

sceneObject.js, line 64

Inherited From:

geo.sceneObject#parent

Parameters:

Name	Type	Attributes	Description
`arg`	geo.sceneObject	<optional>	The new parent or `undefined` to get the current parent.

Returns:

Type: this | geo.sceneObject

pointSearch(geo, gcsopt) → {geo.feature.searchResult}

Description:

Search for features containing the given point. This should be defined in relevant subclasses.

Source:

feature.js, line 194

Inherited From:

geo.feature#pointSearch

Parameters:

Name	Type	Attributes	Description
`geo`	geo.geoPosition		Coordinate.
`gcs`	string \| geo.transform \| null	<optional>	Input gcs. `undefined` to use the interface gcs, `null` to use the map gcs, or any other transform.

Returns:

An object with a list of features and feature indices that are located at the specified point.

Type: geo.feature.searchResult

polygonSearch(poly, optsopt, gcsopt) → {geo.feature.searchResult}

Description:

Search for features contained within a polygon. This should be defined in relevant subclasses.

Source:

feature.js, line 237

Inherited From:

geo.feature#polygonSearch

Parameters:

Name Type Attributes Description

poly

geo.polygonObject

A polygon as an array of coordinates or an object with outer and optionally inner parameters.

opts

object

Additional search options.

Properties

Name	Type	Attributes	Default	Description
`partial`	boolean	<optional>	`false`	If truthy, include features that are partially in the polygon, otherwise only include features that are fully within the region.

gcs

string | geo.transform | null

Input gcs. undefined to use the interface gcs, null to use the map gcs, or any other transform.

Returns:

An object with a list of features and feature indices that are located at the specified point.

Type: geo.feature.searchResult

position(valopt) → {array|function|this}

Description:

Get/Set position accessor. This is identical to getting or setting the position style.

Source:

meshFeature.js, line 207

Inherited From:

geo.meshFeature#position

Parameters:

Name	Type	Attributes	Description
`val`	array \| function	<optional>	If specified, set the position style. If `undefined`, return the current value.

Returns:

Either the position style or this.

Type: array | function | this

removeChild(child) → {this}

Description:

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

Source:

sceneObject.js, line 96

Inherited From:

geo.sceneObject#removeChild

Parameters:

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

Returns:

Type: this

removePromise(promise) → {this}

Description:

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

Source:

sceneObject.js, line 49

Inherited From:

geo.sceneObject#removePromise

Parameters:

Name	Type	Description
`promise`	Promise	A promise object.

Returns:

Type: this

renderer() → {geo.renderer}

Description:

Get the renderer used by the feature.

Source:

feature.js, line 670

Inherited From:

geo.feature#renderer

Returns:

The renderer used to render the feature.

Type: geo.renderer

selectionAPI(argopt, directopt) → {boolean|string|this}

Description:

Get/Set if the selection API is enabled for this feature.

Source:

feature.js, line 890

Inherited From:

geo.feature#selectionAPI

Parameters:

Name	Type	Attributes	Description
`arg`	boolean \| string	<optional>	`undefined` to return the selectionAPI state, a boolean to change the state, or `'auto'` to set the state based on the existence of event handlers. When getting the state, if `direct` is not specified, `'auto'` is never returned.
`direct`	boolean	<optional>	If `true`, when getting the selectionAPI state, disregard the state of the parent layer, and when setting, refresh the state regardless of whether it has changed or not.

Returns:

Either the selectionAPI state or the feature instance.

Type: boolean | string | this

style(arg1opt, arg2opt) → {object|this}

Description:

Get/Set style used by the feature. Styles can be constant values or functions. If a function, the style is typically called with parameters such as (dataElement, dataIndex) or, if the specific style of a feature has a subfeature style, with (subfeatureElement, subfeatureIndex, dataElement, dataIndex).

See the style specification styleSpec for available styles.

Source:

feature.js, line 537

Inherited From:

geo.feature#style

Parameters:

Name	Type	Attributes	Description
`arg1`	string \| object	<optional>	If `undefined`, return the current style object. If a string and `arg2` is undefined, return the style associated with the specified key. If a string and `arg2` is defined, set the named style to the specified value. Otherwise, extend the current style with the values in the specified object.
`arg2`	*	<optional>	If `arg1` is a string, the new value for that style.

Returns:

Either the entire style object, the value of a specific style, or the current class instance.

Type: object | this

style.get(keyopt) → {function|object}

Description:

A uniform getter that always returns a function even for constant styles. This can also return all defined styles as functions in a single object.

If the style key is a color, the returned function will also coerce the result to be a geo.geoColorObject.

Source:

feature.js, line 553

Inherited From:

geo.feature#style_DOT_get

Parameters:

Name	Type	Attributes	Description
`key`	string	<optional>	If defined, return a function for the named style. Otherwise, return an object with a function for all defined styles.

Returns:

Either a function for the named style or an object with functions for all defined styles.

Type: function | object

timestamp() → {number}

Description:

Get time.

Source:

timestamp.js, line 37

Inherited From:

geo.timestamp#timestamp

Returns:

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

Type: number

updateStyleFromArray(keyOrObject, styleArray, refreshopt) → {this}

Description:

Set style(s) from array(s). For each style, the array should have one value per data item. The values are not converted or validated. Color values should be geo.geoColorObjects. If invalid values are given the behavior is undefined. For some feature styles, if the first entry of an array is itself an array, then each entry of the array is expected to be an array, and values are used from these subarrays. This allows a style to apply, for instance, per vertex of a data item rather than per data item.

Source:

feature.js, line 616

Inherited From:

geo.feature#updateStyleFromArray

Parameters:

Name	Type	Attributes	Default	Description
`keyOrObject`	string \| object			Either the name of a single style or an object where the keys are the names of styles and the values are each arrays.
`styleArray`	array			If keyOrObject is a string, an array of values for the style. If keyOrObject is an object, this parameter is ignored.
`refresh`	boolean	<optional>	`false`	`true` to redraw the feature when it has been updated. If an object with styles is passed, the redraw is only done once.

Returns:

The feature instance.

Type: this

updateTime(valopt) → {geo.timestamp|this}

Description:

Get/Set timestamp of last time an update happened.

Source:

feature.js, line 846

Inherited From:

geo.feature#updateTime

Parameters:

Name	Type	Attributes	Description
`val`	geo.timestamp	<optional>	The new update timestamp object or `undefined` to get the current update timestamp object.

Returns:

Type: geo.timestamp | this

visible(valopt, directopt) → {boolean|this}

Description:

Get/Set the visibility of the feature.

Source:

feature.js, line 726

Inherited From:

geo.feature#visible

Parameters:

Name	Type	Attributes	Description
`val`	boolean	<optional>	A boolean to change the visibility, or `undefined` to return the visibility.
`direct`	boolean	<optional>	If `true`, when getting the visibility, disregard the visibility of the parent layer, and when setting, refresh the state regardless of whether it has changed or not. Otherwise, the functional visibility is returned, where both the feature and the layer must be visible for a `true` result.

Returns:

Either the visibility (if getting) or the feature (if setting).

Type: boolean | this