Class AxisCore<T>

Defines a base class for axes used throughout SciChart

Inheritance
java.lang.Object
AxisCore<T>
Implements
Inherited Members
Namespace:
Assembly: .dll
Syntax
public abstract class AxisCore<T> implements IAxisCore
Type Parameters
Name Description
T

Constructors

AxisCore(IRange<T> defaultNonZeroRange)

Creates a new instance of AxisCore class

Declaration
protected AxisCore(IRange<T> defaultNonZeroRange)
Parameters
Type Name Description
IRange<T> defaultNonZeroRange

The default non zero range which should be used by axis

Fields

DEFAULT_AXIS_ID

Declaration
public static final String DEFAULT_AXIS_ID
Field Value
Type Description
String

autoRangeProperty

Declaration
protected final SmartProperty<AutoRange> autoRangeProperty
Field Value
Type Description
SmartProperty<AutoRange>

autoTicksProperty

Declaration
protected final SmartPropertyBoolean autoTicksProperty
Field Value
Type Description
SmartPropertyBoolean

axisBandsStyleProperty

Declaration
protected final SmartProperty<BrushStyle> axisBandsStyleProperty
Field Value
Type Description
SmartProperty<BrushStyle>

axisBorderStyleProperty

Declaration
protected final SmartProperty<AxisBorderStyle> axisBorderStyleProperty
Field Value
Type Description
SmartProperty<AxisBorderStyle>

axisParams

Declaration
protected final AxisParams axisParams
Field Value
Type Description
AxisParams

axisParamsLock

Declaration
protected final IReadWriteLock axisParamsLock
Field Value
Type Description
IReadWriteLock

axisTitleProperty

Declaration
protected final SmartProperty<CharSequence> axisTitleProperty
Field Value
Type Description
SmartProperty<CharSequence>

cursorTextFormattingProperty

Declaration
protected final SmartProperty<String> cursorTextFormattingProperty
Field Value
Type Description
SmartProperty<String>

drawLabelsProperty

Declaration
protected final SmartPropertyBoolean drawLabelsProperty
Field Value
Type Description
SmartPropertyBoolean

drawMajorBandsProperty

Declaration
protected final SmartPropertyBoolean drawMajorBandsProperty
Field Value
Type Description
SmartPropertyBoolean

drawMajorGridLinesProperty

Declaration
protected final SmartPropertyBoolean drawMajorGridLinesProperty
Field Value
Type Description
SmartPropertyBoolean

drawMajorTicksProperty

Declaration
protected final SmartPropertyBoolean drawMajorTicksProperty
Field Value
Type Description
SmartPropertyBoolean

drawMinorGridLinesProperty

Declaration
protected final SmartPropertyBoolean drawMinorGridLinesProperty
Field Value
Type Description
SmartPropertyBoolean

drawMinorTicksProperty

Declaration
protected final SmartPropertyBoolean drawMinorTicksProperty
Field Value
Type Description
SmartPropertyBoolean

flipCoordinatesProperty

Declaration
protected final SmartPropertyBoolean flipCoordinatesProperty
Field Value
Type Description
SmartPropertyBoolean

invalidateAndRecreateCalculatorsCallback

Declaration
protected final AxisCore<T>.InvalidateAndRecreateCalculatorsCallback invalidateAndRecreateCalculatorsCallback
Field Value
Type Description
AxisCore<T>.InvalidateAndRecreateCalculatorsCallback

invalidateElement

Declaration
protected final AxisCore<T>.InvalidateElementCallback invalidateElement
Field Value
Type Description
AxisCore<T>.InvalidateElementCallback

majorDeltaProperty

Declaration
protected final SmartProperty<Comparable> majorDeltaProperty
Field Value
Type Description
SmartProperty<Comparable>

majorGridLineStyleProperty

Declaration
protected final SmartProperty<PenStyle> majorGridLineStyleProperty
Field Value
Type Description
SmartProperty<PenStyle>

