polygonFeature

geo. polygonFeature

new polygonFeature(arg) → {geo.polygonFeature}

Description:

  • Create a new instance of class polygonFeature.

Source:
Parameters:
Name Type Description
arg geo.polygonFeature.spec
Returns:
Type
geo.polygonFeature

Extends

Members

idle

Description:

  • Getter for the idle state. Read only.

Source:
Inherited From:
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:
Inherited From:
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

addChild(child) → {this}

Description:

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

Source:
Inherited From:
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:
Inherited From:
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:
Inherited From:
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:
Inherited From:
Parameters:
Name Type Attributes Description
lowerLeft geo.geoPosition

Lower-left corner.
upperRight geo.geoPosition

Upper-right corner.
opts object <optional>

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

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

Description:

  • Get/Set timestamp of last time a build happened.

Source:
Inherited From:
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:
Inherited From:
Returns:

A copy of the array of child objects.

Type
Array.<geo.object>

data(argopt) → {geo.polygonFeature|object}

Description:

  • Get/set data.

Source:
Overrides:
Parameters:
Name Type Attributes Description
arg object <optional>

if specified, use this for the data and return the feature. If not specified, return the current data.
Returns:
Type
geo.polygonFeature | object

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

Description:

  • Get/Set timestamp of data change.

Source:
Inherited From:
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:
Inherited From:
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() → {object}

Description:

  • Redraw the object.

Source:
Overrides:
Returns:

The results of the superclass draw function.

Type
object

featureGcsToDisplay(c) → {geo.screenPosition}

Description:

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

Source:
Inherited From:
Parameters:
Name Type Description
c geo.geoPosition

The input coordinate to convert.
Returns:

Display space coordinates.

Type
geo.screenPosition

fromPolygonList(poly, optsopt) → {this}

Description:

  • Set the data, position accessor, and polygon accessor to use a list of polygons.

Source:
Parameters:
Name Type Attributes Description
poly geo.polygonList

A list of polygons.
opts geo.util.polyop.spec <optional>

Ignored.
Returns:
Type
this

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

Description:

  • Get/Set the projection of the feature.

Source:
Inherited From:
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:
Inherited From:
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:
Inherited From:
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:
Inherited From:
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:
Inherited From:
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:
Inherited From:
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:
Inherited From:
Returns:

The layer associated with the feature.

Type
geo.layer

modified() → {object}

Description:

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

Source:
Overrides:
Returns:

The results of the superclass modified function.

Type
object

mouseOverOrderClosestBorder(evt)

Description:

  • If the selectionAPI is on, then setting this.geoOn(geo.event.feature.mouseover_order, this.mouseOverOrderClosestBorder) will make it so that the mouseon events prefer the polygon with the closet border, including hole edges.

Source:
Parameters:
Name Type Description
evt geo.event

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

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:
Inherited From:
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:
Inherited From:
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:
Inherited From:
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(coordinate, gcsopt) → {object}

Description:

  • Point search method for selection api. Returns markers containing the given point.

Source:
Overrides:
Parameters:
Name Type Attributes Description
coordinate geo.geoPosition

point to search for.
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 index: a list of polygon indices, and found: a list of polygons that contain the specified coordinate.

Type
object

polygon(valopt) → {object|function|this}

Description:

  • Get/set polygon accessor.

Source:
Parameters:
Name Type Attributes Description
val object | function <optional>

If not specified, return the current polygon accessor. If specified, use this for the polygon accessor and return this. If a function is given, the function is passed (dataElement, dataIndex) and returns a geo.polygon.
Returns:

The current polygon accessor or this feature.

Type
object | function | this

polygonCoordinates() → {Array.<geo.polygonObject>}

Description:

  • Get the set of normalized polygon coordinates.

Source:
Returns:

An array of polygon positions. Each has outer and inner if it has any coordinates, or is undefined.

Type
Array.<geo.polygonObject>

polygonSearch(poly, optsopt, gcsopt) → {object}

Description:

  • Returns polygons that are contained in the given polygon. This could fail to return polygons that are less than their stroke width outside of the specified polygon and whose vertices are not near the selected polygon.

Source:
Overrides:
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 <optional>

Additional search options.

Properties
Name Type Attributes Default Description
partial boolean <optional>
 false

If truthy, include polygons that are partially in the polygon, otherwise only include polygons 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:

An object with index: a list of polygon indices, found: a list of polygons within the polygon, and extra: an object with index keys containing an object with a partial key and a boolean value to indicate if the polygon is on the specified polygon's border.

Type
object

position(valopt) → {geo.geoPosition|this}

Description:

  • Get/Set position accessor.

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

The current position or this feature.

