293 lines
9.3 KiB
Julia
293 lines
9.3 KiB
Julia
|
|
mutable struct CurrentPlot
|
|
nullableplot::Union{AbstractPlot, Nothing}
|
|
end
|
|
const CURRENT_PLOT = CurrentPlot(nothing)
|
|
|
|
isplotnull() = CURRENT_PLOT.nullableplot === nothing
|
|
|
|
"""
|
|
current()
|
|
Returns the Plot object for the current plot
|
|
"""
|
|
function current()
|
|
if isplotnull()
|
|
error("No current plot/subplot")
|
|
end
|
|
CURRENT_PLOT.nullableplot
|
|
end
|
|
current(plot::AbstractPlot) = (CURRENT_PLOT.nullableplot = plot)
|
|
|
|
# ---------------------------------------------------------
|
|
|
|
|
|
Base.string(plt::Plot) = "Plot{$(plt.backend) n=$(plt.n)}"
|
|
Base.print(io::IO, plt::Plot) = print(io, string(plt))
|
|
Base.show(io::IO, plt::Plot) = print(io, string(plt))
|
|
|
|
getplot(plt::Plot) = plt
|
|
getattr(plt::Plot, idx::Int = 1) = plt.attr
|
|
convertSeriesIndex(plt::Plot, n::Int) = n
|
|
|
|
# ---------------------------------------------------------
|
|
|
|
|
|
"""
|
|
The main plot command. Use `plot` to create a new plot object, and `plot!` to add to an existing one:
|
|
|
|
```
|
|
plot(args...; kw...) # creates a new plot window, and sets it to be the current
|
|
plot!(args...; kw...) # adds to the `current`
|
|
plot!(plotobj, args...; kw...) # adds to the plot `plotobj`
|
|
```
|
|
|
|
There are lots of ways to pass in data, and lots of keyword arguments... just try it and it will likely work as expected.
|
|
When you pass in matrices, it splits by columns. To see the list of available attributes, use the `plotattr([attr])`
|
|
function, where `attr` is the symbol `:Series:`, `:Subplot:`, `:Plot` or `:Axis`. Pass any attribute to `plotattr`
|
|
as a String to look up its docstring; e.g. `plotattr("seriestype")`.
|
|
"""
|
|
function plot(args...; kw...)
|
|
# this creates a new plot with args/kw and sets it to be the current plot
|
|
plotattributes = KW(kw)
|
|
preprocessArgs!(plotattributes)
|
|
|
|
# create an empty Plot then process
|
|
plt = Plot()
|
|
# plt.user_attr = plotattributes
|
|
_plot!(plt, plotattributes, args)
|
|
end
|
|
|
|
# build a new plot from existing plots
|
|
# note: we split into plt1 and plts_tail so we can dispatch correctly
|
|
function plot(plt1::Plot, plts_tail::Plot...; kw...)
|
|
plotattributes = KW(kw)
|
|
preprocessArgs!(plotattributes)
|
|
|
|
# build our plot vector from the args
|
|
n = length(plts_tail) + 1
|
|
plts = Array{Plot}(undef, n)
|
|
plts[1] = plt1
|
|
for (i,plt) in enumerate(plts_tail)
|
|
plts[i+1] = plt
|
|
end
|
|
|
|
# compute the layout
|
|
layout = layout_args(plotattributes, n)[1]
|
|
num_sp = sum([length(p.subplots) for p in plts])
|
|
|
|
# create a new plot object, with subplot list/map made of existing subplots.
|
|
# note: we create a new backend figure for this new plot object
|
|
# note: all subplots and series "belong" to this new plot...
|
|
plt = Plot()
|
|
|
|
# TODO: build the user_attr dict by creating "Any matrices" for the args of each subplot
|
|
|
|
# TODO: replace this with proper processing from a merged user_attr KW
|
|
# update plot args, first with existing plots, then override with plotattributes
|
|
for p in plts
|
|
_update_plot_args(plt, copy(p.attr))
|
|
plt.n += p.n
|
|
end
|
|
_update_plot_args(plt, plotattributes)
|
|
|
|
# pass new plot to the backend
|
|
plt.o = _create_backend_figure(plt)
|
|
plt.init = true
|
|
|
|
series_attr = KW()
|
|
for (k,v) in plotattributes
|
|
if is_series_attr(k)
|
|
series_attr[k] = pop!(plotattributes,k)
|
|
end
|
|
end
|
|
|
|
# create the layout
|
|
plt.layout, plt.subplots, plt.spmap = build_layout(layout, num_sp, copy(plts))
|
|
|
|
# do we need to link any axes together?
|
|
link_axes!(plt.layout, plt[:link])
|
|
|
|
# initialize the subplots
|
|
cmdidx = 1
|
|
for (idx, sp) in enumerate(plt.subplots)
|
|
_initialize_subplot(plt, sp)
|
|
serieslist = series_list(sp)
|
|
if sp in sp.plt.inset_subplots
|
|
push!(plt.inset_subplots, sp)
|
|
end
|
|
sp.plt = plt
|
|
sp.attr[:subplot_index] = idx
|
|
for series in serieslist
|
|
merge!(series.plotattributes, series_attr)
|
|
_slice_series_args!(series.plotattributes, plt, sp, cmdidx)
|
|
push!(plt.series_list, series)
|
|
_series_added(plt, series)
|
|
cmdidx += 1
|
|
end
|
|
end
|
|
|
|
# first apply any args for the subplots
|
|
for (idx,sp) in enumerate(plt.subplots)
|
|
_update_subplot_args(plt, sp, plotattributes, idx, false)
|
|
end
|
|
|
|
# finish up
|
|
current(plt)
|
|
_do_plot_show(plt, get(plotattributes, :show, default(:show)))
|
|
plt
|
|
end
|
|
|
|
|
|
|
|
# this adds to the current plot, or creates a new plot if none are current
|
|
function plot!(args...; kw...)
|
|
local plt
|
|
try
|
|
plt = current()
|
|
catch
|
|
return plot(args...; kw...)
|
|
end
|
|
plot!(current(), args...; kw...)
|
|
end
|
|
|
|
# this adds to a specific plot... most plot commands will flow through here
|
|
function plot!(plt::Plot, args...; kw...)
|
|
plotattributes = KW(kw)
|
|
preprocessArgs!(plotattributes)
|
|
# merge!(plt.user_attr, plotattributes)
|
|
_plot!(plt, plotattributes, args)
|
|
end
|
|
|
|
# -------------------------------------------------------------------------------
|
|
|
|
# this is the core plotting function. recursively apply recipes to build
|
|
# a list of series KW dicts.
|
|
# note: at entry, we only have those preprocessed args which were passed in... no default values yet
|
|
function _plot!(plt::Plot, plotattributes::KW, args::Tuple)
|
|
plotattributes[:plot_object] = plt
|
|
|
|
if !isempty(args) && !isdefined(Main, :StatsPlots) &&
|
|
first(split(string(typeof(args[1])), ".")) == "DataFrames"
|
|
@warn("You're trying to plot a DataFrame, but this functionality is provided by StatsPlots")
|
|
end
|
|
|
|
# --------------------------------
|
|
# "USER RECIPES"
|
|
# --------------------------------
|
|
|
|
kw_list = _process_userrecipes(plt, plotattributes, args)
|
|
|
|
# @info(1)
|
|
# map(DD, kw_list)
|
|
|
|
|
|
# --------------------------------
|
|
# "PLOT RECIPES"
|
|
# --------------------------------
|
|
|
|
# "plot recipe", which acts like a series type, and is processed before
|
|
# the plot layout is created, which allows for setting layouts and other plot-wide attributes.
|
|
# we get inputs which have been fully processed by "user recipes" and "type recipes",
|
|
# so we can expect standard vectors, surfaces, etc. No defaults have been set yet.
|
|
still_to_process = kw_list
|
|
kw_list = KW[]
|
|
while !isempty(still_to_process)
|
|
next_kw = popfirst!(still_to_process)
|
|
_process_plotrecipe(plt, next_kw, kw_list, still_to_process)
|
|
end
|
|
|
|
# @info(2)
|
|
# map(DD, kw_list)
|
|
|
|
# --------------------------------
|
|
# Plot/Subplot/Layout setup
|
|
# --------------------------------
|
|
_plot_setup(plt, plotattributes, kw_list)
|
|
_subplot_setup(plt, plotattributes, kw_list)
|
|
|
|
# !!! note: At this point, kw_list is fully decomposed into individual series... one KW per series. !!!
|
|
# !!! The next step is to recursively apply series recipes until the backend supports that series type !!!
|
|
|
|
# --------------------------------
|
|
# "SERIES RECIPES"
|
|
# --------------------------------
|
|
|
|
# @info(3)
|
|
# map(DD, kw_list)
|
|
|
|
for kw in kw_list
|
|
sp::Subplot = kw[:subplot]
|
|
|
|
# in series attributes given as vector with one element per series,
|
|
# select the value for current series
|
|
_slice_series_args!(kw, plt, sp, series_idx(kw_list,kw))
|
|
|
|
|
|
series_attr = Attr(kw, _series_defaults)
|
|
# now we have a fully specified series, with colors chosen. we must recursively handle
|
|
# series recipes, which dispatch on seriestype. If a backend does not natively support a seriestype,
|
|
# we check for a recipe that will convert that series type into one made up of lower-level components.
|
|
# For example, a histogram is just a bar plot with binned data, a bar plot is really a filled step plot,
|
|
# and a step plot is really just a path. So any backend that supports drawing a path will implicitly
|
|
# be able to support step, bar, and histogram plots (and any recipes that use those components).
|
|
_process_seriesrecipe(plt, series_attr)
|
|
end
|
|
|
|
# --------------------------------
|
|
|
|
current(plt)
|
|
|
|
# do we want to force display?
|
|
# if plt[:show]
|
|
# gui(plt)
|
|
# end
|
|
_do_plot_show(plt, plt[:show])
|
|
|
|
plt
|
|
end
|
|
|
|
|
|
# we're getting ready to display/output. prep for layout calcs, then update
|
|
# the plot object after
|
|
function prepare_output(plt::Plot)
|
|
_before_layout_calcs(plt)
|
|
|
|
w, h = plt.attr[:size]
|
|
plt.layout.bbox = BoundingBox(0mm, 0mm, w*px, h*px)
|
|
|
|
# One pass down and back up the tree to compute the minimum padding
|
|
# of the children on the perimeter. This is an backend callback.
|
|
_update_min_padding!(plt.layout)
|
|
for sp in plt.inset_subplots
|
|
_update_min_padding!(sp)
|
|
end
|
|
|
|
# now another pass down, to update the bounding boxes
|
|
update_child_bboxes!(plt.layout)
|
|
|
|
# update those bounding boxes of inset subplots
|
|
update_inset_bboxes!(plt)
|
|
|
|
# the backend callback, to reposition subplots, etc
|
|
_update_plot_object(plt)
|
|
end
|
|
|
|
function backend_object(plt::Plot)
|
|
prepare_output(plt)
|
|
plt.o
|
|
end
|
|
|
|
# --------------------------------------------------------------------
|
|
# plot to a Subplot
|
|
|
|
function plot(sp::Subplot, args...; kw...)
|
|
plt = sp.plt
|
|
plot(plt, args...; kw..., subplot = findfirst(isequal(sp), plt.subplots))
|
|
end
|
|
function plot!(sp::Subplot, args...; kw...)
|
|
plt = sp.plt
|
|
plot!(plt, args...; kw..., subplot = findfirst(isequal(sp), plt.subplots))
|
|
end
|
|
|
|
# --------------------------------------------------------------------
|