majorTickLineLengthProperty

Declaration
protected final SmartPropertyFloat majorTickLineLengthProperty
Field Value
Type Description
SmartPropertyFloat

majorTickLineStyleProperty

Declaration
protected final SmartProperty<PenStyle> majorTickLineStyleProperty
Field Value
Type Description
SmartProperty<PenStyle>

maxAutoTicksProperty

Declaration
protected final SmartPropertyInteger maxAutoTicksProperty
Field Value
Type Description
SmartPropertyInteger

minorDeltaProperty

Declaration
protected final SmartProperty<Comparable> minorDeltaProperty
Field Value
Type Description
SmartProperty<Comparable>

minorGridLineStyleProperty

Declaration
protected final SmartProperty<PenStyle> minorGridLineStyleProperty
Field Value
Type Description
SmartProperty<PenStyle>

minorTickLineLengthProperty

Declaration
protected final SmartPropertyFloat minorTickLineLengthProperty
Field Value
Type Description
SmartPropertyFloat

minorTickLineStyleProperty

Declaration
protected final SmartProperty<PenStyle> minorTickLineStyleProperty
Field Value
Type Description
SmartProperty<PenStyle>

minorsPerMajorProperty

Declaration
protected final SmartPropertyInteger minorsPerMajorProperty
Field Value
Type Description
SmartPropertyInteger

redrawElement

Declaration
protected final AxisCore<T>.RedrawElementCallback redrawElement
Field Value
Type Description
AxisCore<T>.RedrawElementCallback

textFormattingProperty

Declaration
protected final SmartProperty<String> textFormattingProperty
Field Value
Type Description
SmartProperty<String>

Methods

animateVisibleRangeTo(IRange range, long duration)

Animates the visible range of the axis to the destination range, over the specified duration.

Declaration
public void animateVisibleRangeTo(IRange range, long duration)
Parameters
Type Name Description
IRange range
long duration

applyThemeProvider(IThemeProvider themeProvider)

Applies specified theme to current instance

Declaration
public void applyThemeProvider(IThemeProvider themeProvider)
Parameters
Type Name Description
IThemeProvider themeProvider

attachTo(IServiceContainer services)

Declaration
public void attachTo(IServiceContainer services)
Parameters
Type Name Description
IServiceContainer services

coerceVisibleRange(IRange<T> visibleRange)

When overridden in derived classes, changes value of the VisibleRange according to axis requirements

Declaration
protected void coerceVisibleRange(IRange<T> visibleRange)
Parameters
Type Name Description
IRange<T> visibleRange

Visible range to change

decrementSuspend()

Declaration
public void decrementSuspend()

detach()

Declaration
public void detach()

formatCursorText(Comparable value)

Formats value using the CursorTextFormatting of current Axis as formatting string

Declaration
public CharSequence formatCursorText(Comparable value)
Parameters
Type Name Description
Comparable value
Returns
Type Description
CharSequence

formatText(Comparable value)

Formats value using the TextFormatting of current Axis as formatting string

Declaration
public CharSequence formatText(Comparable value)
Parameters
Type Name Description
Comparable value
Returns
Type Description
CharSequence

fromDouble(double doubleValue)

Converts specified double representation of value to data value used by axis

Declaration
protected abstract Comparable fromDouble(double doubleValue)
Parameters
Type Name Description
double doubleValue

The double value to convert
Returns
Type Description
Comparable

The converted data value

getAutoRange()

Gets auto range mode for current axis. Default is AutoRange.Once

Declaration
public final AutoRange getAutoRange()
Returns
Type Description
AutoRange

getAutoTicks()

Get the value that indicates whether calculate ticks automatically. Default is True.

Declaration
public final boolean getAutoTicks()
Returns
Type Description
boolean

getAxisBandsStyle()

Gets the style for Axis Bands

