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 final class ChartRenderArgs extends Object

 

Represent render arguments class. Instance of this class is created internally by aiChart building engine in order to pass rendering parameters to concerned elements.

 

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
    
Instance of ChartArea class represented by this drawing.
android.graphics.Rect Bounds
    
Instance of android.graphics.RectF class representing drawing bounds.
android.graphics.Canvas Canvas
    
Instance of android.graphics.Canvas class that should be used to draw corresponding object on.
ChartEngine Chart
    
Instance of ChartEngine class represented by this drawing.
boolean IsRegionEnabled
    
Identifies whether region calculations is enabeled.
boolean IsRotated
    
Indicated whether this is rotated drawing.
ChartSeries Series
    
Instance of ChartSeries class.
CoordinateSystem System
    
Instance of coordinate system represented by this drawing.
ChartType Type
    
Instance of ChartType class represented by this drawing.
ChartAxis XAxis
    
Instance of ChartAxis class.
ChartAxis YAxis
    
Instance of ChartAxis class.

 

 

Methods Summary
void addRegion(android.graphics.Path path, android.graphics.Rect bounds, java.lang.Object tag)
    
Adds the specified path region to chart's region for further hit testing.
void addRegion(android.graphics.RectF rect, java.lang.Object tag)
    
Adds the specified path region to chart's region for further hit testing.
void addRegion(android.graphics.Rect rect, java.lang.Object tag)
    
Adds the specified path region to chart's region for further hit testing.
static ChartRenderArgs create(android.graphics.Canvas canvas, ChartSeries series, android.graphics.Rect bounds)
    
Creates a new instance of ChartRenderArgs class with specified parameters.
android.graphics.PointF getPoint(double x, double y)
    
Gets android.graphics.PointF point converted relatively to current coordinate system.
void getPoint(double x, double y, android.graphics.PointF outPoint)
    
Fills outPoint with values relative to current chart type.
android.graphics.RectF getRect(double x1, double y1, double x2, double y2)
    
Gets rectangle with values converted relatively to current coordinate system.
void getRect(double x1, double y1, double x2, double y2, android.graphics.RectF rect)
    
Fills rectangle with values converted relatively to current coordinate system.
DoubleRange getSideBySideOffset()
    
Gets offset for side by side chart types.
static DoubleRange getSideBySideOffset(ChartSeries series, ChartType seriesType, ChartArea area)
    
Gets side by side offset for specified parameters.
static double getStackedValue(ChartArea area, ChartSeries series, ChartPoint point, int yIndex, boolean high)
    
Gets stacked value for specified parameters.
double getStackedValue(ChartPoint point, int yIndex, boolean high)
    
Gets stacked point.
boolean isVisible(float x, float y)
    
Determined whether point is visible within current bounds.
boolean isVisible(float x1, float y1, float x2, float y2)
    
Determined whether specified area is visible within current bounds.

 

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

 

 

 

 

Canvas

 

public final android.graphics.Canvas Canvas

 

Instance of android.graphics.Canvas class that should be used to draw corresponding object on.

 

Since: 1.0

 

 

 

Series

 

public final ChartSeries Series

 

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

 

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

 

 

 

Bounds

 

public final android.graphics.Rect Bounds

 

Instance of android.graphics.RectF class representing drawing bounds.

 

Since: 1.0

 

 

 

IsRotated

 

public final boolean IsRotated

 

Indicated whether this is rotated drawing.

 

Since: 1.0

 

 

 

System

 

public final CoordinateSystem System

 

Instance of coordinate system represented by this drawing.

 

Since: 1.0

 

 

 

Type

 

public final ChartType Type

 

Instance of ChartType class represented by this drawing.

 

Since: 1.0

 

 

 

Area

 

public final ChartArea Area

 

Instance of ChartArea class represented by this drawing.

 

Since: 1.0

 

 

 

Chart

 

public final ChartEngine Chart

 

Instance of ChartEngine class represented by this drawing.

 

Since: 1.0

 

 

 

IsRegionEnabled

 

public final boolean IsRegionEnabled

 

Identifies whether region calculations is enabeled.

 

Since: 1.5

 

 

 

 

create

 

public static ChartRenderArgs create( android.graphics.Canvas canvas,
ChartSeries series,
android.graphics.Rect bounds)

 

