Slackblocks.Objects.BarChart (slackblocks v2.8.0)

View Source

A bar chart for a data visualization block.

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

Fields

  • series — Adds data series in display order. Series names must be unique. Required.
  • axis_config — Sets the axis categories and labels. Every series needs exactly one point per category. Required.

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.BarChart{
  axis_config: Slackblocks.Objects.AxisConfig.t(),
  series: [Slackblocks.Objects.DataSeries.t()]
}

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.