public interface IAxisCore extends com.scichart.core.IServiceProvider, com.scichart.core.framework.ISuspendable, com.scichart.core.framework.IInvalidatableElement, IThemeable, com.scichart.core.framework.IAttachable
Modifier and Type | Method and Description |
---|---|
void |
animateVisibleRangeTo(com.scichart.data.model.IRange range,
long duration)
Animates the visible range of the axis to the destination
range , over the specified duration . |
ICoordinateCalculator |
createCoordinateCalculatorFrom(com.scichart.data.model.IRange visibleRange)
Creates a coordinate calculator from specified visible range
|
java.lang.CharSequence |
formatCursorText(java.lang.Comparable value)
Formats
value using the CursorTextFormatting of current Axis as formatting string |
java.lang.CharSequence |
formatText(java.lang.Comparable value)
Formats
value using the TextFormatting of current Axis as formatting string |
AutoRange |
getAutoRange()
Gets auto range mode for current axis.
|
boolean |
getAutoTicks()
Get the value that indicates whether calculate ticks automatically.
|
com.scichart.drawing.common.BrushStyle |
getAxisBandsStyle()
Gets the style for Axis Bands
|
java.lang.String |
getAxisId()
Gets the string Id of this Axis.
|
IReadWriteLock |
getAxisParamsLock()
Gets the lock for current axis params.
|
java.lang.CharSequence |
getAxisTitle()
Gets sets the Axis Title
|
int |
getAxisViewportDimension()
Gets the axis viewport dimension, which is used by
ICoordinateCalculator of the Axis |
float |
getCoordinate(java.lang.Comparable value)
Converts given data value to the x or y pixel coordinate on this axis
|
ICoordinateCalculator |
getCurrentCoordinateCalculator()
Gets the current
ICoordinateCalculator for this Axis, based on current Visible Range and axis type |
java.lang.String |
getCursorTextFormatting()
Gets the Text Formatting String for Labels on this cursor
|
com.scichart.data.model.IRange |
getDataRange()
Gets the data range(full extents of the data) of the Axis
|
com.scichart.data.model.IRange |
getDataRange(boolean forceCacheUpdate)
Gets the data range(full extents of the data) of the Axis
|
java.lang.Comparable |
getDataValue(float pixelCoordinate)
Converts given the x or y pixel coordinate to the data value at this coordinate
|
com.scichart.data.model.IRange |
getDefaultNonZeroRange()
Returns an default non zero
IRange , called internally by SciChart to reset the VisibleRange of an axis to an default state |
boolean |
getDrawLabels()
Gets a flag indicating whether to draw tick labels or not
|
boolean |
getDrawMajorBands()
Gets a flag indicating whether to draw major bands or not
|
boolean |
getDrawMajorGridLines()
Gets a flag indicating whether to draw major grid lines or not
|
boolean |
getDrawMajorTicks()
Gets a flag indicating whether to draw major ticks or not
|
boolean |
getDrawMinorGridLines()
Gets a flag indicating whether to draw minor grid lines or not
|
boolean |
getDrawMinorTicks()
Gets a flag indicating whether to draw minor ticks or not
|
boolean |
getFlipCoordinates()
Gets a flag indicating whether to flip the tick and pixel coordinate generation for this axis, causing the axis ticks to decrement and chart to be flipped in the axis direction
|
com.scichart.data.model.IRange<java.lang.Double> |
getGrowBy()
Gets the GrowBy Factor
|
ILabelProvider |
getLabelProvider()
Gets a
ILabelProvider instance, which may be used to programmatically override the formatting of text and cursor labels. |
java.lang.Comparable |
getMajorDelta()
Gets the Major Delta
|
com.scichart.drawing.common.PenStyle |
getMajorGridLineStyle()
Gets the style which is used to draw all major grid lines on this axis
|
float |
getMajorTickLineLength()
Gets the the length of all major ticks on this axis
|
com.scichart.drawing.common.PenStyle |
getMajorTickLineStyle()
Gets the style which is used to draw all major ticks on this axis
|
int |
getMaxAutoTicks()
Gets the max ticks.
|
com.scichart.data.model.IRange |
getMaximumRange()
Gets the maximum range of the axis, based on the data-range of all series
|
com.scichart.data.model.IRange |
getMaximumRange(boolean forceCacheUpdate)
Gets the maximum range of the axis, based on the data-range of all series
|
java.lang.Comparable |
getMaximumZoomConstrain()
Gets the MaximumZoomConstrain of the Axis.
|
java.lang.Comparable |
getMinimalZoomConstrain()
Gets the MinimalZoomConstrain of the Axis.
|
java.lang.Comparable |
getMinorDelta()
Gets the Minor Delta
|
com.scichart.drawing.common.PenStyle |
getMinorGridLineStyle()
Gets the style which is used to draw all minor grid lines on this axis
|
int |
getMinorsPerMajor()
Gets the number of Minor Delta ticks per Major Tick
|
float |
getMinorTickLineLength()
Gets the the length of all minor ticks on this axis
|
com.scichart.drawing.common.PenStyle |
getMinorTickLineStyle()
Gets the style which is used to draw all minor ticks on this axis
|
java.lang.String |
getTextFormatting()
Gets the Text Formatting String for Axis Tick Labels on this axis
|
ITickCoordinatesProvider |
getTickCoordinatesProvider()
Gets a
ITickCoordinatesProvider instance on current axis,
which is used to transform the data-values received from the ITickProvider instance
to the coordinates for Axis Grid Lines, Ticks and Labels drawing. |
ITickProvider |
getTickProvider()
Gets a
ITickProvider instance on current axis,
which is used to compute the data-values of Axis Grid Lines, Ticks and Labels. |
int |
getVisibility()
Get visibility of this axis
|
com.scichart.data.model.IRange |
getVisibleRange()
Gets the VisibleRange of the Axis
|
com.scichart.data.model.IRange |
getVisibleRangeLimit()
Gets the VisibleRangeLimit of the Axis.
|
com.scichart.data.model.RangeClipMode |
getVisibleRangeLimitMode()
Gets the VisibleRangeLimitMode of the Axis.
|
boolean |
hasDefaultVisibleRange()
Gets whether the VisibleRange has default value
|
boolean |
hasValidVisibleRange()
Gets whether the VisibleRange is valid, e.g.
|
boolean |
isValidRange(com.scichart.data.model.IRange range)
Checks whether
range is valid visible range for this axis |
void |
onDataRangeChanged()
Used internally for notification of axis when data range changes
|
void |
setAutoRange(AutoRange autoRange)
Sets auto range mode for current axis.
|
void |
setAutoTicks(boolean autoTicks)
Sets the value that indicates whether calculate ticks automatically.
|
void |
setAxisBandsStyle(com.scichart.drawing.common.BrushStyle bandsStyle)
Sets the style for Axis Bands.
|
void |
setAxisId(java.lang.String axisId)
Sets the string Id of this Axis.
|
void |
setAxisTitle(java.lang.CharSequence axisTitle)
Sets or sets the Axis Title
|
void |
setCursorTextFormatting(java.lang.String cursorTextFormatting)
Sets the Text Formatting String for Labels on this cursor
|
void |
setDataRangeChangeListener(DataRangeChangeListener listener)
Sets
DataRangeChangeListener for this axis instance |
void |
setDrawLabels(boolean drawLabels)
Sets a flag indicating whether to draw tick labels or not
|
void |
setDrawMajorBands(boolean drawMajorBands)
Sets a flag indicating whether to draw major bands or not
|
void |
setDrawMajorGridLines(boolean drawMajorGridLines)
Sets a flag indicating whether to draw major grid lines or not
|
void |
setDrawMajorTicks(boolean drawMajorTicks)
Sets a flag indicating whether to draw major ticks or not
|
void |
setDrawMinorGridLines(boolean drawMinorGridLines)
Sets a flag indicating whether to draw minor grid lines or not
|
void |
setDrawMinorTicks(boolean drawMinorTicks)
Sets a flag indicating whether to draw minor ticks or not
|
void |
setFlipCoordinates(boolean flipCoordinates)
Sets a flag indicating whether to flip the tick and pixel coordinate generation for this axis, causing the axis ticks to decrement and chart to be flipped in the axis direction
If
true reverses the ticks and coordinates for the axis. |
void |
setGrowBy(com.scichart.data.model.IRange<java.lang.Double> growBy)
Sets the GrowBy Factor.
|
void |
setLabelProvider(ILabelProvider labelProvider)
Sets a
ILabelProvider instance, which may be used to programmatically override the formatting of text and cursor labels. |
void |
setMajorDelta(java.lang.Comparable majorDelta)
Sets the Major Delta
|
void |
setMajorGridLineStyle(com.scichart.drawing.common.PenStyle majorGridLineStyle)
Sets the style which is used to draw all major grid lines on this axis
|
void |
setMajorTickLineLength(float majorTickLineLength)
Sets the the length of all major ticks on this axis
|
void |
setMajorTickLineStyle(com.scichart.drawing.common.PenStyle majorTickLineStyle)
Sets the style which is used to draw all major ticks on this axis
|
void |
setMaxAutoTicks(int maxAutoTicks)
Sets the max ticks.
|
void |
setMaximumZoomConstrain(java.lang.Comparable maximumZoomConstrain)
Sets the MaximumZoomConstrain of the Axis.
|
void |
setMinimalZoomConstrain(java.lang.Comparable minimalZoomConstrain)
Sets the MinimalZoomConstrain of the Axis.
|
void |
setMinorDelta(java.lang.Comparable minorDelta)
Sets the Minor Delta
|
void |
setMinorGridLineStyle(com.scichart.drawing.common.PenStyle minorGridLineStyle)
Sets the style which is used to draw all minor grid lines on this axis
|
void |
setMinorsPerMajor(int minorsPerMajors)
Sets the number of Minor Delta ticks per Major Tick
|
void |
setMinorTickLineLength(float minorTickLineLength)
Sets the the length of all minor ticks on this axis
|
void |
setMinorTickLineStyle(com.scichart.drawing.common.PenStyle minorTickLineStyle)
Sets the style which is used to draw all minor ticks on this axis
|
void |
setTextFormatting(java.lang.String textFormatting)
Sets the Text Formatting String for Axis Tick Labels on this axis
|
void |
setTickCoordinatesProvider(ITickCoordinatesProvider tickCoordinatesProvider)
Sets a
ITickCoordinatesProvider instance on current axis,
which is used to transform the data-values received from the ITickProvider instance
to the coordinates for Axis Grid Lines, Ticks and Labels drawing. |
void |
setTickProvider(ITickProvider tickProvider)
Sets a
ITickProvider instance on current axis,
which is used to compute the data-values of Axis Grid Lines, Ticks and Labels. |
void |
setVisibility(int visibility)
Sets visibility of this axis
|
void |
setVisibleRange(com.scichart.data.model.IRange visibleRange)
Sets the VisibleRange of the Axis.
|
void |
setVisibleRangeChangeListener(VisibleRangeChangeListener listener)
Sets
VisibleRangeChangeListener for this axis instance |
void |
setVisibleRangeLimit(com.scichart.data.model.IRange visibleRangeLimit)
Sets the VisibleRangeLimit of the Axis.
|
void |
setVisibleRangeLimitMode(com.scichart.data.model.RangeClipMode visibleRangeLimitMode)
the VisibleRangeLimitMode of the Axis.
|
decrementSuspend, getIsSuspended, getUpdateSuspenderCount, resumeUpdates, suspendUpdates
invalidateElement
applyThemeProvider
void setVisibleRangeChangeListener(VisibleRangeChangeListener listener)
VisibleRangeChangeListener
for this axis instancelistener
- The listener to setvoid setDataRangeChangeListener(DataRangeChangeListener listener)
DataRangeChangeListener
for this axis instancelistener
- The listener to setcom.scichart.data.model.IRange getMaximumRange()
com.scichart.data.model.IRange getMaximumRange(boolean forceCacheUpdate)
forceCacheUpdate
- Flag indicating whether the cached results should be updatedcom.scichart.data.model.IRange getDataRange()
com.scichart.data.model.IRange getDataRange(boolean forceCacheUpdate)
forceCacheUpdate
- Flag indicating whether the cached results should be updatedvoid setVisibleRange(com.scichart.data.model.IRange visibleRange)
visibleRange
- The new VisibleRange valuecom.scichart.data.model.IRange getVisibleRange()
void setGrowBy(com.scichart.data.model.IRange<java.lang.Double> growBy)
growBy
- The new GrowBy valuecom.scichart.data.model.IRange<java.lang.Double> getGrowBy()
void setAxisId(java.lang.String axisId)
IRenderableSeries
axisId
- The new axis idjava.lang.String getAxisId()
void setVisibleRangeLimit(com.scichart.data.model.IRange visibleRangeLimit)
visibleRangeLimit
- The new VisibleRangeLimit valuecom.scichart.data.model.IRange getVisibleRangeLimit()
void setVisibleRangeLimitMode(com.scichart.data.model.RangeClipMode visibleRangeLimitMode)
getVisibleRangeLimit()
will be used by axisvisibleRangeLimitMode
- The new VisibleRangeLimitMode valuecom.scichart.data.model.RangeClipMode getVisibleRangeLimitMode()
VisibleRangeLimit
will be used by axisvoid setMinimalZoomConstrain(java.lang.Comparable minimalZoomConstrain)
minimalZoomConstrain
- The new minimal zoom constrain valuejava.lang.Comparable getMinimalZoomConstrain()
java.lang.Comparable getMaximumZoomConstrain()
void setMaximumZoomConstrain(java.lang.Comparable maximumZoomConstrain)
maximumZoomConstrain
- The maximum zoom constrain valuevoid setMajorDelta(java.lang.Comparable majorDelta)
majorDelta
- The new Major Delta valuejava.lang.Comparable getMajorDelta()
void setMinorDelta(java.lang.Comparable minorDelta)
minorDelta
- The new Minor Delta valuejava.lang.Comparable getMinorDelta()
void setAutoTicks(boolean autoTicks)
autoTicks
- The new autoTicks valueboolean getAutoTicks()
void setMaxAutoTicks(int maxAutoTicks)
maxAutoTicks
- The new maxAutoTicks valueint getMaxAutoTicks()
void setMinorsPerMajor(int minorsPerMajors)
minorsPerMajors
- The new minorsPerMajors valueint getMinorsPerMajor()
void setFlipCoordinates(boolean flipCoordinates)
true
reverses the ticks and coordinates for the axis.flipCoordinates
- The new flipCoordinates valueboolean getFlipCoordinates()
boolean getDrawMajorTicks()
void setDrawMajorTicks(boolean drawMajorTicks)
drawMajorTicks
- The new drawMajorTicks valueboolean getDrawMajorGridLines()
void setDrawMajorGridLines(boolean drawMajorGridLines)
drawMajorGridLines
- The new drawMajorGridLines valueboolean getDrawMajorBands()
void setDrawMajorBands(boolean drawMajorBands)
drawMajorBands
- The new drawMajorBands valueboolean getDrawMinorTicks()
void setDrawMinorTicks(boolean drawMinorTicks)
drawMinorTicks
- The new drawMinorTicks valueboolean getDrawMinorGridLines()
void setDrawMinorGridLines(boolean drawMinorGridLines)
drawMinorGridLines
- The new drawMinorGridLines valueboolean getDrawLabels()
void setDrawLabels(boolean drawLabels)
drawLabels
- The new drawLabels valuejava.lang.CharSequence getAxisTitle()
void setAxisTitle(java.lang.CharSequence axisTitle)
axisTitle
- The new axis titleAutoRange getAutoRange()
void setAutoRange(AutoRange autoRange)
If AutoRange.Always, the axis should scale to fit the data.
If AutoRange.Once, the axis will try to fit the data once.
If AutoRange.Never, then the axis will never auto range.
autoRange
- The new auto range valueITickProvider getTickProvider()
ITickProvider
instance on current axis,
which is used to compute the data-values of Axis Grid Lines, Ticks and Labels.void setTickProvider(ITickProvider tickProvider)
ITickProvider
instance on current axis,
which is used to compute the data-values of Axis Grid Lines, Ticks and Labels.tickProvider
- The new tick providerITickCoordinatesProvider getTickCoordinatesProvider()
ITickCoordinatesProvider
instance on current axis,
which is used to transform the data-values received from the ITickProvider
instance
to the coordinates for Axis Grid Lines, Ticks and Labels drawing.void setTickCoordinatesProvider(ITickCoordinatesProvider tickCoordinatesProvider)
ITickCoordinatesProvider
instance on current axis,
which is used to transform the data-values received from the ITickProvider
instance
to the coordinates for Axis Grid Lines, Ticks and Labels drawing.tickCoordinatesProvider
- The new tick coordinates providerILabelProvider getLabelProvider()
ILabelProvider
instance, which may be used to programmatically override the formatting of text and cursor labels.NumericLabelProvider
void setLabelProvider(ILabelProvider labelProvider)
ILabelProvider
instance, which may be used to programmatically override the formatting of text and cursor labels.labelProvider
- The new label providerjava.lang.String getTextFormatting()
void setTextFormatting(java.lang.String textFormatting)
textFormatting
- The new text formattingjava.lang.String getCursorTextFormatting()
void setCursorTextFormatting(java.lang.String cursorTextFormatting)
cursorTextFormatting
- The new cursor text formattingcom.scichart.drawing.common.PenStyle getMajorGridLineStyle()
void setMajorGridLineStyle(com.scichart.drawing.common.PenStyle majorGridLineStyle)
majorGridLineStyle
- The new major grid line stylecom.scichart.drawing.common.PenStyle getMinorGridLineStyle()
void setMinorGridLineStyle(com.scichart.drawing.common.PenStyle minorGridLineStyle)
minorGridLineStyle
- The new minor grid line stylevoid setAxisBandsStyle(com.scichart.drawing.common.BrushStyle bandsStyle)
setDrawMajorBands
to enable this behaviorbandsStyle
- The new axis bands stylecom.scichart.drawing.common.BrushStyle getAxisBandsStyle()
com.scichart.drawing.common.PenStyle getMajorTickLineStyle()
void setMajorTickLineStyle(com.scichart.drawing.common.PenStyle majorTickLineStyle)
majorTickLineStyle
- The new major tick line stylecom.scichart.drawing.common.PenStyle getMinorTickLineStyle()
void setMinorTickLineStyle(com.scichart.drawing.common.PenStyle minorTickLineStyle)
minorTickLineStyle
- The new minor tick line stylefloat getMinorTickLineLength()
void setMinorTickLineLength(float minorTickLineLength)
minorTickLineLength
- The new minor tick line length in pixelsfloat getMajorTickLineLength()
void setMajorTickLineLength(float majorTickLineLength)
majorTickLineLength
- The new major tick line length in pixelsICoordinateCalculator getCurrentCoordinateCalculator()
ICoordinateCalculator
for this Axis, based on current Visible Range and axis typeICoordinateCalculator
instanceICoordinateCalculator createCoordinateCalculatorFrom(com.scichart.data.model.IRange visibleRange)
visibleRange
- The visible range to create coordinate calculator fromvoid animateVisibleRangeTo(com.scichart.data.model.IRange range, long duration)
range
, over the specified duration
.range
- The end rangeduration
- The duration of the animationboolean isValidRange(com.scichart.data.model.IRange range)
range
is valid visible range for this axisrange
- The range to checkboolean hasValidVisibleRange()
boolean hasDefaultVisibleRange()
com.scichart.data.model.IRange getDefaultNonZeroRange()
IRange
, called internally by SciChart to reset the VisibleRange of an axis to an default statevoid onDataRangeChanged()
java.lang.Comparable getDataValue(float pixelCoordinate)
pixelCoordinate
- The coordinate in pixels to convertfloat getCoordinate(java.lang.Comparable value)
value
- The data value to convertvoid setVisibility(int visibility)
visibility
- The new visibility valueint getVisibility()
int getAxisViewportDimension()
ICoordinateCalculator
of the AxisIReadWriteLock getAxisParamsLock()
java.lang.CharSequence formatText(java.lang.Comparable value)
value
using the TextFormatting of current Axis as formatting stringvalue
- data value to formatjava.lang.CharSequence formatCursorText(java.lang.Comparable value)
value
using the CursorTextFormatting of current Axis as formatting stringvalue
- data value to format