# Interface: BoxLabelOptions

# Hierarchy

# Properties

# color

Optional color: Scriptable<Color | Color[], PartialEventContext>

# Inherited from

CoreLabelOptions.color

# Defined in

label.d.ts:43 (opens new window)


# content

content: Scriptable<string | string[] | HTMLCanvasElement | HTMLImageElement, PartialEventContext>

Text to display in label. Provide an array to display multiple lines

# Inherited from

CoreLabelOptions.content

# Defined in

label.d.ts:73 (opens new window)


# display

Optional display: Scriptable<boolean, PartialEventContext>

Whether the label should be displayed

Default

true

# Defined in

label.d.ts:143 (opens new window)


# drawTime

Optional drawTime: Scriptable<DrawTime, PartialEventContext>

# Inherited from

CoreLabelOptions.drawTime

# Defined in

label.d.ts:41 (opens new window)


# font

Optional font: Scriptable<Partial<FontSpec> | Partial<FontSpec>[], PartialEventContext>

# Inherited from

CoreLabelOptions.font

# Defined in

label.d.ts:42 (opens new window)


# height

Optional height: Scriptable<number | `${number}%`, PartialEventContext>

Overrides the height of the image. Could be set in pixel by a number, or in percentage of current height of image by a string

# Inherited from

CoreLabelOptions.height

# Defined in

label.d.ts:83 (opens new window)


# opacity

Optional opacity: Scriptable<number, PartialEventContext>

Overrides the opacity of the image.

# Inherited from

CoreLabelOptions.opacity

# Defined in

label.d.ts:87 (opens new window)


# padding

Optional padding: Scriptable<number | LabelPadding, PartialEventContext>

Padding of label

Default

6

# Inherited from

CoreLabelOptions.padding

# Defined in

label.d.ts:48 (opens new window)


# position

Optional position: Scriptable<LabelPosition | LabelPositionObject, PartialEventContext>

# Defined in

label.d.ts:138 (opens new window)


# rotation

Optional rotation: Scriptable<number, PartialEventContext>

# Defined in

label.d.ts:144 (opens new window)


# textAlign

Optional textAlign: Scriptable<LabelTextAlign, PartialEventContext>

Text alignment when the content of the label is multi-line.

Default

'center'

# Inherited from

CoreLabelOptions.textAlign

# Defined in

label.d.ts:53 (opens new window)


# textStrokeColor

Optional textStrokeColor: Scriptable<Color, PartialEventContext>

# Inherited from

CoreLabelOptions.textStrokeColor

# Defined in

label.d.ts:54 (opens new window)


# textStrokeWidth

Optional textStrokeWidth: Scriptable<number, PartialEventContext>

# Inherited from

CoreLabelOptions.textStrokeWidth

# Defined in

label.d.ts:55 (opens new window)


# width

Optional width: Scriptable<number | `${number}%`, PartialEventContext>

Overrides the width of the image. Could be set in pixel by a number, or in percentage of current width of image by a string

# Inherited from

CoreLabelOptions.width

# Defined in

label.d.ts:78 (opens new window)


# xAdjust

Optional xAdjust: Scriptable<number, PartialEventContext>

Adjustment along x-axis (left-right) of label relative to above number (can be negative) For horizontal lines positioned left or right, negative values move the label toward the edge, and positive values toward the center.

Default

0

# Inherited from

CoreLabelOptions.xAdjust

# Defined in

label.d.ts:62 (opens new window)


# yAdjust

Optional yAdjust: Scriptable<number, PartialEventContext>

Adjustment along y-axis (top-bottom) of label relative to above number (can be negative) For vertical lines positioned top or bottom, negative values move the label toward the edge, and positive values toward the center.

Default

0

# Inherited from

CoreLabelOptions.yAdjust

# Defined in

label.d.ts:69 (opens new window)


# z

Optional z: Scriptable<number, PartialEventContext>

# Inherited from

CoreLabelOptions.z

# Defined in

label.d.ts:88 (opens new window)