Declaration
public final BrushStyle getAxisBandsStyle()
Returns
Type Description
BrushStyle

getAxisBorderStyle()

Gets the style which is used to draw the axis border

Declaration
public final AxisBorderStyle getAxisBorderStyle()
Returns
Type Description
AxisBorderStyle

getAxisId()

Gets the string Id of this Axis.

Declaration
public final String getAxisId()
Returns
Type Description
String

getAxisParamsLock()

Gets the lock for current axis params. Used internally for synchronization of axis updated during render pass

Declaration
public final IReadWriteLock getAxisParamsLock()
Returns
Type Description
IReadWriteLock

getAxisTitle()

Gets sets the Axis Title

Declaration
public final CharSequence getAxisTitle()
Returns
Type Description
CharSequence

getCoordinate(Comparable value)

Converts given data value to the x or y pixel coordinate on this axis

Declaration
public float getCoordinate(Comparable value)
Parameters
Type Name Description
Comparable value
Returns
Type Description
float

getCursorTextFormatting()

Gets the Text Formatting String for Labels on this cursor

Declaration
public final String getCursorTextFormatting()
Returns
Type Description
String

getDataRange()

Gets the data range(full extents of the data) of the Axis

Declaration
public final IRange<T> getDataRange()
Returns
Type Description
IRange<T>

getDataRange(boolean forceCacheUpdate)

Gets the data range(full extents of the data) of the Axis

Declaration
public abstract IRange<T> getDataRange(boolean forceCacheUpdate)
Parameters
Type Name Description
boolean forceCacheUpdate
Returns
Type Description
IRange<T>

getDataValue(float pixelCoordinate)

Converts given the x or y pixel coordinate to the data value at this coordinate

Declaration
public Comparable getDataValue(float pixelCoordinate)
Parameters
Type Name Description
float pixelCoordinate
Returns
Type Description
Comparable

getDefaultNonZeroRange()

Returns an default non zero IRange, called internally by SciChart to reset the VisibleRange of an axis to an default state

Declaration
public final IRange<T> getDefaultNonZeroRange()
Returns
Type Description
IRange<T>

getDrawLabels()

Gets a flag indicating whether to draw tick labels or not

Declaration
public final boolean getDrawLabels()
Returns
Type Description
boolean

getDrawMajorBands()

Gets a flag indicating whether to draw major bands or not

Declaration
public final boolean getDrawMajorBands()
Returns
Type Description
boolean

getDrawMajorGridLines()

Gets a flag indicating whether to draw major grid lines or not

Declaration
public final boolean getDrawMajorGridLines()
Returns
Type Description
boolean

getDrawMajorTicks()

Gets a flag indicating whether to draw major ticks or not

Declaration
public final boolean getDrawMajorTicks()
Returns
Type Description
boolean

getDrawMinorGridLines()

Gets a flag indicating whether to draw minor grid lines or not

Declaration
public final boolean getDrawMinorGridLines()
Returns
Type Description
boolean

getDrawMinorTicks()

Gets a flag indicating whether to draw minor ticks or not

Declaration
public final boolean getDrawMinorTicks()
Returns
Type Description
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

Declaration
public final boolean getFlipCoordinates()
Returns
Type Description
boolean

getGrowBy()

Gets the GrowBy Factor

Declaration
public final IRange<Double> getGrowBy()
Returns
Type Description
IRange<Double>

getIsSuspended()

Declaration
public final boolean getIsSuspended()
Returns
Type Description
boolean

getLabelProvider()

Gets a com.scichart.charting.numerics.labelProviders.ILabelProvider instance, which may be used to programmatically override the formatting of text and cursor labels.

Declaration
public final labelProviders.ILabelProvider getLabelProvider()
Returns
Type Description
labelProviders.ILabelProvider

getMajorDelta()

Gets the Major Delta

Declaration
public final Comparable getMajorDelta()
Returns
Type Description
Comparable

getMajorGridLineStyle()

