OverviewSingleDeprecated

jsx3.chart

class GridLines

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

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher

class GridLines
extends jsx3.chart.ChartComponent
A chart component that renders a grid of lines and fills aligned with an x and y axis.

Constructor Summary
void
init(name : String, left : int, top : int, width : int, height : int)
The instance initializer.
Method Summary
String
Returns the borderStroke field, string representation of the stroke used to outline the grid lines.
Array<String>
Returns the fillH field, array of string representations of vector fills used to fill in areas between horizontal major ticks; if the length of the array is greater than one, the areas alternate through the list of fills.
Array<String>
Returns the fillV field, array of string representations of vector fills used to fill in areas between vertical major ticks; if the length of the array is greater than one, the areas alternate through the list of fills.
boolean
Returns the horizontalAbove field, whether to draw the horizontal lines and fills above the vertical ones.
boolean
Returns the inForeground field, whether to draw this legend on top of the data series (or below).
Array<String>
Returns the strokeMajorH field, array of string representations of VectorStroke's used to draw the horizontal major ticks; if the length of the array is greater than one, the ticks alternate through the list of strokes.
Array<String>
Returns the strokeMajorV field, array of string representations of VectorStroke's used to draw the vertical major ticks; if the length of the array is greater than one, the ticks alternate through the list of strokes.
Array<String>
Returns the strokeMinorH field, array of string representations of VectorStroke's used to draw the horizontal minor ticks; if the length of the array is greater than one, the ticks alternate through the list of strokes.
Array<String>
Returns the strokeMinorV field, array of string representations of VectorStroke's used to draw the vertical minor ticks; if the length of the array is greater than one, the ticks alternate through the list of strokes.
static String
Deprecated.
jsx3.chart.Axis
Returns the x (horizontal) axis used to determine where to draw tick lines.
jsx3.chart.Axis
Returns the y (vertical) axis used to determine where to draw tick lines.
void
setBorderStroke(borderStroke : String)
Sets the borderStroke field.
void
setFillH(fillH : Array<String>)
Sets the fillH field.
void
setFillV(fillV : Array<String>)
Sets the fillV field.
void
setHorizontalAbove(horizontalAbove : boolean)
Sets the horizontalAbove field.
void
setInForeground(inForeground : boolean)
Sets the inForeground field.
void
setStrokeMajorH(strokeMajorH : Array<String>)
Sets the strokeMajorH field.
void
setStrokeMajorV(strokeMajorV : Array<String>)
Sets the strokeMajorV field.
void
setStrokeMinorH(strokeMinorH : Array<String>)
Sets the strokeMinorH field.
void
setStrokeMinorV(strokeMinorV : Array<String>)
Sets the strokeMinorV 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
Constructor Detail

init

void init(name : String, left : int, top : int, width : int, height : int)
The instance initializer.

Parameters:

namethe GI name of the instance
leftleft position (in pixels) of the object relative to its parent container
toptop position (in pixels) of the object relative to its parent container
widthwidth (in pixels) of the chart
heightheight (in pixels) of the chart
Method Detail

getBorderStroke

String getBorderStroke()
Returns the borderStroke field, string representation of the stroke used to outline the grid lines.

Returns:

borderStroke  

getFillH

Array<String> getFillH()
Returns the fillH field, array of string representations of vector fills used to fill in areas between horizontal major ticks; if the length of the array is greater than one, the areas alternate through the list of fills.

Returns:

fillH  

getFillV

Array<String> getFillV()
Returns the fillV field, array of string representations of vector fills used to fill in areas between vertical major ticks; if the length of the array is greater than one, the areas alternate through the list of fills.

Returns:

fillV  

getHorizontalAbove

boolean getHorizontalAbove()
Returns the horizontalAbove field, whether to draw the horizontal lines and fills above the vertical ones.

Returns:

horizontalAbove  

getInForeground

boolean getInForeground()
Returns the inForeground field, whether to draw this legend on top of the data series (or below).

Returns:

inForeground  

getStrokeMajorH

Array<String> getStrokeMajorH()
Returns the strokeMajorH field, array of string representations of VectorStroke's used to draw the horizontal major ticks; if the length of the array is greater than one, the ticks alternate through the list of strokes.

Returns:

strokeMajorH  

getStrokeMajorV

Array<String> getStrokeMajorV()
Returns the strokeMajorV field, array of string representations of VectorStroke's used to draw the vertical major ticks; if the length of the array is greater than one, the ticks alternate through the list of strokes.

Returns:

strokeMajorV  

getStrokeMinorH

Array<String> getStrokeMinorH()
Returns the strokeMinorH field, array of string representations of VectorStroke's used to draw the horizontal minor ticks; if the length of the array is greater than one, the ticks alternate through the list of strokes.

Returns:

strokeMinorH  

getStrokeMinorV

Array<String> getStrokeMinorV()
Returns the strokeMinorV field, array of string representations of VectorStroke's used to draw the vertical minor ticks; if the length of the array is greater than one, the ticks alternate through the list of strokes.

Returns:

strokeMinorV  

getVersion

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

Returns:

 

getXAxis

jsx3.chart.Axis getXAxis()
Returns the x (horizontal) axis used to determine where to draw tick lines.

Returns:

 

getYAxis

jsx3.chart.Axis getYAxis()
Returns the y (vertical) axis used to determine where to draw tick lines.

Returns:

 

setBorderStroke

void setBorderStroke(borderStroke : String)
Sets the borderStroke field.

Parameters:

borderStrokethe new value for borderStroke

setFillH

void setFillH(fillH : Array<String>)
Sets the fillH field.

Parameters:

fillHthe new value for fillH

setFillV

void setFillV(fillV : Array<String>)
Sets the fillV field.

Parameters:

fillVthe new value for fillV

setHorizontalAbove

void setHorizontalAbove(horizontalAbove : boolean)
Sets the horizontalAbove field.

Parameters:

horizontalAbovethe new value for horizontalAbove

setInForeground

void setInForeground(inForeground : boolean)
Sets the inForeground field.

Parameters:

inForegroundthe new value for inForeground

setStrokeMajorH

void setStrokeMajorH(strokeMajorH : Array<String>)
Sets the strokeMajorH field.

Parameters:

strokeMajorHthe new value for strokeMajorH

setStrokeMajorV

void setStrokeMajorV(strokeMajorV : Array<String>)
Sets the strokeMajorV field.

Parameters:

strokeMajorVthe new value for strokeMajorV

setStrokeMinorH

void setStrokeMinorH(strokeMinorH : Array<String>)
Sets the strokeMinorH field.

Parameters:

strokeMinorHthe new value for strokeMinorH

setStrokeMinorV

void setStrokeMinorV(strokeMinorV : Array<String>)
Sets the strokeMinorV field.

Parameters:

strokeMinorVthe new value for strokeMinorV