Merge pull request #23 from BigThinkcode/plot_options

Use plot options to plot a chart

Author: Sadique-The-Alchemist

lib/matplotex.ex

@@ -10,6 +10,14 @@ defmodule Matplotex do
   alias Matplotex.Figure
   alias Matplotex.Figure.Areal.BarChart
 
+  def bar(values, width) do
+    bar(width, values, width, [])
+  end
+
+  def bar(values, width, opts) when is_list(opts) do
+    bar(width, values, width, opts)
+  end
+
   def bar(pos, values, width) do
     bar(pos, values, width, [])
   end

lib/matplotex/figure.ex

@@ -3,6 +3,8 @@ defmodule Matplotex.Figure do
   @row_column_default 1
   @margin_default 0.05
   @figsize {10, 6}
+
+  @restricted_keys [:axes, :element, :valid?, :rc_params, :errors]
   defstruct [
     :id,
     :axes,
@@ -32,6 +34,8 @@ defmodule Matplotex.Figure do
     struct(__MODULE__, opts)
   end
 
+  def restricted_keys(), do: @restricted_keys
+
   # TODO: put error message in error
   # def put_error(figure, opts) do
 

lib/matplotex/figure/areal/bar_chart.ex

@@ -1,5 +1,6 @@
 defmodule Matplotex.Figure.Areal.BarChart do
   import Matplotex.Figure.Numer
+  alias Matplotex.Figure.Areal.PlotOptions
   alias Matplotex.Figure.Areal.Region
   alias Matplotex.Element.Legend
   alias Matplotex.Figure.Dataset
@@ -41,6 +42,7 @@ defmodule Matplotex.Figure.Areal.BarChart do
       | rc_params: %RcParams{white_space: width, y_padding: 0},
         axes: %{axes | data: xydata, dataset: datasets}
     }
+    |> PlotOptions.set_options_in_figure(opts)
   end
 
   @impl Areal

lib/matplotex/figure/areal/line_plot.ex

@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure.Areal.LinePlot do
+  alias Matplotex.Figure.Areal.PlotOptions
   alias Matplotex.Utils.Algebra
   alias Matplotex.Figure.Areal.Region
   alias Matplotex.Figure.Areal.Ticker
@@ -31,14 +32,16 @@ defmodule Matplotex.Figure.Areal.LinePlot do
   def create(
         %Figure{axes: %__MODULE__{dataset: data} = axes} = figure,
         {x, y},
-        opts \\ []
+        opts
       ) do
     x = determine_numeric_value(x)
     y = determine_numeric_value(y)
     dataset = Dataset.cast(%Dataset{x: x, y: y}, opts)
     datasets = data ++ [dataset]
     xydata = flatten_for_data(datasets)
+
     %Figure{figure | axes: %{axes | data: xydata, dataset: datasets}}
+    |> PlotOptions.set_options_in_figure(opts)
   end
 
   @impl Areal

lib/matplotex/figure/areal/plot_options.ex

@@ -99,6 +99,48 @@ defmodule Matplotex.Figure.Areal.PlotOptions do
     |> set_options_in_rc_params_struct(options)
   end
 
+  @spec set_options_in_figure(Figure.t(), keyword()) :: Figure.t()
+  def set_options_in_figure(%Figure{} = figure, opts) do
+    figure
+    |> cast_figure(opts)
+    |> cast_axes(opts)
+    |> cast_rc_params(opts)
+  end
+
+  defp cast_figure(figure, opts) do
+    struct(figure, opts)
+  end
+
+  defp cast_axes(%Figure{axes: axes} = figure, opts) do
+    opts = Keyword.delete(opts, :label)
+
+    %Figure{
+      figure
+      | axes: axes |> struct(opts) |> cast_two_d_structs(opts)
+        # |>fulfill_tick_and_lim()
+    }
+  end
+
+  # defp fulfill_tick_and_lim(%{tick: nil, limit: nil} = axes) do
+
+  # end
+
+  defp cast_two_d_structs(%{label: label, tick: tick, limit: limit} = axes, opts)
+       when is_map(opts) do
+    %{
+      axes
+      | label: TwoD.update(label, opts, :label),
+        tick: TwoD.update(tick, opts, :tick),
+        limit: TwoD.update(limit, opts, :limit)
+    }
+  end
+
+  defp cast_two_d_structs(axes, opts), do: cast_two_d_structs(axes, Enum.into(opts, %{}))
+
+  defp cast_rc_params(%Figure{rc_params: rc_params} = figure, opts) do
+    %Figure{figure | rc_params: rc_params |> RcParams.update_with_font(opts) |> struct(opts)}
+  end
+
   defp set_options_in_figure_struct(%Figure{} = figure, %__MODULE__{
          figsize: figsize,
          figrows: figrows,

lib/matplotex/figure/areal/scatter.ex

@@ -1,4 +1,5 @@
 defmodule Matplotex.Figure.Areal.Scatter do
+  alias Matplotex.Figure.Areal.PlotOptions
   alias Matplotex.Figure.Areal.Region
   alias Matplotex.Figure.Areal.Ticker
   alias Matplotex.Figure.Marker
@@ -32,7 +33,9 @@ defmodule Matplotex.Figure.Areal.Scatter do
     dataset = Dataset.cast(%Dataset{x: x, y: y}, opts)
     datasets = data ++ [dataset]
     xydata = flatten_for_data(datasets)
+
     %Figure{figure | axes: %{axes | data: xydata, dataset: datasets}}
+    |> PlotOptions.set_options_in_figure(opts)
   end
 
   @impl Areal

lib/matplotex/figure/cast.ex

@@ -89,7 +89,6 @@ defmodule Matplotex.Figure.Cast do
         } = figure
       ) do
     #  Convert to the svg plane
