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

Class JsAxisDescriptor

java.lang.Object
io.deephaven.web.client.api.widget.plot.JsAxisDescriptor
@JsType(name="AxisDescriptor", namespace="dh.plot") public class JsAxisDescriptor extends Object
A descriptor used to configure an axis when creating a figure from JS.

  • Field Details

    • formatType

      public StringOrNumber formatType

    • type

      public StringOrNumber type

    • position

      public StringOrNumber position

    • log

      public @jsinterop.annotations.JsNullable boolean log
      Whether to use logarithmic scaling.

    • label

      public @JsNullable String label
      The axis label.

    • labelFont

      public @JsNullable String labelFont
      The font used to render the axis label.

    • ticksFont

      public @JsNullable String ticksFont
      The font used to render tick labels.

    • formatPattern

      public @JsNullable String formatPattern
      The format pattern used to render axis values.

    • color

      public @JsNullable String color
      The axis color.

    • minRange

      public @jsinterop.annotations.JsNullable double minRange
      The minimum value for the axis range, or JsNumber.NaN to use the default.

    • maxRange

      public @jsinterop.annotations.JsNullable double maxRange
      The maximum value for the axis range, or JsNumber.NaN to use the default.

    • minorTicksVisible

      public @jsinterop.annotations.JsNullable boolean minorTicksVisible
      Whether minor ticks are visible.

      Minor ticks are typically small, unlabeled tick marks drawn between major ticks.

    • majorTicksVisible

      public @jsinterop.annotations.JsNullable boolean majorTicksVisible
      Whether major ticks are visible.

      Major ticks are the primary tick marks on an axis. They typically determine the main tick spacing and are often the tick marks that are labeled.

    • minorTickCount

      public @jsinterop.annotations.JsNullable int minorTickCount
      The number of minor ticks between adjacent major ticks.

    • gapBetweenMajorTicks

      public @jsinterop.annotations.JsNullable double gapBetweenMajorTicks
      The gap between adjacent major ticks.

    • majorTickLocations

      public @JsNullable elemental2.core.JsArray<Double> majorTickLocations
      Explicit locations for major ticks.

      When specified, these values are used as the primary (major) tick positions instead of automatically choosing major ticks.

    • tickLabelAngle

      public @jsinterop.annotations.JsNullable double tickLabelAngle
      The angle to render tick labels at.

    • invert

      public @jsinterop.annotations.JsNullable boolean invert
      Whether to invert the axis.

    • isTimeAxis

      public @jsinterop.annotations.JsNullable boolean isTimeAxis
      Whether this axis should be treated as a time axis.

  • Constructor Details

    • JsAxisDescriptor

      @JsConstructor public JsAxisDescriptor()

    • JsAxisDescriptor

      @JsIgnore public JsAxisDescriptor(jsinterop.base.JsPropertyMap<Object> source)