Class: Tag
component.Tag
abstract
classdesc
Abstract class representing the basic functionality of for a tag.
#
Hierarchy↳
Tag
↳↳
ExtremePointTag
↳↳
OutlineTag
↳↳
SpotTag
#
Constructors#
constructor• new Tag(id
, geometry
)
Create a tag.
#
ParametersName | Type |
---|---|
id | string |
geometry | Geometry |
#
Overrides#
Defined in#
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.");});
#
ParametersName | Type |
---|---|
type | "geometry" |
handler | (event : TagStateEvent ) => void |
#
Returnsvoid
#
Overrides#
Defined in• 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.");});
#
ParametersName | Type |
---|---|
type | "tag" |
handler | (event : TagStateEvent ) => void |
#
Returnsvoid
#
Defined in#
Accessors#
geometry• get
geometry(): Geometry
Get geometry property.
#
ReturnsThe geometry of the tag.
#
Defined in#
id• get
id(): string
Get id property.
#
Returnsstring
#
Defined in#
Methods#
fireâ–¸ fire(type
, event
): void
#
ParametersName | Type |
---|---|
type | "tag" | "geometry" |
event | TagStateEvent |
#
Returnsvoid
#
OverridesEventEmitter.fire
#
Defined in../doc/component/tag/tag/Tag.ts:103
#
offâ–¸ off(type
, handler
): void
Unsubscribe from an event by its name.
#
ParametersName | Type |
---|---|
type | "tag" | "geometry" |
handler | (event : TagStateEvent ) => void |
#
Returnsvoid