GeoJS

Class: ellipseAnnotation

geo. ellipseAnnotation

new geo.ellipseAnnotation(args, annotationName)

annotation/ellipseAnnotation.js, line 21

Ellipse annotation class.

Ellipses are always rendered as markers.

Name Type Default Description
args geo.ellipseAnnotation.spec optional nullable

Options for the annotation.
annotationName string 'ellipse' optional

Override the annotation name.

Extends

Static Members

staticgeo.ellipseAnnotation.defaults

This object contains the default options to initialize the class.

Methods

inherited actions(state){Array.<geo.actionRecord>}

annotation/annotation.js, line 381

Return actions needed for the specified state of this annotation.

Name Type Description
state string optional

The state to return actions for. Defaults to the current state.
Returns:
Type Description
Array.<geo.actionRecord> A list of actions.

inherited coordinates(gcs){Array.<geo.geoPosition>}

annotation/annotation.js, line 758

Get coordinates associated with this annotation.

Name Type Description
gcs string | geo.transform | null optional

undefined to use the interface gcs, null to use the map gcs, or any other transform.
Returns:
Type Description
Array.<geo.geoPosition> An array of coordinates.

inherited createStyle()

annotation/annotation.js, line 607

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

inherited cursorStyle()

annotation/annotation.js, line 637

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

inherited description(arg){this|string}

annotation/annotation.js, line 292

Get or set the description of this annotation.

Name Type Description
arg string | undefined

If undefined, return the description, otherwise change it.
Returns:
Type Description
this | string The current description or this annotation.

inherited draw(){this}

annotation/annotation.js, line 792

Draw this annotation. This just updates and draws the parent layer.

Returns:
Type Description
this The annotation.

inherited editHandleStyle()

annotation/annotation.js, line 619

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

inherited editStyle()

annotation/annotation.js, line 613

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

features(){array}

annotation/ellipseAnnotation.js, line 36

Get a list of renderable features for this annotation.

Returns:
Type Description
array An array of features.

inherited geojson(gcs, includeCrs){object}

annotation/annotation.js, line 843

Return the annotation as a geojson object.

Name Type Description
gcs string | geo.transform | null optional

undefined to use the interface gcs, null to use the map gcs, or any other transform.
includeCrs boolean optional

If truthy, include the coordinate system.
Returns:
Type Description
object The annotation as a geojson object, or undefined if it should not be represented (for instance, while it is being created).

inherited highlightStyle()

annotation/annotation.js, line 631

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

inherited id(){number}

annotation/annotation.js, line 154

Get a unique annotation id.

Returns:
Type Description
number The annotation id.

inherited label(arg, noFallback){this|string}

annotation/annotation.js, line 200

Get or set the label of this annotation.

Name Type Description
arg string | null | undefined optional

If undefined, return the label, otherwise change it. null to clear the label.
noFallback boolean optional

If not truthy and the label is null, return the name, otherwise return the actual value for label.
Returns:
Type Description
this | string The current label or this annotation.

inherited labelRecord(){geo.annotationLayer.labelRecord|undefined}

annotation/annotation.js, line 261

If the label should be shown, get a record of the label that can be used in a geo.textFeature.

Returns:
Type Description
geo.annotationLayer.labelRecord | undefined A label record, or undefined if it should not be shown.

inherited labelStyle()

annotation/annotation.js, line 625

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

inherited layer(arg){this|geo.annotationLayer}

annotation/annotation.js, line 310

Get or set the annotation layer associated with this annotation.

Name Type Description
arg geo.annotationLayer | undefined

if undefined, return the layer, otherwise change it.
Returns:
Type Description
this | geo.annotationLayer the current layer or this annotation.

inherited modified(){this}

annotation/annotation.js, line 780

Mark this annotation as modified. This just marks the parent layer as modified.

Returns:
Type Description
this The annotation.

inherited mouseClick(evt){boolean|string}

annotation/annotation.js, line 707

Handle a mouse click on this annotation. If the event is processed, evt.handled should be set to true to prevent further processing.

