Search Results for

    Show / Hide Table of Contents

    Class AxisInfo

    Provides information on an axis hit test operation See Also: IAxisInfoProvider#getAxisInfo()

    Inheritance
    java.lang.Object
    AxisInfo
    Implements
    IAxisInfoUpdatable
    Inherited Members
    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 class AxisInfo implements IAxisInfoUpdatable

    Constructors

    AxisInfo(IAxis axis)

    Creates a new instance of AxisInfo class

    Declaration
    public AxisInfo(IAxis axis)
    Parameters
    Type Name Description
    IAxis axis

    The parent axis

    Fields

    axisAlignment

    The AxisAlignment value

    Declaration
    public AxisAlignment axisAlignment
    Field Value
    Type Description
    AxisAlignment

    axisFormattedDataValue

    The data value formatted with IAxis#getTextFormatting() string

    Declaration
    public CharSequence axisFormattedDataValue
    Field Value
    Type Description
    CharSequence

    axisId

    The axis id

    Declaration
    public String axisId
    Field Value
    Type Description
    String

    axisTitle

    The axis title

    Declaration
    public CharSequence axisTitle
    Field Value
    Type Description
    CharSequence

    cursorFormattedDataValue

    The data value formatted with IAxis#getCursorTextFormatting() string

    Declaration
    public CharSequence cursorFormattedDataValue
    Field Value
    Type Description
    CharSequence

    dataValue

    The data value

    Declaration
    public Comparable<?> dataValue
    Field Value
    Type Description
    Comparable<?>

    isHorizontal

    Flag indicating whether the associated axis is horizontal axis

    Declaration
    public boolean isHorizontal
    Field Value
    Type Description
    boolean

    isXAxis

    Flag indicating whether the associated axis is XAxis

    Declaration
    public boolean isXAxis
    Field Value
    Type Description
    boolean

    Methods

    clear()

    Declaration
    public void clear()

    getAxis()

    Gets parent IAxis which is used to update current IAxisInfoUpdatable instance

    Declaration
    public final IAxis getAxis()
    Returns
    Type Description
    IAxis

    obtain(IAxis axis, Comparable<?> dataValue)

    Helper method which creates and updates AxisInfo instance with latest information provided by axis

    Declaration
    public static AxisInfo obtain(IAxis axis, Comparable<?> dataValue)
    Parameters
    Type Name Description
    IAxis axis

    The IAxis instance for which.

    Comparable<?> dataValue

    The dataValue with which AxisInfo should be updated.

    Returns
    Type Description

    The AxisInfo instance with latest information provided by axis.

    update()

    Updates this instance with latest value which does not depend on data value

    Declaration
    public void update()

    update(Comparable dataValue)

    Updates underlying AxisInfo based on dataValue

    Declaration
    public void update(Comparable dataValue)
    Parameters
    Type Name Description
    Comparable dataValue

    Implements

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