bump version [skip ci]

pgfplotsx colorbar improvements

Project.toml

@@ -1,7 +1,7 @@
 name = "Plots"
 uuid = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
 author = ["Tom Breloff (@tbreloff)"]
-version = "1.2.4"
+version = "1.2.5"
 
 [deps]
 Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"

src/backends/gr.jl

@@ -781,161 +781,161 @@ function gr_axis_width(sp, axis)
 end
 
 function _update_min_padding!(sp::Subplot{GRBackend})
-    has_user_gkswstype = haskey(ENV, "GKSwstype")
-    withenv("GKSwstype" => 100, "GKS_ENCODING" => "utf8") do
-        dpi = sp.plt[:thickness_scaling]
-        if has_user_gkswstype && isijulia()
+    dpi = sp.plt[:thickness_scaling]
+    ENV["GKS_ENCODING"] = "utf8"
+    if !haskey(ENV, "GKSwstype")
+        if isijulia()
             ENV["GKSwstype"] = "svg"
         end
-        # Add margin given by the user
-        leftpad   = 2mm  + sp[:left_margin]
-        toppad    = 2mm  + sp[:top_margin]
-        rightpad  = 2mm  + sp[:right_margin]
-        bottompad = 2mm  + sp[:bottom_margin]
-        # Add margin for title
-        if sp[:title] != ""
-            gr_set_font(titlefont(sp), sp)
-            l = last(last(gr_text_size(sp[:title])))
+    end
+    # Add margin given by the user
+    leftpad   = 2mm  + sp[:left_margin]
+    toppad    = 2mm  + sp[:top_margin]
+    rightpad  = 2mm  + sp[:right_margin]
+    bottompad = 2mm  + sp[:bottom_margin]
+    # Add margin for title
+    if sp[:title] != ""
+        gr_set_font(titlefont(sp), sp)
+        l = last(last(gr_text_size(sp[:title])))
+        h = 1mm + get_size(sp)[2] * l * px
+        toppad += h
+    end
+
+    if RecipesPipeline.is3d(sp)
+        xaxis, yaxis, zaxis = sp[:xaxis], sp[:yaxis], sp[:zaxis]
+        xticks, yticks, zticks = get_ticks(sp, xaxis), get_ticks(sp, yaxis), get_ticks(sp, zaxis)
+        # Add margin for x and y ticks
+        h = 0mm
+        if !(xticks in (nothing, false, :none))
+            gr_set_font(
+                tickfont(xaxis),
+                halign = (:left, :hcenter, :right)[sign(xaxis[:rotation]) + 2],
+                valign = (xaxis[:mirror] ? :bottom : :top),
+                rotation = xaxis[:rotation],
+                sp
+            )
+            l = 0.01 + last(gr_get_ticks_size(xticks, xaxis[:rotation]))
+            h = max(h, 1mm + get_size(sp)[2] * l * px)
+        end
+        if !(yticks in (nothing, false, :none))
+            gr_set_font(
+                tickfont(yaxis),
+                halign = (:left, :hcenter, :right)[sign(yaxis[:rotation]) + 2],
+                valign = (yaxis[:mirror] ? :bottom : :top),
+                rotation = yaxis[:rotation],
+                sp
+            )
+            l = 0.01 + last(gr_get_ticks_size(yticks, yaxis[:rotation]))
+            h = max(h, 1mm + get_size(sp)[2] * l * px)
+        end
+        if h > 0mm
+            if xaxis[:mirror] || yaxis[:mirror]
+                toppad += h
+            end
+            if !xaxis[:mirror] || !yaxis[:mirror]
+                bottompad += h
+            end
+        end
+
+        if !(zticks in (nothing, false, :none))
+            gr_set_font(
+                tickfont(zaxis),
+                halign = (zaxis[:mirror] ? :left : :right),
+                valign = (:top, :vcenter, :bottom)[sign(zaxis[:rotation]) + 2],
+                rotation = zaxis[:rotation],
+                color = zaxis[:tickfontcolor],
+                sp
+            )
+            l = 0.01 + first(gr_get_ticks_size(zticks, zaxis[:rotation]))
+            w = 1mm + get_size(sp)[1] * l * px
+            if zaxis[:mirror]
+                rightpad += w
+            else
+                leftpad += w
+            end
+        end
+
+        # Add margin for x or y label
+        h = 0mm
+        if xaxis[:guide] != ""
+            gr_set_font(guidefont(sp[:xaxis]), sp)
+            l = last(gr_text_size(sp[:xaxis][:guide]))
+            h = max(h, 1mm + get_size(sp)[2] * l * px)
+        end
+        if yaxis[:guide] != ""
+            gr_set_font(guidefont(sp[:yaxis]), sp)
+            l = last(gr_text_size(sp[:yaxis][:guide]))
+            h = max(h, 1mm + get_size(sp)[2] * l * px)
+        end
+        if h > 0mm
+            if xaxis[:guide_position] == :top || (xaxis[:guide_position] == :auto && xaxis[:mirror] == true)
+                toppad += h
+            else
+                bottompad += h
+            end
+        end
+        # Add margin for z label
+        if zaxis[:guide] != ""
+            gr_set_font(guidefont(sp[:zaxis]), sp)
+            l = last(gr_text_size(sp[:zaxis][:guide]))
+            w = 1mm + get_size(sp)[2] * l * px
+            if zaxis[:guide_position] == :right || (zaxis[:guide_position] == :auto && zaxis[:mirror] == true)
+                rightpad += w
+            else
+                leftpad += w
+            end
+        end
+    else
+        # Add margin for x and y ticks
+        xticks, yticks = get_ticks(sp, sp[:xaxis]), get_ticks(sp, sp[:yaxis])
+        if !(xticks in (nothing, false, :none))
+            flip, mirror = gr_set_xticks_font(sp)
+            l = 0.01 + last(gr_get_ticks_size(xticks, sp[:xaxis][:rotation]))
             h = 1mm + get_size(sp)[2] * l * px
