Interface: OutlineTagOptions
component.OutlineTagOptions
Interface for the options that define the behavior and appearance of the outline tag.
interface
Properties#
domain#
• Optional domain: TagDomain
The domain where lines between vertices are treated as straight.
description Only applicable for tags that renders polygons.
If the domain is specified as two dimensional, editing of the polygon will be disabled.
default {TagDomain.TwoDimensional}
Defined in#
component/tag/interfaces/OutlineTagOptions.ts:21
editable#
• Optional editable: boolean
Indicate whether the tag geometry should be editable.
description Polygon tags with two dimensional domain
are never editable.
default false
Defined in#
component/tag/interfaces/OutlineTagOptions.ts:31
fillColor#
• Optional fillColor: number
Color for the interior fill as a hexadecimal number.
default 0xFFFFFF
Defined in#
component/tag/interfaces/OutlineTagOptions.ts:37
fillOpacity#
• Optional fillOpacity: number
Opacity of the interior fill between 0 and 1.
default 0.3
Defined in#
component/tag/interfaces/OutlineTagOptions.ts:43
icon#
• Optional icon: string
A string referencing the sprite data property to pull from.
description Icon is not shown for tags with polygon
geometries in spherical.
Defined in#
component/tag/interfaces/OutlineTagOptions.ts:51
iconFloat#
• Optional iconFloat: Alignment
Value determining how the icon will float with respect to its anchor position when rendering.
default {Alignment.Center}
Defined in#
component/tag/interfaces/OutlineTagOptions.ts:59
iconIndex#
• Optional iconIndex: number
Number representing the index for where to show the icon or text for a rectangle geometry.
description The default index corresponds to the bottom right corner.
default 3
Defined in#
component/tag/interfaces/OutlineTagOptions.ts:69
indicateVertices#
• Optional indicateVertices: boolean
Determines whether vertices should be indicated by points when tag is editable.
default true
Defined in#
component/tag/interfaces/OutlineTagOptions.ts:77
lineColor#
• Optional lineColor: number
Color for the edge lines as a hexadecimal number.
default 0xFFFFFF
Defined in#
component/tag/interfaces/OutlineTagOptions.ts:83
lineOpacity#
• Optional lineOpacity: number
Opacity of the edge lines on [0, 1].
default 1
Defined in#
component/tag/interfaces/OutlineTagOptions.ts:89
lineWidth#
• Optional lineWidth: number
Line width in pixels.
default 1
Defined in#
component/tag/interfaces/OutlineTagOptions.ts:95
text#
• Optional text: string
Text shown as label if no icon is provided.
description Text is not shown for tags with
polygon geometries in spherical.
Defined in#
component/tag/interfaces/OutlineTagOptions.ts:103
textColor#
• Optional textColor: number
Text color as hexadecimal number.
default 0xFFFFFF