jsx3.chart.LegendAPI
| Object |
|---|
| Object Type | The JSX foundation class that this object is an instance of. |
| ID | The unique, system-assigned ID for this object. |
| Name | Sets the name assigned by the developer to identify this object. |
| Positioning |
|---|
| Width | Sets the preferred width of this component in pixels. |
| Height | Sets the preferred height of this component in pixels. |
| Label |
|---|
| Box Height | Sets the height of the colored series box. |
| Line Height | Sets the height of each line in this legend. |
| Label CSS Class | Sets the CSS style class of the labels. |
| Label CSS Styles | Sets the CSS style attributes for the labels. |
| Box |
|---|
| Padding | Sets the gap between legend border and legend content. |
| Margin | Sets the gap between legend border and bounding box. |
| Background Fill | Sets the vector fill to use for the background of this legend box. |
| Background Stroke | Sets the vector stroke to use for the background of the legend box. |
| Component |
|---|
| Display | Used to hide this chart component without removing it from the DOM hierarchy. |
| Interaction |
|---|
| Bound Menu | Sets the jsxname property for the context menu instance to display on a right-click. |
Read-Only. The JSX foundation class that this object is an instance of.
Read-Only. The unique, system-assigned ID for this object.
Getter: getId()
Sets the name assigned by the developer to identify this object.
Getter: getName()
Setter: setName()
Property: jsxname
Sets the preferred width of this component in pixels. If the legend placement is at left or right, only width is considered and height is ignored.
Default Value: DEFAULT_WIDTH (jsx3.chart.Legend.DEFAULT_WIDTH)
Getter: getPreferredWidth()
Setter: setPreferredWidth()
Property: preferredWidth
Sets the preferred height of this component in pixels. If the legend placement is at top or bottom, only height is considered and width is ignored.
Default Value: DEFAULT_HEIGHT (jsx3.chart.Legend.DEFAULT_HEIGHT)
Getter: getPreferredHeight()
Setter: setPreferredHeight()
Property: preferredHeight
Sets the height of the colored series box.
Default Value: 0
Getter: getBoxHeight()
Setter: setBoxHeight()
Property: boxHeight
Sets the height of each line in this legend.
Default Value: 0
Getter: getLineHeight()
Setter: setLineHeight()
Property: lineHeight
Sets the CSS style class of the labels. Do not include the leading dot (.) when entering the name.
Default Value: Empty
Getter: getLabelClass()
Setter: setLabelClass()
Property: labelClass
Sets the CSS style attributes for the labels.
Default Value: Empty
Getter: getLabelStyle()
Setter: setLabelStyle()
Property: labelStyle
Sets the gap between legend border and legend content. Specified as 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
Sets the gap between legend border and bounding box. Specified as 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: getMargin()
Setter: setMargin()
Property: jsxmargin
Sets the vector fill to use for the background of this legend box. Specified as color alpha. For example, black 1.
Default Value: Empty
Getter: getBackgroundFill()
Setter: setBackgroundFill()
Property: backgroundFill
Sets the vector stroke to use for the background of the legend box. Specified as color alpha. For example, black 1 1.
Default Value: Empty
Getter: getBackgroundStroke()
Setter: setBackgroundStroke()
Property: backgroundStroke
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)
Sets the jsxname property for the context menu instance to display on a right-click.
Getter: getMenu()
Setter: setMenu()
Property: jsxmenu
Copyright © 2001-2007, TIBCO Software Inc.