Class: trackFeature

geo. trackFeature

new geo.trackFeature(arg){geo.trackFeature}

Create a new instance of class trackFeature.

Name Type Description
arg geo.trackFeature.spec
Returns:
Type Description
geo.trackFeature

Extends

Type Definitions

geo.trackFeature.specgeo.feature.spec

Track feature specification.

Properties:
Name Type Argument Default Description
position geo.geoPosition | function <optional>

Position of the data. Default is (data).

time float | function <optional>

Time of the data. Default is (data).t.

track object | function <optional>

Tracks from the data. Default is (data). Typically, the data is an array of tracks, each of which is an array of points, each of which has a position and time. The position and time functions are called for each point as position(trackPoint, pointIndex, trackEntry, trackEntryIndex).

startTime float | null <optional>
null

Start time. Used for styling. If null, this is the duration before the end time if duration is not null and the minimum time in any track if duration is null.

endTime float <optional>
null

End time. Used for styling and position of the track head. If null and either of startTime or duration are null, this is the maximum time in any track.

duration float <optional>
null

Duration between start and end times. Ignored if both start and end times are specified.

text float | function <optional>

Text to use for the head of the track. If specified, the track head is rendered as text. If undefined a marker is used instead. If null or an empty string (''), neither a marker nor text is used.

style geo.trackFeature.styleSpec <optional>

Style object with default style options.

pastStyle geo.lineFeature.styleSpec <optional>

Style object with style options for the track before the start time.

currentStyle geo.lineFeature.styleSpec <optional>

Style object with style options for the track between the start and end time.

futureStyle geo.lineFeature.styleSpec <optional>

Style object with style options for the track after the end time.

markerStyle geo.markerFeature.styleSpec <optional>

Style object with style options for the track head marker.

textStyle geo.textFeature.styleSpec <optional>

Style object with style options for the track head text.

geo.trackFeature.styleSpecgeo.feature.styleSpec

Style specification for a track feature. Extends geo.lineFeasture.styleSpec.

Properties:
Name Type Argument Default Description
strokeColor geo.geoColor | function <optional>

Color to stroke each line. The color can vary by point.

strokeOpacity number | function <optional>

Opacity for each line stroke. The opacity can vary by point. Opacity is on a [0-1] scale.

strokeWidth number | function <optional>

The weight of the line stroke in pixels. The width can vary by point.

strokeOffset number | function <optional>

This is a value from -1 (left) to 1 (right), with 0 being centered. This can vary by point.

lineCap string | function <optional>
'butt'

One of 'butt', 'square', or 'round'. This can vary by point.

lineJoin string | function <optional>
'miter'

One of 'miter', 'bevel', 'round', or 'miter-clip'. This can vary by point.

closed boolean | function <optional>
false

If true and the renderer supports it, connect the first and last points of a line if the line has more than two points. This applies per line (if a function, it is called with (lineEntry, lineEntryIndex).

miterLimit number | function <optional>
10

For lines of more than two segments that are mitered, if the miter length exceeds the strokeWidth divided by the sine of half the angle between segments, then a bevel join is used instead. This is a single value that applies to all lines. If a function, it is called with (data).

antialiasing number | function <optional>

Antialiasing distance in pixels. Values must be non-negative. A value greater than 1 will produce a visible gradient. This is a single value that applies to all lines.

debug string | function <optional>

If 'debug', render lines in debug mode. This is a single value that applies to all lines.

origin Array.<number> | function <optional>

Origin in map gcs coordinates used for to ensure high precision drawing in this location. When called as a function, this is passed the vertex positions as a single continuous array in map gcs coordinates. It defaults to the first line's first vertex's position.

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

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}

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

calculateTimePosition(time, gcs, calcAngle){Array.<geo.geoPosition>}

Calculate an interpolated position given a time. If the time is outside the range of a track, the first or last point is returned.

Name Type Description
time float

The time to compute a position array for.

gcs string | geo.transform | null optional

undefined to use the feature gcs, null to use the map gcs, or any other transform. This transform is used for the interpolation; the results are still in feature gcs.