-
     {left_x, bottom_y} = Algebra.flip_y_coordinate({content_x, content_y})
 
     {right_x, top_y} =

lib/matplotex/figure/lead.ex

@@ -78,14 +78,29 @@ defmodule Matplotex.Figure.Lead do
   end
 
   defp maybe_generate_ticks(ticks, limit, data, number_of_ticks) do
-    if is_nil(ticks) || length(ticks) < 3 do
-      generate_ticks(limit, data, ceil(number_of_ticks))
-    else
-      {ticks, limit}
+    cond do
+      is_nil(ticks) || length(ticks) < 3 ->
+        generate_ticks(limit, data, ceil(number_of_ticks))
+
+      is_nil(limit) ->
+        {ticks, generate_limit(data)}
+
+      true ->
+        {ticks, limit}
     end
   end
 
   defp generate_ticks(nil, data, number_of_ticks) do
+    data
+    |> generate_limit()
+    |> generate_ticks(data, number_of_ticks)
+  end
+
+  defp generate_ticks({lower_limit, upper_limit} = lim, _data, number_of_ticks) do
+    {lower_limit |> Nx.linspace(upper_limit, n: number_of_ticks) |> Nx.to_list(), lim}
+  end
+
+  defp generate_limit(data) do
     {min, upper_limit} = Enum.min_max(data)
 
     lower_limit =
@@ -95,11 +110,7 @@ defmodule Matplotex.Figure.Lead do
         0
       end
 
-    generate_ticks({lower_limit, upper_limit}, data, number_of_ticks)
-  end
-
-  defp generate_ticks({lower_limit, upper_limit} = lim, _data, number_of_ticks) do
-    {lower_limit |> Nx.linspace(upper_limit, n: number_of_ticks) |> Nx.to_list(), lim}
+    {lower_limit, upper_limit}
   end
 
   defp set_region_xy(
@@ -124,6 +135,7 @@ defmodule Matplotex.Figure.Lead do
        ) do
     space_for_ylabel = height_required_for_text(y_label_font, y_label)
     y_tick = Enum.max_by(y_ticks, &tick_length(&1))
+
     space_for_yticks = length_required_for_text(y_tick_font, y_tick)
 
     space_required_for_region_y =
@@ -352,8 +364,11 @@ defmodule Matplotex.Figure.Lead do
           rotation: 0
         },
         text
-      ),
-      do: tick_length(text) * to_number(font_size) * (pt_to_inch_ratio / 2) + flate
+      ) do
+    text_size = tick_length(text) * to_number(font_size) * (pt_to_inch_ratio / 2)
+    offset_for_text_length = 1 / tick_length(text) * (pt_to_inch_ratio / 2) * to_number(font_size)
+    text_size + offset_for_text_length + flate
+  end
 
   def length_required_for_text(
         %Font{

lib/matplotex/figure/rc_params.ex

@@ -128,7 +128,7 @@ defmodule Matplotex.Figure.RcParams do
     y_label_font
   end
 
-  def update_with_font(rc_params, params) do
+  def update_with_font(rc_params, params) when is_map(params) do
     rc_params
     |> update_font(params, :x_label)
     |> update_font(params, :y_label)
@@ -137,6 +137,11 @@ defmodule Matplotex.Figure.RcParams do
     |> update_font(params, :title)
   end
 
+  def update_with_font(rc_params, params) do
+    params = Enum.into(params, %{})
+    update_with_font(rc_params, params)
+  end
+
   defp update_font(
          rc_params,
          params,

lib/matplotex/figure/two_d.ex

@@ -1,3 +1,15 @@
 defmodule Matplotex.Figure.TwoD do
   defstruct [:x, :y]
+
+  def update(twod, opts, context) do
+    %__MODULE__{
+      twod
+      | x: fetch_from_opts(opts, :x, context),
+        y: fetch_from_opts(opts, :y, context)
+    }
+  end
+
+  defp fetch_from_opts(opts, key, context) do
+    Map.get(opts, :"#{key}_#{context}")
+  end
 end