jsx3.chart.ChartLabelAPI


Object
Object TypeThe JSX foundation class that this object is an instance of.
IDThe unique, system-assigned ID for this object.
NameSets the name assigned by the developer to identify this object.
Positioning
WidthSets the preferred width of this component in pixels.
HeightSets the preferred height of this component in pixels.
ChartLabel
TextSets the text to display in this component.
RotationSets the rotation of this component.
Font
Font NameSets the name of the font family.
Font SizeSets the point size of the font.
Font WeightSets the weight of the font, such as bold or normal.
ColorSets the color of the font.
Box
BG ColorSets the background fill color of this label box.
Border StrokeSets the vector stroke outlining this label box, specified as color width alpha.
BG AlphaSets the alpha of the background fill (0.0 - 1.0).
Text AlignSets the text alignment for the label text.
PaddingSets the white-space gap between this label box and the label text.
Component
DisplayUsed to hide this chart component without removing it from the DOM hierarchy.
Interaction
Bound MenuSets the jsxname property for the context menu instance to display on a right-click.

Object Type

Read-Only. The JSX foundation class that this object is an instance of.

ID

Read-Only. The unique, system-assigned ID for this object.
Getter: getId()

Name

Sets the name assigned by the developer to identify this object.
Getter: getName()
Setter: setName()
Property: jsxname

Width

Sets the preferred width of this component in pixels. If the title placement is right or left, only width is considered and height is ignored.
Default Value: Automatically calculated from size of font and padding
Getter: getPreferredWidth()
Setter: setPreferredWidth()
Property: preferredWidth

Height

Sets the preferred height of this component in pixels. If the title placement is top or bottom, only height is considered and width is ignored.
Default Value: Automatically calculated from size of font and padding
Getter: getPreferredHeight()
Setter: setPreferredHeight()
Property: preferredHeight

Text

Sets the text to display in this component.
Default Value: Empty
Getter: getText()
Setter: setText()
Property: jsxtext

Rotation

Sets the rotation of this component.
Default Value: NONE (jsx3.chart.ChartLabel.ROTATION_NORMAL)
Getter: getLabelRotation()
Setter: setLabelRotation()
Property: labelRotation
Allowed Values:

Font Name

Sets the name of the font family.
Default Value: jsx3.gui.Block.DEFAULTFONTNAME
Getter: getFontName()
Setter: setFontName()
Property: jsxfontname

Font Size

Sets the point size of the font.
Default Value: jsx3.gui.Block.DEFAULTFONTSIZE
Getter: getFontSize()
Setter: setFontSize()
Property: jsxfontsize

Font Weight

Sets the weight of the font, such as bold or normal.
Default Value: Normal (jsx3.gui.Block.FONTNORMAL)
Getter: getFontWeight()
Setter: setFontWeight()
Property: jsxfontweight
Allowed Values:

Color

Sets the color of the font. Accepts CSS values, such as predefined color names, RGB, or hexadecimal values. For example, red, rgb(255,0,0), or #ff0000.
Default Value: jsx3.gui.Block.DEFAULTCOLOR
Getter: getColor()
Setter: setColor()
Property: jsxcolor

BG Color

Sets the background fill color of this label box. Accepts valid CSS values, such as predefined color names, RGB, or hexadecimal values. For example, red, rgb(255,0,0), or #ff0000.
Default Value: Empty
Getter: getBackgroundColor()
Setter: setBackgroundColor()
Property: jsxbgcolor

Border Stroke

Sets the vector stroke outlining this label box, specified as color width alpha. For example, black 1 1.
Default Value: Emtpy
Getter: getBorderStroke()
Setter: setBorderStroke()
Property: borderStroke

BG Alpha

Sets the alpha of the background fill (0.0 - 1.0).
Default Value: 1
Getter: getAlpha()
Setter: setAlpha()
Property: alpha

Text Align

Sets the text alignment for the label text.
Default Value: left (jsx3.gui.Block.ALIGNLEFT)
Getter: getTextAlign()
Setter: setTextAlign()
Property: jsxtextalign
Allowed Values:
  • left (jsx3.gui.Block.ALIGNLEFT)
  • right (jsx3.gui.Block.ALIGNRIGHT)
  • center (jsx3.gui.Block.ALIGNCENTER)

Padding

Sets the white-space gap between this label box and the label text. Specified as either one or four pixel values (top, right, bottom, and left). For example, 2 or 4 2 4 2. CSS syntax is also supported but reduces performance.
Default Value: 0
Getter: getPadding()
Setter: setPadding()
Property: jsxpadding

Display

Used to hide this chart component without removing it from the DOM hierarchy.
Default Value: Block (jsx3.gui.Block.DISPLAYBLOCK)
Getter: getDisplay()
Setter: setDisplay()
Property: jsxdisplay
Allowed Values:
  • Block (jsx3.gui.Block.DISPLAYBLOCK)
  • None (jsx3.gui.Block.DISPLAYNONE)

Bound Menu

Sets the jsxname property for the context menu instance to display on a right-click.
Getter: getMenu()
Setter: setMenu()
Property: jsxmenu