public class Funnel extends Series
Title: Funnel class
Description: Funnel Series.
Copyright (c) 2005-2019 by Steema Software SL. All Rights Reserved.
Company: Steema Software SL
Series.MarkTextResolver
AUTODEPTH, AUTOZORDER, bActive, bBrush, bColorEach, calcVisiblePoints, colorMember, customMarkText, drawBetweenPoints, endZ, firstVisible, hasZValues, iColors, iNumSampleValues, iZOrder, labelMember, lastVisible, listenerList, mandatory, manualData, marks, middleZ, notMandatory, oldDataSource, percentDecimal, percentFormat, sLabels, startZ, useAxis, useSeriesColor, valueFormat, vxValues, vyValues, yMandatory
chart, InternalUse
Constructor and Description |
---|
Funnel() |
Funnel(IBaseChart c) |
Modifier and Type | Method and Description |
---|---|
int |
add(double aQuote,
double aOpportunity,
java.lang.String aLabel,
Color aColor,
boolean aFunnel) |
protected void |
addSampleValues(int numValues) |
int |
addSegment(double aQuote,
double aOpportunity,
java.lang.String aLabel,
Color aColor)
Adds new Funnel segment to the Series.
|
void |
assign(Series source)
Copies all properties from one Series component to another.
Only the common properties shared by both source and destination Series are copied. |
int |
clicked(int x,
int y)
The ValueIndex of the "clicked" point in the Series.
|
void |
doBeforeDrawChart() |
protected void |
draw() |
protected void |
drawMark(int valueIndex,
java.lang.String st,
SeriesMarksPosition aPosition) |
void |
drawValue(int valueIndex)
Called internally.
|
Color |
getAboveColor()
Funnel segment color if Opportunity value is greater than Quote
value.
Default value: GREEN |
boolean |
getAutoUpdate()
Reconstructs FunnelSeries with every added point.
To speed up the drawing of Funnel series, set the AutoUpdate to false and call the Recalculate method when all points are added. Default value: true |
Color |
getBelowColor()
Funnel segment color if Opportunity value is more than the
DifferenceLimit % below the Quote value.
Default value: RED |
ChartBrush |
getBrush()
Defines Brush to fill Funnel Series.
|
int |
getCountLegendItems() |
java.lang.String |
getDescription()
Gets descriptive text.
|
double |
getDifferenceLimit()
The difference (expressed in Quote %) used to define the Funnel
segment color.
If the Opportunity value falls below (100-Difference)*Quote/100 then the BelowColor will be used to paint the Funnel segment. If the Opportunity value falls between (100-Difference)*Quote/100 and Quote, then the WithinColor will be used to paint the Funnel segment. Otherwise (if Opportunity > Quote) the AboveColor will be used to paint the Funnel segment. |
java.lang.String |
getLegendString(int legendIndex,
LegendTextStyle legendTextStyle)
Returns LegendString for LegendIndex'th item.
|
ChartPen |
getLinesPen()
Defines Pen to draw FunnelSeries bounding polygon.
|
java.lang.String |
getMarkText(int valueIndex)
Returns the String corresponding to the Series Mark text for a given
ValueIndex point.
The Mark text depends on the Marks.Style method. |
double |
getMaxXValue()
Returns the Maximum Value of the Series X Values List.
|
double |
getMinXValue()
Returns the Minimum Value of the Series X Values List.
As some Series have more than one Y Values List, this Minimum Value is the "Minimum of Minimums" of all Series Y Values lists. |
double |
getMinYValue()
Returns the Minimum Value of the Series Y Values List.
As some Series have more than one Y Values List, this Minimum Value is the "Minimum of Minimums" of all Series Y Values lists. |
ValueList |
getOpportunityValues() |
ChartPen |
getPen()
Define Pen to draw the Funnel Chart.
|
boolean |
getQuotesSorted()
Sorts added segments by QuoteValues in descending order.
Setting QuotesSorted to false will enable the internal sorting algorithm. |
ValueList |
getQuoteValues()
Accesses the quote values of the FunnelSeries.
|
Color |
getWithinColor()
Funnel segment color if Opportunity value is within DifferenceLimit %
below the Quote value.
Default value: YELLOW |
Color |
legendItemColor(int legendIndex) |
protected java.lang.Object |
readResolve() |
void |
reCalc()
Uses all Quote and Opportunity values to restatic finalruct the Funnel
chart.
|
void |
setAboveColor(Color value)
Funnel segment color if Opportunity value is greater than Quote
value.
Default value: GREEN |
void |
setAutoUpdate(boolean value)
Reconstructs FunnelSeries with every added point.
Default value: true |
void |
setBelowColor(Color value)
Funnel segment color if Opportunity value is more than the
DifferenceLimit % below the Quote value.
Default value: RED |
void |
setChart(IBaseChart c)
Chart associated with this object.
|
void |
setDifferenceLimit(double value)
Sets the difference (expressed in Quote %) used to define the Funnel
segment color.
Default value: 30 |
void |
setOpportunityValues(ValueList value) |
void |
setQuotesSorted(boolean value)
Sorts added segments by QuoteValues in descending order.
Default value: false |
void |
setWithinColor(Color value)
Funnel segment color if Opportunity value is within DifferenceLimit %
below the Quote value.
Default value: YELLOW |
add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, addChartValue, added, addedValue, addNull, addNullXY, addSeriesMouseListener, addSeriesPaintListener, addValues, assignDispose, assignValues, associatedToAxis, beginUpdate, calcFirstLastVisibleIndex, calcHorizMargins, calcPercentSt, calcPosValue, calculateMarkPosition, calcVerticalMargins, calcXPos, calcXPosValue, calcXSizeValue, calcYPos, calcYPosValue, calcYSizeValue, calcZOrder, canAddRandomPoints, changeType, checkDataSource, checkMouse, checkOrder, checkOtherSeries, clear, clearLists, clicked, clone, cloneSeries, convertArray, countLegendItems, createNewSeries, createNewSeries, createNewSeries, createSubGallery, dataSourceArray, delete, delete, delete, dispose, doAfterDrawValues, doBeforeDrawValues, doClick, doClickPointer, doDoubleClick, drawHiddenValue, drawLegend, drawLegend, drawLegendShape, drawMarks, drawMarksSeries, drawSeries, drawSeriesForward, drawValuesForward, endUpdate, fillSampleValues, fillSampleValues, fireSeriesMouseEvent, fireSeriesPaint, firstDisplayed, galleryChanged3D, getActive, getAllowSinglePoint, getBitmapEditor, getColor, getColorEach, getColorMember, getColors, getCount, getCursor, getCustomHorizAxis, getCustomVertAxis, getDataSource, getDefaultColor, getDefaultNullValue, getDepth, getEndZ, getFields, getFirstVisible, getFunction, getHasZValues, getHorizAxis, getHorizontalAxis, getLabelMember, getLabels, getLastVisible, getMandatory, getMandatoryAxis, getMarks, getMarkValue, getMaxYValue, getMaxZValue, getMiddleZ, getMinZValue, getNotMandatory, getNumGallerySeries, getNumSampleValues, getOriginValue, getPercentFormat, getPoint, getSeriesColor, getShowInLegend, getStartZ, getTitle, getUseAxis, getValueColor, getValueFormat, getValueIndexSwapper, getValueList, getValueList, getValueMarkText, getValuesLists, getVertAxis, getVerticalAxis, getVisible, getXValues, getYMandatory, getYValueList, getYValues, getZOrder, hasClickEvents, hasColors, hasDataSource, hasLabels, hasListenersOf, hasNoMandatoryValues, isNull, isPointInChartRect, isValidSeriesSource, isValidSourceOf, lastDisplayed, lastVisibleMark, legendToValueIndex, maxMarkWidth, moreSameZOrder, mouseEvent, newFromType, numSampleValues, onDisposing, prepareForGallery, prepareLegendCanvas, randomBounds, recalcGetAxis, refreshSeries, removeMarkTextResolver, removeSeriesMouseListener, removeSeriesPaintListener, repaint, sameClass, setActive, setColor, setColorEach, setColorMember, setColors, setCursor, setCustomHorizAxis, setCustomHorizAxis, setCustomVertAxis, setCustomVertAxis, setDataSource, setDefaultNullValue, setDepth, setEndZ, setFunction, setHorizontal, setHorizontalAxis, setLabelMember, setLabels, setMarks, setMarkTextResolver, setMiddleZ, setNull, setNull, setPercentFormat, setSeriesColor, setShowInLegend, setStartZ, setSubGallery, setTitle, setValueFormat, setValueList, setVerticalAxis, setVisible, setXValues, setYValues, setZOrder, setZPositions, sortByLabels, sortByLabels, sortDrawSeries, swapValueIndex, titleOrName, toString, valueListOfAxis, valuesListAdd, xScreenToValue, yScreenToValue
getChart, invalidate, setBooleanProperty, setColorProperty, setDoubleProperty, setIntegerProperty, setStringProperty
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getChart, invalidate
public Funnel(IBaseChart c)
public Funnel()
public void assign(Series source)
Series
public int clicked(int x, int y)
protected java.lang.Object readResolve()
readResolve
in class Series
public Color getAboveColor()
public void setAboveColor(Color value)
value
- Colorpublic Color getWithinColor()
public void setWithinColor(Color value)
value
- Colorpublic Color getBelowColor()
public void setBelowColor(Color value)
value
- Colorpublic ChartPen getPen()
public ChartPen getLinesPen()
public ChartBrush getBrush()
public void setChart(IBaseChart c)
TeeBase
public java.lang.String getMarkText(int valueIndex)
Series
getMarkText
in interface ISeries
getMarkText
in class Series
valueIndex
- intpublic void doBeforeDrawChart()
doBeforeDrawChart
in class Series
public int getCountLegendItems()
getCountLegendItems
in interface ISeries
getCountLegendItems
in class Series
public Color legendItemColor(int legendIndex)
legendItemColor
in interface ISeries
legendItemColor
in class Series
public java.lang.String getLegendString(int legendIndex, LegendTextStyle legendTextStyle)
getLegendString
in interface ISeries
getLegendString
in class Series
legendIndex
- intlegendTextStyle
- LegendTextStylepublic int add(double aQuote, double aOpportunity, java.lang.String aLabel, Color aColor, boolean aFunnel)
protected void addSampleValues(int numValues)
addSampleValues
in class Series
protected void drawMark(int valueIndex, java.lang.String st, SeriesMarksPosition aPosition)
public ValueList getQuoteValues()
public double getDifferenceLimit()
public void setDifferenceLimit(double value)
value
- doublepublic double getMinYValue()
getMinYValue
in class Series
public double getMaxXValue()
getMaxXValue
in class Series
public double getMinXValue()
getMinXValue
in class Series
public void drawValue(int valueIndex)
public boolean getQuotesSorted()
public void setQuotesSorted(boolean value)
value
- booleanpublic void setOpportunityValues(ValueList value)
public ValueList getOpportunityValues()
public boolean getAutoUpdate()
public void setAutoUpdate(boolean value)
value
- booleanpublic void reCalc()
public int addSegment(double aQuote, double aOpportunity, java.lang.String aLabel, Color aColor)
aQuote
- doubleaOpportunity
- doubleaLabel
- StringaColor
- Colorpublic java.lang.String getDescription()
getDescription
in class Series