Class: meshFeature

geo. meshFeature

new geo.meshFeature(arg){this}

Create a new instance of class meshFeature. This should be the parent of a more useable feature class.

Name Type Description
arg geo.meshFeature.spec
Returns:
Type Description
this

Extends

Type Definitions

geo.meshFeature.meshInfoobject

A set of elements and their associated positions for a mesh.

Properties:
Name Type Description
shape string

One of 'triangle' or 'square'. If square, each pair of elements is one square. These elements have vertices v00, v01, v02, v10, v11, v12. The square is formed via v00-v01-v10-v11-v00. For triangle, each element stands alone.

elements Array.<number>

A packed array of indices into the pos array defining the elements. Each sequential three values forms a triangle.

index Array.<number>

An array that references which data index is associated with each vertex.

pos Array.<number>

A packed array of coordinates in the interface gcs for the vertices. This is in the order x0, y0, z0, x1, y1, z2, x2, ...

numberVertices number

the number of vertices in the mesh.

numberElementsthe number

number of elements (squares or triangles) in the mesh.

verticesPerElement number

3 for triangles, 6 for squares.

geo.meshFeature.meshSpecobject

A mesh formed by a set of triangular or square elements or a squarely-connected grid that is of rectangular extent. The gird can be regularly spaced or have arbitrary position coordinates for each node. All of these properties can be functions, which get passed data.

Properties:
Name Type Argument Default Description
elements Array.<number> | array.<Array.<number>> <optional>

If specified, a list of indices into the data array that form elements. If this is an array of arrays, each subarray must have at least either 3 values for triangular elements or 4 values for square elements. If this is a single array, the data indices are of all elements are packed one after another and the elementPacking property is used to determine element shape. If this null or undefined, a rectangular grid of squares is used based on gridWidth and gridHeight or an implicit version of those parameters.

elementPacking string <optional>
'auto'

If elements is provided as a single array, this determines the shape of the elements. It is one of auto, triangle, or square. triangle uses triplets of values to define elements. square uses quads of values. auto is identical to triangle unless elements's length is a multiple of 4 and not a multiple of 3, in which case it is the same as square.

gridWidth number <optional>

The number of data columns in the grid. If this is not specified and gridHeight is given, this is the number of data elements divided by gridHeight. If neither gridWidth nor gridHeight are specified, the squareroot of the number of data elements is used. If both are specified, some data could be unused. Ignored if elements is used.

gridHeight number <optional>

The number of data rows in the grid. If this is not specified and gridWidth is given, this is the number of data elements divided by gridWidth. If neither gridWidth not gridHeight are specified, the squareroot of the number of data elements is used. If both are specified, some data could be unused. Ignored if elements is used.

x0 number <optional>

The x coordinate of the 0th data point. If null or undefined, the coordinate is taken from the position style. Ignored if elements is used.

y0 number <optional>

The y coordinate of the 0th data point. If null or undefined, the coordinate is taken from the position style. Ignored if elements is used.

dx number <optional>

The distance in the x direction between the 0th and 1st data point. This may be positive or negative. If 0, null, or undefined, the coordinate is taken from the position style. Ignored if elements is used.

dy number <optional>

The distance in the y direction between the 0th and gridWidthth data point. This may be positive or negative. If 0, null, or undefined, the coordinate is taken from the position style. Ignored if elements is used.

wrapLongitude boolean <optional>
true

If truthy and position is not used (elements is not used and x0, y0, dx, and dy are all set appropriately), assume the x coordinates are longitude and should be adjusted to be within -180 to 180. If the data spans 180 degrees, the points or squares that straddle the meridian will be duplicated to ensure that the map is covered from -180 to 180 as appropriate. Set this to false if using a non-longitude x coordinate.

geo.meshFeature.specgeo.feature.spec

Mesh feature specification.

Properties:
Name Type Argument Default Description
data Array.<object> <optional>
[]

An array of arbitrary objects used to construct the feature.

style geo.feature.styleSpec <optional>

An object that contains style values for the feature.

mesh geo.meshFeature.meshSpec <optional>

The mesh specification for the feature.

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

inherited addChild(child){this}

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}

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

Name Type Description
promise Promise

A promise object.

Returns:
Type Description
this

inherited bin(val, actualValue){number|this}

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.

Name Type 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:
Type Description
number | this The current bin number or a reference to this.

inherited boxSearch(lowerLeft, upperRight, opts){geo.feature.searchResult}

Search for features contained within a rectangular region.

Name Type Description
lowerLeft geo.geoPosition

Lower-left corner in gcs coordinates.

