GnuplotEx.Plot.Abbreviations (gnuplot_ex v0.5.1)

Expands abbreviated keywords to full forms.

This module provides a consistent way to use short keyword names in plot functions for convenience.

Abbreviations

ShortFull
ttitle or label
xlx_label
yly_label
zlz_label
xrx_range
yry_range
zrz_range
ccolor
lwline_width
pspoint_size
ptpoint_type
llabel
uru_range
vrv_range
sssurface_style
clcontour_levels
cscontour_style
palpalette
cbrcolorbar_range
cbcolorbar
ffilled
aalpha
irinner_radius
expexplode
sastart_angle
bcborder_color
bwborder_width

Example

iex> GnuplotEx.Plot.Abbreviations.expand([t: "Title", xr: 0..10, c: "#red"])
[title: "Title", x_range: 0..10, color: "#red"]

Summary

Functions

Get all available abbreviations.

Expand abbreviated keywords in an options list.

Functions

abbreviations()

@spec abbreviations() :: map()

Get all available abbreviations.

Returns a map of short keys to full keys.

expand(opts)

@spec expand(keyword()) :: keyword()

Expand abbreviated keywords in an options list.

Unknown keys pass through unchanged.

Example

iex> expand([t: "Title", xr: 0..10, c: "#red"])
[title: "Title", x_range: 0..10, color: "#red"]

iex> expand([custom: "value"])
[custom: "value"]