public class CustomBox extends Points
Title: CustomBox class
Description: CustomBox Series.
Copyright (c) 2005-2019 by Steema Software SL. All Rights Reserved.
Company: Steema Software SL
Series.MarkTextResolver
Modifier and Type | Field and Description |
---|---|
protected double |
dPosition |
protected boolean |
iVertical |
iStacked, point
linePen, treatNans, treatnulls
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 |
---|
CustomBox() |
CustomBox(IBaseChart c) |
Modifier and Type | Method and Description |
---|---|
protected void |
addSampleValues(int numValues) |
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. |
void |
doBeforeDrawValues() |
protected void |
draw() |
protected void |
drawMark(int valueIndex,
java.lang.String s,
SeriesMarksPosition position) |
void |
drawValue(int index)
Called internally.
|
double |
getAdjacentPoint1()
Read from AdjacentPoint1 to get SampleValues lower adjacent point
limit.
NOTE: Writing to AdjacentPoint1 does not ensure custom value will be used to construct a box plot. |
double |
getAdjacentPoint3()
Read from AdjacentPoint3 to get SampleValues upper adjacent point.
AdjacentPoint3 is the data point that is closest to InnerFence3, without lying above InnerFence3. |
SeriesPointer |
getBox()
Controls the appearance of CustomBoxSeries box.
Box contains several properties to control the formatting attributes of box, like Pen, Brush, Draw3D, Visible, etc. |
SeriesPointer |
getExtrOut()
Controls the appearance of the extreme range of outer points.
ExtrOut contains several properties to control the formatting attributes of the extreme range of outer points like Pen, Brush, Draw3D, Visible, etc. |
double |
getInnerFence1()
Read from InnerFence1 to get SampleValues lower inner fence.
Write to InnerFence1 to override TCustomBoxSeries default calculating algorithm and use supplied value to construct box plot. |
double |
getInnerFence3()
Read from InnerFence3 to get SampleValues upper inner fence.
Write to InnerFence3 to override TCustomBoxSeries default calculating algorithm and use supplied value to construct box plot. NOTE: Writing to InnerFence1 does not ensure custom value will be used to construct a box plot. |
double |
getMedian()
Read from Median to get SampleValues median value.
Write to Median to CustomBox Series default calculating algorithm and use supplied value to construct box plot. NOTE: Writing to Median does not ensure custom value will be used to construct a box plot. |
ChartPen |
getMedianPen()
Defines the Pen to draw the median line.
Use the properties of MedianPen to change the color or style of median pen. |
SeriesPointer |
getMildOut()
Controls the appearance of the mid range of outer points.
MildOut contains several properties to control the formatting attributes of the mid range of outer points like Pen, Brush, Draw3D, Visible, etc. |
double |
getOuterFence1()
Read from OuterFence1 to get SampleValues lower outer fence.
Write to OuterFence1 to CustomBox Series default calculating algorithm and use supplied value to static finalruct box plot. NOTE: Writing to OuterFence1 does not ensure custom value will be used to construct a box plot. |
double |
getOuterFence3()
Read from OuterFence3 to get SampleValues upper outer fence.
Write to OuterFence3 to CustomBox Series default calculating algorithm and use supplied value to static finalruct box plot. NOTE: Writing to OuterFence3 does not ensure custom value will be used to construct a box plot. |
double |
getPosition()
Specifies the position of box series.
If series is a Box series then Position specifies the horizontal axis position. If series is a HorizBox series then Position specifies the vertical axis position. |
double |
getQuartile1()
Read from Quartile1 to get SampleValues first quartile.
Approximately 25% of the data will fall on or below Quartile1. Write to Quartile1 to override TCustomBoxSeries default calculating algorithm and use supplied value to construct box plot. |
double |
getQuartile3()
Read from Quartile3 to get SampleValues first quartile.
Approximately 75% of the data will fall on or below Quartile3. Write to Quartile3 to override TCustomBoxSeries default calculating algorithm and use supplied value to construct box plot. |
ValueList |
getSampleValues()
Use SampleValues property to get access to the values of Series.
WARNING : If you are using internal lagorithm (UseCustomValues = false) then you must make sure SampleValues are sorted in ascending order. |
boolean |
getUseCustomValues()
Set to true if you want to override internal algorithm to construct a
box plot.
Default (internal) algorithm does the following steps: 1. |
double |
getWhiskerLength()
Defines the whisker length as a function of the inter-quartike range
(IQR).
Default value: 1.5 |
ChartPen |
getWhiskerPen()
Defines the Pen to draw the whisker lines.
Use the properties of WhiskerPen to change the color or style of whisker lines. |
void |
prepareForGallery(boolean isEnabled) |
void |
reconstructFromData()
Reconstructs the box plot from series data.
|
void |
setAdjacentPoint1(double value)
Read from AdjacentPoint1 to get SampleValues lower adjacent point
limit.
Default value: 0 |
void |
setAdjacentPoint3(double value)
Read from AdjacentPoint3 to get SampleValues upper adjacent point.
Default value: O |
void |
setChart(IBaseChart c)
Chart associated with this object.
|
void |
setInnerFence1(double value)
Read from InnerFence1 to get SampleValues lower inner fence.
Default value: O |
void |
setInnerFence3(double value)
Read from InnerFence3 to get SampleValues upper inner fence.
Default value: O |
void |
setMedian(double value)
Read from Median to get SampleValues median value.
Default value: O |
void |
setOuterFence1(double value)
Read from OuterFence1 to get SampleValues lower outer fence.
Default value: O |
void |
setOuterFence3(double value)
Read from OuterFence3 to get SampleValues upper outer fence.
Default value: O |
void |
setPosition(double value)
Specifies the position of box series.
Default value: O |
void |
setQuartile1(double value)
Read from Quartile1 to get SampleValues first quartile.
Default value: O |
void |
setQuartile3(double value)
Read from Quartile3 to get SampleValues first quartile.
Default value: O |
void |
setUseCustomValues(boolean value)
Set to true if you want to override internal algorithm to construct a
box plot.
Default value: false |
void |
setWhiskerLength(double value)
Sets the whisker length as a function of the inter-quartike range
(IQR).
Default value: 1.5D |
canDoExtra, createSubGallery, getColor, getDescription, getLinePen, setColor, setColorEach, setSubGallery
addSeriesMouseListener, calcHorizMargins, calcVerticalMargins, calcXPos, calcYPos, calcZOrder, clicked, clickedPointer, drawLegendShape, drawPointer, getMaxXValue, getMaxYValue, getMinXValue, getMinYValue, getOriginPos, getPointer, getStacked, onGetPointerStyle, removePointerStyleResolver, removeSeriesMouseListener, sameClassOrigin, setPointerStyleResolver, setStacked
add, add, calcMinMaxValue, doNotPaintNull, getTreatNaNAsNull, getTreatNulls, IgnoreNull, setTreatNaNAsNull, setTreatNulls
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, addSeriesPaintListener, addValues, assignDispose, assignValues, associatedToAxis, beginUpdate, calcFirstLastVisibleIndex, calcPercentSt, calcPosValue, calculateMarkPosition, calcXPosValue, calcXSizeValue, calcYPosValue, calcYSizeValue, canAddRandomPoints, changeType, checkDataSource, checkMouse, checkOrder, checkOtherSeries, clear, clearLists, clicked, clone, cloneSeries, convertArray, countLegendItems, createNewSeries, createNewSeries, createNewSeries, dataSourceArray, delete, delete, delete, dispose, doAfterDrawValues, doBeforeDrawChart, doClick, doClickPointer, doDoubleClick, drawHiddenValue, drawLegend, drawLegend, drawMarks, drawMarksSeries, drawSeries, drawSeriesForward, drawValuesForward, endUpdate, fillSampleValues, fillSampleValues, fireSeriesMouseEvent, fireSeriesPaint, firstDisplayed, galleryChanged3D, getActive, getAllowSinglePoint, getBitmapEditor, getBrush, getColorEach, getColorMember, getColors, getCount, getCountLegendItems, getCursor, getCustomHorizAxis, getCustomVertAxis, getDataSource, getDefaultColor, getDefaultNullValue, getDepth, getEndZ, getFields, getFirstVisible, getFunction, getHasZValues, getHorizAxis, getHorizontalAxis, getLabelMember, getLabels, getLastVisible, getLegendString, getMandatory, getMandatoryAxis, getMarks, getMarkText, getMarkValue, 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, legendItemColor, legendToValueIndex, maxMarkWidth, moreSameZOrder, mouseEvent, newFromType, numSampleValues, onDisposing, prepareLegendCanvas, randomBounds, readResolve, recalcGetAxis, refreshSeries, removeMarkTextResolver, removeSeriesPaintListener, repaint, sameClass, setActive, 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, 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 CustomBox()
public CustomBox(IBaseChart c)
public void assign(Series source)
Series
public double getWhiskerLength()
public void setWhiskerLength(double value)
value
- doublepublic SeriesPointer getBox()
public ValueList getSampleValues()
public double getPosition()
public void setPosition(double value)
value
- doublepublic ChartPen getWhiskerPen()
public ChartPen getMedianPen()
public void reconstructFromData()
public void doBeforeDrawValues()
doBeforeDrawValues
in class Series
public void drawValue(int index)
drawValue
in interface ISeries
drawValue
in class CustomPoint
index
- intprotected void addSampleValues(int numValues)
addSampleValues
in class Series
public void prepareForGallery(boolean isEnabled)
prepareForGallery
in class Series
protected void drawMark(int valueIndex, java.lang.String s, SeriesMarksPosition position)
drawMark
in class CustomPoint
public void setChart(IBaseChart c)
TeeBase
setChart
in interface ISeries
setChart
in class CustomPoint
c
- IBaseChartpublic double getAdjacentPoint1()
CustomBox
public void setAdjacentPoint1(double value)
value
- doublepublic double getAdjacentPoint3()
CustomBox
public void setAdjacentPoint3(double value)
value
- doubleCustomBox
public double getOuterFence3()
CustomBox
public void setOuterFence3(double value)
value
- doubleCustomBox
public double getOuterFence1()
CustomBox
public void setOuterFence1(double value)
value
- doubleCustomBox
public double getInnerFence1()
CustomBox
public void setInnerFence1(double value)
value
- doubleCustomBox
public double getInnerFence3()
CustomBox
public void setInnerFence3(double value)
value
- doubleCustomBox
public double getQuartile1()
CustomBox
public void setQuartile1(double value)
value
- doubleCustomBox
public double getQuartile3()
CustomBox
public void setQuartile3(double value)
value
- doubleCustomBox
public double getMedian()
CustomBox
public void setMedian(double value)
value
- doubleCustomBox
public boolean getUseCustomValues()
public void setUseCustomValues(boolean value)
value
- booleanpublic SeriesPointer getMildOut()
public SeriesPointer getExtrOut()