Gets the style which is used to draw all major grid lines on this axis

Declaration
public final PenStyle getMajorGridLineStyle()
Returns
Type Description
PenStyle

getMajorTickLineLength()

Gets the the length of all major ticks on this axis

Declaration
public final float getMajorTickLineLength()
Returns
Type Description
float

getMajorTickLineStyle()

Gets the style which is used to draw all major ticks on this axis

Declaration
public final PenStyle getMajorTickLineStyle()
Returns
Type Description
PenStyle

getMaxAutoTicks()

Gets the max ticks.

Declaration
public final int getMaxAutoTicks()
Returns
Type Description
int

getMaximumRange()

Gets the maximum range of the axis, based on the data-range of all series

Declaration
public final IRange<T> getMaximumRange()
Returns
Type Description
IRange<T>

getMaximumRange(boolean forceCacheUpdate)

Gets the maximum range of the axis, based on the data-range of all series

Declaration
public abstract IRange<T> getMaximumRange(boolean forceCacheUpdate)
Parameters
Type Name Description
boolean forceCacheUpdate
Returns
Type Description
IRange<T>

getMaximumZoomConstrain()

Gets the MaximumZoomConstrain of the Axis. This is used to set maximum distance between Min and Max of the VisibleRange

Declaration
public final Comparable getMaximumZoomConstrain()
Returns
Type Description
Comparable

getMinimalZoomConstrain()

Gets the MinimalZoomConstrain of the Axis. This is used to set minimum distance between Min and Max of the VisibleRange

Declaration
public final Comparable getMinimalZoomConstrain()
Returns
Type Description
Comparable

getMinorDelta()

Gets the Minor Delta

Declaration
public final Comparable getMinorDelta()
Returns
Type Description
Comparable

getMinorGridLineStyle()

Gets the style which is used to draw all minor grid lines on this axis

Declaration
public final PenStyle getMinorGridLineStyle()
Returns
Type Description
PenStyle

getMinorTickLineLength()

Gets the the length of all minor ticks on this axis

Declaration
public final float getMinorTickLineLength()
Returns
Type Description
float

getMinorTickLineStyle()

Gets the style which is used to draw all minor ticks on this axis

Declaration
public final PenStyle getMinorTickLineStyle()
Returns
Type Description
PenStyle

getMinorsPerMajor()

Gets the number of Minor Delta ticks per Major Tick

Declaration
public final int getMinorsPerMajor()
Returns
Type Description
int

getServices()

Declaration
public final IServiceContainer getServices()
Returns
Type Description
IServiceContainer

getTextFormatting()

Gets the Text Formatting String for Axis Tick Labels on this axis

Declaration
public final String getTextFormatting()
Returns
Type Description
String

getTickCoordinatesProvider()

Gets a ITickCoordinatesProvider instance on current axis, which is used to transform the data-values received from the com.scichart.charting.numerics.tickProviders.ITickProvider instance to the coordinates for Axis Grid Lines, Ticks and Labels drawing.

Declaration
public final tickCoordinatesProviders.ITickCoordinatesProvider getTickCoordinatesProvider()
Returns
Type Description
tickCoordinatesProviders.ITickCoordinatesProvider

getTickProvider()

Gets a com.scichart.charting.numerics.tickProviders.ITickProvider instance on current axis, which is used to compute the data-values of Axis Grid Lines, Ticks and Labels.

Declaration
public final tickProviders.ITickProvider getTickProvider()
Returns
Type Description
tickProviders.ITickProvider

getType()

Gets base value type for current axis

Declaration
protected abstract Class<T> getType()
Returns
Type Description
Class<T>

Type of values for current axis

getUpdateSuspenderCount()

Declaration
public final AtomicInteger getUpdateSuspenderCount()
Returns
Type Description
AtomicInteger

getVisibility()

Get visibility of this axis

Declaration
public final int getVisibility()
Returns
Type Description
int

