Method Detail

• topAxis

  @Composable() final static HorizontalAxis<AxisPosition.Horizontal.Top> topAxis(TextComponent label, LineComponent axis, LineComponent tick, Dp tickLength, LineComponent guideline, AxisValueFormatter<AxisPosition.Horizontal.Top> valueFormatter, Axis.SizeConstraint sizeConstraint, Float labelRotationDegrees, TextComponent titleComponent, CharSequence title, AxisItemPlacer.Horizontal itemPlacer)

  Creates a top axis (i.e., a HorizontalAxis with AxisPosition.Horizontal.Top).

  Parameters:

  label - the TextComponent to use for the labels.

  axis - the LineComponent to use for the axis line.

  tick - the LineComponent to use for the ticks.

  tickLength - the length of the ticks.

  guideline - the LineComponent to use for the guidelines.

  valueFormatter - formats the axis values.

  sizeConstraint - defines how the HorizontalAxis is to size itself.

  labelRotationDegrees - the rotation of the axis labels (in degrees).

  titleComponent - an optional TextComponent use as the axis title.

  title - the axis title.

  itemPlacer - determines for what x values the HorizontalAxis is to display labels, ticks, and guidelines.

• topAxis

  @Composable()@Deprecated(message = `labelSpacing` and `labelOffset` are being replaced by `AxisItemPlacer.Horizontal`. Create a base implementation
          with the desired spacing and offset via `AxisItemPlacer.Horizontal.default`, and use the `itemPlacer` parameter
          of the other `topAxis` overload to apply it to the `HorizontalAxis` being created., replaceWith = @ReplaceWith(imports = {com.patrykandpatrick.vico.core.axis.horizontal.AxisItemPlacer}, expression = topAxis(
              label = label,
              axis = axis,
              tick = tick,
              tickLength = tickLength,
              guideline = guideline,
              valueFormatter = valueFormatter,
              sizeConstraint = sizeConstraint,
              labelRotationDegrees = labelRotationDegrees,
              titleComponent = titleComponent,
              title = title,
              itemPlacer = AxisItemPlacer.Horizontal.default(spacing = labelSpacing, offset = labelOffset),
          ))) final static HorizontalAxis<AxisPosition.Horizontal.Top> topAxis(TextComponent label, LineComponent axis, LineComponent tick, Dp tickLength, LineComponent guideline, AxisValueFormatter<AxisPosition.Horizontal.Top> valueFormatter, Axis.SizeConstraint sizeConstraint, Float labelRotationDegrees, TextComponent titleComponent, CharSequence title, Integer labelSpacing, Integer labelOffset)

  Creates a top axis (i.e., a HorizontalAxis with AxisPosition.Horizontal.Top).

  Parameters:

  label - the TextComponent to use for the labels.

  axis - the LineComponent to use for the axis line.

  tick - the LineComponent to use for the ticks.

  tickLength - the length of the ticks.

  guideline - the LineComponent to use for the guidelines.

  valueFormatter - formats the axis values.

  sizeConstraint - defines how the HorizontalAxis is to size itself.

  labelRotationDegrees - the rotation of the axis labels (in degrees).

  titleComponent - an optional TextComponent use as the axis title.

  title - the axis title.

  labelSpacing - how often labels (and their corresponding ticks and guidelines) should be drawn.

  labelOffset - the number of labels (and, for HorizontalLayout.FullWidth, their corresponding ticks and guidelines) to skip from the start.

• bottomAxis

  @Composable() final static HorizontalAxis<AxisPosition.Horizontal.Bottom> bottomAxis(TextComponent label, LineComponent axis, LineComponent tick, Dp tickLength, LineComponent guideline, AxisValueFormatter<AxisPosition.Horizontal.Bottom> valueFormatter, Axis.SizeConstraint sizeConstraint, TextComponent titleComponent, CharSequence title, Float labelRotationDegrees, AxisItemPlacer.Horizontal itemPlacer)

  Creates a bottom axis (i.e., a HorizontalAxis with AxisPosition.Horizontal.Bottom).

  Parameters:

  label - the TextComponent to use for the labels.

  axis - the LineComponent to use for the axis line.

  tick - the LineComponent to use for the ticks.

  tickLength - the length of the ticks.

  guideline - the LineComponent to use for the guidelines.

  valueFormatter - formats the axis values.

  sizeConstraint - defines how the HorizontalAxis is to size itself.

  titleComponent - an optional TextComponent use as the axis title.

  title - the axis title.

  labelRotationDegrees - the rotation of the axis labels (in degrees).

  itemPlacer - determines for what x values the HorizontalAxis is to display labels, ticks, and guidelines.

• bottomAxis

  @Composable()@Deprecated(message = `labelSpacing` and `labelOffset` are being replaced by `AxisItemPlacer.Horizontal`. Create a base implementation
          with the desired spacing and offset via `AxisItemPlacer.Horizontal.default`, and use the `itemPlacer` parameter
          of the other `bottomAxis` overload to apply it to the `HorizontalAxis` being created., replaceWith = @ReplaceWith(imports = {com.patrykandpatrick.vico.core.axis.horizontal.AxisItemPlacer}, expression = bottomAxis(
              label = label,
              axis = axis,
              tick = tick,
              tickLength = tickLength,
              guideline = guideline,
              valueFormatter = valueFormatter,
              sizeConstraint = sizeConstraint,
              titleComponent = titleComponent,
              title = title,
              labelRotationDegrees = labelRotationDegrees,
              itemPlacer = AxisItemPlacer.Horizontal.default(spacing = labelSpacing, offset = labelOffset),
          ))) final static HorizontalAxis<AxisPosition.Horizontal.Bottom> bottomAxis(TextComponent label, LineComponent axis, LineComponent tick, Dp tickLength, LineComponent guideline, AxisValueFormatter<AxisPosition.Horizontal.Bottom> valueFormatter, Axis.SizeConstraint sizeConstraint, TextComponent titleComponent, CharSequence title, Float labelRotationDegrees, Integer labelSpacing, Integer labelOffset)

  Creates a bottom axis (i.e., a HorizontalAxis with AxisPosition.Horizontal.Bottom).

  Parameters:

  label - the TextComponent to use for the labels.

  axis - the LineComponent to use for the axis line.

  tick - the LineComponent to use for the ticks.

  tickLength - the length of the ticks.

  guideline - the LineComponent to use for the guidelines.

  valueFormatter - formats the axis values.

  sizeConstraint - defines how the HorizontalAxis is to size itself.

  titleComponent - an optional TextComponent use as the axis title.

  title - the axis title.

  labelRotationDegrees - the rotation of the axis labels (in degrees).

  labelSpacing - how often labels (and their corresponding ticks and guidelines) should be drawn.

  labelOffset - the number of labels (and, for HorizontalLayout.FullWidth, their corresponding ticks and guidelines) to skip from the start.