-            toppad += h
-        end
-
-        if RecipesPipeline.is3d(sp)
-            xaxis, yaxis, zaxis = sp[:xaxis], sp[:yaxis], sp[:zaxis]
-            xticks, yticks, zticks = get_ticks(sp, xaxis), get_ticks(sp, yaxis), get_ticks(sp, zaxis)
-            # Add margin for x and y ticks
-            h = 0mm
-            if !(xticks in (nothing, false, :none))
-                gr_set_font(
-                    tickfont(xaxis),
-                    halign = (:left, :hcenter, :right)[sign(xaxis[:rotation]) + 2],
-                    valign = (xaxis[:mirror] ? :bottom : :top),
-                    rotation = xaxis[:rotation],
-                    sp
-                )
-                l = 0.01 + last(gr_get_ticks_size(xticks, xaxis[:rotation]))
-                h = max(h, 1mm + get_size(sp)[2] * l * px)
-            end
-            if !(yticks in (nothing, false, :none))
-                gr_set_font(
-                    tickfont(yaxis),
-                    halign = (:left, :hcenter, :right)[sign(yaxis[:rotation]) + 2],
-                    valign = (yaxis[:mirror] ? :bottom : :top),
-                    rotation = yaxis[:rotation],
-                    sp
-                )
-                l = 0.01 + last(gr_get_ticks_size(yticks, yaxis[:rotation]))
-                h = max(h, 1mm + get_size(sp)[2] * l * px)
-            end
-            if h > 0mm
-                if xaxis[:mirror] || yaxis[:mirror]
-                    toppad += h
-                end
-                if !xaxis[:mirror] || !yaxis[:mirror]
-                    bottompad += h
-                end
-            end
-
-            if !(zticks in (nothing, false, :none))
-                gr_set_font(
-                    tickfont(zaxis),
-                    halign = (zaxis[:mirror] ? :left : :right),
-                    valign = (:top, :vcenter, :bottom)[sign(zaxis[:rotation]) + 2],
-                    rotation = zaxis[:rotation],
-                    color = zaxis[:tickfontcolor],
-                    sp
-                )
-                l = 0.01 + first(gr_get_ticks_size(zticks, zaxis[:rotation]))
-                w = 1mm + get_size(sp)[1] * l * px
-                if zaxis[:mirror]
-                    rightpad += w
-                else
-                    leftpad += w
-                end
-            end
-
-            # Add margin for x or y label
-            h = 0mm
-            if xaxis[:guide] != ""
-                gr_set_font(guidefont(sp[:xaxis]), sp)
-                l = last(gr_text_size(sp[:xaxis][:guide]))
-                h = max(h, 1mm + get_size(sp)[2] * l * px)
-            end
-            if yaxis[:guide] != ""
-                gr_set_font(guidefont(sp[:yaxis]), sp)
-                l = last(gr_text_size(sp[:yaxis][:guide]))
-                h = max(h, 1mm + get_size(sp)[2] * l * px)
-            end
-            if h > 0mm
-                if xaxis[:guide_position] == :top || (xaxis[:guide_position] == :auto && xaxis[:mirror] == true)
-                    toppad += h
-                else
-                    bottompad += h
-                end
-            end
-            # Add margin for z label
-            if zaxis[:guide] != ""
-                gr_set_font(guidefont(sp[:zaxis]), sp)
-                l = last(gr_text_size(sp[:zaxis][:guide]))
-                w = 1mm + get_size(sp)[2] * l * px
-                if zaxis[:guide_position] == :right || (zaxis[:guide_position] == :auto && zaxis[:mirror] == true)
-                    rightpad += w
-                else
-                    leftpad += w
-                end
-            end
-        else
-            # Add margin for x and y ticks
-            xticks, yticks = get_ticks(sp, sp[:xaxis]), get_ticks(sp, sp[:yaxis])
-            if !(xticks in (nothing, false, :none))
-                flip, mirror = gr_set_xticks_font(sp)
-                l = 0.01 + last(gr_get_ticks_size(xticks, sp[:xaxis][:rotation]))
-                h = 1mm + get_size(sp)[2] * l * px
-                if mirror
-                    toppad += h
-                else
-                    bottompad += h
-                end
-            end
-            if !(yticks in (nothing, false, :none))
-                flip, mirror = gr_set_yticks_font(sp)
-                l = 0.01 + first(gr_get_ticks_size(yticks, sp[:yaxis][:rotation]))
-                w = 1mm + get_size(sp)[1] * l * px
-                if mirror
-                    rightpad += w
-                else
-                    leftpad += w
-                end
-            end
-
-            # Add margin for x label
-            if sp[:xaxis][:guide] != ""
-                gr_set_font(guidefont(sp[:xaxis]), sp)
-                l = last(gr_text_size(sp[:xaxis][:guide]))
-                h = 1mm + get_size(sp)[2] * l * px
-                if sp[:xaxis][:guide_position] == :top || (sp[:xaxis][:guide_position] == :auto && sp[:xaxis][:mirror] == true)
-                    toppad += h
-                else
-                    bottompad += h
-                end
-            end
-            # Add margin for y label
-            if sp[:yaxis][:guide] != ""
-                gr_set_font(guidefont(sp[:yaxis]), sp)
-                l = last(gr_text_size(sp[:yaxis][:guide]))
-                w = 1mm + get_size(sp)[2] * l * px
-                if sp[:yaxis][:guide_position] == :right || (sp[:yaxis][:guide_position] == :auto && sp[:yaxis][:mirror] == true)
-                    rightpad += w
-                else
-                    leftpad += w
-                end
+            if mirror
+                toppad += h
+            else
+                bottompad += h
             end
         end
