Summ:  Nested Fields Constr. Methods    Details:  Fields Constr. Methods      Class:  Prev Next
com.artfulbits.aiCharts.Types
Class ChartFunnelType

java.lang.Object com.artfulbits.aiCharts.Base.ChartType com.artfulbits.aiCharts.Types.ChartFunnelType

Declaration: public class ChartFunnelType extends com.artfulbits.aiCharts.Base.ChartType

 

Represents Funnel chart type. Funnel chart type displays data that equals 100% when totaled. This is a single series chart representing the data as portions of 100%. This chart type does not require coordinate system to be displayed.
 // Creating series.
 ChartSeries series = new ChartSeries("Series 1", ChartTypes.Funnel);
 // Filling series with 10 data points.
 for (int i = 0; i < 10; i++)
 {
 	series.getPoints().addXY(i, i);
 }
 
Similar output should be expected:

Funnel type uses YValue type to determine index of corresponding Y value among chart point's Y values.

 

Since: 1.0

 

 

Nested Members Summary
static enum ChartFunnelType.Style
    
Represents the mode that is used to draw the funnel.

 

 

Fields Summary
static ChartCustomAttribute<java.lang.Float> GAP_RATIO
    
Identifies the gap ratio for funnel type.
static ChartCustomAttribute<java.lang.Float> MINIMAL
    
Identifies the minimal value.
static ChartCustomAttribute<java.lang.Float> NECK_HEIGHT
    
Identifies height of funnel's neck.
static ChartCustomAttribute<java.lang.Float> NECK_WIDTH
    
Identifies width of funnel's neck.
static ChartCustomAttribute<ChartFunnelType.Style> STYLE
    
Identifies the style used to draw funnel.

 

Fields inherited from class: com.artfulbits.aiCharts.Base.ChartType
POINT_WIDTH

 

 

Constructors Summary
ChartFunnelType()
    
Sole constructor.

 

 

Methods Summary
boolean colorPerPoint()
    
Indicated whether this chart type requires separate color for each point it draws.
void draw(ChartRenderArgs args)
    
Draws this chart type on surface specified along.
void drawMarkers(ChartRenderArgs args)
    
Iterates over points collection for this chart type and draws marker for each point that requires it.
java.lang.String getName()
    
Provides human-readable representation of this chart type.
CoordinateSystem getRequiredCoordinateSystem()
    
Gets value indicating coordinate system that this chart type requires to be shown.

 

Methods inherited from class: com.artfulbits.aiCharts.Base.ChartType
computeXRange, computeYRange, getRequiredUsages, getXRange, getYRange, isCompatible, isCompatible, isOriginDependent, isRotated, isSideBySide, isStacked, isStacked100

 

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

 

 

 

 

STYLE

 

public static final ChartCustomAttribute<ChartFunnelType.Style> STYLE

 

Identifies the style used to draw funnel.

 

Since: 1.0

 

 

 

MINIMAL

 

public static final ChartCustomAttribute<java.lang.Float> MINIMAL

 

Identifies the minimal value.

 

Since: 1.0

 

 

 

GAP_RATIO

 

public static final ChartCustomAttribute<java.lang.Float> GAP_RATIO

 

Identifies the gap ratio for funnel type.

 

Since: 1.0

 

 

 

NECK_WIDTH

 

public static final ChartCustomAttribute<java.lang.Float> NECK_WIDTH

 

Identifies width of funnel's neck.

 

Since: 1.0

 

 

 

NECK_HEIGHT

 

public static final ChartCustomAttribute<java.lang.Float> NECK_HEIGHT

 

Identifies height of funnel's neck.

 

Since: 1.0

 

 

 

 

ChartFunnelType

 

public ChartFunnelType( )

 

Sole constructor. (For invocation by subclass constructors, typically implicit.)

 

Since: 1.0

 

 

 

 

getRequiredCoordinateSystem

 

public CoordinateSystem getRequiredCoordinateSystem( )

 

[ description from ChartType.getRequiredCoordinateSystem() ]
 
Gets value indicating coordinate system that this chart type requires to be shown.

 

Returns:
instance of

 

Overrides: ChartType.getRequiredCoordinateSystem()

 

 

 

colorPerPoint

 

public boolean colorPerPoint( )

 

[ description from ChartType.colorPerPoint() ]
 
Indicated whether this chart type requires separate color for each point it draws.

 

Returns:
true if this chart type requires color for each point, otherwise false.

 

Overrides: ChartType.colorPerPoint()

 

 

 

drawMarkers

 

public void drawMarkers( ChartRenderArgs args)

 

[ description from ChartType.drawMarkers(ChartRenderArgs) ]
 
Iterates over points collection for this chart type and draws marker for each point that requires it.

 

Parameters:
args-
instance of ChartRenderArgs that provides facilities to draw markers for this type.

 

Overrides: ChartType.drawMarkers(ChartRenderArgs)

 

 

 

draw

 

public void draw( ChartRenderArgs args)

 

[ description from ChartType.draw(ChartRenderArgs) ]
 
Draws this chart type on surface specified along.

 

Parameters:
args-
instance of ChartRenderArgs that provides facilities to draw this type.

 

Implements: ChartType.draw(ChartRenderArgs)

 

 

 

getName

 

public java.lang.String getName( )

 

[ description from ChartType.getName() ]
 
Provides human-readable representation of this chart type.

 

Returns:
instance of

 

Implements: ChartType.getName()

 

 

© 2005 - 2010 ArtfulBits. All rights reserved.