Class: ExtremePointTag

component.ExtremePointTag

classdesc Tag holding properties for visualizing a extreme points and their outline.

example

var geometry = new PointsGeometry([[0.3, 0.3], [0.5, 0.4]]);var tag = new ExtremePointTag(    "id-1",    geometry    { editable: true, lineColor: 0xff0000 });
tagComponent.add([tag]);

Hierarchy

• Tag

  ↳ ExtremePointTag

Constructors

constructor

• new ExtremePointTag(id, geometry, options?)

Create an extreme point tag.

override

Parameters

Name	Type	Description
id	string	Unique identifier of the tag.
geometry	PointsGeometry	Geometry defining points of tag.
options?	ExtremePointTagOptions	Options defining the visual appearance and behavior of the extreme point tag.

Overrides

Tag.constructor

Defined in

component/tag/tag/ExtremePointTag.ts:43

Events

on

• on(type, handler): void

Event fired when the geometry of the tag has changed.

example

var tag = new OutlineTag({ // tag options });// Set an event listenertag.on('geometry', function() {  console.log("A geometry event has occurred.");});

Parameters

Name	Type
type	"geometry"
handler	(event: TagStateEvent) => void

Returns

void

Inherited from

Tag.on

Defined in

component/tag/tag/Tag.ts:147

• on(type, handler): void

Event fired when a tag has been updated.

example

var tag = new OutlineTag({ // tag options });// Set an event listenertag.on('tag', function() {  console.log("A tag event has occurred.");});

Parameters

Name	Type
type	"tag"
handler	(event: TagStateEvent) => void

Returns

void

Inherited from

Tag.on

Defined in

component/tag/tag/Tag.ts:164

Accessors

editable

• get editable(): boolean

Get editable property.

Returns

boolean

Value indicating if tag is editable.

Defined in

component/tag/tag/ExtremePointTag.ts:61

• set editable(value): void

Set editable property.

fires changed

Parameters

Name	Type
value	boolean

Returns

void

Value indicating if tag is editable.

Defined in

component/tag/tag/ExtremePointTag.ts:71

---

fillColor

• get fillColor(): number

Get fill color property.

Returns

number

Defined in

component/tag/tag/ExtremePointTag.ts:80

• set fillColor(value): void

Set fill color property.

fires changed

Parameters

Name	Type
value	number

Returns

void

Defined in

component/tag/tag/ExtremePointTag.ts:90

---

fillOpacity

• get fillOpacity(): number

Get fill opacity property.

Returns

number

Defined in

component/tag/tag/ExtremePointTag.ts:99

• set fillOpacity(value): void

Set fill opacity property.

fires changed

Parameters

Name	Type
value	number

Returns

void

Defined in

component/tag/tag/ExtremePointTag.ts:109

---

geometry

• get geometry(): PointsGeometry

inheritdoc

Returns

PointsGeometry

Defined in

component/tag/tag/ExtremePointTag.ts:115

---

id

• get id(): string

Get id property.

Returns

string

Defined in

component/tag/tag/Tag.ts:68

---

indicateVertices

• get indicateVertices(): boolean

Get indicate vertices property.

Returns

boolean

Value indicating if vertices should be indicated when tag is editable.

Defined in

component/tag/tag/ExtremePointTag.ts:124

• set indicateVertices(value): void

Set indicate vertices property.

fires changed

Parameters

Name	Type
value	boolean

Returns

void

Value indicating if vertices should be indicated when tag is editable.

Defined in

component/tag/tag/ExtremePointTag.ts:134

---

lineColor

• get lineColor(): number

Get line color property.

Returns

number

Defined in

component/tag/tag/ExtremePointTag.ts:143

• set lineColor(value): void

Set line color property.

fires changed

Parameters

Name	Type
value	number

Returns

void

Defined in

component/tag/tag/ExtremePointTag.ts:153

---

lineOpacity

• get lineOpacity(): number

Get line opacity property.

Returns

number

Defined in

component/tag/tag/ExtremePointTag.ts:162

• set lineOpacity(value): void

Set line opacity property.

fires changed

Parameters

Name	Type
value	number

Returns

void

Defined in

component/tag/tag/ExtremePointTag.ts:172

---

lineWidth

• get lineWidth(): number

Get line width property.

Returns

number

Defined in

component/tag/tag/ExtremePointTag.ts:181

• set lineWidth(value): void

Set line width property.

fires changed

Parameters

Name	Type
value	number

Returns

void

Defined in

component/tag/tag/ExtremePointTag.ts:191

Methods

fire

▸ fire(type, event): void

Parameters

Name	Type
type	"tag" | "geometry"
event	TagStateEvent

Returns

void

Inherited from

Tag.fire

Defined in

../doc/component/tag/tag/Tag.ts:103

---

off

▸ off(type, handler): void

Unsubscribe from an event by its name.

Parameters

Name	Type
type	"tag" | "geometry"
handler	(event: TagStateEvent) => void

Returns

void

Inherited from

Tag.off

Defined in

../doc/component/tag/tag/Tag.ts:118

---

setOptions

▸ setOptions(options): void

Set options for tag.

description Sets all the option properties provided and keeps the rest of the values as is.

fires changed

Parameters

Name	Type	Description
options	ExtremePointTagOptions	Extreme point tag options

Returns

void

Defined in

component/tag/tag/ExtremePointTag.ts:206