circleAnnotation

geo. circleAnnotation

new circleAnnotation(argsopt, nullable, annotationNameopt)

Description:

Circle annotation class.

Circles are a subset of rectangles with a fixed aspect ratio.

Source:

annotation/circleAnnotation.js, line 20

Parameters:

Name	Type	Attributes	Default	Description
`args`	geo.circleAnnotation.spec	<optional> <nullable>		Options for the annotation.
`annotationName`	string	<optional>	`'circle'`	Override the annotation name.

Extends

geo.annotation

Members

(static) defaults

Description:

This object contains the default options to initialize the class.

Source:

annotation/circleAnnotation.js, line 33

This object contains the default options to initialize the class.

Methods

actions(stateopt) → {Array.<geo.actionRecord>}

Description:

Return actions needed for the specified state of this annotation.

Source:

annotation/annotation.js, line 380

Inherited From:

geo.annotation#actions

Parameters:

Name	Type	Attributes	Description
`state`	string	<optional>	The state to return actions for. Defaults to the current state.

Returns:

A list of actions.

Type: Array.<geo.actionRecord>

coordinates(gcsopt) → {Array.<geo.geoPosition>}

Description:

Get coordinates associated with this annotation.

Source:

annotation/annotation.js, line 757

Inherited From:

geo.annotation#coordinates

Parameters:

Name	Type	Attributes	Description
`gcs`	string \| geo.transform \| null	<optional>	`undefined` to use the interface gcs, `null` to use the map gcs, or any other transform.

Returns:

An array of coordinates.

Type: Array.<geo.geoPosition>

createStyle()

Description:

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

Source:

annotation/annotation.js, line 606

Inherited From:

geo.annotation#createStyle

cursorStyle()

Description:

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

Source:

annotation/annotation.js, line 636

Inherited From:

geo.annotation#cursorStyle

description(arg) → {this|string}

Description:

Get or set the description of this annotation.

Source:

annotation/annotation.js, line 291

Inherited From:

geo.annotation#description

Parameters:

Name	Type	Description
`arg`	string \| undefined	If `undefined`, return the description, otherwise change it.

Returns:

The current description or this annotation.

Type: this | string

draw() → {this}

Description:

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

Source:

annotation/annotation.js, line 791

Inherited From:

geo.annotation#draw

Returns:

The annotation.

Type: this

editHandleStyle()

Description:

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

Source:

annotation/annotation.js, line 618

Inherited From:

geo.annotation#editHandleStyle

editStyle()

Description:

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

Source:

annotation/annotation.js, line 612

Inherited From:

geo.annotation#editStyle

features() → {array}

Description:

Get a list of renderable features for this annotation. The list index is functionally a z-index for the feature. Each entry is a dictionary with the key as the feature name (such as line, quad, or polygon), and the value a dictionary of values to pass to the feature constructor, such as style and coordinates.

Source:

annotation/annotation.js, line 692

Inherited From:

geo.annotation#features

Returns:

An array of features.

Type: array

geojson(gcsopt, includeCrsopt) → {object}

Description:

Return the annotation as a geojson object.

Source:

annotation/annotation.js, line 842

Inherited From:

geo.annotation#geojson

Parameters:

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

The annotation as a geojson object, or undefined if it should not be represented (for instance, while it is being created).

Type: object

highlightStyle()

Description:

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

Source:

annotation/annotation.js, line 630

Inherited From:

geo.annotation#highlightStyle

id() → {number}

Description:

Get a unique annotation id.

Source:

annotation/annotation.js, line 153

Inherited From:

geo.annotation#id

Returns:

The annotation id.

Type: number

label(argopt, noFallbackopt) → {this|string}

Description:

Get or set the label of this annotation.

Source:

annotation/annotation.js, line 199

Inherited From:

geo.annotation#label

Parameters:

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

The current label or this annotation.

Type: this | string

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

Description:

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

Source:

annotation/annotation.js, line 260

Inherited From:

geo.annotation#labelRecord

Returns:

A label record, or undefined if it should not be shown.

Type: geo.annotationLayer.labelRecord | undefined

labelStyle()

Description:

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

Source:

