Add param legend_size to plotx

Author: ufechner7

README.md

@@ -164,9 +164,10 @@ Full function signature:
 ```julia
 plotx(X, Y...; xlabel="time [s]", ylabels=nothing, labels=nothing, xlims=nothing, 
       ylims=nothing, ann=nothing, scatter=false, fig="", title="", ysize=14, 
-      yzoom=1.0, bottom=nothing, disp=false)
+      legend_size=10, yzoom=1.0, bottom=nothing, disp=false)
 ```
 The optional parameter `ysize` can be used to change the size of the y-axis labels. The default value is 14 points.
+The optional parameter `legend_size` can be used to control the font size of the legend. The default value is 10 points.
 The optional parameter `bottom` can be used to control the bottom margin of the plot when using `plt.tight_layout(rect=[0, bottom, 1, 1])`. When `nothing`, the default tight layout is used.
 
 ### **n x m** Plot

src/ControlPlots.jl

@@ -18,6 +18,7 @@ mutable struct PlotX
     xlabel
     ylabels
     ysize
+    legend_size
     yzoom
     xlims
     ylims
@@ -57,7 +58,7 @@ function plotxy(X, Y; xlabel="", ylabel="", xlims=nothing, ylims=nothing, ann=no
         plt.grid(which="major", color="#DDDDDD")
         plt.tight_layout()
     end
-    PlotX(X, Y, nothing, xlabel, ylabel, ysize, nothing, xlims, ylims, ann, scatter, title, fig, nothing, 3)
+    PlotX(X, Y, nothing, xlabel, ylabel, ysize, nothing, nothing, xlims, ylims, ann, scatter, title, fig, nothing, 3)
 end
 
 function display(P::PlotX)
@@ -66,7 +67,7 @@ function display(P::PlotX)
              scatter=P.scatter, fig=P.fig, title=P.title, ysize=P.ysize, disp=true)
     elseif P.type == 2
         plotx(P.X, P.Y...; xlabel=P.xlabel, ylabels=P.ylabels, labels=P.labels, xlims=P.xlims, ylims=P.ylims, ann=P.ann, 
-              scatter=P.scatter, fig=P.fig, title=P.title, ysize=P.ysize, yzoom=P.yzoom, bottom=P.bottom, disp=true)
+              scatter=P.scatter, fig=P.fig, title=P.title, ysize=P.ysize, legend_size=P.legend_size, yzoom=P.yzoom, bottom=P.bottom, disp=true)
     elseif P.type == 3
         plotxy(P.X, P.Y; xlabel=P.xlabel, ylabel=P.ylabels, xlims=P.xlims, ylims=P.ylims, ann=P.ann, 
                scatter=P.scatter, fig=P.fig, title=P.title, ysize=P.ysize, disp=true)

src/plot.jl