-        if sp[:colorbar_title] != ""
-            rightpad += 4mm
+        if !(yticks in (nothing, false, :none))
+            flip, mirror = gr_set_yticks_font(sp)
+            l = 0.01 + first(gr_get_ticks_size(yticks, sp[:yaxis][:rotation]))
+            w = 1mm + get_size(sp)[1] * l * px
+            if mirror
+                rightpad += w
+            else
+                leftpad += w
+            end
         end
-        sp.minpad = Tuple(dpi * [leftpad, toppad, rightpad, bottompad])
-    end # end withenv
+
+        # Add margin for x label
+        if sp[:xaxis][:guide] != ""
+            gr_set_font(guidefont(sp[:xaxis]), sp)
+            l = last(gr_text_size(sp[:xaxis][:guide]))
+            h = 1mm + get_size(sp)[2] * l * px
+            if sp[:xaxis][:guide_position] == :top || (sp[:xaxis][:guide_position] == :auto && sp[:xaxis][:mirror] == true)
+                toppad += h
+            else
+                bottompad += h
+            end
+        end
+        # Add margin for y label
+        if sp[:yaxis][:guide] != ""
+            gr_set_font(guidefont(sp[:yaxis]), sp)
+            l = last(gr_text_size(sp[:yaxis][:guide]))
+            w = 1mm + get_size(sp)[2] * l * px
+            if sp[:yaxis][:guide_position] == :right || (sp[:yaxis][:guide_position] == :auto && sp[:yaxis][:mirror] == true)
+                rightpad += w
+            else
+                leftpad += w
+            end
+        end
+    end
+    if sp[:colorbar_title] != ""
+        rightpad += 4mm
+    end
+    sp.minpad = Tuple(dpi * [leftpad, toppad, rightpad, bottompad])
 end
 
 function is_equally_spaced(v)
@@ -1938,17 +1938,20 @@ for (mime, fmt) in (
     "image/svg+xml" => "svg",
 )
     @eval function _show(io::IO, ::MIME{Symbol($mime)}, plt::Plot{GRBackend})
+        ENV["GKS_ENCODING"] = "utf8"
         GR.emergencyclosegks()
         filepath = tempname() * "." * $fmt
-        withenv(
-            "GKS_ENCODING" => "utf8", 
-            "GKSwstype" => $fmt, 
-            "GKS_FILEPATH" => filepath
-        ) do
-            gr_display(plt, $fmt)
-            GR.emergencyclosegks()
-            write(io, read(filepath, String))
-            rm(filepath)
+        env = get(ENV, "GKSwstype", "0")
+        ENV["GKSwstype"] = $fmt
+        ENV["GKS_FILEPATH"] = filepath
+        gr_display(plt, $fmt)
+        GR.emergencyclosegks()
+        write(io, read(filepath, String))
+        rm(filepath)
+        if env != "0"
+            ENV["GKSwstype"] = env
+        else
+            pop!(ENV, "GKSwstype")
         end
     end
 end
@@ -1958,17 +1961,16 @@ function _display(plt::Plot{GRBackend})
     if plt[:display_type] == :inline
         GR.emergencyclosegks()
         filepath = tempname() * ".pdf"
-        withenv("GKSwstype" => "pdf", "GKS_FILEPATH" => filepath) do
-            gr_display(plt)
-            GR.emergencyclosegks()
-            content = string("\033]1337;File=inline=1;preserveAspectRatio=0:", base64encode(open(read, filepath)), "\a")
-            println(content)
-            rm(filepath)
-        end
+        ENV["GKSwstype"] = "pdf"
+        ENV["GKS_FILEPATH"] = filepath
+        gr_display(plt)
+        GR.emergencyclosegks()
+        content = string("\033]1337;File=inline=1;preserveAspectRatio=0:", base64encode(open(read, filepath)), "\a")
+        println(content)
+        rm(filepath)
     else
-        withenv("GKS_DOUBLE_BUF" => true) do
-            gr_display(plt)
-        end
+        ENV["GKS_DOUBLE_BUF"] = true
+        gr_display(plt)
     end
 end
 

src/backends/pgfplotsx.jl

@@ -206,41 +206,50 @@ function (pgfx_plot::PGFPlotsXPlot)(plt::Plot{PGFPlotsXBackend})
             # As it is likely that all series within the same axis use the same
             # colormap this should not cause any problem.
             for series in series_list(sp)
-                    if hascolorbar(series)
-                        cg = get_colorgradient(series)
-                        cm = pgfx_colormap(get_colorgradient(series))
-                        PGFPlotsX.push_preamble!(
-                            pgfx_plot.the_plot,
-                            """\\pgfplotsset{
-                            colormap={plots$(sp.attr[:subplot_index])}{$cm},
-                            }""",
-                        )
+                if hascolorbar(series)
+                    cg = get_colorgradient(series)
+                    cm = pgfx_colormap(get_colorgradient(series))
+                    PGFPlotsX.push_preamble!(
+                        pgfx_plot.the_plot,
+                        """\\pgfplotsset{
+                        colormap={plots$(sp.attr[:subplot_index])}{$cm},
+                        }""",
+                    )
+                    push!(axis_opt, "colormap name" => "plots$(sp.attr[:subplot_index])")
+                    if cg isa PlotUtils.CategoricalColorGradient
                         push!(
                             axis_opt,
-                            "colorbar" => nothing,
-                            "colormap name" => "plots$(sp.attr[:subplot_index])",
+                            "colormap access" => "piecewise const",
+                            "colorbar sampled" => nothing,
                         )
-                        if cg isa PlotUtils.CategoricalColorGradient
-                            push!(
-                                axis_opt,
-                                "colormap access" => "piecewise const",
-                                "colorbar sampled" => nothing,
-                            )
-                        end
-                        # goto is needed to break out of col and series for
-                        @goto colorbar_end
                     end
+                    # goto is needed to break out of col and series for
+                    @goto colorbar_end
+                end
             end
             @label colorbar_end
 
-            push!(
-                axis_opt,
-                "colorbar style" => PGFPlotsX.Options(
+            if hascolorbar(sp)
+                colorbar_style = PGFPlotsX.Options(
                     "title" => sp[:colorbar_title],
-                ),
-                "point meta max" => get_clims(sp)[2],
-                "point meta min" => get_clims(sp)[1],
-            )
+                    "xticklabel style" => pgfx_get_ticklabel_style(sp, sp[:xaxis]),
+                    "yticklabel style" => pgfx_get_ticklabel_style(sp, sp[:yaxis]),
+                )
+                if sp[:colorbar] === :top
+                    push!(colorbar_style,
+                        "at" => string((0.5, 1.05)),
+                        "anchor" => "south",
+                        "xticklabel pos" => "upper",
+                    )
+                end
+                push!(
+                    axis_opt,
+                    string("colorbar", pgfx_get_colorbar_pos(sp[:colorbar])) => nothing,
+                    "colorbar style" => colorbar_style,
+                    "point meta max" => get_clims(sp)[2],
+                    "point meta min" => get_clims(sp)[1],
+                )
+            end
             if RecipesPipeline.is3d(sp)
                 azim, elev = sp[:camera]
                 push!(axis_opt, "view" => (azim, elev))
@@ -669,6 +678,22 @@ pgfx_get_legend_pos(k) = get(
     ("at" => string((1.02, 1)), "anchor" => "north west"),
 )
 
+pgfx_get_colorbar_pos(s) =
+    get((left = " left", bottom = " horizontal", top = " horizontal"), s, "")
+pgfx_get_colorbar_pos(b::Bool) = ""
+
+function pgfx_get_ticklabel_style(sp, axis)
+    cstr = plot_color(axis[:tickfontcolor])
+    return PGFPlotsX.Options(
+        "font" => pgfx_font(
+            axis[:tickfontsize], pgfx_thickness_scaling(sp)
+        ),
+        "color" => cstr,
+        "draw opacity" => alpha(cstr),
+        "rotate" => axis[:tickfontrotation],
+    )
+end
+
 ## --------------------------------------------------------------------------------------
 # Generates a colormap for pgfplots based on a ColorGradient
 pgfx_arrow(::Nothing) = "every arrow/.append style={-}"
@@ -1105,17 +1130,8 @@ function pgfx_axis!(opt::PGFPlotsX.Options, sp::Subplot, letter)
             string(letter, "tick align") =>
                 (axis[:tick_direction] == :out ? "outside" : "inside"),
         )
-        cstr = plot_color(axis[:tickfontcolor])
-        α = alpha(cstr)
         push!(
-            opt,
-            string(letter, "ticklabel style") => PGFPlotsX.Options(
-                "font" =>
-                    pgfx_font(axis[:tickfontsize], pgfx_thickness_scaling(sp)),
-                "color" => cstr,
-                "draw opacity" => α,
-                "rotate" => axis[:tickfontrotation],
-            ),
+            opt, string(letter, "ticklabel style") => pgfx_get_ticklabel_style(sp, axis)
         )
         push!(
             opt,
@@ -1203,6 +1219,7 @@ function pgfx_axis!(opt::PGFPlotsX.Options, sp::Subplot, letter)
         )
     end
 end
+
 # --------------------------------------------------------------------------------------
 # display calls this and then _display, its called 3 times for plot(1:5)
 # Set the (left, top, right, bottom) minimum padding around the plot area

src/backends/pyplot.jl

@@ -589,6 +589,12 @@ function py_add_series(plt::Plot{PyPlotBackend}, series::Series)
             push!(handles, handle)
         else
             # do a normal scatter plot
+
+            # Add depthshade option for 3d plots
+            if RecipesPipeline.is3d(sp)
+                extrakw[:depthshade] = get(series[:extra_kwargs], :depthshade, false)
+            end
+
             handle = ax."scatter"(xyargs...;
                 label = series[:label],
                 zorder = series[:series_plotindex] + 0.5,