Class: Tag

component.Tag

abstract

classdesc Abstract class representing the basic functionality of for a tag.

Hierarchy

• EventEmitter

  ↳ Tag

  ↳↳ ExtremePointTag

  ↳↳ OutlineTag

  ↳↳ SpotTag

Constructors

constructor

• new Tag(id, geometry)

Create a tag.

Parameters

Name	Type
id	string
geometry	Geometry

Overrides

EventEmitter.constructor

Defined in

component/tag/tag/Tag.ts:33

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

Overrides

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

Defined in

component/tag/tag/Tag.ts:164

Accessors

geometry

• get geometry(): Geometry

Get geometry property.

Returns

Geometry

The geometry of the tag.

Defined in

component/tag/tag/Tag.ts:76

---

id

• get id(): string

Get id property.

Returns

string

Defined in

component/tag/tag/Tag.ts:68

Methods

fire

▸ fire(type, event): void

Parameters

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

Returns

void

Overrides

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

Overrides

EventEmitter.off

Defined in

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