OverviewSingleDeprecated

jsx3.chart

class LogarithmicAxis

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

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher
class LogarithmicAxis
extends jsx3.chart.Axis
An axis that displays a range of values logarithmically (base^n and base^(n+1) occupy same visual space).
Constructor Summary
void
init(name : String, horizontal : boolean, primary : boolean)
The instance initializer.
Method Summary
boolean
getAutoAdjust()
Returns the autoAdjust field.
int
getBase()
Returns the base field.
boolean
getBaseAtZero()
Returns the baseAtZero field, whether or not to set the minimum value to base^0, otherwise will choose an appropriate value for the data range.
int
getCoordinateFor(value : Number)
convert a number value to a coordinate between 0 and this.length, if the value is outside of the range of the axis, return the closest value in the range
void
getCoordinateForNoClip(value : ?)
same as getCoordinateFor(), but does not clip to bounds of the axis
int
getMajorDivisions()
Returns the majorDivisions field, the number of major tick line divisions to place between the values base^n and base^(n+1).
int
getMaxExponent()
Returns the maxExponent field, the range of values displayed will end at base^maxExponent.
int
getMinExponent()
Returns the minExponent field, the range of values displayed will begin at base^minExpronent.
boolean
getShowNegativeValues()
Returns the showNegativeValues field.
static String
getVersion()
Deprecated.
void
setAutoAdjust(autoAdjust : boolean)
Sets the autoAdjust field.
void
setBase(base : int)
Sets the base field.
void
setBaseAtZero(baseAtZero : boolean)
Sets the baseAtZero field.
void
setMajorDivisions(majorDivisions : int)
Sets the majorDivisions field.
void
setMaxExponent(maxExponent : int)
Sets the maxExponent field.
void
setMinExponent(minExponent : int)
Sets the minExponent field.
void
setShowNegativeValues(showNegativeValues : boolean)
Sets the showNegativeValues 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
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

getAutoAdjust

boolean getAutoAdjust()
Returns the autoAdjust field.

Returns:

autoAdjust  

getBase

int getBase()
Returns the base field.

Returns:

base  

getBaseAtZero

boolean getBaseAtZero()
Returns the baseAtZero field, whether or not to set the minimum value to base^0, otherwise will choose an appropriate value for the data range.

Returns:

baseAtZero  

getCoordinateFor

int getCoordinateFor(value : Number)
convert a number value to a coordinate between 0 and this.length, if the value is outside of the range of the axis, return the closest value in the range

Parameters:

value – a value displayed along the axis

Returns:

coordinate along the axis  

getCoordinateForNoClip

void getCoordinateForNoClip(value : ?)
same as getCoordinateFor(), but does not clip to bounds of the axis

Parameters:

value –

getMajorDivisions

int getMajorDivisions()
Returns the majorDivisions field, the number of major tick line divisions to place between the values base^n and base^(n+1). A good value can be base-1, though the default value is 1..

Returns:

majorDivisions  

getMaxExponent

int getMaxExponent()
Returns the maxExponent field, the range of values displayed will end at base^maxExponent.

Returns:

maxExponent  

getMinExponent

int getMinExponent()
Returns the minExponent field, the range of values displayed will begin at base^minExpronent.

Returns:

minExponent  

getShowNegativeValues

boolean getShowNegativeValues()
Returns the showNegativeValues field.

Returns:

showNegativeValues  

getVersion

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

Returns:

 

setAutoAdjust

void setAutoAdjust(autoAdjust : boolean)
Sets the autoAdjust field.

Parameters:

autoAdjust – the new value for autoAdjust

setBase

void setBase(base : int)
Sets the base field.

Parameters:

base – the new value for base

setBaseAtZero

void setBaseAtZero(baseAtZero : boolean)
Sets the baseAtZero field.

Parameters:

baseAtZero – the new value for baseAtZero

setMajorDivisions

void setMajorDivisions(majorDivisions : int)
Sets the majorDivisions field.

Parameters:

majorDivisions – the new value for majorDivisions

setMaxExponent

void setMaxExponent(maxExponent : int)
Sets the maxExponent field.

Parameters:

maxExponent – the new value for maxExponent

setMinExponent

void setMinExponent(minExponent : int)
Sets the minExponent field.

Parameters:

minExponent – the new value for minExponent

setShowNegativeValues

void setShowNegativeValues(showNegativeValues : boolean)
Sets the showNegativeValues field.

Parameters:

showNegativeValues – the new value for showNegativeValues
Copyright © 2001-2007, TIBCO Software Inc.