calcAngle boolean optional

If truthy, also calculate the angle.

Returns:
Type Description
Array.<geo.geoPosition> An array of positions, one per track. If the angle is computed, these position objects are supplemented with an angle key in radians.

Get an array of the child objects.

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

currentStyle()

Calls geo.annotation#style with styleType='currentStyle'.

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.

draw(){object}

Redraw the object.

Returns:
Type Description
object The results of the superclass draw function.

duration(val){float|null|this}

Get or set the duration.

Name Type Description
val float | null optional

If specified, the new duration.

Returns:
Type Description
float | null | this If set, the instance. Otherwise, the current duration.

endTime(val){float|null|this}

Get or set the end time.

Name Type Description
val float | null optional

If specified, the new end time.

Returns:
Type Description
float | null | this If set, the instance. Otherwise, the current end time value.

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.

futureStyle()

Calls geo.annotation#style with styleType='futureStyle'.

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.

markerStyle()

Calls geo.annotation#style with styleType='markerStyle'.

modified(){object}

Update the timestamp to the next global timestamp value. Mark sub-features as modified, too.

Returns:
Type Description
object The results of the superclass modified function.

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

pastStyle()

Calls geo.annotation#style with styleType='pastStyle'.

pointSearch(p){object}

Returns an array of datum indices that contain the given point.

Name Type Description
p geo.geoPosition

point to search for in map interface gcs.

Returns:
Type Description
object An object with index: a list of track indices, found: a list of tracks that contain the specified coordinate, extra: an object with keys that are track indices and values that are the first segement index for which the track was matched, and where: an object with keys that are track indices and values that are past, future, or marker if the point was found in that part of the track, or unset if the point was found in the current part of the track.

polygonSearch(poly, opts){object}

Returns tracks that are contained in the given polygon.

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 tracks that are partially in the polygon, otherwise only include tracks that are fully within the region.

Returns:
Type Description
object An object with index: a list of track indices, found: a list of tracks within the polygon, extra: an object with index keys containing an object with a segment key with a value indicating one of the track segments that is inside the polygon and partial key and a boolean value to indicate if the track is on the polygon's border, and where: an object with keys that are track indices and values that are past, future, or marker if the point was found in that part of the track, or unset if the point was found in the current part of the track.

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

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. If a function is given, this is called with (vertexElement, vertexIndex, dataElement, dataIndex).

Returns:
Type Description
geo.geoPosition | function | this The current position or this feature.

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.

startTime(val){float|null|this}

Get or set the start time.

Name Type Description
val float | null optional

If specified, the new start time.

Returns:
Type Description
float | null | this If set, the instance. Otherwise, the current start time value.

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

Set or get style.

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

styleType string 'style' optional

The name of the style type, such as markerStyle, textStyle, pastStyle, currentStyle, or futureStyle.

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.

textStyle()

Calls geo.annotation#style with styleType='textStyle'.

time(val){float|function|this}

Get/Set time accessor.

Name Type Description
val float optional

If not specified, return the current time accessor. If specified, use this for the time accessor and return this. If a function is given, this is called with (vertexElement, vertexIndex, dataElement, dataIndex).

Returns:
Type Description
float | function | this The current time or this feature.

timeRange(val){object|this}

Set or query the time range for the tracks. Tracks are rendered differently before the start time and after the end time. The track's marker or text is rendered at the position corresponding to the end time.

Name Type Description
val object optional

An object with any of startTime, endTime, and duration. A value of undefined won't change that field. A value of null uses the default. If val is undefined, the existsing settings are returned.

Returns:
Type Description
object | this Either the instance or the current settings. If the current settings, start and end are included with the calculated start and end times, and minimum and maximum are values computed from the data.

inherited timestamp(){number}

Get time.

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

track(val){object|function|this}

Get/set track accessor.

Name Type Description
val object | function optional

If not specified, return the current track accessor. If specified, use this for the track accessor and return this. If a function is given, the function is passed (dataElement, dataIndex) and returns an array of vertex elements.

Returns:
Type Description
object | function | this The current track accessor or this feature.

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