Summ:  Fields Methods    Details:  Fields Methods      Class:  Prev Next
com.artfulbits.aiCharts.Base
Class ChartRenderArgs

java.lang.Object com.artfulbits.aiCharts.Base.ChartRenderArgs

Declaration: public class ChartRenderArgs extends Object

 

Represents chart rendering arguments that provides additional information to parties interested in rendering chart.

 

Since: 1.0

 

 

Fields Summary
ChartAxis ActualXAxis
    
Instance of ChartAxis class representing actual X axis for currently drawing chart type.
ChartAxis ActualYAxis
    
Instance of ChartAxis class representing actual Y axis for currently drawing chart type.
ChartArea Area
    
Corresponding ChartArea instance
XYRect Bounds
    
Render bounds.
ChartEngine Chart
    
ChartEngine instance
Graphics Graphics
    
Current Graphics context
boolean IsRotated
    
Cashed value of ChartType.isRotated() result.
ChartSeries Series
    
ChartSeries instance
ChartType Type
    
ChartType instance
ChartAxis XAxis
    
Instance of ChartAxis class.
ChartAxis YAxis
    
Instance of ChartAxis class.

 

 

Methods Summary
void drawMarkers()
    
Draws markers for chart type.
void getPoint(double x, double y, XYPoint outPoint)
    
Fills specified XYPoint instance with actual pixel values.
void getRect(double x1, double y1, double x2, double y2, XYRect rect)
    
Fills rectangle with values converted relatively to current coordinate system.
DoubleRange getSideBySideOffset()
    
Gets side-by-side points offset with respect to current chart type.
static DoubleRange getSideBySideOffset(ChartSeries series, ChartType type, ChartArea area)
    
Gets series side-by-side offset.
static double getStackedValue(ChartArea area, ChartSeries series, ChartPoint point, int yIndex, boolean high)
    
Helper method to calculate stacked value for specified stacked value.
double getStackedValue(ChartPoint point, int index, boolean high)
    
Gets stacked value for current chart series.

 

Methods inherited from class: java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

 

 

 

Graphics

 

public final Graphics Graphics

 

Current Graphics context

 

Since: 1.0

 

 

 

Series

 

public final ChartSeries Series

 

ChartSeries instance

 

Since: 1.0

 

 

 

Area

 

public final ChartArea Area

 

Corresponding ChartArea instance

 

Since: 1.0

 

 

 

Chart

 

public final ChartEngine Chart

 

ChartEngine instance

 

Since: 1.0

 

 

 

Type

 

public final ChartType Type

 

ChartType instance

 

Since: 1.0

 

 

 

Bounds

 

public final XYRect Bounds

 

Render bounds.

 

Since: 1.0

 

 

 

IsRotated

 

public final boolean IsRotated

 

Cashed value of ChartType.isRotated() result.

 

Since: 1.0

 

 

 

XAxis

 

public final ChartAxis XAxis

 

Instance of ChartAxis class. May be null depending on object that uses ChartRenderArgs.

 

Since: 1.0

 

 

 

YAxis

 

public final ChartAxis YAxis

 

Instance of ChartAxis class. May be null depending on object that uses ChartRenderArgs.

 

Since: 1.0

 

 

 

ActualXAxis

 

public final ChartAxis ActualXAxis

 

Instance of ChartAxis class representing actual X axis for currently drawing chart type.

 

Since: 1.0

 

 

 

ActualYAxis

 

public final ChartAxis ActualYAxis

 

Instance of ChartAxis class representing actual Y axis for currently drawing chart type.

 

Since: 1.0

 

 

 

 

getStackedValue

 

public static double getStackedValue( ChartArea area,
ChartSeries series,
ChartPoint point,
int yIndex,
boolean high)

 

Helper method to calculate stacked value for specified stacked value.

 

Parameters:
area-
instance of corresponding ChartArea.
series-
instance of corresponding ChartSeries.
point-
instance of corresponding ChartPoint.
yIndex-
target y values index.
high-
stacked high value.
Returns:
value representing stacked value.

 

 

 

getSideBySideOffset

 

public static DoubleRange getSideBySideOffset( ChartSeries series,
ChartType type,
ChartArea area)

 

Gets series side-by-side offset.

 

Parameters:
series-
instance of target ChartSeries.
type-
instance of corresponding ChartType.
area-
target ChartArea.
Returns:
DoubleRange side-by-side offset.

 

 

 

drawMarkers

 

public void drawMarkers( )

 

Draws markers for chart type.

 

 

 

getPoint

 

public void getPoint( double x,
double y,
XYPoint outPoint)

 

Fills specified XYPoint instance with actual pixel values.

 

Parameters:
x-
x-coordinate value.
y-
y-coordinate value.
outPoint-
instance of XYPoint.

 

 

 

getRect

 

public void getRect( double x1,
double y1,
double x2,
double y2,
XYRect rect)

 

Fills rectangle with values converted relatively to current coordinate system.

 

Parameters:
x1-
left value of target absolute rectangle.
y1-
bottom value of target absolute rectangle.
x2-
right value of target absolute rectangle.
y2-
top value of target absolute rectangle.
rect-
target XYRect rectangle.

 

Since: 1.0

 

 

 

getStackedValue

 

public double getStackedValue( ChartPoint point,
int index,
boolean high)

 

Gets stacked value for current chart series. Usually used by stacked* chart types.

 

Parameters:
point-
instance of target ChartPoint.
index-
Y-value index used for stack.
high-
true for high value.
Returns:
stacked point value.

 

 

 

getSideBySideOffset

 

public DoubleRange getSideBySideOffset( )

 

Gets side-by-side points offset with respect to current chart type. Generally used to determine distance between columns for column-alike chart types.

 

Returns:
side-by-side range.

 

 

© 2005 - 2010 ArtfulBits. All rights reserved.