getVisibleRange()

Gets the VisibleRange of the Axis

Declaration
public final IRange<T> getVisibleRange()
Returns
Type Description
IRange<T>

getVisibleRangeAnimator()

Gets a IVisibleRangeAnimator instance used to animate the VisibleRange on this axis.

Declaration
protected rangeAnimators.IVisibleRangeAnimator getVisibleRangeAnimator()
Returns
Type Description
rangeAnimators.IVisibleRangeAnimator

The IVisibleRangeAnimator instance.

getVisibleRangeLimit()

Gets the VisibleRangeLimit of the Axis. This will be used to clip the axis during ZoomExtents and AutoRange operations

Declaration
public final IRange<T> getVisibleRangeLimit()
Returns
Type Description
IRange<T>

getVisibleRangeLimitMode()

Gets the VisibleRangeLimitMode of the Axis. This property defines which parts of VisibleRangeLimit will be used by axis

Declaration
public final RangeClipMode getVisibleRangeLimitMode()
Returns
Type Description
RangeClipMode

getVisibleRangeType()

Gets the type of visible range which is supported by current axis

Declaration
protected abstract Class<? extends IRange<T>> getVisibleRangeType()
Returns
Type Description
Class<? extends com.scichart.data.model.IRange<T>>

The type of visible range for current axis

getZoomConstrainType()

Gets the type of zoom constrain value which is supported by current axis.

Declaration
protected Class<? extends Comparable> getZoomConstrainType()
Returns
Type Description
Class<? extends java.lang.Comparable>

The type of zoom constrain value which is supported by current axis.

hasDefaultVisibleRange()

Gets whether the VisibleRange has default value

Declaration
public final boolean hasDefaultVisibleRange()
Returns
Type Description
boolean

hasValidVisibleRange()

Gets whether the VisibleRange is valid, e.g. is not null, is not NaN and the difference between Max and Min is not zero

Declaration
public final boolean hasValidVisibleRange()
Returns
Type Description
boolean

invalidateElement()

Declaration
public final void invalidateElement()

invalidateElement(boolean isAxisDirty)

Invalidate current axis

Declaration
public abstract void invalidateElement(boolean isAxisDirty)
Parameters
Type Name Description
boolean isAxisDirty

True if axis layout has changed

isAttached()

Declaration
public final boolean isAttached()
Returns
Type Description
boolean

isValidRange(IRange range)

Checks whether range is valid visible range for this axis

Declaration
public boolean isValidRange(IRange range)
Parameters
Type Name Description
IRange range
Returns
Type Description
boolean

isValidVisibleRange(IRange visibleRange)

Checks whether IRange instance is valid for current axis

Declaration
protected boolean isValidVisibleRange(IRange visibleRange)
Parameters
Type Name Description
IRange visibleRange

The range to check
Returns
Type Description
boolean

True if range instance is valid

isZoomConstrainSatisfied(IRange<T> range)

Checks if specified range satisfies zoom constrain for this axis

Declaration
protected boolean isZoomConstrainSatisfied(IRange<T> range)
Parameters
Type Name Description
IRange<T> range

The range to check
Returns
Type Description
boolean

If true range satisfies zoom constrain for this axis

onDataRangeChanged()

Used internally for notification of axis when data range changes

Declaration
public void onDataRangeChanged()

onVisibilityChanged(int visibility)

Called when visibility of axis changes

Declaration
protected void onVisibilityChanged(int visibility)
Parameters
Type Name Description
int visibility

The new axis visibility

onVisibleRangeChanged(IRange oldRange, IRange newRange, boolean isAnimating)

Called when VisibleRange changes

Declaration
protected void onVisibleRangeChanged(IRange oldRange, IRange newRange, boolean isAnimating)
Parameters
Type Name Description
IRange oldRange

The old VisibleRange
IRange newRange

The new VisibleRange
boolean isAnimating

