Slackblocks.Objects.AxisConfig (slackblocks v2.8.0)

View Source

The categories and labels shared by bar, area, and line chart axes.

Slack reference: https://docs.slack.dev/reference/block-kit/blocks/data-visualization-block

Fields

  • categories — Adds axis categories in display order. Labels must be unique. Required.
  • x_label — Sets the horizontal axis label. Optional; nil omits the field.
  • y_label — Sets the vertical axis label. Optional; nil omits the field.

Summary

Types

t()

Functions

change(value, options)

Atomically replaces supplied fields; omitted fields retain their values.

change!(value, options)

Replaces fields or raises Slackblocks.ValidationError.

new(options)

Constructs and validates a value. Text conveniences apply to keyword input.

new!(options)

Constructs a value or raises Slackblocks.ValidationError.

Types

t()

@type t() :: %Slackblocks.Objects.AxisConfig{
  categories: [binary()],
  x_label: binary() | nil,
  y_label: binary() | nil
}

Functions

change(value, options)

@spec change(
  t(),
  keyword()
) :: {:ok, t()} | {:error, Slackblocks.ValidationError.t()}

Atomically replaces supplied fields; omitted fields retain their values.

change!(value, options)

@spec change!(
  t(),
  keyword()
) :: t()

Replaces fields or raises Slackblocks.ValidationError.

new(options)

@spec new(keyword()) :: {:ok, t()} | {:error, Slackblocks.ValidationError.t()}

Constructs and validates a value. Text conveniences apply to keyword input.

new!(options)

@spec new!(keyword()) :: t()

Constructs a value or raises Slackblocks.ValidationError.