Package travel.wink.sdk.affiliate.model

Class ChartCategoryAxis

java.lang.Object
travel.wink.sdk.affiliate.model.ChartCategoryAxis
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2022-07-21T13:34:06.734669+07:00[Asia/Bangkok]") public class ChartCategoryAxis extends Object
The configuration options of the category axis.

  • Field Details

  • Constructor Details

    • ChartCategoryAxis

      public ChartCategoryAxis()

  • Method Details

    • autoBaseUnitSteps

      public ChartCategoryAxis autoBaseUnitSteps(AutoBaseUnitSteps autoBaseUnitSteps)

    • getAutoBaseUnitSteps

      @Nullable @Valid public @Valid AutoBaseUnitSteps getAutoBaseUnitSteps()
      Get autoBaseUnitSteps
      Returns:
      autoBaseUnitSteps

    • setAutoBaseUnitSteps

      public void setAutoBaseUnitSteps(AutoBaseUnitSteps autoBaseUnitSteps)

    • axisCrossingValue

      public ChartCategoryAxis axisCrossingValue(List<Object> axisCrossingValue)

    • addAxisCrossingValueItem

      public ChartCategoryAxis addAxisCrossingValueItem(Object axisCrossingValueItem)

    • getAxisCrossingValue

      @Nullable public List<Object> getAxisCrossingValue()
      The category index or the date (for date category axis) at which the first value axis crosses this axis. The category indices or the date (for date category axis) at which the value axes cross the category axis (when set as an array). To denote the far end of the axis, set an index greater than or equal to the Number of categories.
      Returns:
      axisCrossingValue

    • setAxisCrossingValue

      public void setAxisCrossingValue(List<Object> axisCrossingValue)

    • background

      public ChartCategoryAxis background(String background)

    • getBackground

      @Nullable public String getBackground()
      The background color of the axis.
      Returns:
      background

    • setBackground

      public void setBackground(String background)

    • baseUnit

      public ChartCategoryAxis baseUnit(ChartCategoryAxis.BaseUnitEnum baseUnit)

    • getBaseUnit

      @Nullable public ChartCategoryAxis.BaseUnitEnum getBaseUnit()
      The base time interval for the date axis. The default base unit is automatically determined by the minimum difference between subsequent categories. The supported values are: - `fit` - `milliseconds` - `seconds` - `minutes` - `hours` - `days` - `weeks` - `months` - `years` Setting `baseUnit` to `fit` sets such a base unit and `categoryAxis.baseUnitStep` that the total Number of categories does not exceed `categoryAxis.maxDateGroups`. Series data is aggregated for the specified base unit by using the `series.aggregate` function.
      Returns:
      baseUnit

    • setBaseUnit

      public void setBaseUnit(ChartCategoryAxis.BaseUnitEnum baseUnit)

    • baseUnitStep

      public ChartCategoryAxis baseUnitStep(BigDecimal baseUnitStep)

    • getBaseUnitStep

      @Nullable @Valid public @Valid BigDecimal getBaseUnitStep()
      The step (interval) between the categories in base units. Setting it to `auto` sets the step to such a value that the total Number of categories does not exceed `categoryAxis.maxDateGroups`. The option is ignored if `categoryAxis.baseUnit` is set to `fit`.
      Returns:
      baseUnitStep

    • setBaseUnitStep

      public void setBaseUnitStep(BigDecimal baseUnitStep)

    • categories

      public ChartCategoryAxis categories(List<String> categories)

    • addCategoriesItem

      public ChartCategoryAxis addCategoriesItem(String categoriesItem)

    • getCategories

      @Nullable public List<String> getCategories()
      The category names. The Chart creates a category for every item of the array.
      Returns:
      categories

    • setCategories

      public void setCategories(List<String> categories)

    • color

      public ChartCategoryAxis color(String color)

    • getColor

      @Nullable public String getColor()
      The color to apply to all axis elements. Accepts a valid CSS color String, including hex and rgb. Can be overridden by `categoryAxis.labels.color` and `categoryAxis.line.color`.
      Returns:
      color

    • setColor

      public void setColor(String color)

    • justified

      public ChartCategoryAxis justified(Boolean justified)

    • getJustified

      @Nullable public Boolean getJustified()
      If set to `true`, the Chart positions categories and series points on major ticks. This removes the empty space before and after the series. The default value is `false` except for `area`, `verticalArea`, `rangeArea`, and `verticalRangeArea`. The option is ignored if the `series.type` option is set to `bar`, `column`, `boxPlot`, `ohlc`, `candlestick`, or `waterfall`.
      Returns:
      justified

    • setJustified

      public void setJustified(Boolean justified)

    • line

      public ChartCategoryAxis line(AxisLine line)

    • getLine

      @Nullable @Valid public @Valid AxisLine getLine()
      Get line
      Returns:
      line

    • setLine

      public void setLine(AxisLine line)

    • majorGridLines

      public ChartCategoryAxis majorGridLines(ChartCategoryAxisMajorGridLines majorGridLines)

    • getMajorGridLines

      @Nullable @Valid public @Valid ChartCategoryAxisMajorGridLines getMajorGridLines()
      Get majorGridLines
      Returns:
      majorGridLines

    • setMajorGridLines

      public void setMajorGridLines(ChartCategoryAxisMajorGridLines majorGridLines)

    • majorTicks

      public ChartCategoryAxis majorTicks(AxisTicks majorTicks)

    • getMajorTicks

      @Nullable @Valid public @Valid AxisTicks getMajorTicks()
      Get majorTicks
      Returns:
      majorTicks

    • setMajorTicks

      public void setMajorTicks(AxisTicks majorTicks)

    • max

      public ChartCategoryAxis max(OffsetDateTime max)

    • getMax

      @Nullable @Valid public @Valid OffsetDateTime getMax()
      The last date displayed on a date category axis or the index of the last category displayed on a category axis. By default, the max value is the same as the last category. This is often used in combination with the `categoryAxis.min` and `categoryAxis.roundToBaseUnit` options to set up a fixed date range.
      Returns:
      max

    • setMax

      public void setMax(OffsetDateTime max)

    • maxDateGroups

      public ChartCategoryAxis maxDateGroups(BigDecimal maxDateGroups)

    • getMaxDateGroups

      @Nullable @Valid public @Valid BigDecimal getMaxDateGroups()
      The maximum Number of groups (categories) to display when `categoryAxis.baseUnit` is set to `fit` or `categoryAxis.baseUnitStep` is set to `auto`.
      Returns:
      maxDateGroups

    • setMaxDateGroups

      public void setMaxDateGroups(BigDecimal maxDateGroups)

    • maxDivisions

      public ChartCategoryAxis maxDivisions(BigDecimal maxDivisions)

    • getMaxDivisions

      @Nullable @Valid public @Valid BigDecimal getMaxDivisions()
      The maximum Number of ticks and labels to display. Applicabable for date category axis.
      Returns:
      maxDivisions

    • setMaxDivisions

      public void setMaxDivisions(BigDecimal maxDivisions)

    • min

      public ChartCategoryAxis min(OffsetDateTime min)

    • getMin

      @Nullable @Valid public @Valid OffsetDateTime getMin()
      The first date which is displayed on a date category axis or the index of the first category whcih is displayed on a category axis. By default, the min value is the same as the first category. This is often used in combination with the `categoryAxis.max` and `categoryAxis.roundToBaseUnit` options to set up a fixed date range.
      Returns:
      min

    • setMin

      public void setMin(OffsetDateTime min)

    • minorGridLines

      public ChartCategoryAxis minorGridLines(GridLines minorGridLines)

    • getMinorGridLines

      @Nullable @Valid public @Valid GridLines getMinorGridLines()
      Get minorGridLines
      Returns:
      minorGridLines

    • setMinorGridLines

      public void setMinorGridLines(GridLines minorGridLines)

    • minorTicks

      public ChartCategoryAxis minorTicks(AxisTicks minorTicks)

    • getMinorTicks

      @Nullable @Valid public @Valid AxisTicks getMinorTicks()
      Get minorTicks
      Returns:
      minorTicks

    • setMinorTicks

      public void setMinorTicks(AxisTicks minorTicks)

    • name

      public ChartCategoryAxis name(String name)

    • getName

      @Nullable public String getName()
      The unique axis name. Used to associate a series with a category axis, which utilizes the `series.categoryAxis` option.
      Returns:
      name

    • setName

      public void setName(String name)

    • pane

      public ChartCategoryAxis pane(String pane)

    • getPane

      @Nullable public String getPane()
      The name of the pane in which the category axis has to be rendered. If not set, the axis will be rendered in the first (default) pane.
      Returns:
      pane

    • setPane

      public void setPane(String pane)

    • plotBands

      public ChartCategoryAxis plotBands(List<PlotBand> plotBands)

    • addPlotBandsItem

      public ChartCategoryAxis addPlotBandsItem(PlotBand plotBandsItem)

    • getPlotBands

      @Nullable @Valid public @Valid List<PlotBand> getPlotBands()
      The plot bands of the category axis.
      Returns:
      plotBands

    • setPlotBands

      public void setPlotBands(List<PlotBand> plotBands)

    • reverse

      public ChartCategoryAxis reverse(Boolean reverse)

    • getReverse

      @Nullable public Boolean getReverse()
      If set to `true`, the category axis direction is reversed. By default, categories are listed from left to right and from bottom to top.
      Returns:
      reverse

    • setReverse

      public void setReverse(Boolean reverse)

    • roundToBaseUnit

      public ChartCategoryAxis roundToBaseUnit(Boolean roundToBaseUnit)

    • getRoundToBaseUnit

      @Nullable public Boolean getRoundToBaseUnit()
      If set to `true`, the Chart rounds the first and last date to the nearest base unit.
      Returns:
      roundToBaseUnit

    • setRoundToBaseUnit

      public void setRoundToBaseUnit(Boolean roundToBaseUnit)

    • startAngle

      public ChartCategoryAxis startAngle(BigDecimal startAngle)

    • getStartAngle

      @Nullable @Valid public @Valid BigDecimal getStartAngle()
      The angle (degrees) of the first category on the axis. Angles increase clockwise with zero to the left. Negative values are acceptable.
      Returns:
      startAngle

    • setStartAngle

      public void setStartAngle(BigDecimal startAngle)

    • type

      public ChartCategoryAxis type(ChartCategoryAxis.TypeEnum type)

    • getType

      @Nullable public ChartCategoryAxis.TypeEnum getType()
      The category axis type. The supported values are: - `category` Discrete category axis.- `date` Specialized axis for displaying chronological data.
      Returns:
      type

    • setType

      public void setType(ChartCategoryAxis.TypeEnum type)

    • visible

      public ChartCategoryAxis visible(Boolean visible)

    • getVisible

      @Nullable public Boolean getVisible()
      If set to `true`, the Chart displays the category axis. By default, the category axis is visible.
      Returns:
      visible

    • setVisible

      public void setVisible(Boolean visible)

    • weekStartDay

      public ChartCategoryAxis weekStartDay(ChartCategoryAxis.WeekStartDayEnum weekStartDay)

    • getWeekStartDay

      @Nullable public ChartCategoryAxis.WeekStartDayEnum getWeekStartDay()
      The week start day when the `baseUnit` is set to `weeks`.
      Returns:
      weekStartDay

    • setWeekStartDay

      public void setWeekStartDay(ChartCategoryAxis.WeekStartDayEnum weekStartDay)

    • crosshair

      public ChartCategoryAxis crosshair(CategoryAxisCrosshair crosshair)

    • getCrosshair

      @Nullable @Valid public @Valid CategoryAxisCrosshair getCrosshair()
      Get crosshair
      Returns:
      crosshair

    • setCrosshair

      public void setCrosshair(CategoryAxisCrosshair crosshair)

    • labels

      public ChartCategoryAxis labels(ChartCategoryAxisLabels labels)

    • getLabels

      @Nullable @Valid public @Valid ChartCategoryAxisLabels getLabels()
      Get labels
      Returns:
      labels

    • setLabels

      public void setLabels(ChartCategoryAxisLabels labels)

    • notes

      public ChartCategoryAxis notes(CategoryAxisNotes notes)

    • getNotes

      @Nullable @Valid public @Valid CategoryAxisNotes getNotes()
      Get notes
      Returns:
      notes

    • setNotes

      public void setNotes(CategoryAxisNotes notes)

    • select

      public ChartCategoryAxis select(CategoryAxisSelect select)

    • getSelect

      @Nullable @Valid public @Valid CategoryAxisSelect getSelect()
      Get select
      Returns:
      select

    • setSelect

      public void setSelect(CategoryAxisSelect select)

    • title

      public ChartCategoryAxis title(CategoryAxisTitle title)

    • getTitle

      @Nullable @Valid public @Valid CategoryAxisTitle getTitle()
      Get title
      Returns:
      title

    • setTitle

      public void setTitle(CategoryAxisTitle title)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object