GeoJS

Class: pixelmapFeature

geo.canvas. pixelmapFeature

new geo.canvas.pixelmapFeature(arg){geo.canvas.pixelmapFeature}

canvas/pixelmapFeature.js, line 35

Create a new instance of class pixelmapFeature.

Name Type Description
arg geo.pixelmapFeature.spec
Returns:
Type Description
geo.canvas.pixelmapFeature

Extends

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}

sceneObject.js, line 79

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

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}

feature.js, line 740

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, gcs){geo.feature.searchResult}

feature.js, line 212

Search for features contained within a rectangular region.

Name Type Description
lowerLeft geo.geoPosition

Lower-left corner.
upperRight geo.geoPosition

Upper-right corner.
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.
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:
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}

feature.js, line 783

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

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

sceneObject.js, line 110

Get an array of the child objects.

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

inherited color(val){geo.geoColor|function|this}

pixelmapFeature.js, line 108

Get/Set color accessor.

Name Type Description
val geo.geoColor | function optional

The new color map accessor or undefined to get the current accessor.
Returns:
Type Description
geo.geoColor | function | this

inherited data(data){array|this}

feature.js, line 820

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

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

feature.js, line 766

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}

feature.js, line 715

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}

sceneObject.js, line 121

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}

feature.js, line 657

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}

feature.js, line 638

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}

object.js, line 187

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}

feature.js, line 948

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}

feature.js, line 926

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 geoOnce(event, handler){function}

object.js, line 168

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

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
function The actual bound handler. This is a wrapper around the handler that was passed to the function.

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

sceneObject.js, line 136

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 indexModified(idx, idx2){this|Array.<number>}

pixelmapFeature.js, line 134

Mark that an index's data value (and hence its color) has changed without marking all of the data array as changed. If this function is called without any parameters, it clears the tracked changes.

Name Type Description
idx number optional

The lowest data index that has changed. If undefined, return the current tracked changed range.
idx2 number | 'clear' optional

If an index was specified in idx and this is specified, the highest index (inclusive) that has changed. If returning the tracked changed range and this is clear, clear the tracked range.
Returns:
Type Description
this | Array.<number> When returning a range, this is the lowest and highest index values that have changed (inclusive), so their range is [0, data.length).

inherited layer(){geo.layer}

feature.js, line 615

Get the layer referenced by the feature.

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

inherited maxIndex(){number}

pixelmapFeature.js, line 177

Get the maximum index value from the pixelmap. This is a value present in the pixelmap.

Returns:
Type Description
number The maximum index value.

inherited modified(){this}

timestamp.js, line 25

Update the timestamp to the next global timestamp value.

Returns:
Type Description
this

inherited mouseOverOrderHighestIndex(evt)

feature.js, line 873

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}

object.js, line 36

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 parent(arg){this|geo.sceneObject}

sceneObject.js, line 64

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

pointSearch(geo, gcs){geo.feature.searchResult}

canvas/pixelmapFeature.js, line 61

If the specified coordinates are in the rendered quad, use the basis information from the quad to determine the pixelmap index value so that it can be included in the found results.

Name Type 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:
Type Description
geo.feature.searchResult An object with a list of features and feature indices that are located at the specified point.

inherited polygonSearch(poly, opts, gcs){geo.feature.searchResult}

feature.js, line 233

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.
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.
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:
Type Description
geo.feature.searchResult An object with a list of features and feature indices that are located at the specified point.

inherited position(val){geo.geoPosition|function|this}

pixelmapFeature.js, line 70

Get/Set position accessor.

Name Type Description
val geo.geoPosition | function optional

If not specified, return the current position accessor. If specified, use this for the position accessor and return this. See geo.quadFeature.position for for details on this position.
Returns:
Type Description
geo.geoPosition | function | this

inherited removeChild(child){this}

sceneObject.js, line 96

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

inherited removePromise(promise){this}

sceneObject.js, line 49

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

Name Type Description
promise Promise

A promise object.
Returns:
Type Description
this

inherited renderer(){geo.renderer}

feature.js, line 624

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}

feature.js, line 844

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}

feature.js, line 491

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}

feature.js, line 507

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}

timestamp.js, line 37

Get time.

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

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

feature.js, line 570

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}

feature.js, line 800

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 url(val){string|function|this}

pixelmapFeature.js, line 89

Get/Set url accessor.

Name Type Description
val string | function optional

If not specified, return the current url accessor. If specified, use this for the url accessor and return this.
Returns:
Type Description
string | function | this

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

feature.js, line 680

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