upperRight geo.geoPosition

Upper-right corner in gcs coordinates.

opts object optional

Additional search options.

Name Type Default Description
partial boolean false optional

If truthy, include features that are partially in the box, otherwise only include features that are fully within the region.

Returns:
Type Description
geo.feature.searchResult An object with a list of features and feature indices that are located at the specified point.

inherited buildTime(val){geo.timestamp|this}

Get/Set timestamp of last time a build happened.

Name Type Description
val geo.timestamp optional

The new build timestamp object or undefined to get the current build timestamp object.

Returns:
Type Description
geo.timestamp | this

Get an array of the child objects.

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

inherited data(data){array|this}

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.

Name Type Description
data array optional

A new data array or undefined to return the existing array.

Returns:
Type Description
array | this

Get/Set timestamp of data change.

Name Type Description
val geo.timestamp optional

The new data timestamp object or undefined to get the current data timestamp object.

Returns:
Type Description
geo.timestamp | this

inherited dependentFeatures(arg){Array.<geo.feature>|this}

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

Name Type Description
arg Array.<geo.feature> optional

If specified, the new list of dependent features. Otherwise, return the current list of dependent features.

Returns:
Type Description
Array.<geo.feature> | this The current list of dependent features or a reference to this.

inherited draw(arg){this}

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

inherited featureGcsToDisplay(c){geo.screenPosition}

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

Name Type Description
c geo.geoPosition

The input coordinate to convert.

Returns:
Type Description
geo.screenPosition Display space coordinates.

inherited gcs(val){string|this}

Get/Set the projection of the feature.

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.

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}

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}

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}

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}

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

Get the layer referenced by the feature.

Returns:
Type Description
geo.layer The layer associated with the feature.

mesh(specOrProperty, value){geo.meshFeature.meshSpec|object|this}

Get/Set mesh accessor.

Name Type 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:
Type Description
geo.meshFeature.meshSpec | object | this The current mesh specification, the value of a named mesh property, or this mesh object.

mesh.get(key){object|function}

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

Name Type Description
key string | undefined

The name of the mesh key or undefined to return an object with all keys as functions.

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

inherited modified(){this}

Update the timestamp to the next global timestamp value.

Returns:
Type Description
this

inherited mouseOverOrderHighestIndex(evt)

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.

Name Type Description
evt geo.event

The event; this should be triggered from geo.event.feature.mouseover_order.

inherited onIdle(handler){this}

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

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

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

Name Type Description
geo geo.geoPosition

Coordinate in interface gcs.

Returns:
Type Description
geo.feature.searchResult An object with a list of features and feature indices that are located at the specified point.

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

Name Type Description
poly geo.polygonObject

A polygon as an array of coordinates or an object with outer and optionally inner parameters. All coordinates are in map interface gcs.

opts object optional

Additional search options.

Name Type Default Description
partial boolean false optional

If truthy, include features that are partially in the polygon, otherwise only include features that are fully within the region.

Returns:
Type Description
geo.feature.searchResult An object with a list of features and feature indices that are located at the specified point.

position(val){array|function|this}

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

Name Type Description
val array | function optional

If specified, set the position style. If undefined, return the current value.

Returns:
Type Description
array | function | this Either the position style or this.

inherited removeChild(child){this}

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

Get the renderer used by the feature.

Returns:
Type Description
geo.renderer The renderer used to render the feature.

inherited selectionAPI(arg, direct){boolean|string|this}

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

Name Type 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:
Type Description
boolean | string | this Either the selectionAPI state or the feature instance.

inherited style(arg1, arg2){object|this}

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.

Name Type 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:
Type Description
object | this Either the entire style object, the value of a specific style, or the current class instance.

inherited style.get(key){function|object}

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.

Name Type 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:
Type Description
function | object Either a function for the named style or an object with functions for all defined styles.

inherited timestamp(){number}

Get time.

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

inherited updateStyleFromArray(keyOrObject, styleArray, refresh){this}

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.

Name Type 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 false optional

true to redraw the feature when it has been updated. If an object with styles is passed, the redraw is only done once.

Returns:
Type Description
this The feature instance.

inherited updateTime(val){geo.timestamp|this}

Get/Set timestamp of last time an update happened.

Name Type Description
val geo.timestamp optional

The new update timestamp object or undefined to get the current update timestamp object.

Returns:
Type Description
geo.timestamp | this

inherited visible(val, direct){boolean|this}

Get/Set the visibility of the feature.

Name Type 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:
Type Description
boolean | this Either the visibility (if getting) or the feature (if setting).