@@ -86,7 +86,7 @@ function plot(X, Ys::AbstractVector{<:Union{AbstractVector, Tuple}}; xlabel="",
     else
         println("OK")
     end
-    PlotX(X, Ys, labels, xlabel, ylabel, ysize, nothing, xlims, ylims, ann, scatter, title, fig, nothing, 4)
+    PlotX(X, Ys, labels, xlabel, ylabel, ysize, nothing, nothing, xlims, ylims, ann, scatter, title, fig, nothing, 4)
 end
 
 function plot(X, Y1::AbstractVector{<:AbstractVector}, Y2::AbstractVector{<:Number}; 
@@ -126,7 +126,7 @@ function plot(X, Y1::AbstractVector{<:AbstractVector}, Y2::AbstractVector{<:Numb
         else
             println("OK")
         end
-        PlotX(X, [Y1, Y2], labels, xlabel, ylabels, ysize, nothing, xlims, ylims, ann, scatter, title, fig, nothing, 5)
+        PlotX(X, [Y1, Y2], labels, xlabel, ylabels, ysize, nothing, nothing, xlims, ylims, ann, scatter, title, fig, nothing, 5)
     end
 
 end
@@ -186,7 +186,7 @@ function plot(X, Y1::AbstractVector{<:Number}, Y2::AbstractVector{<:Number};
     else
         println("OK")
     end
-    PlotX(X, [Y1, Y2], labels, xlabel, ylabels, ysize, nothing, xlims, ylims, ann, scatter, title, fig, nothing, 5)
+    PlotX(X, [Y1, Y2], labels, xlabel, ylabels, ysize, nothing, nothing, xlims, ylims, ann, scatter, title, fig, nothing, 5)
 end
 
 function plot(Y::AbstractVector{<:Number}; xlabel="", ylabel="", title="", fig="", ysize=14, disp=false)
@@ -226,6 +226,6 @@ function plot(X, Y::AbstractVector{<:Number}; xlabel="", ylabel="", xlims=nothin
         plt.grid(which="major", color="#DDDDDD")
         plt.tight_layout()
     end
-    PlotX(X, Y, nothing, xlabel, ylabel, ysize, nothing, xlims, ylims, ann, scatter, title, fig, nothing, 1)
+    PlotX(X, Y, nothing, xlabel, ylabel, ysize, nothing, nothing, xlims, ylims, ann, scatter, title, fig, nothing, 1)
 end
 

src/plotx.jl

@@ -1,6 +1,6 @@
 """
     plotx(X, Y...; xlabel="time [s]", ylabels=nothing, labels=nothing, xlims=nothing, ylims=nothing, ann=nothing, 
-               scatter=false, title="", fig="", title="", ysize=14, yzoom=1.0, bottom=nothing, disp=false)
+               scatter=false, title="", fig="", title="", ysize=14, legend_size=10, yzoom=1.0, bottom=nothing, disp=false)
 
 Create an oscilloscope like plot with multiple y axes and one x axis.
 
@@ -17,12 +17,13 @@ Create an oscilloscope like plot with multiple y axes and one x axis.
 - `fig::String`: figure name
 - `title::String`: title
 - `ysize::Int`: y-axis label size
+- `legend_size::Int`: legend font size
 - `yzoom::Float64`: y-axis zoom factor
 - `bottom::Float64`: bottom margin for the plot
 - `disp::Bool`: display plot or just return the PlotX struct
 """
 function plotx(X, Y...; xlabel="time [s]", ylabels=nothing, labels=nothing, xlims=nothing, ylims=nothing, ann=nothing, 
-               scatter=false, title="", fig="", ysize=14, yzoom=1.0, bottom=nothing, disp=false)
+               scatter=false, title="", fig="", ysize=14, legend_size=10, yzoom=1.0, bottom=nothing, disp=false)
     if disp
         len=length(Y)
         fig_ = plt.figure(fig, figsize=(8, len*2*yzoom))
@@ -68,7 +69,7 @@ function plotx(X, Y...; xlabel="time [s]", ylabels=nothing, labels=nothing, xlim
             plt.xlim(X[begin], X[end])
             plt.ylabel(ylbl; fontsize=ysize);  
             if ! isnothing(lbl) && lbl != ""
-                plt.legend()
+                plt.legend(fontsize=legend_size)
             end
             plt.grid(true)
             plt.grid(which="major", color="#DDDDDD")
@@ -85,5 +86,5 @@ function plotx(X, Y...; xlabel="time [s]", ylabels=nothing, labels=nothing, xlim
             plt.tight_layout()
         end
     end
-    PlotX(collect(X), Y, labels, xlabel, ylabels, ysize, yzoom, xlims, ylims, ann, scatter, title, fig, bottom, 2)
+    PlotX(collect(X), Y, labels, xlabel, ylabels, ysize, legend_size, yzoom, xlims, ylims, ann, scatter, title, fig, bottom, 2)
 end

test_legend_size.jl

@@ -0,0 +1,17 @@
+using ControlPlots
+
+# Test the legend_size parameter
+T = 0:0.1:2π
+Y1 = sin.(T)
+Y2 = cos.(T)
+
+# Test plotx with default legend_size
+p1 = plotx(T, [Y1, Y2]; ylabels=["Channel 1"], labels=[["sin", "cos"]], fig="test1", title="Default legend size")
+display(p1)
+
+# Test plotx with custom legend_size
+p2 = plotx(T, [Y1, Y2]; ylabels=["Channel 1"], labels=[["sin", "cos"]], fig="test2", title="Large legend size", legend_size=16)
+display(p2)
+
+println("legend_size parameter value in p1: ", p1.legend_size)
+println("legend_size parameter value in p2: ", p2.legend_size)