Name Type Description
evt geo.event

The mouse click event.
Returns:
Type Description
boolean | string true to update the annotation, 'done' if the annotation was completed (changed from create to done state), 'remove' if the annotation should be removed, falsy to not update anything.

inherited mouseClickEdit(evt){boolean|string}

annotation/annotation.js, line 722

Handle a mouse click on this annotation when in edit mode. If the event is processed, evt.handled should be set to true to prevent further processing.

Name Type Description
evt geo.event

The mouse click event.
Returns:
Type Description
boolean | string true to update the annotation, 'done' if the annotation was completed (changed from create to done state), 'remove' if the annotation should be removed, falsy to not update anything.

inherited mouseMove(evt){boolean}

annotation/annotation.js, line 733

Handle a mouse move on this annotation.

Name Type Description
evt geo.event

The mouse move event.
Returns:
Type Description
boolean Truthy to update the annotation, falsy to not update anything.

inherited name(arg){this|string}

annotation/annotation.js, line 177

Get or set the name of this annotation.

Name Type Description
arg string | undefined optional

If undefined, return the name, otherwise change it. When setting the name, the value is trimmed of whitespace. The name will not be changed to an empty string.
Returns:
Type Description
this | string The current name or this annotation.

inherited newId(){this}

annotation/annotation.js, line 163

Assign a new id to this annotation.

Returns:
Type Description
this

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

annotation/annotation.js, line 519

Get or set options.

Name Type Description
arg1 string | object optional

If undefined, return the options object. If a string, either set or return the option of that name. If an object, update the options with the object's values.
arg2 object optional

If arg1 is a string and this is defined, set the option to this value.
Fires:
Returns:
Type Description
object | this If options are set, return the annotation, otherwise return the requested option or the set of options.

inherited processAction(evt){boolean|string}

annotation/annotation.js, line 424

Process any non-edit actions for this annotation.

Name Type Description
evt geo.event

The action event.
Returns:
Type Description
boolean | string true to update the annotation, 'done' if the annotation was completed (changed from create to done state), 'remove' if the annotation should be removed, falsy to not update anything.

inherited processEditAction(evt){boolean}

annotation/annotation.js, line 435

Process any edit actions for this annotation.

Name Type Description
evt geo.event

The action event.
Returns:
Type Description
boolean true to update the annotation, falsy to not update anything.

inherited selectEditHandle(handle, enable){this}

annotation/annotation.js, line 479

When an edit handle is selected or deselected (for instance, by moving the mouse on or off of it), mark if it is selected and record the current coordinates.

Name Type Description
handle object

The data for the edit handle.
enable boolean

True to enable the handle, false to disable.
Fires:
Returns:
Type Description
this

inherited state(arg){this|string}

annotation/annotation.js, line 348

Get or set the state of this annotation.

Name Type Description
arg string | undefined optional

If undefined, return the state, otherwise change it. This should be one of the geo.annotation.state values.
Fires:
Returns:
Type Description
this | string The current state or this annotation.

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

annotation/annotation.js, line 587

Get or set 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 createStyle, editStyle, editHandleStyle, labelStyle, highlightStyle, or cursorStyle.
Returns:
Type Description
object | this Either the entire style object, the value of a specific style, or the current class instance.

inherited styleForState(state){object}

annotation/annotation.js, line 657

Return the style dictionary for a particular state.

Name Type Description
state string optional

The state to return styles for. Defaults to the current state.
Returns:
Type Description
object The style object for the state. If there is no such style defined, the default style is used.

toPolygonList(opts){geo.polygonList}

annotation/ellipseAnnotation.js, line 83

Return this annotation as a polygon list.

Name Type Description
opts geo.util.polyop.spec optional

The tolerance and pixelTolerance parameters are used if set. Otherwise, a polygon is approximated to 1/10th of a pixel at the map's current maximum zoom level.
Returns:
Type Description
geo.polygonList A list of polygons.

inherited type(){string}

annotation/annotation.js, line 680

Get the type of this annotation.

Returns:
Type Description
string The annotation type.