Search Results for

    Show / Hide Table of Contents

    Class AxisBase<T>

    Defines a base functionality for 2D Axes used throughout SciChart

    Inheritance
    java.lang.Object
    AxisCore
    AxisBase<T>
    Implements
    IAxis
    ISciChartSurfaceProvider
    Inherited Members
    AxisCore.animateVisibleRangeTo(IRange,long)
    AxisCore.applyThemeProvider(IThemeProvider)
    AxisCore.attachTo(IServiceContainer)
    AxisCore.coerceVisibleRange(IRange<T>)
    AxisCore.decrementSuspend()
    AxisCore.detach()
    AxisCore.formatCursorText(Comparable)
    AxisCore.formatText(Comparable)
    AxisCore.fromDouble(double)
    AxisCore.getAutoRange()
    AxisCore.getAutoTicks()
    AxisCore.getAxisBandsStyle()
    AxisCore.getAxisBorderStyle()
    AxisCore.getAxisId()
    AxisCore.getAxisParamsLock()
    AxisCore.getAxisTitle()
    AxisCore.getCoordinate(Comparable)
    AxisCore.getCursorTextFormatting()
    AxisCore.getDataRange()
    AxisCore.getDataRange(boolean)
    AxisCore.getDataValue(float)
    AxisCore.getDefaultNonZeroRange()
    AxisCore.getDrawLabels()
    AxisCore.getDrawMajorBands()
    AxisCore.getDrawMajorGridLines()
    AxisCore.getDrawMajorTicks()
    AxisCore.getDrawMinorGridLines()
    AxisCore.getDrawMinorTicks()
    AxisCore.getFlipCoordinates()
    AxisCore.getGrowBy()
    AxisCore.getIsSuspended()
    AxisCore.getLabelProvider()
    AxisCore.getMajorDelta()
    AxisCore.getMajorGridLineStyle()
    AxisCore.getMajorTickLineLength()
    AxisCore.getMajorTickLineStyle()
    AxisCore.getMaxAutoTicks()
    AxisCore.getMaximumRange()
    AxisCore.getMaximumRange(boolean)
    AxisCore.getMaximumZoomConstrain()
    AxisCore.getMinimalZoomConstrain()
    AxisCore.getMinorDelta()
    AxisCore.getMinorGridLineStyle()
    AxisCore.getMinorTickLineLength()
    AxisCore.getMinorTickLineStyle()
    AxisCore.getMinorsPerMajor()
    AxisCore.getServices()
    AxisCore.getTextFormatting()
    AxisCore.getTickCoordinatesProvider()
    AxisCore.getTickProvider()
    AxisCore.getType()
    AxisCore.getUpdateSuspenderCount()
    AxisCore.getVisibility()
    AxisCore.getVisibleRange()
    AxisCore.getVisibleRangeAnimator()
    AxisCore.getVisibleRangeLimit()
    AxisCore.getVisibleRangeLimitMode()
    AxisCore.getVisibleRangeType()
    AxisCore.getZoomConstrainType()
    AxisCore.hasDefaultVisibleRange()
    AxisCore.hasValidVisibleRange()
    AxisCore.invalidateElement()
    AxisCore.invalidateElement(boolean)
    AxisCore.isAttached()
    AxisCore.isValidRange(IRange)
    AxisCore.isValidVisibleRange(IRange)
    AxisCore.isZoomConstrainSatisfied(IRange<T>)
    AxisCore.onDataRangeChanged()
    AxisCore.onVisibilityChanged(int)
    AxisCore.onVisibleRangeChanged(IRange,IRange,boolean)
    AxisCore.recreateCalculator()
    AxisCore.resumeUpdates(IUpdateSuspender)
    AxisCore.setAutoRange(AutoRange)
    AxisCore.setAutoTicks(boolean)
    AxisCore.setAxisBandsStyle(BrushStyle)
    AxisCore.setAxisBorderStyle(AxisBorderStyle)
    AxisCore.setAxisId(String)
    AxisCore.setAxisTitle(CharSequence)
    AxisCore.setCursorTextFormatting(String)
    AxisCore.setDataRangeChangeListener(DataRangeChangeListener)
    AxisCore.setDrawLabels(boolean)
    AxisCore.setDrawMajorBands(boolean)
    AxisCore.setDrawMajorGridLines(boolean)
    AxisCore.setDrawMajorTicks(boolean)
    AxisCore.setDrawMinorGridLines(boolean)
    AxisCore.setDrawMinorTicks(boolean)
    AxisCore.setFlipCoordinates(boolean)
    AxisCore.setGrowBy(IRange<Double>)
    AxisCore.setLabelProvider(labelProviders.ILabelProvider)
    AxisCore.setMajorDelta(Comparable)
    AxisCore.setMajorGridLineStyle(PenStyle)
    AxisCore.setMajorTickLineLength(float)
    AxisCore.setMajorTickLineStyle(PenStyle)
    AxisCore.setMaxAutoTicks(int)
    AxisCore.setMaximumZoomConstrain(Comparable)
    AxisCore.setMinimalZoomConstrain(Comparable)
    AxisCore.setMinorDelta(Comparable)
    AxisCore.setMinorGridLineStyle(PenStyle)
    AxisCore.setMinorTickLineLength(float)
    AxisCore.setMinorTickLineStyle(PenStyle)
    AxisCore.setMinorsPerMajor(int)
    AxisCore.setTextFormatting(String)
    AxisCore.setTickCoordinatesProvider(tickCoordinatesProviders.ITickCoordinatesProvider)
    AxisCore.setTickProvider(tickProviders.ITickProvider)
    AxisCore.setVisibility(int)
    AxisCore.setVisibleRange(IRange)
    AxisCore.setVisibleRangeAnimator(rangeAnimators.IVisibleRangeAnimator)
    AxisCore.setVisibleRangeChangeListener(VisibleRangeChangeListener)
    AxisCore.setVisibleRangeLimit(IRange)
    AxisCore.setVisibleRangeLimitMode(RangeClipMode)
    AxisCore.suspendUpdates()
    AxisCore.toDouble(Comparable)
    AxisCore.tryApplyVisibleRangeLimitTo(IRange<T>)
    Object.clone()
    Object.equals(Object)
    Object.finalize()
    Object.getClass()
    Object.hashCode()
    Object.notify()
    Object.notifyAll()
    Object.toString()
    Object.wait()
    Object.wait(long)
    Object.wait(long,int)
    Namespace:
    Assembly: .dll
    Syntax
    public abstract class AxisBase<T> extends AxisCore<T> implements IAxis, ISciChartSurfaceProvider
    Type Parameters
    Name Description
    T

    Constructors

    AxisBase(IRange<T> defaultNonZeroRange, IAxisModifierSurface axisModifierSurface)

    Creates a new instance of AxisBase class

    Declaration
    protected AxisBase(IRange<T> defaultNonZeroRange, IAxisModifierSurface axisModifierSurface)
    Parameters
    Type Name Description
    IRange<T> defaultNonZeroRange

    The default non zero range which should be used by axis

    IAxisModifierSurface axisModifierSurface

    The IAxisModifierSurface to use by this axis

    Fields

    DEFAULT_AXIS_ID

    Declaration
    public static final String DEFAULT_AXIS_ID
    Field Value
    Type Description
    String

    DEFAULT_AXIS_TICK_LABEL_STYLE

    Declaration
    public static final AxisTickLabelStyle DEFAULT_AXIS_TICK_LABEL_STYLE
    Field Value
    Type Description
    AxisTickLabelStyle

    autoFitMarginLabelsProperty

    Declaration
    protected final SmartPropertyBoolean autoFitMarginLabelsProperty
    Field Value
    Type Description
    SmartPropertyBoolean

    axisLabelRotationProperty

    Declaration
    protected final SmartPropertyInteger axisLabelRotationProperty
    Field Value
    Type Description
    SmartPropertyInteger

    axisTickLabelStyleProperty

    Declaration
    protected final SmartProperty<AxisTickLabelStyle> axisTickLabelStyleProperty
    Field Value
    Type Description
    SmartProperty<AxisTickLabelStyle>

    axisTitleGravityProperty

    Declaration
    protected final SmartPropertyInteger axisTitleGravityProperty
    Field Value
    Type Description
    SmartPropertyInteger

    axisTitleOrientationProperty

    Declaration
    protected final SmartProperty<AxisTitleOrientation> axisTitleOrientationProperty
    Field Value
    Type Description
    SmartProperty<AxisTitleOrientation>

    axisTitlePlacementProperty

    Declaration
    protected final SmartProperty<AxisTitlePlacement> axisTitlePlacementProperty
    Field Value
    Type Description
    SmartProperty<AxisTitlePlacement>

    currentCoordinateCalculator

    Declaration
    protected coordinateCalculators.ICoordinateCalculator currentCoordinateCalculator
    Field Value
    Type Description
    coordinateCalculators.ICoordinateCalculator

    currentInteractivityHelper

    Declaration
    protected IAxisInteractivityHelper currentInteractivityHelper
    Field Value
    Type Description
    IAxisInteractivityHelper

    isLabelCullingEnabledProperty

    Declaration
    protected final SmartPropertyBoolean isLabelCullingEnabledProperty
    Field Value
    Type Description
    SmartPropertyBoolean

    isLayoutRectDirty

    Declaration
    protected volatile boolean isLayoutRectDirty
    Field Value
    Type Description
    boolean

    isPrimaryAxisProperty

    Declaration
    protected final SmartPropertyBoolean isPrimaryAxisProperty
    Field Value
    Type Description
    SmartPropertyBoolean

    isProvidersDirty

    Declaration
    protected volatile boolean isProvidersDirty
    Field Value
    Type Description
    boolean

    isRenderersDirty

    Declaration
    protected volatile boolean isRenderersDirty
    Field Value
    Type Description
    boolean

    tickLabelStyleProperty

    Declaration
    protected final SmartProperty<FontStyle> tickLabelStyleProperty
    Field Value
    Type Description
    SmartProperty<FontStyle>

    titleStyleProperty

    Declaration
    protected final SmartProperty<FontStyle> titleStyleProperty
    Field Value
    Type Description
    SmartProperty<FontStyle>

    Methods

    applyThemeProvider(IThemeProvider themeProvider)

    Applies specified theme to current instance

    Declaration
    public void applyThemeProvider(IThemeProvider themeProvider)
    Parameters
    Type Name Description
    IThemeProvider themeProvider
    Overrides
    AxisCore<T>.applyThemeProvider(IThemeProvider themeProvider)

    attachTo(IServiceContainer services)

    Declaration
    public void attachTo(IServiceContainer services)
    Parameters
    Type Name Description
    IServiceContainer services
    Overrides
    AxisCore<T>.attachTo(IServiceContainer services)

    calculateAxisOffset()

    Calculates axis offset relative to IRenderableSeriesArea in pixels

    Declaration
    protected int calculateAxisOffset()
    Returns
    Type Description
    int

    Axis offset in pixels

    calculateAxisViewportDimension()

    Calculates axis viewport dimension in pixels

    Declaration
    protected int calculateAxisViewportDimension()
    Returns
    Type Description
    int

    Viewport dimension in pixels

    createCoordinateCalculator(AxisParams axisParams, double visibleRangeMin, double visibleRangeMax)

    Creates new ICoordinateCalculator based on axis params values and double representation of visible range

    Declaration
    protected coordinateCalculators.ICoordinateCalculator createCoordinateCalculator(AxisParams axisParams, double visibleRangeMin, double visibleRangeMax)
    Parameters
    Type Name Description
    AxisParams axisParams

    Axis params to create calculator from

    double visibleRangeMin

    The double representation of min value for visible range to create calculator from

    double visibleRangeMax

    The double representation of max value for visible range to create calculator from

    Returns
    Type Description
    coordinateCalculators.ICoordinateCalculator

    New ICoordinateCalculator instance

    createCoordinateCalculatorFrom(IRange visibleRange)

    Creates a coordinate calculator from specified visible range

    Declaration
    public final coordinateCalculators.ICoordinateCalculator createCoordinateCalculatorFrom(IRange visibleRange)
    Parameters
    Type Name Description
    IRange visibleRange
    Returns
    Type Description
    coordinateCalculators.ICoordinateCalculator

    createInteractivityHelper(coordinateCalculators.ICoordinateCalculator currentCoordinateCalculator)

    Creates a new IAxisInteractivityHelper instance for this axis

    Declaration
    protected IAxisInteractivityHelper createInteractivityHelper(coordinateCalculators.ICoordinateCalculator currentCoordinateCalculator)
    Parameters
    Type Name Description
    coordinateCalculators.ICoordinateCalculator currentCoordinateCalculator

    The current coordinate calculator for this axis

    Returns
    Type Description
    IAxisInteractivityHelper

    The new axis interactivity helper

    detach()

    Declaration
    public void detach()
    Overrides
    AxisCore<T>.detach()

    getAutoFitMarginalLabels()

    Gets a value indicating whether marginal labels get shifted to fit inside an axis when too long.

    Declaration
    public final boolean getAutoFitMarginalLabels()
    Returns
    Type Description
    boolean

    getAxisAlignment()

    Gets the com.scichart.charting.visuals.axes.AxisAlignment for this Axis.

    Declaration
    public final AxisAlignment getAxisAlignment()
    Returns
    Type Description
    AxisAlignment

    getAxisInfoProvider()

    Gets the IAxisInfoProvider instance associated with this axis.

    Declaration
    public IAxisInfoProvider getAxisInfoProvider()
    Returns
    Type Description
    IAxisInfoProvider

    getAxisLabelRotation()

    Declaration
    public Integer getAxisLabelRotation()
    Returns
    Type Description
    Integer

    getAxisLayoutState()

    Gets current AxisLayoutState for this axis instance

    Declaration
    public final AxisLayoutState getAxisLayoutState()
    Returns
    Type Description
    AxisLayoutState

    getAxisModifierSurface()

    Gets the axis modifier surface, which is used to place tooltips on this Axis

    Declaration
    public final IAxisModifierSurface getAxisModifierSurface()
    Returns
    Type Description
    IAxisModifierSurface

    getAxisOffset()

    Gets offset, which is used by com.scichart.charting.numerics.coordinateCalculators.ICoordinateCalculator of this Axis

    Declaration
    public final int getAxisOffset()
    Returns
    Type Description
    int

    getAxisTickLabelStyle()

    Gets style for axis tick labels

    Declaration
    public final AxisTickLabelStyle getAxisTickLabelStyle()
    Returns
    Type Description
    AxisTickLabelStyle

    getAxisTitleGravity()

    Gets axis title gravity

    Declaration
    public final int getAxisTitleGravity()
    Returns
    Type Description
    int

    getAxisTitleMarginBottom()

    Gets the bottom margin of the IAxis instance in pixels.

    Declaration
    public final int getAxisTitleMarginBottom()
    Returns
    Type Description
    int

    getAxisTitleMarginLeft()

    Gets the left margin of the IAxis instance in pixels.

    Declaration
    public final int getAxisTitleMarginLeft()
    Returns
    Type Description
    int

    getAxisTitleMarginRight()

    Gets the right margin of the IAxis instance in pixels.

    Declaration
    public final int getAxisTitleMarginRight()
    Returns
    Type Description
    int

    getAxisTitleMarginTop()

    Gets the top margin of the IAxis instance in pixels.

    Declaration
    public final int getAxisTitleMarginTop()
    Returns
    Type Description
    int

    getAxisTitleOrientation()

    Gets axis title orientation

    Declaration
    public final AxisTitleOrientation getAxisTitleOrientation()
    Returns
    Type Description
    AxisTitleOrientation

    getAxisTitlePlacement()

    Gets axis title placement

    Declaration
    public final AxisTitlePlacement getAxisTitlePlacement()
    Returns
    Type Description
    AxisTitlePlacement

    getAxisViewportDimension()

    Gets the axis viewport dimension, which is used by com.scichart.charting.numerics.coordinateCalculators.ICoordinateCalculator of the Axis

    Declaration
    public final int getAxisViewportDimension()
    Returns
    Type Description
    int

    getBoundsRelativeTo(Rect bounds, IHitTestable hitTestable)

    Declaration
    public final boolean getBoundsRelativeTo(Rect bounds, IHitTestable hitTestable)
    Parameters
    Type Name Description
    android.graphics.Rect bounds
    IHitTestable hitTestable
    Returns
    Type Description
    boolean

    getBoundsRelativeTo(RectF bounds, IHitTestable hitTestable)

    Declaration
    public final boolean getBoundsRelativeTo(RectF bounds, IHitTestable hitTestable)
    Parameters
    Type Name Description
    android.graphics.RectF bounds
    IHitTestable hitTestable
    Returns
    Type Description
    boolean

    getContext()

    Declaration
    public final Context getContext()
    Returns
    Type Description
    android.content.Context

    getCurrentCoordinateCalculator()

    Gets the current ICoordinateCalculator for this Axis, based on current Visible Range and axis type

    Declaration
    public final coordinateCalculators.ICoordinateCalculator getCurrentCoordinateCalculator()
    Returns
    Type Description
    coordinateCalculators.ICoordinateCalculator

    getCurrentInteractivityHelper()

    Gets the current com.scichart.charting.visuals.axes.IAxisInteractivityHelper for this Axis

    Declaration
    public final IAxisInteractivityHelper getCurrentInteractivityHelper()
    Returns
    Type Description
    IAxisInteractivityHelper

    getDataRange(boolean forceCacheUpdate)

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

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

    getFixedSize()

    Declaration
    public Integer getFixedSize()
    Returns
    Type Description
    Integer

    getIsAxisFlipped()

    Gets whether this axis is flipped (e.g YAxis on the bottom or top, or XAxis on the left or right)

    Declaration
    public final boolean getIsAxisFlipped()
    Returns
    Type Description
    boolean

    getIsLabelCullingEnabled()

    Gets a value indicating whether Label Culling is enabled (when labels overlap) on this axis instance

    Declaration
    public final boolean getIsLabelCullingEnabled()
    Returns
    Type Description
    boolean

    getIsPrimaryAxis()

    Gets whether current Axis is the main one in axis collection.

    Declaration
    public final boolean getIsPrimaryAxis()
    Returns
    Type Description
    boolean

    getLayoutHeight()

    Get height of layout placement rect

    Declaration
    public final int getLayoutHeight()
    Returns
    Type Description
    int

    getLayoutRect()

    Gets Rect with layout placement

    Declaration
    public final Rect getLayoutRect()
    Returns
    Type Description
    android.graphics.Rect

    getLayoutWidth()

    Get width of layout placement rect

    Declaration
    public final int getLayoutWidth()
    Returns
    Type Description
    int

    getMaximumRange(boolean forceCacheUpdate)

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

    Declaration
    public final IRange<T> getMaximumRange(boolean forceCacheUpdate)
    Parameters
    Type Name Description
    boolean forceCacheUpdate
    Returns
    Type Description
    IRange<T>
    Overrides
    AxisCore<T>.getMaximumRange(boolean forceCacheUpdate)

    getOrientation()

    Gets the Axis Orientation, e.g. Horizontal (XAxis) or Vertical (YAxis)

    Declaration
    public final int getOrientation()
    Returns
    Type Description
    int

    getParentSurface()

    Gets the parent surface that this instance is associated with

    Declaration
    public final ISciChartSurface getParentSurface()
    Returns
    Type Description
    ISciChartSurface

    getTickLabelStyle()

    Gets the style which is used to draw all tick labels on this axis

    Declaration
    public final FontStyle getTickLabelStyle()
    Returns
    Type Description
    FontStyle

    getTitleStyle()

    Gets the style which is used to draw axis title

    Declaration
    public final FontStyle getTitleStyle()
    Returns
    Type Description
    FontStyle

    getView()

    Declaration
    public final View getView()
    Returns
    Type Description
    android.view.View

    getWindowedYRange(Map<String,coordinateCalculators.ICoordinateCalculator> xCoordCalcs)

    Called by the SciChartSurface internally. Returns the max range only for that axis (by the data-series on it), based on xRanges

    "windowed" = "displayed in current viewport"

    Note:uses GrowBy()

    Declaration
    public final IRange<T> getWindowedYRange(Map<String,coordinateCalculators.ICoordinateCalculator> xCoordCalcs)
    Parameters
    Type Name Description
    Map<String,ICoordinateCalculator> xCoordCalcs
    Returns
    Type Description
    IRange<T>

    hitTest(Comparable value)

    Perform a HitTest on this Axis at specified data point

    Declaration
    public AxisInfo hitTest(Comparable value)
    Parameters
    Type Name Description
    Comparable value
    Returns
    Type Description
    AxisInfo

    invalidateElement(boolean isAxisDirty)

    Invalidate current axis

    Declaration
    public void invalidateElement(boolean isAxisDirty)
    Parameters
    Type Name Description
    boolean isAxisDirty
    Overrides
    AxisCore<T>.invalidateElement(boolean isAxisDirty)

    isCategoryAxis()

    Deprecated. Please use #getCurrentCoordinateCalculator() and ICoordinateCalculator#isCategoryAxisCalculator()

    Gets the value indicating whether this instance is a category axis

    Declaration
    public boolean isCategoryAxis()
    Returns
    Type Description
    boolean

    True if this instance is category axis

    isCenterAxis()

    Gets whether current Axis should placed in the center of chart or not

    Declaration
    public final boolean isCenterAxis()
    Returns
    Type Description
    boolean

    isHorizontalAxis()

    Gets whether this axis is horizontal or not

    Declaration
    public final boolean isHorizontalAxis()
    Returns
    Type Description
    boolean

    isPointWithinBounds(float x, float y)

    Declaration
    public final boolean isPointWithinBounds(float x, float y)
    Parameters
    Type Name Description
    float x
    float y
    Returns
    Type Description
    boolean

    isPointWithinBounds(float x, float y, IHitTestable hitTestable)

    Declaration
    public final boolean isPointWithinBounds(float x, float y, IHitTestable hitTestable)
    Parameters
    Type Name Description
    float x
    float y
    IHitTestable hitTestable
    Returns
    Type Description
    boolean

    isXAxis()

    Gets whether this axis is an X-Axis or not

    Declaration
    public final boolean isXAxis()
    Returns
    Type Description
    boolean

    layoutArea(int left, int top, int right, int bottom)

    Places this instance relative to parent com.scichart.charting.visuals.SciChartSurface

    Declaration
    public void layoutArea(int left, int top, int right, int bottom)
    Parameters
    Type Name Description
    int left
    int top
    int right
    int bottom

    onDataRangeChanged()

    Used internally for notification of axis when data range changes

    Declaration
    public void onDataRangeChanged()
    Overrides
    AxisCore<T>.onDataRangeChanged()

    onDraw(IRenderContext2D renderContext, IAssetManager2D assetManager)

    Declaration
    public final void onDraw(IRenderContext2D renderContext, IAssetManager2D assetManager)
    Parameters
    Type Name Description
    IRenderContext2D renderContext
    IAssetManager2D assetManager

    onDraw(IRenderContext2D renderContext, IAssetManager2D assetManager, RenderOperationLayers drawingLayers)

    Draws axis grid lines in the center of the chart

    Declaration
    public final void onDraw(IRenderContext2D renderContext, IAssetManager2D assetManager, RenderOperationLayers drawingLayers)
    Parameters
    Type Name Description
    IRenderContext2D renderContext
    IAssetManager2D assetManager
    RenderOperationLayers drawingLayers

    onDrawAxis(IRenderContext2D renderContext, IAssetManager2D assetManager)

    Renders axis using specified IRenderContext2D and IAssetManager2D

    Declaration
    protected void onDrawAxis(IRenderContext2D renderContext, IAssetManager2D assetManager)
    Parameters
    Type Name Description
    IRenderContext2D renderContext

    The render context instance to draw on

    IAssetManager2D assetManager

    The asset manager associated with render context

    onDrawGridLines(IRenderContext2D renderContext, IAssetManager2D assetManager, RenderOperationLayers drawingLayers)

    Draws axis grid lines in the center of the chart See Also: RenderOperationLayers#RENDERABLE_SERIES, RenderOperationLayers#AXIS_MINOR_GRID_LINES, RenderOperationLayers#AXIS_BANDS, RenderOperationLayers#AXIS_MAJOR_GRID_LINES

    Declaration
    protected void onDrawGridLines(IRenderContext2D renderContext, IAssetManager2D assetManager, RenderOperationLayers drawingLayers)
    Parameters
    Type Name Description
    IRenderContext2D renderContext

    IRenderContext2D instance to draw on

    IAssetManager2D assetManager

    IAssetManager2D instance which manages assets related to current com.scichart.drawing.common.IRenderSurface

    RenderOperationLayers drawingLayers

    Specifies different drawing layers for drawing of axis grid lines

    onIsPrimaryAxisChanged(boolean isPrimaryAxis)

    Called when #isPrimaryAxisProperty changes

    Declaration
    protected void onIsPrimaryAxisChanged(boolean isPrimaryAxis)
    Parameters
    Type Name Description
    boolean isPrimaryAxis

    The new IsPrimaryAxis value

    onParentSurfaceResized(ResizedMessage resizedMessage)

    Called when chart resized.

    Declaration
    public void onParentSurfaceResized(ResizedMessage resizedMessage)
    Parameters
    Type Name Description
    ResizedMessage resizedMessage

    onRenderSurfaceChanged()

    Called when new IRenderSurface instance is set for parent ISciChartSurface

    Declaration
    public void onRenderSurfaceChanged()

    onSizeChanged(int w, int h, int oldw, int oldh)

    This method is called when axis size has changed during its layout

    Declaration
    protected void onSizeChanged(int w, int h, int oldw, int oldh)
    Parameters
    Type Name Description
    int w

    New width of axis in pixels

    int h

    New height of axis in pixels

    int oldw

    Old width of axis in pixels

    int oldh

    Old height of axi in pixels

    onUpdateMeasure()

    Updates axis parts which should be updated before measure

    Declaration
    protected void onUpdateMeasure()

    onVisibilityChanged(int visibility)

    Called when visibility of axis changes

    Declaration
    protected void onVisibilityChanged(int visibility)
    Parameters
    Type Name Description
    int visibility
    Overrides
    AxisCore<T>.onVisibilityChanged(int 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
    IRange newRange
    boolean isAnimating
    Overrides
    AxisCore<T>.onVisibleRangeChanged(IRange oldRange, IRange newRange, boolean isAnimating)

    recreateCalculator()

    Recreates coordinate calculator for current axis

    Declaration
    protected final void recreateCalculator()
    Overrides
    AxisCore<T>.recreateCalculator()

    scroll(float pixelsToScroll, ClipMode clipMode)

    Scrolls current Visible Range by the specified number of pixels

    Declaration
    public final void scroll(float pixelsToScroll, ClipMode clipMode)
    Parameters
    Type Name Description
    float pixelsToScroll
    ClipMode clipMode

    scroll(float pixelsToScroll, ClipMode clipMode, ClipModeTarget clipTarget)

    Scrolls current Visible Range by the specified number of pixels with the specified animation duration

    Declaration
    public final void scroll(float pixelsToScroll, ClipMode clipMode, ClipModeTarget clipTarget)
    Parameters
    Type Name Description
    float pixelsToScroll
    ClipMode clipMode
    ClipModeTarget clipTarget

    scroll(float pixelsToScroll, ClipMode clipMode, ClipModeTarget clipTarget, long duration)

    /** Scrolls current Visible Range by the specified number of pixels with the specified animation duration

    Declaration
    public final void scroll(float pixelsToScroll, ClipMode clipMode, ClipModeTarget clipTarget, long duration)
    Parameters
    Type Name Description
    float pixelsToScroll
    ClipMode clipMode
    ClipModeTarget clipTarget
    long duration

    scroll(float pixelsToScroll, ClipMode clipMode, long duration)

    Scrolls current Visible Range by the specified number of pixels with the specified animation duration

    Declaration
    public final void scroll(float pixelsToScroll, ClipMode clipMode, long duration)
    Parameters
    Type Name Description
    float pixelsToScroll
    ClipMode clipMode
    long duration

    setAutoFitMarginalLabels(boolean autoFitMarginalLabels)

    Sets a value indicating whether marginal labels get shifted to fit inside an axis when too long.

    Declaration
    public final void setAutoFitMarginalLabels(boolean autoFitMarginalLabels)
    Parameters
    Type Name Description
    boolean autoFitMarginalLabels

    setAxisAlignment(AxisAlignment axisAlignment)

    Sets the com.scichart.charting.visuals.axes.AxisAlignment for this Axis.

    Declaration
    public final void setAxisAlignment(AxisAlignment axisAlignment)
    Parameters
    Type Name Description
    AxisAlignment axisAlignment

    setAxisInfoProvider(IAxisInfoProvider axisInfoProvider)

    Sets the IAxisInfoProvider instance associated with this axis.

    Declaration
    public void setAxisInfoProvider(IAxisInfoProvider axisInfoProvider)
    Parameters
    Type Name Description
    IAxisInfoProvider axisInfoProvider

    setAxisLabelRotation(Integer axisLabelRotation)

    Declaration
    public void setAxisLabelRotation(Integer axisLabelRotation)
    Parameters
    Type Name Description
    Integer axisLabelRotation

    setAxisLayoutManager(IAxisLayoutManager axisLayoutManager)

    Sets IAxisLayoutManager which will be used for layout of this axis

    Declaration
    protected final void setAxisLayoutManager(IAxisLayoutManager axisLayoutManager)
    Parameters
    Type Name Description
    IAxisLayoutManager axisLayoutManager

    New IAxisLayoutManager instance

    setAxisRenderer(IAxisRenderer axisRenderer)

    Sets IAxisRenderer instance which will be used for rendering of this axis

    Declaration
    public final void setAxisRenderer(IAxisRenderer axisRenderer)
    Parameters
    Type Name Description
    IAxisRenderer axisRenderer

    New IAxisRenderer instance

    setAxisTickLabelStyle(AxisTickLabelStyle axisTickLabelStyle)

    Sets style for axis tick labels

    Declaration
    public final void setAxisTickLabelStyle(AxisTickLabelStyle axisTickLabelStyle)
    Parameters
    Type Name Description
    AxisTickLabelStyle axisTickLabelStyle

    setAxisTitleGravity(int axisTitleGravity)

    Sets axis title gravity

    Declaration
    public final void setAxisTitleGravity(int axisTitleGravity)
    Parameters
    Type Name Description
    int axisTitleGravity

    setAxisTitleMargins(int margin)

    Sets the axis title margins, in pixels

    Declaration
    public final void setAxisTitleMargins(int margin)
    Parameters
    Type Name Description
    int margin

    setAxisTitleMargins(int left, int top, int right, int bottom)

    Sets the axis title margins, in pixels

    Declaration
    public final void setAxisTitleMargins(int left, int top, int right, int bottom)
    Parameters
    Type Name Description
    int left
    int top
    int right
    int bottom

    setAxisTitleOrientation(AxisTitleOrientation axisTitleOrientation)

    Sets axis title orientation

    Declaration
    public final void setAxisTitleOrientation(AxisTitleOrientation axisTitleOrientation)
    Parameters
    Type Name Description
    AxisTitleOrientation axisTitleOrientation

    setAxisTitlePlacement(AxisTitlePlacement axisTitlePlacement)

    Sets axis title placement

    Declaration
    public final void setAxisTitlePlacement(AxisTitlePlacement axisTitlePlacement)
    Parameters
    Type Name Description
    AxisTitlePlacement axisTitlePlacement

    setAxisTitleRenderer(IAxisTitleRenderer axisTitleRenderer)

    Sets IAxisTitleRenderer instance which will be used for rendering of axis title

    Declaration
    protected final void setAxisTitleRenderer(IAxisTitleRenderer axisTitleRenderer)
    Parameters
    Type Name Description
    IAxisTitleRenderer axisTitleRenderer

    New IAxisTitleRenderer instance

    setFixedSize(Integer fixedSize)

    Declaration
    public void setFixedSize(Integer fixedSize)
    Parameters
    Type Name Description
    Integer fixedSize

    setGridLinesRenderer(IAxisGridLinesRenderer gridLinesRenderer)

    Sets IAxisGridLinesRenderer instance which will be used for rendering of grid lines for this axis

    Declaration
    protected final void setGridLinesRenderer(IAxisGridLinesRenderer gridLinesRenderer)
    Parameters
    Type Name Description
    IAxisGridLinesRenderer gridLinesRenderer

    New IAxisGridLinesRenderer instance

    setIsCenterAxis(boolean isCenterAxis)

    Sets whether current Axis should placed in the center of chart or not

    Declaration
    public final void setIsCenterAxis(boolean isCenterAxis)
    Parameters
    Type Name Description
    boolean isCenterAxis

    setIsLabelCullingEnabled(boolean isLabelCullingEnabled)

    Sets a value indicating whether Label Culling is enabled (when labels overlap) on this axis instance

    Declaration
    public final void setIsLabelCullingEnabled(boolean isLabelCullingEnabled)
    Parameters
    Type Name Description
    boolean isLabelCullingEnabled

    setIsPrimaryAxis(boolean isPrimaryAxis)

    Sets whether current Axis is the main one in axis collection.

    Declaration
    public final void setIsPrimaryAxis(boolean isPrimaryAxis)
    Parameters
    Type Name Description
    boolean isPrimaryAxis

    setIsXAxis(boolean isXAxis)

    Sets whether this axis is an X-Axis or not

    Declaration
    public final void setIsXAxis(boolean isXAxis)
    Parameters
    Type Name Description
    boolean isXAxis

    setMargins(int margin)

    Deprecated. use #setAxisTitleMargins(int) instead

    Sets the axis title margins, in pixels

    Declaration
    public final void setMargins(int margin)
    Parameters
    Type Name Description
    int margin

    setMargins(int left, int top, int right, int bottom)

    Deprecated. use #setAxisTitleMargins(int, int, int, int) instead

    Sets the axis title margins, in pixels

    Declaration
    public final void setMargins(int left, int top, int right, int bottom)
    Parameters
    Type Name Description
    int left
    int top
    int right
    int bottom

    setOrientation(int orientation)

    Sets the Axis Orientation, e.g. Horizontal (XAxis) or Vertical (YAxis)

    Declaration
    public final void setOrientation(int orientation)
    Parameters
    Type Name Description
    int orientation

    setRangeCalculationHelper(rangeCalculators.IRangeCalculationHelper<T> rangeCalculationHelper)

    Sets IRangeCalculationHelper instance which will be used for range calculations in this axis

    Declaration
    protected final void setRangeCalculationHelper(rangeCalculators.IRangeCalculationHelper<T> rangeCalculationHelper)
    Parameters
    Type Name Description
    IRangeCalculationHelper<T> rangeCalculationHelper

    New IRangeCalculationHelper instance

    setTickLabelStyle(FontStyle tickLabelStyle)

    Sets the style which is used to draw all tick labels on this axis

    Declaration
    public final void setTickLabelStyle(FontStyle tickLabelStyle)
    Parameters
    Type Name Description
    FontStyle tickLabelStyle

    setTitleStyle(FontStyle titleStyle)

    Sets the style which is used to draw axis title

    Declaration
    public final void setTitleStyle(FontStyle titleStyle)
    Parameters
    Type Name Description
    FontStyle titleStyle

    translatePoint(PointF point, IHitTestable hitTestable)

    Declaration
    public final boolean translatePoint(PointF point, IHitTestable hitTestable)
    Parameters
    Type Name Description
    android.graphics.PointF point
    IHitTestable hitTestable
    Returns
    Type Description
    boolean

    update(IAssetManager2D assetManager, RenderPassState renderPassState)

    Updates the state of this IUpdatable before rendering

    Declaration
    public final void update(IAssetManager2D assetManager, RenderPassState renderPassState)
    Parameters
    Type Name Description
    IAssetManager2D assetManager
    RenderPassState renderPassState

    updateAxisMeasurements()

    Updates measurements of axis for proper layout of its content

    Declaration
    public final void updateAxisMeasurements()

    updateAxisParams(AxisParams axisParams)

    Updates axis params according to current state of axis

    Declaration
    protected void updateAxisParams(AxisParams axisParams)
    Parameters
    Type Name Description
    AxisParams axisParams

    Axis params to update

    updateCore(RenderPassState renderPassState)

    Performs core update of axis

    Declaration
    public void updateCore(RenderPassState renderPassState)
    Parameters
    Type Name Description
    RenderPassState renderPassState

    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

    Declaration
    public final void zoom(float fromCoordinate, float toCoordinate)
    Parameters
    Type Name Description
    float fromCoordinate
    float toCoordinate

    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

    Declaration
    public final void zoom(float fromCoordinate, float toCoordinate, long duration)
    Parameters
    Type Name Description
    float fromCoordinate
    float toCoordinate
    long duration

    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

    Declaration
    public final void zoomBy(double minFraction, double maxFraction)
    Parameters
    Type Name Description
    double minFraction
    double maxFraction

    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

    Declaration
    public final void zoomBy(double minFraction, double maxFraction, long duration)
    Parameters
    Type Name Description
    double minFraction
    double maxFraction
    long duration

    Implements

    IAxis
    ISciChartSurfaceProvider
    Back to top © 2011-2025 SciChart. All rights reserved. | sitemap.xml