View Source Tucan.Axes (tucan v0.2.0)
Utilities for configuring plot axes.
Summary
Functions
Sets an arbitrary set of options to the given encoding
axis object.
Set the title of the given axis
.
Sets the x axis title.
Sets the x-axis and y-axis titles at once.
Sets the y axis title.
Types
@type axis() :: :x | :y
Functions
@spec put_options(vl :: VegaLite.t(), encoding :: atom(), options :: keyword()) :: VegaLite.t()
Sets an arbitrary set of options to the given encoding
axis object.
Notice that no validation is performed, any option set will be merged with
the existing axis
options of the given encoding
.
An ArgumentError
is raised if the given encoding channel is not defined.
@spec set_title(vl :: VegaLite.t(), axis :: axis(), title :: binary()) :: VegaLite.t()
Set the title of the given axis
.
@spec set_x_title(vl :: VegaLite.t(), title :: binary()) :: VegaLite.t()
Sets the x axis title.
@spec set_xy_titles(vl :: VegaLite.t(), x_title :: binary(), y_title :: binary()) :: VegaLite.t()
Sets the x-axis and y-axis titles at once.
@spec set_y_title(vl :: VegaLite.t(), title :: binary()) :: VegaLite.t()
Sets the y axis title.