Flag indicating whether the VisibleRange is animating

recreateCalculator()

Recreates coordinate calculator for current axis

Declaration
protected abstract void recreateCalculator()

resumeUpdates(IUpdateSuspender suspender)

Declaration
public void resumeUpdates(IUpdateSuspender suspender)
Parameters
Type Name Description
IUpdateSuspender suspender

setAutoRange(AutoRange autoRange)

Sets auto range mode for current axis. Default is AutoRange.Once

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.

Declaration
public final void setAutoRange(AutoRange autoRange)
Parameters
Type Name Description
AutoRange autoRange

setAutoTicks(boolean autoTicks)

Sets the value that indicates whether calculate ticks automatically. Default is True.

Declaration
public final void setAutoTicks(boolean autoTicks)
Parameters
Type Name Description
boolean autoTicks

setAxisBandsStyle(BrushStyle axisBandsPaint)

Sets the style for Axis Bands. Also see setDrawMajorBands to enable this behavior

Declaration
public final void setAxisBandsStyle(BrushStyle axisBandsPaint)
Parameters
Type Name Description
BrushStyle axisBandsPaint

setAxisBorderStyle(AxisBorderStyle axisBorderStyle)

Sets the style which is used to draw the axis border

Declaration
public final void setAxisBorderStyle(AxisBorderStyle axisBorderStyle)
Parameters
Type Name Description
AxisBorderStyle axisBorderStyle

setAxisId(String axisId)

Sets the string Id of this Axis. Used to associated com.scichart.charting.visuals.renderableSeries.IRenderableSeries

Declaration
public final void setAxisId(String axisId)
Parameters
Type Name Description
String axisId

setAxisTitle(CharSequence axisTitle)

Sets or sets the Axis Title

Declaration
public final void setAxisTitle(CharSequence axisTitle)
Parameters
Type Name Description
CharSequence axisTitle

setCursorTextFormatting(String cursorTextFormatting)

Sets the Text Formatting String for Labels on this cursor

Declaration
public final void setCursorTextFormatting(String cursorTextFormatting)
Parameters
Type Name Description
String cursorTextFormatting

setDataRangeChangeListener(DataRangeChangeListener listener)

Sets DataRangeChangeListener for this axis instance

Declaration
public void setDataRangeChangeListener(DataRangeChangeListener listener)
Parameters
Type Name Description
DataRangeChangeListener listener

setDrawLabels(boolean drawLabels)

Sets a flag indicating whether to draw tick labels or not

Declaration
public final void setDrawLabels(boolean drawLabels)
Parameters
Type Name Description
boolean drawLabels

setDrawMajorBands(boolean drawMajorBands)

Sets a flag indicating whether to draw major bands or not

Declaration
public final void setDrawMajorBands(boolean drawMajorBands)
Parameters
Type Name Description
boolean drawMajorBands

setDrawMajorGridLines(boolean drawMajorGridLines)

Sets a flag indicating whether to draw major grid lines or not

Declaration
public final void setDrawMajorGridLines(boolean drawMajorGridLines)
Parameters
Type Name Description
boolean drawMajorGridLines

setDrawMajorTicks(boolean drawMajorTicks)

Sets a flag indicating whether to draw major ticks or not

Declaration
public final void setDrawMajorTicks(boolean drawMajorTicks)
Parameters
Type Name Description
boolean drawMajorTicks

setDrawMinorGridLines(boolean drawMinorGridLines)

Sets a flag indicating whether to draw minor grid lines or not

Declaration
public final void setDrawMinorGridLines(boolean drawMinorGridLines)
Parameters
Type Name Description
boolean drawMinorGridLines

setDrawMinorTicks(boolean drawMinorTicks)

Sets a flag indicating whether to draw minor ticks or not

Declaration
public final void setDrawMinorTicks(boolean drawMinorTicks)
Parameters
Type Name Description
boolean drawMinorTicks

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.

