Plotex (plotex v0.5.4)

Documentation for Plotex.

TODO

Summary

Functions

Generates a stream of the data points (ticks) for a given axis.

Find the appropriate limits given an enumerable of datasets.

Create a Plotex struct for given datasets and configuration. Will load and scan data for all input datasets.

Returns of scaled data for both X & Y coordinates for a given {X,Y} dataset.

Returns a stream of scaled data points zipped with the original points.

Types

@type data() :: Stream.t(data_pair()) | Enum.t(data_pair())
@type data_item() :: Stream.t(data_types()) | Enum.t(data_types())
@type data_pair() :: {data_item(), data_item()}
Link to this type

data_types()

@type data_types() :: number() | DateTime.t() | NaiveDateTime.t()
@type t() :: %Plotex{
  config: Plotex.Config.t(),
  datasets: Enumerable.t(),
  xticks: Enumerable.t(),
  yticks: Enumerable.t()
}

Functions

Link to this function

generate_axis(axis)

Generates a stream of the data points (ticks) for a given axis.

Link to this function

limits(datasets, opts \\ [])

Find the appropriate limits given an enumerable of datasets.

For example, given {[1,2,3,4], [0.4,0.3,0.2,0.1]} will find the X limits 1..4 and the Y limits of 0.1..0.4.

Link to this function

plot(datasets, opts \\ [])

@spec plot(data(), Keyword.t()) :: t()

Create a Plotex struct for given datasets and configuration. Will load and scan data for all input datasets.

Link to this function

plot_data(arg, xaxis, yaxis)

Returns of scaled data for both X & Y coordinates for a given {X,Y} dataset.

Link to this function

scale_data(data, axis)

Returns a stream of scaled data points zipped with the original points.

Link to this function

std_units(opts)