# Interface: CoreLabelOptions
# Hierarchy
CoreLabelOptions
# Properties
# color
• Optional color: Scriptable<Color, PartialEventContext>
# 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
# Defined in
label.d.ts:57 (opens new window)
# drawTime
• Optional drawTime: Scriptable<DrawTime, PartialEventContext>
# Defined in
label.d.ts:25 (opens new window)
# font
• Optional font: FontSpec
# 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
# Defined in
label.d.ts:67 (opens new window)
# padding
• Optional padding: Scriptable<number | LabelPadding, PartialEventContext>
Padding of label
Default
6
# 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'
# Defined in
label.d.ts:37 (opens new window)
# textStrokeColor
• Optional textStrokeColor: Scriptable<Color, PartialEventContext>
# Defined in
label.d.ts:38 (opens new window)
# textStrokeWidth
• Optional textStrokeWidth: Scriptable<number, PartialEventContext>
# 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
# 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
# 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
# Defined in
label.d.ts:53 (opens new window)
# z
• Optional z: Scriptable<number, PartialEventContext>