Declaration
public final void setFlipCoordinates(boolean flipCoordinates)
Parameters
Type Name Description
boolean flipCoordinates

setGrowBy(IRange<Double> growBy)

Sets the GrowBy Factor. e.g. GrowBy(0.1, 0.2) will increase the axis extents by 10% (min) and 20% (max) outside of the data range

Declaration
public final void setGrowBy(IRange<Double> growBy)
Parameters
Type Name Description
IRange<Double> growBy

setLabelProvider(labelProviders.ILabelProvider labelProvider)

Sets a com.scichart.charting.numerics.labelProviders.ILabelProvider instance, which may be used to programmatically override the formatting of text and cursor labels.

Declaration
public final void setLabelProvider(labelProviders.ILabelProvider labelProvider)
Parameters
Type Name Description
labelProviders.ILabelProvider labelProvider

setMajorDelta(Comparable majorDelta)

Sets the Major Delta

Declaration
public final void setMajorDelta(Comparable majorDelta)
Parameters
Type Name Description
Comparable majorDelta

setMajorGridLineStyle(PenStyle majorGridLineStyle)

Sets the style which is used to draw all major grid lines on this axis

Declaration
public final void setMajorGridLineStyle(PenStyle majorGridLineStyle)
Parameters
Type Name Description
PenStyle majorGridLineStyle

setMajorTickLineLength(float majorTickLineLength)

Sets the the length of all major ticks on this axis

Declaration
public final void setMajorTickLineLength(float majorTickLineLength)
Parameters
Type Name Description
float majorTickLineLength

setMajorTickLineStyle(PenStyle majorTickLineStyle)

Sets the style which is used to draw all major ticks on this axis

Declaration
public final void setMajorTickLineStyle(PenStyle majorTickLineStyle)
Parameters
Type Name Description
PenStyle majorTickLineStyle

setMaxAutoTicks(int maxAutoTicks)

Sets the max ticks.

Declaration
public final void setMaxAutoTicks(int maxAutoTicks)
Parameters
Type Name Description
int maxAutoTicks

setMaximumZoomConstrain(Comparable maximumZoomConstrain)

Sets the MaximumZoomConstrain of the Axis. This is used to set maximum distance between Min and Max of the VisibleRange

Declaration
public final void setMaximumZoomConstrain(Comparable maximumZoomConstrain)
Parameters
Type Name Description
Comparable maximumZoomConstrain

setMinimalZoomConstrain(Comparable minimalZoomConstrain)

Sets the MinimalZoomConstrain of the Axis. This is used to set minimum distance between Min and Max of the VisibleRange

Declaration
public final void setMinimalZoomConstrain(Comparable minimalZoomConstrain)
Parameters
Type Name Description
Comparable minimalZoomConstrain

setMinorDelta(Comparable minorDelta)

Sets the Minor Delta

Declaration
public final void setMinorDelta(Comparable minorDelta)
Parameters
Type Name Description
Comparable minorDelta

setMinorGridLineStyle(PenStyle minorGridLineStyle)

Sets the style which is used to draw all minor grid lines on this axis

Declaration
public final void setMinorGridLineStyle(PenStyle minorGridLineStyle)
Parameters
Type Name Description
PenStyle minorGridLineStyle

setMinorTickLineLength(float minorTickLineLength)

Sets the the length of all minor ticks on this axis

Declaration
public final void setMinorTickLineLength(float minorTickLineLength)
Parameters
Type Name Description
float minorTickLineLength

setMinorTickLineStyle(PenStyle minorTickLineStyle)

Sets the style which is used to draw all minor ticks on this axis

Declaration
public final void setMinorTickLineStyle(PenStyle minorTickLineStyle)
Parameters
Type Name Description
PenStyle minorTickLineStyle

setMinorsPerMajor(int minorsPerMajor)

Sets the number of Minor Delta ticks per Major Tick

