# Interface: ContainedLabelOptions

# Hierarchy

# Properties

# backgroundColor

Optional backgroundColor: Scriptable<Color, PartialEventContext>

# Defined in

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


# borderCapStyle

Optional borderCapStyle: Scriptable<CanvasLineCap, PartialEventContext>

Border line cap style. See MDN.

Default

'butt'

# Defined in

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


# borderColor

Optional borderColor: Scriptable<Color, PartialEventContext>

# Defined in

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


# borderDash

Optional borderDash: Scriptable<number[], PartialEventContext>

Border line dash. See MDN.

Default

[]

# Defined in

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


# borderDashOffset

Optional borderDashOffset: Scriptable<number, PartialEventContext>

Border line dash offset. See MDN.

Default

0.0

# Defined in

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


# borderJoinStyle

Optional borderJoinStyle: Scriptable<CanvasLineJoin, PartialEventContext>

Border line join style. See MDN.

Default

'miter'

# Defined in

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


# borderRadius

Optional borderRadius: Scriptable<number | BorderRadius, PartialEventContext>

Border radius of the label rectangle

Default

6

# Defined in

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


# borderWidth

Optional borderWidth: Scriptable<number, PartialEventContext>

# Defined in

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


# color

Optional color: Scriptable<Color, PartialEventContext>

# Inherited from

CoreLabelOptions.color

# Defined in

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


# content

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

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

# Inherited from

CoreLabelOptions.content

# Defined in

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


# drawTime

Optional drawTime: Scriptable<DrawTime, PartialEventContext>

# Inherited from

CoreLabelOptions.drawTime

# Defined in

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


# font

Optional font: FontSpec

# Inherited from

CoreLabelOptions.font

# Defined in

label.d.ts:26 (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:67 (opens new window)


# padding

Optional padding: Scriptable<number | LabelPadding, PartialEventContext>

Padding of label

Default

6

# Inherited from

CoreLabelOptions.padding

# Defined in

label.d.ts:32 (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:37 (opens new window)


# textStrokeColor

Optional textStrokeColor: Scriptable<Color, PartialEventContext>

# Inherited from

CoreLabelOptions.textStrokeColor

# Defined in

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


# textStrokeWidth

Optional textStrokeWidth: Scriptable<number, PartialEventContext>

# Inherited from

CoreLabelOptions.textStrokeWidth

# Defined in

label.d.ts:39 (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:62 (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:46 (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:53 (opens new window)


# z

Optional z: Scriptable<number, PartialEventContext>

# Inherited from

CoreLabelOptions.z

# Defined in

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