public interface IAxis extends IAxisCore, com.scichart.drawing.common.IDrawable, IAxisGridLinesDrawable, com.scichart.core.framework.IHitTestable, com.scichart.core.framework.IContextProvider, IUpdatable, ILayoutable, IRenderSurfaceChangedListener, IChartResizeListener
Modifier and Type | Method and Description |
---|---|
boolean |
getAutoFitMarginalLabels()
Gets a value indicating whether marginal labels get shifted to fit inside an axis when too long.
|
AxisAlignment |
getAxisAlignment()
Gets the
AxisAlignment for this Axis. |
IAxisInfoProvider |
getAxisInfoProvider()
Gets the
IAxisInfoProvider instance associated with this axis. |
AxisLayoutState |
getAxisLayoutState()
Gets current
AxisLayoutState for this axis instance |
IAxisModifierSurface |
getAxisModifierSurface()
Gets the axis modifier surface, which is used to place tooltips on this Axis
|
int |
getAxisOffset()
Gets offset, which is used by
ICoordinateCalculator of this Axis |
AxisTickLabelStyle |
getAxisTickLabelStyle()
Gets style for axis tick labels
|
int |
getAxisTitleGravity()
Gets axis title gravity
|
int |
getAxisTitleMarginBottom()
Gets the bottom margin of the
IAxis instance in pixels. |
int |
getAxisTitleMarginLeft()
Gets the left margin of the
IAxis instance in pixels. |
int |
getAxisTitleMarginRight()
Gets the right margin of the
IAxis instance in pixels. |
int |
getAxisTitleMarginTop()
Gets the top margin of the
IAxis instance in pixels. |
AxisTitleOrientation |
getAxisTitleOrientation()
Gets axis title orientation
|
AxisTitlePlacement |
getAxisTitlePlacement()
Gets axis title placement
|
IAxisInteractivityHelper |
getCurrentInteractivityHelper()
Gets the current
IAxisInteractivityHelper for this Axis |
boolean |
getIsAxisFlipped()
Gets whether this axis is flipped (e.g YAxis on the bottom or top, or XAxis on the left or right)
|
boolean |
getIsLabelCullingEnabled()
Gets a value indicating whether Label Culling is enabled (when labels overlap) on this axis instance
|
boolean |
getIsPrimaryAxis()
Gets whether current Axis is the main one in axis collection.
|
int |
getOrientation()
Gets the Axis Orientation, e.g.
|
com.scichart.drawing.common.FontStyle |
getTickLabelStyle()
Gets the style which is used to draw all tick labels on this axis
|
com.scichart.drawing.common.FontStyle |
getTitleStyle()
Gets the style which is used to draw axis title
|
com.scichart.data.model.IRange |
getWindowedYRange(java.util.Map<java.lang.String,ICoordinateCalculator> xCoordCalcs)
Called by the SciChartSurface internally.
|
AxisInfo |
hitTest(java.lang.Comparable value)
Perform a HitTest on this Axis at specified data point
|
boolean |
isCategoryAxis()
Gets the value indicating whether this instance is a category axis
|
boolean |
isCenterAxis()
Gets whether current Axis should placed in the center of chart or not
|
boolean |
isHorizontalAxis()
Gets whether this axis is horizontal or not
|
boolean |
isXAxis()
Gets whether this axis is an X-Axis or not
|
void |
scroll(float pixelsToScroll,
ClipMode clipMode)
Scrolls current Visible Range by the specified number of pixels
|
void |
scroll(float pixelsToScroll,
ClipMode clipMode,
ClipModeTarget clipTarget)
Scrolls current Visible Range by the specified number of pixels with the specified animation duration
|
void |
scroll(float pixelsToScroll,
ClipMode clipMode,
ClipModeTarget clipTarget,
long duration)
/**
Scrolls current Visible Range by the specified number of pixels with the specified animation duration
|
void |
scroll(float pixelsToScroll,
ClipMode clipMode,
long duration)
Scrolls current Visible Range by the specified number of pixels with the specified animation duration
|
void |
setAutoFitMarginalLabels(boolean autoFitMarginalLabels)
Sets a value indicating whether marginal labels get shifted to fit inside an axis when too long.
|
void |
setAxisAlignment(AxisAlignment axisAlignment)
Sets the
AxisAlignment for this Axis. |
void |
setAxisInfoProvider(IAxisInfoProvider axisInfoProvider)
Sets the
IAxisInfoProvider instance associated with this axis. |
void |
setAxisTickLabelStyle(AxisTickLabelStyle axisTickLabelStyle)
Sets style for axis tick labels
|
void |
setAxisTitleGravity(int axisTitleGravity)
Sets axis title gravity
|
void |
setAxisTitleMargins(int margin)
Sets the axis title margins, in pixels
|
void |
setAxisTitleMargins(int left,
int top,
int right,
int bottom)
Sets the axis title margins, in pixels
|
void |
setAxisTitleOrientation(AxisTitleOrientation axisTitleOrientation)
Sets axis title orientation
|
void |
setAxisTitlePlacement(AxisTitlePlacement axisTitlePlacement)
Sets axis title placement
|
void |
setIsCenterAxis(boolean isCenterAxis)
Sets whether current Axis should placed in the center of chart or not
|
void |
setIsLabelCullingEnabled(boolean isLabelCullingEnabled)
Sets a value indicating whether Label Culling is enabled (when labels overlap) on this axis instance
|
void |
setIsPrimaryAxis(boolean isPrimaryAxis)
Sets whether current Axis is the main one in axis collection.
|
void |
setIsXAxis(boolean isXAxis)
Sets whether this axis is an X-Axis or not
|
void |
setMargins(int margin)
Deprecated.
use
setAxisTitleMargins(int) instead |
void |
setMargins(int left,
int top,
int right,
int bottom)
Deprecated.
use
setAxisTitleMargins(int, int, int, int) instead |
void |
setOrientation(int orientation)
Sets the Axis Orientation, e.g.
|
void |
setTickLabelStyle(com.scichart.drawing.common.FontStyle tickLabelStyle)
Sets the style which is used to draw all tick labels on this axis
|
void |
setTitleStyle(com.scichart.drawing.common.FontStyle titleStyle)
Sets the style which is used to draw axis title
|
void |
updateAxisMeasurements()
Updates measurements of axis for proper layout of its content
|
void |
updateCore(RenderPassState renderPassState)
Performs core update of axis
|
void |
zoom(float fromCoordinate,
float toCoordinate)
Performs zoom on current Axis, using
fromCoord as a coordinate of new range start and toCoord as a coordinate of new range end |
void |
zoom(float fromCoordinate,
float toCoordinate,
long duration)
Performs zoom on current axis, using
fromCoord as a coordinate of new range start and toCoord as a coordinate of new range end with the specified animation duration |
void |
zoomBy(double minFraction,
double maxFraction)
Performs zoom on current axis, using
minFraction as a multiplier of range start and maxFraction as a multiplier of range end |
void |
zoomBy(double minFraction,
double maxFraction,
long duration)
Performs zoom on current axis, using
minFraction as a multiplier of range start and maxFraction as a multiplier of range end with the specified animation duration |
animateVisibleRangeTo, createCoordinateCalculatorFrom, formatCursorText, formatText, getAutoRange, getAutoTicks, getAxisBandsStyle, getAxisId, getAxisParamsLock, getAxisTitle, getAxisViewportDimension, getCoordinate, getCurrentCoordinateCalculator, getCursorTextFormatting, getDataRange, getDataRange, getDataValue, getDefaultNonZeroRange, getDrawLabels, getDrawMajorBands, getDrawMajorGridLines, getDrawMajorTicks, getDrawMinorGridLines, getDrawMinorTicks, getFlipCoordinates, getGrowBy, getLabelProvider, getMajorDelta, getMajorGridLineStyle, getMajorTickLineLength, getMajorTickLineStyle, getMaxAutoTicks, getMaximumRange, getMaximumRange, getMaximumZoomConstrain, getMinimalZoomConstrain, getMinorDelta, getMinorGridLineStyle, getMinorsPerMajor, getMinorTickLineLength, getMinorTickLineStyle, getTextFormatting, getTickCoordinatesProvider, getTickProvider, getVisibility, getVisibleRange, getVisibleRangeLimit, getVisibleRangeLimitMode, hasDefaultVisibleRange, hasValidVisibleRange, isValidRange, onDataRangeChanged, setAutoRange, setAutoTicks, setAxisBandsStyle, setAxisId, setAxisTitle, setCursorTextFormatting, setDataRangeChangeListener, setDrawLabels, setDrawMajorBands, setDrawMajorGridLines, setDrawMajorTicks, setDrawMinorGridLines, setDrawMinorTicks, setFlipCoordinates, setGrowBy, setLabelProvider, setMajorDelta, setMajorGridLineStyle, setMajorTickLineLength, setMajorTickLineStyle, setMaxAutoTicks, setMaximumZoomConstrain, setMinimalZoomConstrain, setMinorDelta, setMinorGridLineStyle, setMinorsPerMajor, setMinorTickLineLength, setMinorTickLineStyle, setTextFormatting, setTickCoordinatesProvider, setTickProvider, setVisibility, setVisibleRange, setVisibleRangeChangeListener, setVisibleRangeLimit, setVisibleRangeLimitMode
decrementSuspend, getIsSuspended, getUpdateSuspenderCount, resumeUpdates, suspendUpdates
invalidateElement
applyThemeProvider
attachTo, detach, isAttached
onDraw
getBoundsRelativeTo, getBoundsRelativeTo, getView, isPointWithinBounds, isPointWithinBounds, translatePoint
update
getLayoutHeight, getLayoutRect, getLayoutWidth, layoutArea
onRenderSurfaceChanged
onParentSurfaceResized
void setIsPrimaryAxis(boolean isPrimaryAxis)
isPrimaryAxis
- The new isPrimaryAxis
valueboolean getIsPrimaryAxis()
isPrimaryAxis
valuecom.scichart.data.model.IRange getWindowedYRange(java.util.Map<java.lang.String,ICoordinateCalculator> xCoordCalcs)
xRanges
"windowed" = "displayed in current viewport"
Note:uses GrowBy()
xCoordCalcs
- Calculates the max range based on corresponding x coordinate calculatorsboolean isXAxis()
void setIsXAxis(boolean isXAxis)
isXAxis
- The new isXAxis
valueboolean isHorizontalAxis()
boolean getIsAxisFlipped()
AxisAlignment getAxisAlignment()
AxisAlignment
for this Axis.void setAxisAlignment(AxisAlignment axisAlignment)
AxisAlignment
for this Axis.axisAlignment
- The new axis alignment valueint getOrientation()
void setOrientation(int orientation)
orientation
- The new orientation valueboolean getIsLabelCullingEnabled()
void setIsLabelCullingEnabled(boolean isLabelCullingEnabled)
isLabelCullingEnabled
- The isLabelCullingEnabled valueboolean getAutoFitMarginalLabels()
void setAutoFitMarginalLabels(boolean autoFitMarginalLabels)
autoFitMarginalLabels
- The new autoFitMarginalLabels valuevoid setAxisTitlePlacement(AxisTitlePlacement axisTitlePlacement)
axisTitlePlacement
- The new axis title placement valueAxisTitlePlacement getAxisTitlePlacement()
void setAxisTitleOrientation(AxisTitleOrientation axisTitleOrientation)
axisTitleOrientation
- The new axis title orientationAxisTitleOrientation getAxisTitleOrientation()
void setAxisTitleGravity(int axisTitleGravity)
axisTitleGravity
- The new axis title gravityint getAxisTitleGravity()
@Deprecated void setMargins(int left, int top, int right, int bottom)
setAxisTitleMargins(int, int, int, int)
insteadleft
- the left margin size.top
- the top margin size.right
- the right margin size.bottom
- the bottom margin size.@Deprecated void setMargins(int margin)
setAxisTitleMargins(int)
insteadmargin
- the left, top, right and bottom margin size.void setAxisTitleMargins(int left, int top, int right, int bottom)
left
- the left margin size.top
- the top margin size.right
- the right margin size.bottom
- the bottom margin size.void setAxisTitleMargins(int margin)
margin
- the left, top, right and bottom margin size.int getAxisTitleMarginLeft()
IAxis
instance in pixels.IAxis
instance in pixels.int getAxisTitleMarginTop()
IAxis
instance in pixels.IAxis
instance in pixels.int getAxisTitleMarginRight()
IAxis
instance in pixels.IAxis
instance in pixels.int getAxisTitleMarginBottom()
IAxis
instance in pixels.IAxis
instance in pixels.void setAxisTickLabelStyle(AxisTickLabelStyle axisTickLabelStyle)
axisTickLabelStyle
- The new style for axis tick labelsAxisTickLabelStyle getAxisTickLabelStyle()
com.scichart.drawing.common.FontStyle getTitleStyle()
void setTitleStyle(com.scichart.drawing.common.FontStyle titleStyle)
titleStyle
- The new axis title stylecom.scichart.drawing.common.FontStyle getTickLabelStyle()
void setTickLabelStyle(com.scichart.drawing.common.FontStyle tickLabelStyle)
tickLabelStyle
- The new tick label styleIAxisInteractivityHelper getCurrentInteractivityHelper()
IAxisInteractivityHelper
for this AxisIAxisInteractivityHelper
for this Axisvoid scroll(float pixelsToScroll, ClipMode clipMode)
pixelsToScroll
- Scroll N pixels from the current visible rangeclipMode
- Defines how scrolling behaves when you reach the edge of the Axis extents.
e.g. ClipMode.ClipAtExtents
prevents panning outside of the Axis, ClipMode.None
allows panning outsidevoid scroll(float pixelsToScroll, ClipMode clipMode, long duration)
pixelsToScroll
- Scroll N pixels from the current visible rangeclipMode
- Defines how scrolling behaves when you reach the edge of the Axis extents.
e.g. ClipMode.ClipAtExtents
prevents panning outside of the Axis, ClipMode.None
allows panning outsideduration
- The duration of animation when zooming to extentsvoid scroll(float pixelsToScroll, ClipMode clipMode, ClipModeTarget clipTarget)
pixelsToScroll
- Scroll N pixels from the current visible rangeclipMode
- Defines how scrolling behaves when you reach the edge of the Axis extents.clipTarget
- Defines target which is used for clippingvoid scroll(float pixelsToScroll, ClipMode clipMode, ClipModeTarget clipTarget, long duration)
pixelsToScroll
- Scroll N pixels from the current visible rangeclipMode
- Defines how scrolling behaves when you reach the edge of the Axis extents.clipTarget
- Defines target which is used for clippingduration
- The duration of animation when zooming to extentsvoid zoom(float fromCoordinate, float toCoordinate)
fromCoord
as a coordinate of new range start and toCoord
as a coordinate of new range endfromCoordinate
- The coordinate of new range start in pixelstoCoordinate
- The coordinate of new range end in pixelsvoid zoom(float fromCoordinate, float toCoordinate, long duration)
fromCoord
as a coordinate of new range start and toCoord
as a coordinate of new range end with the specified animation durationfromCoordinate
- The coordinate of new range start in pixelstoCoordinate
- The coordinate of new range end in pixelsduration
- The duration of animation when zooming to extentsvoid zoomBy(double minFraction, double maxFraction)
minFraction
as a multiplier of range start and maxFraction
as a multiplier of range endminFraction
- The multiplier of range startmaxFraction
- The multiplier of range endvoid zoomBy(double minFraction, double maxFraction, long duration)
minFraction
as a multiplier of range start and maxFraction
as a multiplier of range end with the specified animation durationminFraction
- The multiplier of range startmaxFraction
- The multiplier of range endduration
- The duration of animation when zooming to extentsboolean isCategoryAxis()
boolean isCenterAxis()
void setIsCenterAxis(boolean isCenterAxis)
isCenterAxis
- The new isCenterAxis valueAxisInfo hitTest(java.lang.Comparable value)
value
- data value for hit testAxisInfo
which contains the HitTest resultsIAxisInfoProvider getAxisInfoProvider()
IAxisInfoProvider
instance associated with this axis.IAxisInfoProvider
instance.void setAxisInfoProvider(IAxisInfoProvider axisInfoProvider)
IAxisInfoProvider
instance associated with this axis.axisInfoProvider
- New IAxisInfoProvider
instance.IAxisModifierSurface getAxisModifierSurface()
IAxisModifierSurface
for this Axisvoid updateAxisMeasurements()
AxisLayoutState getAxisLayoutState()
AxisLayoutState
for this axis instanceAxisLayoutState
for this axis instanceint getAxisOffset()
ICoordinateCalculator
of this Axisvoid updateCore(RenderPassState renderPassState)
renderPassState
- The RenderPassState
instance for current render pass