Creates a new instance of ChartRenderArgs class with specified parameters.

 

Parameters:
canvas-
instance of android.graphics.Canvas class that should be used to draw on.
series-
instance of corresponding ChartSeries class.
bounds-
instance of android.graphics.RectF class representing drawing area.
Returns:
Instance of ChartRenderArgs

 

Since: 1.0

 

 

 

getPoint

 

public void getPoint( double x,
double y,
android.graphics.PointF outPoint)

 

Fills outPoint with values relative to current chart type.

 

Parameters:
x-
Absolute X value.
y-
Absolute Y value.
outPoint-
instance of android.graphics.PointF class.

 

Since: 1.0

 

 

 

getPoint

 

public android.graphics.PointF getPoint( double x,
double y)

 

Gets android.graphics.PointF point converted relatively to current coordinate system.

 

Parameters:
x-
Absolute X value.
y-
Absolute Y value.
Returns:
instance of point with converted X and Y values.

 

Since: 1.0

 

 

 

getRect

 

public void getRect( double x1,
double y1,
double x2,
double y2,
android.graphics.RectF 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 rectangle.

 

Since: 1.0

 

 

 

getRect

 

public android.graphics.RectF getRect( double x1,
double y1,
double x2,
double y2)

 

Gets 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.
Returns:
instance of rectangle filled with converted values.

 

Since: 1.0

 

 

 

isVisible

 

public boolean isVisible( float x,
float y)

 

Determined whether point is visible within current bounds.

 

Parameters:
x-
point's X value.
y-
point's Y value.
Returns:
true if specified point is visible, otherwise false.

 

Since: 1.0

 

 

 

isVisible

 

public boolean isVisible( float x1,
float y1,
float x2,
float y2)

 

Determined whether specified area is visible within current bounds.

 

Parameters:
x1-
left value of target area.
y1-
bottom value of target area.
x2-
right value of target area.
y2-
top value of target area.
Returns:
true if specified area is visible, otherwise false.

 

Since: 1.0

 

 

 

getStackedValue

 

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

 

Gets stacked point. Actual for stacked chart types.

 

Parameters:
point-
instance of ChartPoint class.
yIndex-
index of target Y value.
high-
true if value is considered to be high, otherwise false.
Returns:
value representing point in stacked mode.

 

Since: 1.0

 

 

 

getSideBySideOffset

 

public DoubleRange getSideBySideOffset( )

 

Gets offset for side by side chart types.

 

Returns:
instance of DoubleRange representing side by side offset.

 

Since: 1.0

 

 

 

getStackedValue

 

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

 

Gets stacked value for specified parameters. Actual for stacked chart types.

 

Parameters:
area-
instance of target area.
series-
instance of target series.
point-
instance of target point.
yIndex-
index of concerned Y value.
high-
true for high values, otherwise false.
Returns:
stacked value.

 

Since: 1.0

 

 

 

getSideBySideOffset

 

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

 

Gets side by side offset for specified parameters.

 

Parameters:
series-
instance of target series.
seriesType-
instance of target chart type.
area-
instance of target area.
Returns:
instance of DoubleRange representing side by side offset.

 

Since: 1.0

 

 

 

addRegion

 

public void addRegion( android.graphics.Rect rect,
java.lang.Object tag)

 

Adds the specified path region to chart's region for further hit testing.

 

Parameters:
rect-
instance of android.graphics.Rect class representing bounds of object.
tag-
region represented by object.

 

Since: 1.5

 

 

 

addRegion

 

public void addRegion( android.graphics.RectF rect,
java.lang.Object tag)

 

Adds the specified path region to chart's region for further hit testing.

 

Parameters:
rect-
instance of android.graphics.Rect class representing bounds of object.
tag-
region represented by object.

 

Since: 1.5

 

 

 

addRegion

 

public void addRegion( android.graphics.Path path,
android.graphics.Rect bounds,
java.lang.Object tag)

 

Adds the specified path region to chart's region for further hit testing.

 

Parameters:
path-
instance of android.graphics.Path class representing region object.
bounds-
instance of android.graphics.Rect class representing bounds of object.
tag-
region represented by object.

 

Since: 1.5

 

 

© 2005 - 2010 ArtfulBits. All rights reserved.