ContEx
ContEx v0.5.0

View Source Contex.TimeScale (ContEx v0.5.0)

A time scale to map date and time data to a plotting coordinate system.

Almost identical Contex.ContinuousLinearScale in terms of concepts and usage, except it applies to DateTime and NaiveDateTime domain data types.

TimeScale handles the complexities of calculating nice tick intervals etc for almost any time range between a few seconds and a few years.

Link to this section Summary

Types

datetimes()
t()

Functions

domain(scale, data)

Define the data domain for the scale from a list of data.

domain(scale, min, max)

Define the data domain for the scale

interval_count(scale, interval_count)

Specifies the number of intervals the scale should display.

new()

Creates a new TimeScale struct with basic defaults set

Link to this section Types

Link to this type

datetimes()

View Source 
@type datetimes() :: NaiveDateTime.t() | DateTime.t()
Link to this type

t()

View Source 
@type t() :: %Contex.TimeScale{
  custom_tick_formatter: term(),
  display_format: term(),
  domain: term(),
  interval_count: term(),
  nice_domain: term(),
  range: term(),
  tick_interval: term()
}

Link to this section Functions

Link to this function

domain(scale, data)

View Source 
@spec domain(t(), [datetimes()]) :: t()

Define the data domain for the scale from a list of data.

Extents will be calculated by the scale.

Link to this function

domain(scale, min, max)

View Source 
@spec domain(t(), datetimes(), datetimes()) :: t()

Define the data domain for the scale

Link to this function

interval_count(scale, interval_count)

View Source 
@spec interval_count(t(), integer()) :: t()

Specifies the number of intervals the scale should display.

Default is 10.

Link to this function

new()

View Source 
@spec new() :: t()

Creates a new TimeScale struct with basic defaults set