Class: OutlineTag

classdesc Tag holding properties for visualizing a geometry outline.

example

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

Hierarchy#

Tag
↳ OutlineTag

Constructors#

constructor#

• new OutlineTag(id, geometry, options?)

Create an outline tag.

override

Parameters#

Name	Type	Description
`id`	`string`	Unique identifier of the tag.
`geometry`	`VertexGeometry`	Geometry defining vertices of tag.
`options?`	`OutlineTagOptions`	Options defining the visual appearance and behavior of the outline tag.

Overrides#

Tag.constructor

Defined in#

component/tag/tag/OutlineTag.ts:58

Events#

on#

• on(type, handler): void

Event fired when the icon of the outline tag is clicked.

example

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

Parameters#

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

Returns#

void

Overrides#

Tag.on

Defined in#

component/tag/tag/OutlineTag.ts:402

• 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#

Tag.on

Defined in#

component/tag/tag/OutlineTag.ts:419

• 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/OutlineTag.ts:436

Accessors#

click$#

• get click$(): Subject<OutlineTag>

Click observable.

description An observable emitting the tag when the icon of the tag has been clicked.

Returns#

Subject<OutlineTag>

Defined in#

component/tag/tag/OutlineTag.ts:104

domain#

• get domain(): TagDomain

Get domain property.

description Readonly property that can only be set in constructor.

Returns#

TagDomain

Value indicating the domain of the tag.

Defined in#

component/tag/tag/OutlineTag.ts:115

editable#

• get editable(): boolean

Get editable property.

Returns#

boolean

Value indicating if tag is editable.

Defined in#

component/tag/tag/OutlineTag.ts:123

• 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/OutlineTag.ts:133

fillColor#

• get fillColor(): number

Get fill color property.

Returns#

number

Defined in#

component/tag/tag/OutlineTag.ts:146

• set fillColor(value): void

Set fill color property.

fires changed

Parameters#

Name	Type
`value`	`number`

Returns#

void

Defined in#

component/tag/tag/OutlineTag.ts:156

fillOpacity#

• get fillOpacity(): number

Get fill opacity property.

Returns#

number

Defined in#

component/tag/tag/OutlineTag.ts:165

• set fillOpacity(value): void

Set fill opacity property.

fires changed

Parameters#

Name	Type
`value`	`number`

Returns#

void

Defined in#

component/tag/tag/OutlineTag.ts:175

geometry#

• get geometry(): VertexGeometry

inheritdoc

Returns#

VertexGeometry

Defined in#

component/tag/tag/OutlineTag.ts:181

icon#

• get icon(): string

Get icon property.

Returns#

string

Defined in#

component/tag/tag/OutlineTag.ts:189

• set icon(value): void

Set icon property.

fires changed

Parameters#

Name	Type
`value`	`string`

Returns#

void

Defined in#

component/tag/tag/OutlineTag.ts:199

iconFloat#

• get iconFloat(): Alignment

Get icon float property.

Returns#

Alignment

Defined in#

component/tag/tag/OutlineTag.ts:208

• set iconFloat(value): void

Set icon float property.

fires changed

Parameters#

Name	Type
`value`	`Alignment`

Returns#

void

Defined in#

component/tag/tag/OutlineTag.ts:218

iconIndex#

• get iconIndex(): number

Get icon index property.

Returns#

number

Defined in#

component/tag/tag/OutlineTag.ts:227

• set iconIndex(value): void

Set icon index property.

fires changed

Parameters#

Name	Type
`value`	`number`

Returns#

void

Defined in#

component/tag/tag/OutlineTag.ts:237

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/OutlineTag.ts:247

• 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/OutlineTag.ts:257

lineColor#

• get lineColor(): number

Get line color property.

Returns#

number

Defined in#

component/tag/tag/OutlineTag.ts:266

• set lineColor(value): void

Set line color property.

fires changed

Parameters#

Name	Type
`value`	`number`

Returns#

void

Defined in#

component/tag/tag/OutlineTag.ts:276

lineOpacity#

• get lineOpacity(): number

Get line opacity property.

Returns#

number

Defined in#

component/tag/tag/OutlineTag.ts:285

• set lineOpacity(value): void

Set line opacity property.

fires changed

Parameters#

Name	Type
`value`	`number`

Returns#

void

Defined in#

component/tag/tag/OutlineTag.ts:295

lineWidth#

• get lineWidth(): number

Get line width property.

Returns#

number

Defined in#

component/tag/tag/OutlineTag.ts:304

• set lineWidth(value): void

Set line width property.

fires changed

Parameters#

Name	Type
`value`	`number`

Returns#

void

Defined in#

component/tag/tag/OutlineTag.ts:314

text#

• get text(): string

Get text property.

Returns#

string

Defined in#

component/tag/tag/OutlineTag.ts:323

• set text(value): void

Set text property.

fires changed

Parameters#

Name	Type
`value`	`string`

Returns#

void

Defined in#

component/tag/tag/OutlineTag.ts:333

textColor#

• get textColor(): number

Get text color property.

Returns#

number

Defined in#

component/tag/tag/OutlineTag.ts:342

• set textColor(value): void

Set text color property.

fires changed

Parameters#

Name	Type
`value`	`number`

Returns#

void

Defined in#

component/tag/tag/OutlineTag.ts:352

Methods#

fire#

▸ fire(type, event): void

Parameters#

Name	Type
`type`	`TagEventType`
`event`	`TagStateEvent`

Returns#

void

Overrides#

Tag.fire

Defined in#

../doc/component/tag/tag/OutlineTag.ts:357

off#

▸ off(type, handler): void

Unsubscribe from an event by its name.

Parameters#

Name	Type
`type`	`TagEventType`
`handler`	(`event`: `TagStateEvent`) => `void`

Returns#

void

Overrides#

Tag.off

Defined in#

../doc/component/tag/tag/OutlineTag.ts:373

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`	`OutlineTagOptions`	Outline tag options

Returns#

void

Defined in#

component/tag/tag/OutlineTag.ts:457