Package io.deephaven.web.client.api.widget.plot

Class JsAxis

java.lang.Object
io.deephaven.web.client.api.widget.plot.JsAxis
@TsInterface @TsName(namespace="dh.plot", name="Axis") public class JsAxis extends Object
Defines one axis used with by series. These instances will be found both on the Chart and the Series instances, and may be shared between Series instances.

  • Constructor Details

  • Method Details

    • getBusinessCalendar

      @JsProperty public JsBusinessCalendar getBusinessCalendar()
      The calendar with the business hours and holidays to transform plot data against. Defaults to null, or no transform.
      Returns:
      dh.calendar.BusinessCalendar

    • getId

      @JsProperty public String getId()
      The unique id for this axis.
      Returns:
      String

    • getFormatType

      @JsProperty @TsTypeRef(JsAxisFormatType.class) public @com.vertispan.tsdefs.annotations.TsTypeRef(io.deephaven.web.client.api.widget.plot.enums.JsAxisFormatType.class) int getFormatType()
      The type for this axis. See AxisFormatType enum for more details.
      Returns:
      int

    • getType

      @JsProperty @TsTypeRef(JsAxisType.class) public @com.vertispan.tsdefs.annotations.TsTypeRef(io.deephaven.web.client.api.widget.plot.enums.JsAxisType.class) int getType()
      The type for this axis, indicating how it will be drawn. See AxisType enum for more details.
      Returns:
      int

    • getPosition

      @JsProperty @TsTypeRef(JsAxisPosition.class) public @com.vertispan.tsdefs.annotations.TsTypeRef(io.deephaven.web.client.api.widget.plot.enums.JsAxisPosition.class) int getPosition()
      The position for this axis. See AxisPosition enum for more details.
      Returns:
      int

    • isLog

      @JsProperty public boolean isLog()

    • getLabel

      @JsProperty public String getLabel()
      The label for this axis.
      Returns:
      String

    • getLabelFont

      @JsProperty public String getLabelFont()

    • getTicksFont

      @JsProperty public String getTicksFont()

    • getFormatPattern

      @JsProperty public @JsNullable String getFormatPattern()
      The format pattern to use with this axis. Use the type to determine which type of formatter to use.
      Returns:
      String

    • getColor

      @JsProperty public String getColor()

    • getMinRange

      @JsProperty public double getMinRange()

    • getMaxRange

      @JsProperty public double getMaxRange()

    • isMinorTicksVisible

      @JsProperty public boolean isMinorTicksVisible()

    • isMajorTicksVisible

      @JsProperty public boolean isMajorTicksVisible()

    • getMinorTickCount

      @JsProperty public int getMinorTickCount()

    • getGapBetweenMajorTicks

      @JsProperty public @JsNullable Double getGapBetweenMajorTicks()

    • getMajorTickLocations

      @JsProperty public double[] getMajorTickLocations()

    • getTickLabelAngle

      @JsProperty public double getTickLabelAngle()

    • isInvert

      @JsProperty public boolean isInvert()

    • isTimeAxis

      @JsProperty public boolean isTimeAxis()

    • range

      @JsMethod public void range(@JsOptional @JsNullable Double pixelCount, @JsOptional @JsNullable Object min, @JsOptional @JsNullable Object max)
      Indicates that this axis is only `widthInPixels` wide, so any extra data can be downsampled out, if this can be done losslessly. The second two arguments represent the current zoom range of this axis, and if provided, most of the data outside of this range will be filtered out automatically and the visible width mapped to that range. When the UI zooms, pans, or resizes, this method should be called again to update these three values to ensure that data is correct and current.
      Parameters:
      pixelCount -
      min -
      max -

    • getDescriptor

      public AxisDescriptor getDescriptor()