LabelSpec

Label style specification

Source

Members

alignment :string|Vector2

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

Type:
Source

backgroundColor :ColorSpec

color of background, default black

Type:
Source

backgroundImage :any

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

Type:
  • any
Source

backgroundOpacity :number

opacity of background, default 1.0

Type:
  • number
Source

borderColor :ColorSpec

color of border, default backgroundColor

Type:
Source

borderOpacity :number

opacity of border

Type:
  • number
Source

borderThickness :number

line width of border around label, default 0

Type:
  • number
Source

font :string

font name, default sans-serif

Type:
  • string
Source

fontColor :ColorSpec

font color, default white

Type:
Source

fontOpacity :number

font opacity, default 1

Type:
  • number
Source

fontSize :number

height of text, default 18

Type:
  • number
Source

frame :number

if set, only display in this frame of an animation

Type:
  • number
Source

inFront :boolean

always put labels in front of model

Type:
  • boolean
Source

position :XYZ

coordinates for label

Type:
Source

screenOffset :Vector2

x,y,z pixel offset of label from position; for screen labels z is a z-index

Type:
Source

showBackground :boolean

show background rounded rectangle, default true

Type:
  • boolean
Source

useScreen :boolean

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

Type:
  • boolean
Source