Contex.Plot (ContEx v0.4.0) View Source

Manages the layout of various plot elements, including titles, axis labels, legends etc and calculates appropriate margins depending on the options set.

Link to this section Summary

Types

plot_text()

row()

t()

Functions

attributes(plot, attrs)

Updates attributes for the plot. Takes a keyword list of attributes, which can include both "plot options" items passed individually as well as :title, :subtitle, :x_label and :y_label.

axis_labels(plot, x_label, y_label)

Sets the x-axis & y-axis labels for the plot. Empty string or nil will remove them.

dataset(plot, dataset)

Replaces the plot dataset and updates the plot content. Accepts a dataset or a list of lists/tuples representing the new data. The plot's dataset's original headers are preserved.

dataset(plot, data, headers)

Replaces the plot dataset and updates the plot content. Accepts list of lists/tuples representing the new data and a list of strings with new headers.

new(width, height, plot_content)

Creates a new plot with specified plot content.

new(dataset, type, width, height, attrs \\ [])

Creates a new plot with specified dataset and plot type. Other plot attributes can be set via a keyword list of options.

plot_options(plot, new_plot_options)

Updates plot options for the plot.

size(plot, width, height)

Updates the size for the plot

titles(plot, title, subtitle)

Sets the title and sub-title for the plot. Empty string or nil will remove the title or sub-title

to_svg(plot)

Generates SVG output marked as safe for the configured plot.

to_xml(plot)

Generates a complete XML document string.

Link to this section Types

plot_text()

Specs

plot_text() :: String.t() | nil

row()

Specs

row() :: list() | tuple()

t()

Specs

t() :: %Contex.Plot{
  default_style: term(),
  height: term(),
  margins: term(),
  plot_content: term(),
  plot_options: term(),
  subtitle: term(),
  title: term(),
  width: term(),
  x_label: term(),
  y_label: term()
}

Link to this section Functions

attributes(plot, attrs)

Specs

attributes(t(), keyword()) :: t()

Updates attributes for the plot. Takes a keyword list of attributes, which can include both "plot options" items passed individually as well as :title, :subtitle, :x_label and :y_label.

axis_labels(plot, x_label, y_label)

Specs

axis_labels(t(), plot_text(), plot_text()) :: t()

Sets the x-axis & y-axis labels for the plot. Empty string or nil will remove them.

dataset(plot, dataset)

Specs

dataset(t(), Contex.Dataset.t() | [row()]) :: t()

Replaces the plot dataset and updates the plot content. Accepts a dataset or a list of lists/tuples representing the new data. The plot's dataset's original headers are preserved.

dataset(plot, data, headers)

Specs

dataset(t(), [row()], [String.t()]) :: t()

Replaces the plot dataset and updates the plot content. Accepts list of lists/tuples representing the new data and a list of strings with new headers.

new(width, height, plot_content)

Specs

new(integer(), integer(), Contex.PlotContent.t()) :: t()

Creates a new plot with specified plot content.

new(dataset, type, width, height, attrs \\ [])

Specs

new(Contex.Dataset.t(), module(), integer(), integer(), keyword()) :: t()

Creates a new plot with specified dataset and plot type. Other plot attributes can be set via a keyword list of options.

plot_options(plot, new_plot_options)

Updates plot options for the plot.

size(plot, width, height)

Specs

size(t(), integer(), integer()) :: t()

Updates the size for the plot

titles(plot, title, subtitle)

Specs

titles(t(), plot_text(), plot_text()) :: t()

Sets the title and sub-title for the plot. Empty string or nil will remove the title or sub-title

to_svg(plot)

Generates SVG output marked as safe for the configured plot.

to_xml(plot)

Specs

to_xml(t()) :: iolist()

Generates a complete XML document string.