424 lines
14 KiB
Julia
424 lines
14 KiB
Julia
|
||
|
||
# ------------------------------------------------------------------
|
||
# preprocessing
|
||
|
||
function command_idx(kw_list::AVec{KW}, kw::KW)
|
||
Int(kw[:series_plotindex]) - Int(kw_list[1][:series_plotindex]) + 1
|
||
end
|
||
|
||
function _expand_seriestype_array(d::KW, args)
|
||
sts = get(d, :seriestype, :path)
|
||
if typeof(sts) <: AbstractArray
|
||
delete!(d, :seriestype)
|
||
RecipeData[begin
|
||
dc = copy(d)
|
||
dc[:seriestype] = sts[r:r,:]
|
||
RecipeData(dc, args)
|
||
end for r=1:size(sts,1)]
|
||
else
|
||
RecipeData[RecipeData(copy(d), args)]
|
||
end
|
||
end
|
||
|
||
function _preprocess_args(d::KW, args, still_to_process::Vector{RecipeData})
|
||
# the grouping mechanism is a recipe on a GroupBy object
|
||
# we simply add the GroupBy object to the front of the args list to allow
|
||
# the recipe to be applied
|
||
if haskey(d, :group)
|
||
args = (extractGroupArgs(d[:group], args...), args...)
|
||
end
|
||
|
||
# if we were passed a vector/matrix of seriestypes and there's more than one row,
|
||
# we want to duplicate the inputs, once for each seriestype row.
|
||
if !isempty(args)
|
||
append!(still_to_process, _expand_seriestype_array(d, args))
|
||
end
|
||
|
||
# remove subplot and axis args from d... they will be passed through in the kw_list
|
||
if !isempty(args)
|
||
for (k,v) in d
|
||
for defdict in (_subplot_defaults,
|
||
_axis_defaults,
|
||
_axis_defaults_byletter)
|
||
if haskey(defdict, k)
|
||
delete!(d, k)
|
||
end
|
||
end
|
||
end
|
||
end
|
||
|
||
args
|
||
end
|
||
|
||
# ------------------------------------------------------------------
|
||
# user recipes
|
||
|
||
|
||
function _process_userrecipes(plt::Plot, d::KW, args)
|
||
still_to_process = RecipeData[]
|
||
args = _preprocess_args(d, args, still_to_process)
|
||
|
||
# for plotting recipes, swap out the args and update the parameter dictionary
|
||
# we are keeping a stack of series that still need to be processed.
|
||
# each pass through the loop, we pop one off and apply the recipe.
|
||
# the recipe will return a list a Series objects... the ones that are
|
||
# finished (no more args) get added to the kw_list, the ones that are not
|
||
# are placed on top of the stack and are then processed further.
|
||
kw_list = KW[]
|
||
while !isempty(still_to_process)
|
||
# grab the first in line to be processed and either add it to the kw_list or
|
||
# pass it through apply_recipe to generate a list of RecipeData objects (data + attributes)
|
||
# for further processing.
|
||
next_series = shift!(still_to_process)
|
||
# recipedata should be of type RecipeData. if it's not then the inputs must not have been fully processed by recipes
|
||
if !(typeof(next_series) <: RecipeData)
|
||
error("Inputs couldn't be processed... expected RecipeData but got: $next_series")
|
||
end
|
||
if isempty(next_series.args)
|
||
_process_userrecipe(plt, kw_list, next_series)
|
||
else
|
||
rd_list = RecipesBase.apply_recipe(next_series.d, next_series.args...)
|
||
prepend!(still_to_process,rd_list)
|
||
end
|
||
end
|
||
|
||
# don't allow something else to handle it
|
||
d[:smooth] = false
|
||
kw_list
|
||
end
|
||
|
||
function _process_userrecipe(plt::Plot, kw_list::Vector{KW}, recipedata::RecipeData)
|
||
# when the arg tuple is empty, that means there's nothing left to recursively
|
||
# process... finish up and add to the kw_list
|
||
kw = recipedata.d
|
||
preprocessArgs!(kw)
|
||
_preprocess_userrecipe(kw)
|
||
warnOnUnsupported_scales(plt.backend, kw)
|
||
|
||
# add the plot index
|
||
plt.n += 1
|
||
kw[:series_plotindex] = plt.n
|
||
|
||
push!(kw_list, kw)
|
||
_add_errorbar_kw(kw_list, kw)
|
||
_add_smooth_kw(kw_list, kw)
|
||
return
|
||
end
|
||
|
||
function _preprocess_userrecipe(kw::KW)
|
||
_add_markershape(kw)
|
||
|
||
# if there was a grouping, filter the data here
|
||
_filter_input_data!(kw)
|
||
|
||
# map marker_z if it's a Function
|
||
if isa(get(kw, :marker_z, nothing), Function)
|
||
# TODO: should this take y and/or z as arguments?
|
||
kw[:marker_z] = map(kw[:marker_z], kw[:x], kw[:y], kw[:z])
|
||
end
|
||
|
||
# map line_z if it's a Function
|
||
if isa(get(kw, :line_z, nothing), Function)
|
||
kw[:line_z] = map(kw[:line_z], kw[:x], kw[:y], kw[:z])
|
||
end
|
||
|
||
# convert a ribbon into a fillrange
|
||
if get(kw, :ribbon, nothing) != nothing
|
||
make_fillrange_from_ribbon(kw)
|
||
end
|
||
return
|
||
end
|
||
|
||
function _add_errorbar_kw(kw_list::Vector{KW}, kw::KW)
|
||
# handle error bars by creating new recipedata data... these will have
|
||
# the same recipedata index as the recipedata they are copied from
|
||
for esym in (:xerror, :yerror)
|
||
if get(kw, esym, nothing) != nothing
|
||
# we make a copy of the KW and apply an errorbar recipe
|
||
errkw = copy(kw)
|
||
errkw[:seriestype] = esym
|
||
errkw[:label] = ""
|
||
errkw[:primary] = false
|
||
push!(kw_list, errkw)
|
||
end
|
||
end
|
||
end
|
||
|
||
function _add_smooth_kw(kw_list::Vector{KW}, kw::KW)
|
||
# handle smoothing by adding a new series
|
||
if get(kw, :smooth, false)
|
||
x, y = kw[:x], kw[:y]
|
||
β, α = convert(Matrix{Float64}, [x ones(length(x))]) \ convert(Vector{Float64}, y)
|
||
sx = [ignorenan_minimum(x), ignorenan_maximum(x)]
|
||
sy = β * sx + α
|
||
push!(kw_list, merge(copy(kw), KW(
|
||
:seriestype => :path,
|
||
:x => sx,
|
||
:y => sy,
|
||
:fillrange => nothing,
|
||
:label => "",
|
||
:primary => false,
|
||
)))
|
||
end
|
||
end
|
||
|
||
# ------------------------------------------------------------------
|
||
# plot recipes
|
||
|
||
# Grab the first in line to be processed and pass it through apply_recipe
|
||
# to generate a list of RecipeData objects (data + attributes).
|
||
# If we applied a "plot recipe" without error, then add the returned datalist's KWs,
|
||
# otherwise we just add the original KW.
|
||
function _process_plotrecipe(plt::Plot, kw::KW, kw_list::Vector{KW}, still_to_process::Vector{KW})
|
||
if !isa(get(kw, :seriestype, nothing), Symbol)
|
||
# seriestype was never set, or it's not a Symbol, so it can't be a plot recipe
|
||
push!(kw_list, kw)
|
||
return
|
||
end
|
||
try
|
||
st = kw[:seriestype]
|
||
st = kw[:seriestype] = get(_typeAliases, st, st)
|
||
datalist = RecipesBase.apply_recipe(kw, Val{st}, plt)
|
||
for data in datalist
|
||
preprocessArgs!(data.d)
|
||
if data.d[:seriestype] == st
|
||
error("Plot recipe $st returned the same seriestype: $(data.d)")
|
||
end
|
||
push!(still_to_process, data.d)
|
||
end
|
||
catch err
|
||
if isa(err, MethodError)
|
||
push!(kw_list, kw)
|
||
else
|
||
rethrow()
|
||
end
|
||
end
|
||
return
|
||
end
|
||
|
||
|
||
# ------------------------------------------------------------------
|
||
# setup plot and subplot
|
||
|
||
function _plot_setup(plt::Plot, d::KW, kw_list::Vector{KW})
|
||
# merge in anything meant for the Plot
|
||
for kw in kw_list, (k,v) in kw
|
||
haskey(_plot_defaults, k) && (d[k] = pop!(kw, k))
|
||
end
|
||
|
||
# TODO: init subplots here
|
||
_update_plot_args(plt, d)
|
||
if !plt.init
|
||
plt.o = Base.invokelatest(_create_backend_figure, plt)
|
||
|
||
# create the layout and subplots from the inputs
|
||
plt.layout, plt.subplots, plt.spmap = build_layout(plt.attr)
|
||
for (idx,sp) in enumerate(plt.subplots)
|
||
sp.plt = plt
|
||
sp.attr[:subplot_index] = idx
|
||
end
|
||
|
||
plt.init = true
|
||
end
|
||
|
||
|
||
# handle inset subplots
|
||
insets = plt[:inset_subplots]
|
||
if insets != nothing
|
||
if !(typeof(insets) <: AVec)
|
||
insets = [insets]
|
||
end
|
||
for inset in insets
|
||
parent, bb = is_2tuple(inset) ? inset : (nothing, inset)
|
||
P = typeof(parent)
|
||
if P <: Integer
|
||
parent = plt.subplots[parent]
|
||
elseif P == Symbol
|
||
parent = plt.spmap[parent]
|
||
else
|
||
parent = plt.layout
|
||
end
|
||
sp = Subplot(backend(), parent=parent)
|
||
sp.plt = plt
|
||
push!(plt.subplots, sp)
|
||
push!(plt.inset_subplots, sp)
|
||
sp.attr[:relative_bbox] = bb
|
||
sp.attr[:subplot_index] = length(plt.subplots)
|
||
end
|
||
end
|
||
plt[:inset_subplots] = nothing
|
||
end
|
||
|
||
function _subplot_setup(plt::Plot, d::KW, kw_list::Vector{KW})
|
||
# we'll keep a map of subplot to an attribute override dict.
|
||
# Subplot/Axis attributes set by a user/series recipe apply only to the
|
||
# Subplot object which they belong to.
|
||
# TODO: allow matrices to still apply to all subplots
|
||
sp_attrs = Dict{Subplot,Any}()
|
||
for kw in kw_list
|
||
# get the Subplot object to which the series belongs.
|
||
sps = get(kw, :subplot, :auto)
|
||
sp = get_subplot(plt, _cycle(sps == :auto ? plt.subplots : plt.subplots[sps], command_idx(kw_list,kw)))
|
||
kw[:subplot] = sp
|
||
|
||
# extract subplot/axis attributes from kw and add to sp_attr
|
||
attr = KW()
|
||
for (k,v) in kw
|
||
if haskey(_subplot_defaults, k) || haskey(_axis_defaults_byletter, k)
|
||
attr[k] = pop!(kw, k)
|
||
end
|
||
if haskey(_axis_defaults, k)
|
||
v = pop!(kw, k)
|
||
for letter in (:x,:y,:z)
|
||
attr[Symbol(letter,k)] = v
|
||
end
|
||
end
|
||
for k in (:scale,), letter in (:x,:y,:z)
|
||
# Series recipes may need access to this information
|
||
lk = Symbol(letter,k)
|
||
if haskey(attr, lk)
|
||
kw[lk] = attr[lk]
|
||
end
|
||
end
|
||
end
|
||
sp_attrs[sp] = attr
|
||
end
|
||
|
||
# override subplot/axis args. `sp_attrs` take precendence
|
||
for (idx,sp) in enumerate(plt.subplots)
|
||
attr = if !haskey(d, :subplot) || d[:subplot] == idx
|
||
merge(d, get(sp_attrs, sp, KW()))
|
||
else
|
||
get(sp_attrs, sp, KW())
|
||
end
|
||
_update_subplot_args(plt, sp, attr, idx, false)
|
||
end
|
||
|
||
# do we need to link any axes together?
|
||
link_axes!(plt.layout, plt[:link])
|
||
end
|
||
|
||
# getting ready to add the series... last update to subplot from anything
|
||
# that might have been added during series recipes
|
||
function _prepare_subplot(plt::Plot{T}, d::KW) where T
|
||
st::Symbol = d[:seriestype]
|
||
sp::Subplot{T} = d[:subplot]
|
||
sp_idx = get_subplot_index(plt, sp)
|
||
_update_subplot_args(plt, sp, d, sp_idx, true)
|
||
|
||
st = _override_seriestype_check(d, st)
|
||
|
||
# change to a 3d projection for this subplot?
|
||
if is3d(st)
|
||
sp.attr[:projection] = "3d"
|
||
end
|
||
|
||
# initialize now that we know the first series type
|
||
if !haskey(sp.attr, :init)
|
||
_initialize_subplot(plt, sp)
|
||
sp.attr[:init] = true
|
||
end
|
||
sp
|
||
end
|
||
|
||
# ------------------------------------------------------------------
|
||
# series types
|
||
|
||
function _override_seriestype_check(d::KW, st::Symbol)
|
||
# do we want to override the series type?
|
||
if !is3d(st)
|
||
z = d[:z]
|
||
if !isa(z, Void) && (size(d[:x]) == size(d[:y]) == size(z))
|
||
st = (st == :scatter ? :scatter3d : :path3d)
|
||
d[:seriestype] = st
|
||
end
|
||
end
|
||
st
|
||
end
|
||
|
||
function _prepare_annotations(sp::Subplot, d::KW)
|
||
# strip out series annotations (those which are based on series x/y coords)
|
||
# and add them to the subplot attr
|
||
sp_anns = annotations(sp[:annotations])
|
||
# series_anns = annotations(pop!(d, :series_annotations, []))
|
||
# if isa(series_anns, SeriesAnnotations)
|
||
# series_anns.x = d[:x]
|
||
# series_anns.y = d[:y]
|
||
# elseif length(series_anns) > 0
|
||
# x, y = d[:x], d[:y]
|
||
# nx, ny, na = map(length, (x,y,series_anns))
|
||
# n = max(nx, ny, na)
|
||
# series_anns = [(x[mod1(i,nx)], y[mod1(i,ny)], text(series_anns[mod1(i,na)])) for i=1:n]
|
||
# end
|
||
# sp.attr[:annotations] = vcat(sp_anns, series_anns)
|
||
end
|
||
|
||
function _expand_subplot_extrema(sp::Subplot, d::KW, st::Symbol)
|
||
# adjust extrema and discrete info
|
||
if st == :image
|
||
w, h = size(d[:z])
|
||
expand_extrema!(sp[:xaxis], (0,w))
|
||
expand_extrema!(sp[:yaxis], (0,h))
|
||
sp[:yaxis].d[:flip] = true
|
||
elseif !(st in (:pie, :histogram, :bins2d, :histogram2d))
|
||
expand_extrema!(sp, d)
|
||
end
|
||
# expand for zerolines (axes through origin)
|
||
if sp[:framestyle] in (:origin, :zerolines)
|
||
expand_extrema!(sp[:xaxis], 0.0)
|
||
expand_extrema!(sp[:yaxis], 0.0)
|
||
end
|
||
end
|
||
|
||
function _add_the_series(plt, sp, d)
|
||
warnOnUnsupported_args(plt.backend, d)
|
||
warnOnUnsupported(plt.backend, d)
|
||
series = Series(d)
|
||
push!(plt.series_list, series)
|
||
push!(sp.series_list, series)
|
||
_series_added(plt, series)
|
||
end
|
||
|
||
# -------------------------------------------------------------------------------
|
||
|
||
# this method recursively applies series recipes when the seriestype is not supported
|
||
# natively by the backend
|
||
function _process_seriesrecipe(plt::Plot, d::KW)
|
||
# replace seriestype aliases
|
||
st = Symbol(d[:seriestype])
|
||
st = d[:seriestype] = get(_typeAliases, st, st)
|
||
|
||
# shapes shouldn't have fillrange set
|
||
if d[:seriestype] == :shape
|
||
d[:fillrange] = nothing
|
||
end
|
||
|
||
# if it's natively supported, finalize processing and pass along to the backend, otherwise recurse
|
||
if is_seriestype_supported(st)
|
||
sp = _prepare_subplot(plt, d)
|
||
_prepare_annotations(sp, d)
|
||
_expand_subplot_extrema(sp, d, st)
|
||
_add_the_series(plt, sp, d)
|
||
|
||
else
|
||
# get a sub list of series for this seriestype
|
||
datalist = RecipesBase.apply_recipe(d, Val{st}, d[:x], d[:y], d[:z])
|
||
|
||
# assuming there was no error, recursively apply the series recipes
|
||
for data in datalist
|
||
if isa(data, RecipeData)
|
||
preprocessArgs!(data.d)
|
||
if data.d[:seriestype] == st
|
||
error("The seriestype didn't change in series recipe $st. This will cause a StackOverflow.")
|
||
end
|
||
_process_seriesrecipe(plt, data.d)
|
||
else
|
||
warn("Unhandled recipe: $(data)")
|
||
break
|
||
end
|
||
end
|
||
end
|
||
nothing
|
||
end
|