Type
geo.geoPosition | this

rdpSimplifyData(data, toleranceopt, posFuncopt, polyFuncopt, returnDataopt) → {this|array}

Description:

  • Take a set of data, reduce the number of vertices per polygon using the Ramer–Douglas–Peucker algorithm, and use the result as the new data. This changes the instance's data, the position accessor, and the polygon accessor.

Source:
Parameters:
Name Type Attributes Default Description
data array

A new data array.
tolerance number <optional>

The maximum variation allowed in map.gcs units. A value of zero will only remove perfectly collinear points. If not specified, this is set to a half display pixel at the map's current zoom level.
posFunc function <optional>
 this.style.get('position')

The function to get the position of each vertex.
polyFunc function <optional>
 this.style.get('polygon')

The function to get each polygon.
returnData boolean <optional>
 false

If truthy, return the new data array rather than modifying the feature.
Returns:
Type
this | array

removeChild(child) → {this}

Description:

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

Source:
Inherited From:
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:
Inherited From:
Parameters:
Name Type Description
promise Promise

A promise object.
Returns:
Type
this

renderer() → {geo.renderer}

Description:

  • Get the renderer used by the feature.

Source:
Inherited From:
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:
Inherited From:
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. This calls the super function, then checks if strokes are required.

    See the style specification styleSpec for available styles.

Source:
Overrides:
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:
Inherited From:
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:
Inherited From:
Returns:

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

Type
number

toPolygonList(optsopt) → {geo.polygonList}

Description:

  • Return the polygons as a polygon list: an array of polygons, each of which is an array of polylines, each of which is an array of points, each of which is a 2-tuple of numbers.

Source:
Parameters:
Name Type Attributes Description
opts geo.util.polyop.spec <optional>

Ignored.
Returns:

A list of polygons.

Type
geo.polygonList

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:
Inherited From:
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:
Inherited From:
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:
Inherited From:
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

(static) create(layer, spec) → {geo.polygonFeature|null}

Description:

  • Create a polygonFeature from an object.

Source:
See:
Parameters:
Name Type Description
layer geo.layer

The layer to add the feature to
spec geo.polygonFeature.spec

The object specification
Returns:
Type
geo.polygonFeature | null

Type Definitions

spec

Description:

  • Polygon feature specification.

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

Position of the data. Default is (data).
polygon geo.polygon | function <optional>

Polygons from the data. Default (data).
style geo.polygonFeature.styleSpec <optional>

Style object with default style options.
layer geo.layer <optional>

the parent layer associated with the feature.
selectionAPI boolean | 'auto' <optional>
 'auto'

If 'auto', enable selection events if any geo.event.feature events are bound to the feature. Otherwise, if truthy, enable selection events on the feature. Selection events are those in geo.event.feature. They can be bound via a call like

feature.geoOn(geo.event.feature.mousemove, function (evt) {
  // do something with the feature
});

where the handler is passed a geo.event.feature object.
visible boolean <optional>
 true

If truthy, show the feature. If falsy, hide the feature and do not allow interaction with it.
gcs string <optional>

The interface gcs for this feature. If undefined or null, this uses the layer's interface gcs. This is a string used by geo.transform.
bin number <optional>
 null

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, more 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. A value of null will use the current position of the feature within its parent's list of children as the bin number.
renderer geo.renderer <optional>

A reference to the renderer used for the feature. If null or unset or identical to layer.renderer(), the layer's renderer is used.

Polygon feature specification.

Type:

styleSpec

Description:

  • Style specification for a polygon feature.

Source:
Properties:
Name Type Attributes Default Description
fill boolean | function <optional>
 true

True to fill polygon.
fillColor geo.geoColor | function <optional>

Color to fill each polygon. The color can vary by vertex.
fillOpacity number | function <optional>

Opacity for each polygon. The opacity can vary by vertex. Opacity is on a [0-1] scale.
stroke boolean | function <optional>
 false

True to stroke polygon.
uniformPolygon boolean | function <optional>
 false

Boolean indicating if each polygon has a uniform style (uniform fill color, fill opacity, stroke color, and stroke opacity). Can vary by polygon.
closed boolean | function <optional>
 true

Ignored. Always true.
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 an array of items, each of which has a vertices property that is a single continuous array in map gcs coordinates. It defaults to the first polygon's first vertex's position.
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.
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).
uniformLine boolean | string | function <optional>
 false

Boolean indicating if each line has a uniform style (uniform stroke color, opacity, and width). Can vary by line. A value of 'drop' will modify rendered vertex order by dropping duplicates and setting later values to zero opacity. This can be faster but makes it so updating the style array can no longer be used.
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.

Style specification for a polygon feature.

Type: