Interface

LabelSpec

LabelSpec

Label style specification

View Source Label.ts, line 230

Members

string

# alignment Optional

how to orient the label w/respect to position: topLeft (default), topCenter, topRight, centerLeft, center, centerRight, bottomLeft, bottomCenter, bottomRight

View Source Label.ts, line 308

ColorSpec

# backgroundColor Optional

color of background, default black

View Source Label.ts, line 268

any

# backgroundImage Optional

An elment to draw into the label. Any CanvasImageSource is allowed. Label is resized to size of image

View Source Label.ts, line 303

number

# backgroundOpacity Optional

opacity of background, default 1.0

View Source Label.ts, line 273

ColorSpec

# borderColor Optional

color of border, default backgroundColor

View Source Label.ts, line 258

number

# borderOpacity Optional

opacity of border

View Source Label.ts, line 263

number

# borderThickness Optional

line width of border around label, default 0

View Source Label.ts, line 253

string

# font Optional

font name, default sans-serif

View Source Label.ts, line 233

ColorSpec

# fontColor Optional

font color, default white

View Source Label.ts, line 243

number

# fontOpacity Optional

font opacity, default 1

View Source Label.ts, line 248

number

# fontSize Optional

height of text, default 18

View Source Label.ts, line 238

number

# frame Optional

if set, only display in this frame of an animation

View Source Label.ts, line 313

boolean

# inFront Optional

always put labels in front of model

View Source Label.ts, line 288

XYZ

# position Optional

coordinates for label

View Source Label.ts, line 278

Vector2

# screenOffset Optional

x,y pixel offset of label from position

View Source Label.ts, line 283

boolean

# showBackground Optional

show background rounded rectangle, default true

View Source Label.ts, line 293

boolean

# useScreen Optional

position is in screen (not model) coordinates which are pixel offsets from the upper left corner

View Source Label.ts, line 298