Declaration
public final void setMinorsPerMajor(int minorsPerMajor)
Parameters
Type Name Description
int minorsPerMajor

setTextFormatting(String textFormatting)

Sets the Text Formatting String for Axis Tick Labels on this axis

Declaration
public final void setTextFormatting(String textFormatting)
Parameters
Type Name Description
String textFormatting

setTickCoordinatesProvider(tickCoordinatesProviders.ITickCoordinatesProvider tickCoordinatesProvider)

Sets a ITickCoordinatesProvider instance on current axis, which is used to transform the data-values received from the com.scichart.charting.numerics.tickProviders.ITickProvider instance to the coordinates for Axis Grid Lines, Ticks and Labels drawing.

Declaration
public final void setTickCoordinatesProvider(tickCoordinatesProviders.ITickCoordinatesProvider tickCoordinatesProvider)
Parameters
Type Name Description
tickCoordinatesProviders.ITickCoordinatesProvider tickCoordinatesProvider

setTickProvider(tickProviders.ITickProvider tickProvider)

Sets a com.scichart.charting.numerics.tickProviders.ITickProvider instance on current axis, which is used to compute the data-values of Axis Grid Lines, Ticks and Labels.

Declaration
public final void setTickProvider(tickProviders.ITickProvider tickProvider)
Parameters
Type Name Description
tickProviders.ITickProvider tickProvider

setVisibility(int visibility)

Sets visibility of this axis

Declaration
public final void setVisibility(int visibility)
Parameters
Type Name Description
int visibility

setVisibleRange(IRange visibleRange)

Sets the VisibleRange of the Axis. Note: Setting the VisibleRange will cause the axis to redraw

Declaration
public final void setVisibleRange(IRange visibleRange)
Parameters
Type Name Description
IRange visibleRange

setVisibleRangeAnimator(rangeAnimators.IVisibleRangeAnimator visibleRangeAnimator)

Sets a IVisibleRangeAnimator instance used to animate the VisibleRange on this axis.

Declaration
protected void setVisibleRangeAnimator(rangeAnimators.IVisibleRangeAnimator visibleRangeAnimator)
Parameters
Type Name Description
rangeAnimators.IVisibleRangeAnimator visibleRangeAnimator

a new IVisibleRangeAnimator instance.

setVisibleRangeChangeListener(VisibleRangeChangeListener listener)

Sets VisibleRangeChangeListener for this axis instance

Declaration
public void setVisibleRangeChangeListener(VisibleRangeChangeListener listener)
Parameters
Type Name Description
VisibleRangeChangeListener listener

setVisibleRangeLimit(IRange visibleRangeLimit)

Sets the VisibleRangeLimit of the Axis. This will be used to clip the axis during ZoomExtents and AutoRange operations

Declaration
public final void setVisibleRangeLimit(IRange visibleRangeLimit)
Parameters
Type Name Description
IRange visibleRangeLimit

setVisibleRangeLimitMode(RangeClipMode visibleRangeLimitMode)

the VisibleRangeLimitMode of the Axis. This property defines which parts of IAxis#getVisibleRangeLimit() will be used by axis

Declaration
public final void setVisibleRangeLimitMode(RangeClipMode visibleRangeLimitMode)
Parameters
Type Name Description
RangeClipMode visibleRangeLimitMode

suspendUpdates()

Declaration
public final IUpdateSuspender suspendUpdates()
Returns
Type Description
IUpdateSuspender

toDouble(Comparable dataValue)

Converts specified data value to its double representation

Declaration
protected abstract double toDouble(Comparable dataValue)
Parameters
Type Name Description
Comparable dataValue

The data value to convert
Returns
Type Description
double

The double representation of data value

tryApplyVisibleRangeLimitTo(IRange<T> range)

Declaration
protected final void tryApplyVisibleRangeLimitTo(IRange<T> range)
Parameters
Type Name Description
IRange<T> range

Implements