annotation/annotation.js, line 624

Inherited From:

geo.annotation#labelStyle

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

Description:

Get or set the annotation layer associated with this annotation.

Source:

annotation/annotation.js, line 309

Inherited From:

geo.annotation#layer

Parameters:

Name	Type	Description
`arg`	geo.annotationLayer \| undefined	if undefined, return the layer, otherwise change it.

Returns:

the current layer or this annotation.

Type: this | geo.annotationLayer

modified() → {this}

Description:

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

Source:

annotation/annotation.js, line 779

Inherited From:

geo.annotation#modified

Returns:

The annotation.

Type: this

mouseClick(evt) → {boolean|string}

Description:

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

Source:

annotation/annotation.js, line 706

Inherited From:

geo.annotation#mouseClick

Parameters:

Name	Type	Description
`evt`	geo.event	The mouse click event.

Returns:

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.

Type: boolean | string

mouseClickEdit(evt) → {boolean|string}

Description:

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.

Source:

annotation/annotation.js, line 721

Inherited From:

geo.annotation#mouseClickEdit

Parameters:

Name	Type	Description
`evt`	geo.event	The mouse click event.

Returns:

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.

Type: boolean | string

mouseMove(evt) → {boolean}

Description:

Handle a mouse move on this annotation.

Source:

annotation/annotation.js, line 732

Inherited From:

geo.annotation#mouseMove

Parameters:

Name	Type	Description
`evt`	geo.event	The mouse move event.

Returns:

Truthy to update the annotation, falsy to not update anything.

Type: boolean

name(argopt) → {this|string}

Description:

Get or set the name of this annotation.

Source:

annotation/annotation.js, line 176

Inherited From:

geo.annotation#name

Parameters:

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

The current name or this annotation.

Type: this | string

newId() → {this}

Description:

Assign a new id to this annotation.

Source:

annotation/annotation.js, line 162

Inherited From:

geo.annotation#newId

Returns:

Type: this

options(arg1opt, arg2opt) → {object|this}

Description:

Get or set options.

Source:

annotation/annotation.js, line 518

Inherited From:

geo.annotation#options

Parameters:

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

geo.event.annotation.coordinates

Returns:

If options are set, return the annotation, otherwise return the requested option or the set of options.

Type: object | this

processAction(evt) → {boolean|string}

Description:

Process any non-edit actions for this annotation.

Source:

annotation/annotation.js, line 423

Inherited From:

geo.annotation#processAction

Parameters:

Name	Type	Description
`evt`	geo.event	The action event.

Returns:

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.

Type: boolean | string

processEditAction(evt) → {boolean}

Description:

Process any edit actions for this annotation.

Source:

annotation/annotation.js, line 434

Inherited From:

geo.annotation#processEditAction

Parameters:

Name	Type	Description
`evt`	geo.event	The action event.

Returns:

true to update the annotation, falsy to not update anything.

Type: boolean

selectEditHandle(handle, enable) → {this}

Description:

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.

Source:

annotation/annotation.js, line 478

Inherited From:

geo.annotation#selectEditHandle

Parameters:

Name	Type	Description
`handle`	object	The data for the edit handle.
`enable`	boolean	True to enable the handle, false to disable.

Fires:

geo.event.annotation.select_edit_handle

Returns:

Type: this

state(argopt) → {this|string}

Description:

Get or set the state of this annotation.

Source:

annotation/annotation.js, line 347

Inherited From:

geo.annotation#state

Parameters:

Name	Type	Attributes	Description
`arg`	string \| undefined	<optional>	If `undefined`, return the state, otherwise change it. This should be one of the `geo.annotation.state` values.

Fires:

geo.event.annotation.state

Returns:

The current state or this annotation.

Type: this | string

style(arg1opt, arg2opt, styleTypeopt) → {object|this}

Description:

Get or set style.

Source:

annotation/annotation.js, line 586

Inherited From:

geo.annotation#style

Parameters:

Name	Type	Attributes	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	<optional>	`'style'`	The name of the style type, such as `createStyle`, `editStyle`, `editHandleStyle`, `labelStyle`, `highlightStyle`, or `cursorStyle`.