OverviewSingleDeprecated

jsx3.chart

class CategoryAxis

Object
->jsx3.lang.Object
  ->jsx3.app.Model
    ->jsx3.gui.Painted
      ->jsx3.gui.Block
        ->jsx3.chart.ChartComponent
          ->jsx3.chart.Axis
            ->jsx3.chart.CategoryAxis

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher
class CategoryAxis
extends jsx3.chart.Axis
Axis type that displays a set of discrete values (categories). Usually a category corresponds to a record in the chart's data provider.
Field Summary
static String
TICKS_ALIGNED
static String
TICKS_BETWEEN
Constructor Summary
void
init(name : String, horizontal : boolean, primary : boolean)
The instance initializer.
Method Summary
String
getCategoryField()
Returns the categoryField field, the attribute of records from the data provider that contains the category name (this value can still be transformed by Axis's 'labelFunction' field).
float
getPaddingHigh()
Returns the paddingHigh field, the number of category widths to pad the end of the axis with.
float
getPaddingLow()
Returns the paddingLow field, the number of category widths to pad the beginning of the axis with.
String
getTickAlignment()
Returns the tickAlignment field, if 'between' then the midpoint of the category is between two major ticks, otherwise if 'aligned' then the midpoint of the category is aligned with a major tick.
static String
getVersion()
Deprecated.
void
setCategoryField(categoryField : String)
Sets the categoryField field.
void
setPaddingHigh(paddingHigh : float)
Sets the paddingHigh field.
void
setPaddingLow(paddingLow : float)
Sets the paddingLow field.
void
setTickAlignment(tickAlignment : String)
Sets the tickAlignment field.
Methods Inherited From jsx3.chart.Axis
getAxisStroke, getAxisTitle, getDisplayWidth, getHorizontal, getLabelClass, getLabelColor, getLabelFunction, getLabelGap, getLabelStyle, getMinorTickDivisions, getMinorTickLength, getMinorTickPlacement, getMinorTickStroke, getOpposingAxis, getShowAxis, getShowLabels, getTickLength, getTickPlacement, getTickStroke, setAxisStroke, setDisplayWidth, setHorizontal, setLabelClass, setLabelColor, setLabelFunction, setLabelGap, setLabelPlacement, setLabelStyle, setMinorTickDivisions, setMinorTickLength, setMinorTickPlacement, setMinorTickStroke, setShowAxis, setShowLabels, setTickLength, setTickPlacement, setTickStroke
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

TICKS_ALIGNED

static final String TICKS_ALIGNED

TICKS_BETWEEN

static final String TICKS_BETWEEN
Constructor Detail

init

void init(name : String, horizontal : boolean, primary : boolean)
The instance initializer.

Parameters:

name – the GI name of the instance
horizontal – whether this axis is horizontal (x), otherwise it's vertical (y)
primary – whether this axis is primary, otherwise it's secondary
Method Detail

getCategoryField

String getCategoryField()
Returns the categoryField field, the attribute of records from the data provider that contains the category name (this value can still be transformed by Axis's 'labelFunction' field).

Returns:

categoryField  

getPaddingHigh

float getPaddingHigh()
Returns the paddingHigh field, the number of category widths to pad the end of the axis with.

Returns:

paddingHigh  

getPaddingLow

float getPaddingLow()
Returns the paddingLow field, the number of category widths to pad the beginning of the axis with.

Returns:

paddingLow  

getTickAlignment

String getTickAlignment()
Returns the tickAlignment field, if 'between' then the midpoint of the category is between two major ticks, otherwise if 'aligned' then the midpoint of the category is aligned with a major tick.

Returns:

tickAlignment, one of {'aligned','between'}  

getVersion

static String getVersion()
Deprecated.
Returns the release/build for the class (i.e., "2.2.00").

Returns:

 

setCategoryField

void setCategoryField(categoryField : String)
Sets the categoryField field.

Parameters:

categoryField – the new value for categoryField

setPaddingHigh

void setPaddingHigh(paddingHigh : float)
Sets the paddingHigh field.

Parameters:

paddingHigh – the new value for paddingHigh

setPaddingLow

void setPaddingLow(paddingLow : float)
Sets the paddingLow field.

Parameters:

paddingLow – the new value for paddingLow

setTickAlignment

void setTickAlignment(tickAlignment : String)
Sets the tickAlignment field.

Parameters:

tickAlignment – the new value for tickAlignment, one of {'aligned','between'}
Copyright © 2001-2007, TIBCO Software Inc.