jsx3.chart

class Legend

->jsx3.lang.Object

->jsx3.app.Model

->jsx3.gui.Painted

->jsx3.gui.Block

->jsx3.chart.ChartComponent

->jsx3.chart.Legend

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher

class Legend
extends jsx3.chart.ChartComponent

Chart component that renders a simple legend. A legend may contain a list of series or a list of categories, depending on the type of chart.

Field Summary
static int	DEFAULT_HEIGHT the default height
static int	DEFAULT_WIDTH the default width

Constructor Summary
void	init(name : String) The instance initializer.

Method Summary
String	getBackgroundFill() Returns the backgroundFill field, a string representation of the vector fill used to color in the background of the legend.
String	getBackgroundStroke() Returns the backgroundStroke field, a string representation of the VectorStroke used to outline the legend.
int	getBoxHeight() Returns the boxHeight field, the diameter of the box that shows the fill of each series or category.
String	getLabelClass() Returns the labelClass field, the CSS class name applied to the name of each series or category.
String	getLabelStyle() Returns the labelStyle field, a CSS style attribute applied to the name of each series or category, ie "font-family: Arial; font-size: 10px;".
jsx3.chart.ChartLabel	getLegendTitle() Find the first jsx3.chart.ChartLabel child
int	getLineHeight() Returns the lineHeight field, the vertical space taken for each legend entry.
int	getPreferredHeight() Returns the preferredHeight field, the height that this component would like to have, though its true size is dictated by the container component.
int	getPreferredWidth() Returns the preferredWidth field, the width that this component would like to have, though its true size is dictated by the container component.
static String	getVersion() Deprecated.
void	setBackgroundFill(backgroundFill : String) Sets the backgroundFill field.
void	setBackgroundStroke(backgroundStroke : String) Sets the backgroundStroke field.
void	setBoxHeight(boxHeight : int) Sets the boxHeight field.
void	setLabelClass(labelClass : String) Sets the labelClass field.
void	setLabelStyle(labelStyle : String) Sets the labelStyle field.
void	setLineHeight(lineHeight : int) Sets the lineHeight field.
void	setPreferredHeight(preferredHeight : int) Sets the preferredHeight field.
void	setPreferredWidth(preferredWidth : int) Sets the preferredWidth field.

Methods Inherited From jsx3.chart.ChartComponent
getChart

Methods Inherited From jsx3.gui.Block

getBackground, getBackgroundColor, getBorder, getCSSOverride, getClassName, getColor, getCursor, getDimensions, getDisplay, getFontName, getFontSize, getFontWeight, getHeight, getIndex, getLeft, getMargin, getOverflow, getPadding, getRelativePosition, getTagName, getText, getTextAlign, getTip, getTop, getVisibility, getWidth, getZIndex, hideMask, paint, setBackground, setBackgroundColor, setBorder, setCSSOverride, setClassName, setColor, setCursor, setDimensions, setDisplay, setFontName, setFontSize, setFontWeight, setHeight, setIndex, setLeft, setMargin, setOverflow, setPadding, setRelativePosition, setTagName, setText, setTextAlign, setTip, setTop, setVisibility, setWidth, setZIndex, showMask

Methods Inherited From jsx3.gui.Interactive
doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy

Methods Inherited From jsx3.gui.Painted
focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty

Methods Inherited From jsx3.app.Model

adoptChild, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, setChild, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc

Methods Inherited From jsx3.util.EventDispatcher
publish, subscribe, unsubscribe, unsubscribeAll

Methods Inherited From jsx3.lang.Object
clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf

Field Detail

DEFAULT_HEIGHT

static int DEFAULT_HEIGHT

the default height

DEFAULT_WIDTH

static int DEFAULT_WIDTH

the default width

Constructor Detail

init

void init(name : String)

The instance initializer.

Parameters:

name – the GI name of the instance

Method Detail

getBackgroundFill

String getBackgroundFill()

Returns the backgroundFill field, a string representation of the vector fill used to color in the background of the legend.

Returns:

backgroundFill

getBackgroundStroke

String getBackgroundStroke()

Returns the backgroundStroke field, a string representation of the VectorStroke used to outline the legend.

Returns:

backgroundStroke

getBoxHeight

int getBoxHeight()

Returns the boxHeight field, the diameter of the box that shows the fill of each series or category.

Returns:

boxHeight

getLabelClass

String getLabelClass()

Returns the labelClass field, the CSS class name applied to the name of each series or category.

Returns:

labelClass

getLabelStyle

String getLabelStyle()

Returns the labelStyle field, a CSS style attribute applied to the name of each series or category, ie "font-family: Arial; font-size: 10px;".

Returns:

labelStyle

getLegendTitle

jsx3.chart.ChartLabel getLegendTitle()

Find the first jsx3.chart.ChartLabel child

Returns:

getLineHeight

int getLineHeight()

Returns the lineHeight field, the vertical space taken for each legend entry.

Returns:

lineHeight

getPreferredHeight

int getPreferredHeight()

Returns the preferredHeight field, the height that this component would like to have, though its true size is dictated by the container component.

Returns:

preferredHeight

getPreferredWidth

int getPreferredWidth()

Returns the preferredWidth field, the width that this component would like to have, though its true size is dictated by the container component.

Returns:

preferredWidth

getVersion

static String getVersion()

Deprecated.

Returns the release/build for the class (i.e., "2.2.00").

Returns:

setBackgroundFill

void setBackgroundFill(backgroundFill : String)

Sets the backgroundFill field.

Parameters:

backgroundFill – the new value for backgroundFill

setBackgroundStroke

void setBackgroundStroke(backgroundStroke : String)

Sets the backgroundStroke field.

Parameters:

backgroundStroke – the new value for backgroundStroke

setBoxHeight

void setBoxHeight(boxHeight : int)

Sets the boxHeight field.

Parameters:

boxHeight – the new value for boxHeight

setLabelClass

void setLabelClass(labelClass : String)

Sets the labelClass field.

Parameters:

labelClass – the new value for labelClass

setLabelStyle

void setLabelStyle(labelStyle : String)

Sets the labelStyle field.

Parameters:

labelStyle – the new value for labelStyle

setLineHeight

void setLineHeight(lineHeight : int)

Sets the lineHeight field.

Parameters:

lineHeight – the new value for lineHeight

setPreferredHeight

void setPreferredHeight(preferredHeight : int)

Sets the preferredHeight field.

Parameters:

preferredHeight – the new value for preferredHeight

setPreferredWidth

void setPreferredWidth(preferredWidth : int)

Sets the preferredWidth field.

Parameters:

preferredWidth – the new value for preferredWidth

Copyright © 2001-2007, TIBCO Software Inc.