From 77ff71699931f3ac6fbe4ed57345794614603f2e Mon Sep 17 00:00:00 2001 From: Andrew J <42456097+Ininterrompue@users.noreply.github.com> Date: Tue, 13 Dec 2022 12:16:10 -0800 Subject: [PATCH 01/12] Separate attributes section --- docs/src/{ => Attributes}/attributes.md | 0 docs/src/Attributes/attributes_axis.md | 0 docs/src/Attributes/attributes_plot.md | 0 docs/src/Attributes/attributes_series.md | 264 ++++++++++++++++++++++ docs/src/Attributes/attributes_subplot.md | 0 5 files changed, 264 insertions(+) rename docs/src/{ => Attributes}/attributes.md (100%) create mode 100644 docs/src/Attributes/attributes_axis.md create mode 100644 docs/src/Attributes/attributes_plot.md create mode 100644 docs/src/Attributes/attributes_series.md create mode 100644 docs/src/Attributes/attributes_subplot.md diff --git a/docs/src/attributes.md b/docs/src/Attributes/attributes.md similarity index 100% rename from docs/src/attributes.md rename to docs/src/Attributes/attributes.md diff --git a/docs/src/Attributes/attributes_axis.md b/docs/src/Attributes/attributes_axis.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/src/Attributes/attributes_plot.md b/docs/src/Attributes/attributes_plot.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/src/Attributes/attributes_series.md b/docs/src/Attributes/attributes_series.md new file mode 100644 index 0000000000..781186a06f --- /dev/null +++ b/docs/src/Attributes/attributes_series.md @@ -0,0 +1,264 @@ + +# Series Attributes + +Series attributes apply to individual series, such as lines, scatters, heatmaps, etc. + +:label => (AStr, "The label for a series, which appears in a legend. If empty, no legend entry is added."), +:seriescolor => (ColorType, "The base color for this series. `:auto` (the default) will select a color from the subplot's `color_palette`, based on the order it was added to the subplot. Also describes the colormap for surfaces."), +:seriesalpha => (Real, "The alpha/opacity override for the series. `nothing` (the default) means it will take the alpha value of the color."), +:seriestype => (Symbol, "This is the identifier of the type of visualization for this series. Choose from $(_allTypes) or any series recipes which are defined."), +:linestyle => (Symbol, "Style of the line (for path and bar stroke). Choose from $(_allStyles)"), +:linewidth => (Real, "Width of the line (in pixels)."), +:linecolor => (ColorType, "Color of the line (for path and bar stroke). `:match` will take the value from `:seriescolor`, (though histogram/bar types use `:black` as a default)."), +:linealpha => (Real, "The alpha/opacity override for the line. `nothing` (the default) means it will take the alpha value of linecolor."), +:fillrange => (Union{Real,AVec}, "Fills area between fillrange and `y` for line-types, sets the base for `bar`, `sticks` types, and similar for other types."), +:fillcolor => (ColorType, "Color of the filled area of path or bar types. `:match` will take the value from `:seriescolor`."), +:fillalpha => (Real, "The alpha/opacity override for the fill area. `nothing` (the default) means it will take the alpha value of fillcolor."), +:markershape => (Union{Symbol,Shape,AVec}, "Choose from $(_allMarkers)."), +:fillstyle => (Symbol, "Style of the fill area. `nothing` (the default) means solid fill. Choose from :/, :\\, :|, :-, :+, :x."), +:markercolor => (ColorType, "Color of the interior of the marker or shape. `:match` will take the value from `:seriescolor`."), +:markeralpha => (Real, "The alpha/opacity override for the marker interior. `nothing` (the default) means it will take the alpha value of markercolor."), +:markersize => (Union{Real,AVec}, "Size (radius pixels) of the markers."), +:markerstrokestyle => (Symbol, "Style of the marker stroke (border). Choose from $(_allStyles)."), +:markerstrokewidth => (Real, "Width of the marker stroke (border) in pixels."), +:markerstrokecolor => (ColorType, "Color of the marker stroke (border). `:match` will take the value from `:foreground_color_subplot`."), +:markerstrokealpha => (Real, "The alpha/opacity override for the marker stroke (border). `nothing` (the default) means it will take the alpha value of markerstrokecolor."), +:bins => (Union{Integer,NTuple{2,Integer},AVec,Symbol}, """ + Default is :auto (the Freedman-Diaconis rule). For histogram-types, defines the approximate number of bins to aim for, or the auto-binning algorithm to use (:sturges, :sqrt, :rice, :scott or :fd). + For fine-grained control pass a Vector of break values, e.g. `range(minimum(x), stop = maximum(x), length = 25)`."""), +:smooth => (Bool, "Add a regression line ?"), +:group => (AVec, "Data is split into a separate series, one for each unique value in `group`."), +:x => (Any, "Input data (first dimension)."), +:y => (Any, "Input data (second dimension)."), +:z => (Any, "Input data (third dimension). May be wrapped by a `Surface` for surface and heatmap types."), +:marker_z => (Union{AVec,Function}, "z-values for each series data point, which correspond to the color to be used from a markercolor gradient (`f(x,y,z) -> z_value` or `f(x,y) -> z_value`)."), +:line_z => (Union{AVec,Function}, "z-values for each series line segment, which correspond to the color to be used from a linecolor gradient. Note that for N points, only the first N-1 values are used (one per line-segment)."), +:fill_z => (AMat, "Matrix of the same size as z matrix, which specifies the color of the 3D surface."), +:levels => (Union{AVec,Integer}, "Singleton for number of contours or iterable for contour values. Determines contour levels for a contour type."), +:permute => (NTuple{2,Symbol}, "Permutes data and axis properties of the axes given in the tuple, e.g. (:x, :y)."), +:orientation => (Symbol, "(deprecated) Horizontal or vertical orientation for bar types. Values `:h`, `:hor`, `:horizontal` correspond to horizontal (sideways, anchored to y-axis), and `:v`, `:vert`, and `:vertical` correspond to vertical (the default)."), +:xerror => (Union{AVec,NTuple{2,AVec}}, "`x` (horizontal) error relative to x-value. If 2-tuple of vectors, the first vector corresponds to the left error (and the second to the right)."), +:yerror => (Union{AVec,NTuple{2,AVec}}, "`y` (vertical) error relative to y-value. If 2-tuple of vectors, the first vector corresponds to the bottom error (and the second to the top)."), +:ribbon => (Union{Real,AVec}, "Creates a fillrange around the data points."), +:quiver => (Union{AVec,NTuple{2,AVec}}, "The directional vectors U,V which specify velocity/gradient vectors for a quiver plot."), +:normalize => (Union{Bool,Symbol}, "Histogram normalization mode. Possible values are: false/:none (no normalization, default), true/:pdf (normalize to a discrete PDF, where the total area of the bins is 1), :probability (bin heights sum to 1) and :density (the area of each bin, rather than the height, is equal to the counts - useful for uneven bin sizes)."), +:weights => (AVec, "Used in histogram types for weighted counts."), +:show_empty_bins => (Bool, "Whether empty bins in a 2D histogram are colored as 0 (true), or transparent (the default)."), +:contours => (Bool, "Add contours to the side-grids of 3D plots? Used in surface/wireframe."), +:contour_labels => (Bool, "Show labels at the contour lines ?"), +:match_dimensions => (Bool, "For heatmap types: should the first dimension of a matrix (rows) correspond to the first dimension of the plot (`x`-axis) ? Defaults to `false`, which matches the behavior of Matplotlib, Plotly, and others. Note: when passing a function for `z`, the function should still map `(x,y) -> z`."), +:subplot => (Union{Integer,Subplot}, "The subplot that this series belongs to."), +:series_annotations => (Union{AVec,AStr,PlotText}, "These are annotations which are mapped to data points/positions."), +:primary => (Bool, "Does this count as a 'real series'? For example, you could have a path (primary), and a scatter (secondary) as two separate series, maybe with different data (see `sticks` recipe for an example). The secondary series will get the same color, etc as the primary."), +:hover => (AVec{AStr}, "Text to display when hovering over each data point."), +:colorbar_entry => (Bool, "Include this series in the color bar? Set to `false` to exclude."), +:z_order => (Union{Symbol,Integer}, ":front (default), :back or index of position where 1 is farest in the background."), + +### arrow +```julia +arrow :: Union{Bool, Plots.Arrow} +``` +Defines arrowheads that should be displayed at the end of path line segments (just before a NaN and the last non-NaN point). Used in quiverplot, streamplot, or similar. + +Alias `:arrows`. + +Defaults to `nothing`. + +### bar_edges +```julia +bar_edges :: Bool +``` +Align bars to edges with `true`, or centers with `false`. + +Defaults to `false`. + +### bar_position +```julia +bar_position :: Symbol +``` +Choose from `:overlay` (default) or `:stack`. (Warning: may only be partially implemented) + +Aliases `bar_positions`, `barpositions`. + + +### bar_width + :bar_width => (Real, " Width of bars in data coordinates. When `nothing`, chooses based on `x` (or `y` when `orientation = :h`)."), + +### bins +```julia +bins :: Union{Integer, Symbol, Tuple{Integer, Integer}, AbstractVector} +``` +Defines the number of bins. + +Aliases `:bin`, `:nb`, `:nbin`, `:nbins`. + +Defaults to `:auto`, the Freedman-Diaconis rule. + +Can take in one of the following types: +* `Integer` – defines the approximate number of bins to aim for. Not guaranteed to give the exact value. + * `bins=10` gives a 1D histogram with about 10 bins. + * `bins=10` gives a 2D histogram with about 10 bins for each dimension. +* `Tuple{Integer, Integer}` – for two-dimensional histograms, defines the approximate number of bins per dimension. Not guaranteed to give the exact values. + * `bins=(10, 20)` gives a 2D histogram with about 10 bins for the `x` dimension and about 20 bins for the `y` dimension. +* `Symbol` – defines the auto-binning algorithm to use. + * `:sturges` – [Sturges' rule](https://en.wikipedia.org/wiki/Histogram#Sturges'_formula) + * `:sqrt` – [Square root rule](https://en.wikipedia.org/wiki/Histogram#Square-root_choice) + * `:rice` – [Rice rule](https://en.wikipedia.org/wiki/Histogram#Rice_rule) + * `:scott` – [Scott's normal reference rule](https://en.wikipedia.org/wiki/Histogram#Scott's_normal_reference_rule) + * `:fd` (default) – [Freedman-Diaconis' rule](https://en.wikipedia.org/wiki/Histogram#Freedman%E2%80%93Diaconis'_choice) +* `AbstractVector` – defines a vector of values for bin edges. + * `bins=range(-10, 10, length=21)` gives a histogram with bins starting from -10, ending at 10, and containing 21 break values, giving 20 bins. + +Relevant attribute for the following series types: +* [`histogram`](https://docs.juliaplots.org/stable/api/#Plots.histogram-Tuple) +* [`histogram2d`](https://docs.juliaplots.org/stable/api/#Plots.histogram2d-Tuple) + +### colorbar_entry + + +### connections + + +### contour_labels + + +### contours + + +### extra_kwargs + + +### fill_z + + +### fillalpha + + +### fillcolor + + +### fillrange + + +### fillstyle + + +### group + + +### hover + + +### label + + +### levels + + +### line_z + + +### linealpha + + +### linecolor + + +### linestyle + + +### linewidth + + +### marker_z + + +### markeralpha + + +### markercolor + + +### markershape + + +### markersize + + +### markerstrokealpha + + +### markerstrokestyle + + +### markerstrokewidth + + +### normalize + + +### orientation + + +### permute + + +### primary + + +### quiver + + +### ribbon + + +### series_annotations + + +### seriesalpha + + +### seriescolor + + +### seriestype + + +### show_empty_bins + + +### smooth + + +### stride + + +### subplot + + +### weights + + +### x + + +### xerror + + +### y + + +### yerror + + +### z + + +### z_order + + +### zerror + + + + diff --git a/docs/src/Attributes/attributes_subplot.md b/docs/src/Attributes/attributes_subplot.md new file mode 100644 index 0000000000..e69de29bb2 From 27d4b31deb6b1f62e05785b375316d8468eb88ff Mon Sep 17 00:00:00 2001 From: Andrew J <42456097+Ininterrompue@users.noreply.github.com> Date: Tue, 13 Dec 2022 13:37:31 -0800 Subject: [PATCH 02/12] Update attributes_series.md --- docs/src/Attributes/attributes_series.md | 448 ++++++++++++++++++++--- 1 file changed, 389 insertions(+), 59 deletions(-) diff --git a/docs/src/Attributes/attributes_series.md b/docs/src/Attributes/attributes_series.md index 781186a06f..d5581f8f1b 100644 --- a/docs/src/Attributes/attributes_series.md +++ b/docs/src/Attributes/attributes_series.md @@ -3,64 +3,24 @@ Series attributes apply to individual series, such as lines, scatters, heatmaps, etc. -:label => (AStr, "The label for a series, which appears in a legend. If empty, no legend entry is added."), -:seriescolor => (ColorType, "The base color for this series. `:auto` (the default) will select a color from the subplot's `color_palette`, based on the order it was added to the subplot. Also describes the colormap for surfaces."), -:seriesalpha => (Real, "The alpha/opacity override for the series. `nothing` (the default) means it will take the alpha value of the color."), -:seriestype => (Symbol, "This is the identifier of the type of visualization for this series. Choose from $(_allTypes) or any series recipes which are defined."), -:linestyle => (Symbol, "Style of the line (for path and bar stroke). Choose from $(_allStyles)"), -:linewidth => (Real, "Width of the line (in pixels)."), -:linecolor => (ColorType, "Color of the line (for path and bar stroke). `:match` will take the value from `:seriescolor`, (though histogram/bar types use `:black` as a default)."), -:linealpha => (Real, "The alpha/opacity override for the line. `nothing` (the default) means it will take the alpha value of linecolor."), -:fillrange => (Union{Real,AVec}, "Fills area between fillrange and `y` for line-types, sets the base for `bar`, `sticks` types, and similar for other types."), -:fillcolor => (ColorType, "Color of the filled area of path or bar types. `:match` will take the value from `:seriescolor`."), -:fillalpha => (Real, "The alpha/opacity override for the fill area. `nothing` (the default) means it will take the alpha value of fillcolor."), -:markershape => (Union{Symbol,Shape,AVec}, "Choose from $(_allMarkers)."), -:fillstyle => (Symbol, "Style of the fill area. `nothing` (the default) means solid fill. Choose from :/, :\\, :|, :-, :+, :x."), -:markercolor => (ColorType, "Color of the interior of the marker or shape. `:match` will take the value from `:seriescolor`."), -:markeralpha => (Real, "The alpha/opacity override for the marker interior. `nothing` (the default) means it will take the alpha value of markercolor."), -:markersize => (Union{Real,AVec}, "Size (radius pixels) of the markers."), -:markerstrokestyle => (Symbol, "Style of the marker stroke (border). Choose from $(_allStyles)."), -:markerstrokewidth => (Real, "Width of the marker stroke (border) in pixels."), -:markerstrokecolor => (ColorType, "Color of the marker stroke (border). `:match` will take the value from `:foreground_color_subplot`."), -:markerstrokealpha => (Real, "The alpha/opacity override for the marker stroke (border). `nothing` (the default) means it will take the alpha value of markerstrokecolor."), -:bins => (Union{Integer,NTuple{2,Integer},AVec,Symbol}, """ - Default is :auto (the Freedman-Diaconis rule). For histogram-types, defines the approximate number of bins to aim for, or the auto-binning algorithm to use (:sturges, :sqrt, :rice, :scott or :fd). - For fine-grained control pass a Vector of break values, e.g. `range(minimum(x), stop = maximum(x), length = 25)`."""), -:smooth => (Bool, "Add a regression line ?"), -:group => (AVec, "Data is split into a separate series, one for each unique value in `group`."), -:x => (Any, "Input data (first dimension)."), -:y => (Any, "Input data (second dimension)."), -:z => (Any, "Input data (third dimension). May be wrapped by a `Surface` for surface and heatmap types."), -:marker_z => (Union{AVec,Function}, "z-values for each series data point, which correspond to the color to be used from a markercolor gradient (`f(x,y,z) -> z_value` or `f(x,y) -> z_value`)."), -:line_z => (Union{AVec,Function}, "z-values for each series line segment, which correspond to the color to be used from a linecolor gradient. Note that for N points, only the first N-1 values are used (one per line-segment)."), -:fill_z => (AMat, "Matrix of the same size as z matrix, which specifies the color of the 3D surface."), -:levels => (Union{AVec,Integer}, "Singleton for number of contours or iterable for contour values. Determines contour levels for a contour type."), -:permute => (NTuple{2,Symbol}, "Permutes data and axis properties of the axes given in the tuple, e.g. (:x, :y)."), -:orientation => (Symbol, "(deprecated) Horizontal or vertical orientation for bar types. Values `:h`, `:hor`, `:horizontal` correspond to horizontal (sideways, anchored to y-axis), and `:v`, `:vert`, and `:vertical` correspond to vertical (the default)."), -:xerror => (Union{AVec,NTuple{2,AVec}}, "`x` (horizontal) error relative to x-value. If 2-tuple of vectors, the first vector corresponds to the left error (and the second to the right)."), -:yerror => (Union{AVec,NTuple{2,AVec}}, "`y` (vertical) error relative to y-value. If 2-tuple of vectors, the first vector corresponds to the bottom error (and the second to the top)."), -:ribbon => (Union{Real,AVec}, "Creates a fillrange around the data points."), -:quiver => (Union{AVec,NTuple{2,AVec}}, "The directional vectors U,V which specify velocity/gradient vectors for a quiver plot."), -:normalize => (Union{Bool,Symbol}, "Histogram normalization mode. Possible values are: false/:none (no normalization, default), true/:pdf (normalize to a discrete PDF, where the total area of the bins is 1), :probability (bin heights sum to 1) and :density (the area of each bin, rather than the height, is equal to the counts - useful for uneven bin sizes)."), -:weights => (AVec, "Used in histogram types for weighted counts."), -:show_empty_bins => (Bool, "Whether empty bins in a 2D histogram are colored as 0 (true), or transparent (the default)."), -:contours => (Bool, "Add contours to the side-grids of 3D plots? Used in surface/wireframe."), -:contour_labels => (Bool, "Show labels at the contour lines ?"), + + + + + :match_dimensions => (Bool, "For heatmap types: should the first dimension of a matrix (rows) correspond to the first dimension of the plot (`x`-axis) ? Defaults to `false`, which matches the behavior of Matplotlib, Plotly, and others. Note: when passing a function for `z`, the function should still map `(x,y) -> z`."), -:subplot => (Union{Integer,Subplot}, "The subplot that this series belongs to."), -:series_annotations => (Union{AVec,AStr,PlotText}, "These are annotations which are mapped to data points/positions."), -:primary => (Bool, "Does this count as a 'real series'? For example, you could have a path (primary), and a scatter (secondary) as two separate series, maybe with different data (see `sticks` recipe for an example). The secondary series will get the same color, etc as the primary."), -:hover => (AVec{AStr}, "Text to display when hovering over each data point."), -:colorbar_entry => (Bool, "Include this series in the color bar? Set to `false` to exclude."), -:z_order => (Union{Symbol,Integer}, ":front (default), :back or index of position where 1 is farest in the background."), + + + + ### arrow ```julia arrow :: Union{Bool, Plots.Arrow} ``` -Defines arrowheads that should be displayed at the end of path line segments (just before a NaN and the last non-NaN point). Used in quiverplot, streamplot, or similar. +Aliases: `arrows` -Alias `:arrows`. +Defines arrowheads that should be displayed at the end of path line segments (just before a NaN and the last non-NaN point). Used in quiverplot, streamplot, or similar. Defaults to `nothing`. @@ -68,6 +28,7 @@ Defaults to `nothing`. ```julia bar_edges :: Bool ``` + Align bars to edges with `true`, or centers with `false`. Defaults to `false`. @@ -76,21 +37,27 @@ Defaults to `false`. ```julia bar_position :: Symbol ``` -Choose from `:overlay` (default) or `:stack`. (Warning: may only be partially implemented) +Aliases: `bar_positions` `barpositions` -Aliases `bar_positions`, `barpositions`. +Choose from `:overlay` or `:stack`. (Warning: may only be partially implemented) +Defaults to `:overlay`. ### bar_width - :bar_width => (Real, " Width of bars in data coordinates. When `nothing`, chooses based on `x` (or `y` when `orientation = :h`)."), +```julia +bar_width :: Real +``` +Aliases: `bar_widths` `barwidths` + +Width of bars in data coordinates. When `nothing`, chooses based on `x` (or `y` when `orientation = :h`). ### bins ```julia bins :: Union{Integer, Symbol, Tuple{Integer, Integer}, AbstractVector} ``` -Defines the number of bins. +Aliases: `bin` `nb` `nbin` `nbins` -Aliases `:bin`, `:nb`, `:nbin`, `:nbins`. +Defines the number of bins. Defaults to `:auto`, the Freedman-Diaconis rule. @@ -114,151 +81,514 @@ Relevant attribute for the following series types: * [`histogram2d`](https://docs.juliaplots.org/stable/api/#Plots.histogram2d-Tuple) ### colorbar_entry +```julia +colorbar_entry :: Bool +``` +Aliases: `colorbar_entrys` `colorbarentrys` + +Include this series in the color bar? Set to `false` to exclude. +Defaults to `true`. ### connections +```julia +connections :: Any +``` +Defaults to `nothing`. ### contour_labels +```julia +contour_labels :: Bool +``` +Aliases: `clabels` `clabs` `contourlabels` +Show labels at the contour lines? + +Defaults to `false`. ### contours +```julia +contours :: Bool +``` +Add contours to the side-grids of 3D plots? Used in surface/wireframe. + +Defaults to `false`. ### extra_kwargs +```julia +extra_kwargs :: Symbol +``` +Specify for which element extra keyword args are collected or a KW (Dict{Symbol, Any}) to pass a map of extra keyword args which may be specific to a backend. Choose from (`:plot`, `:subplot`, `:series`), defaults to `:series`. Example: `pgfplotsx(); scatter(1:5, extra_kwargs=Dict(:subplot=>Dict("axis line shift" => "10pt"))`. + +Defaults to `Dict{Any, Any}()`. ### fill_z +```julia +fill_z :: AbstractMatrix +``` +Aliases: `fill_zs` `fillz` `fillzs` `fz` `sc` `surfacecolor` `surfacecolour` `surfcolor` `surfcolour` +Matrix of the same size as z matrix, which specifies the color of the 3D surface. + +Defaults to `nothing`. ### fillalpha +```julia +fillalpha :: Real +``` +Aliases: `fa` `falpha` `fillalphas` `fillopacity` `fopacity` `fα` + +The alpha/opacity override for the fill area. `nothing` means it will take the alpha value of fillcolor. +Defaults to `nothing`. ### fillcolor +```julia +fillcolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} +``` +Aliases: `fc` `fcolor` `fcolour` `fillcolors` `fillcolour` + +Color of the filled area of path or bar types. `:match` will take the value from `:seriescolor`. +Defaults to `:match`. ### fillrange +```julia +fillrange :: Union{Real, AbstractVector} +``` +Aliases: `fill_between` `fillbetween` `fillranges` `fillrng` `fillto` `frange` + +Fills area between fillrange and `y` for line-types, sets the base for `bar`, `sticks` types, and similar for other types. +Defaults to `nothing`. ### fillstyle +```julia +fillstyle :: Symbol +``` +Aliases: `fillstyles` +Style of the fill area. `nothing` means solid fill. Choose from `:/`, `:\\`, `:|`, `:-`, `:+`, `:x`. + +Defaults to `nothing`. ### group +```julia +group :: AbstractVector +``` +Aliases: `g` `grouping` `groups` +Data is split into a separate series, one for each unique value in `group`. + +Defaults to `nothing`. ### hover +```julia +hover :: AbstractVector{AbstractString} +``` +Aliases: `hovers` + +Text to display when hovering over each data point. +Defaults to `nothing`. ### label +```julia +label :: AbstractString +``` +Aliases: `lab` `labels` + +The label for a series, which appears in a legend. If empty, no legend entry is added. +Defaults to `:auto`. ### levels +```julia +levels :: Union{Integer, AbstractVector} +``` +Aliases: `levs` `nlev` `nlevels` + +Singleton for number of contours or iterable for contour values. Determines contour levels for a contour type. +Defaults to `15`. ### line_z +```julia +line_z :: Union{Function, AbstractVector} +``` +Aliases: `line_zs` `linez` `linezs` `lz` `zline` + +z-values for each series line segment, which correspond to the color to be used from a linecolor gradient. Note that for N points, only the first N-1 values are used (one per line-segment). +Defaults to `nothing`. ### linealpha +```julia +linealpha :: Real +``` +Aliases: `la` `lalpha` `linealphas` `lineopacity` `lopacity` `lα` +The alpha/opacity override for the line. `nothing` means it will take the alpha value of linecolor. + +Defaults to `nothing`. ### linecolor +```julia +linecolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} +``` +Aliases: `lc` `lcolor` `lcolour` `linecolors` `linecolour` + +Color of the line (for path and bar stroke). `:match` will take the value from `:seriescolor`, (though histogram/bar types use `:black` as a default). +Defaults to `:auto`. ### linestyle +```julia +linestyle :: Symbol +``` +Aliases: `linestyles` `ls` `s` `style` +Style of the line (for path and bar stroke). + +Defaults to `:solid`. + +Choose from the following: +* `:auto` `:solid` `:dash` `:dot` `:dashdot` `:dashdotdot` ### linewidth +```julia +linewidth :: Real +``` +Aliases: `linewidths` `lw` `w` `width` + +Width of the line (in pixels). +Defaults to `:auto`. ### marker_z +```julia +marker_z :: Union{Function, AbstractVector} +``` +Aliases: `marker_zs` `markerz` `markerzs` `mz` `zcolor` + +z-values for each series data point, which correspond to the color to be used from a markercolor gradient (`f(x,y,z) -> z_value` or `f(x,y) -> z_value`). +Defaults to `nothing`. ### markeralpha +```julia +markeralpha :: Real +``` +Aliases: `ma` `malpha` `markeralphas` `markeropacity` `mopacity` `mα` + +The alpha/opacity override for the marker interior. `nothing` means it will take the alpha value of markercolor. +Defaults to `nothing`. ### markercolor +```julia +markercolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} +``` +Aliases: `markercolors` `markercolour` `mc` `mcolor` `mcolour` +Color of the interior of the marker or shape. `:match` will take the value from `:seriescolor`. + +Defaults to `:match`. ### markershape +```julia +markershape :: Union{Symbol, AbstractVector, Shape} +``` +Aliases: `markershapes` `shape` +Defaults to `:none`. + +Choose from the following: +* `:none` `:auto` `:cross` `:xcross` `:vline` `:hline` `:+` `:x` +* `:circle` `:rect` `:diamond` +* `:utriangle` `:dtriangle` `:rtriangle` `:ltriangle` +* `:star4` `:star5` `:star6` `:star7` `:star8` +* `:pentagon` `:hexagon` `:heptagon` `:octagon` ### markersize +```julia +markersize :: Union{Real, AbstractVector} +``` +Aliases: `markersizes` `ms` `msize` +Size (radius pixels) of the markers. + +Defaults to `4`. ### markerstrokealpha +```julia +markerstrokealpha :: Real +``` +Aliases: `markerstrokealphas` `markerstrokeopacity` `msa` `msalpha` `msopacity` `msα` +The alpha/opacity override for the marker stroke (border). `nothing` means it will take the alpha value of `markerstrokecolor`. + +Defaults to `nothing`. + +### markerstrokecolor +```julia +markerstrokecolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} +``` +Aliases: `markerstrokecolors` `markerstrokecolour` `msc` `mscolor` `mscolour` + +Color of the marker stroke (border). `:match` will take the value from `:foreground_color_subplot`. + +Defaults to `:match`. ### markerstrokestyle +```julia +markerstrokestyle :: Symbol +``` +Aliases: `markerstrokestyles` + +Style of the marker stroke (border). +Defaults to `:solid`. + +Choose from the following: +* `:auto` `:solid` `:dash` `:dot` `:dashdot` `:dashdotdot` ### markerstrokewidth +```julia +markerstrokewidth :: Real +``` +Aliases: `markerstrokewidths` `msw` `mswidth` + +Width of the marker stroke (border) in pixels. +Defaults to `1`. ### normalize +```julia +normalize :: Union{Bool, Symbol} +``` +Aliases: `norm` `normalized` `normalizes` `normed` +Normalizes the histogram. + +Defaults to `false`. + +Can take in one of the following types: +* `Symbol` – defines the normalization scheme. + * `:none` – no normalization + * `:pdf` – normalize to a discrete PDF, where the total area of the bins is 1 + * `:density` – the area of each bin, rather than the height, is equal to the counts (useful for uneven bin sizes) +* `Bool` – defines the normalization scheme. + * `false` (default) – same as `:none` + * `true` – same as `:pdf` ### orientation +```julia +orientation :: Symbol +``` +Aliases: `dir` `direction` `orientations` + +(deprecated) Horizontal or vertical orientation for bar types. Values `:h`, `:hor`, `:horizontal` correspond to horizontal (sideways, anchored to y-axis), and `:v`, `:vert`, and `:vertical` correspond to vertical. +Defaults to `:vertical`. ### permute +```julia +permute :: Tuple{Symbol, Symbol} +``` +Aliases: `permutes` +Permutes data and axis properties of the axes given in the tuple, e.g. `(:x, :y)`. + +Defaults to `:none`. ### primary +```julia +primary :: Bool +``` +Aliases: `primarys` + +Does this count as a "real series?" For example, you could have a path (primary) and a scatter (secondary) as two separate series, maybe with different data (see `sticks` recipe for an example). The secondary series will get the same color, etc. as the primary. +Defaults to `true`. ### quiver +```julia +quiver :: Union{Tuple{AbstractVector, AbstractVector}, AbstractVector} +``` +Aliases: `gradient` `quiver2d` `quivers` `vectorfield` `velocity` + +The directional vectors `(U, V)` which specify velocity/gradient vectors for a quiver plot. +Defaults to `nothing`. ### ribbon +```julia +ribbon :: Union{Real, AbstractVector} +``` +Aliases: `rib` `ribbons` +Creates a fillrange around the data points. + +Defaults to `nothing`. ### series_annotations +```julia +series_annotations :: Union{AbstractString, Plots.PlotText, AbstractVector} +``` +Aliases: `series_ann` `series_annotation` `series_anns` `seriesann` `seriesannotation` `seriesanns` `text` `texts` `txt` `txts` +Annotations which are mapped to data points/positions. + +Defaults to `nothing`. ### seriesalpha +```julia +seriesalpha :: Real +``` +Aliases: `alpha` `opacity` `seriesalphas` `α` + +The alpha/opacity override for the series. `nothing` means it will take the alpha value of the color. +Defaults to `nothing`. ### seriescolor +```julia +seriescolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} +``` +Aliases: `c` `cmap` `color` `colormap` `colour` `seriescolors` + +The base color for this series. `:auto` will select a color from the subplot's `color_palette`, based on the order it was added to the subplot. Also describes the colormap for surfaces. +Defaults to `:auto`. ### seriestype +```julia +seriestype :: Symbol +``` +Aliases: `linetype` `lt` `seriestypes` `st` `t` `typ` + +Identifier of the type of visualization for this series. + +Defaults to `:path`. +Choose from any series recipes which are defined, or the following: +* `:none` `:line` `:path` `:steppre` `:stepmid` `:steppost` `:sticks` `:scatter` `:heatmap` `:hexbin` `:barbins` `:barhist` `:histogram` `:scatterbins` `:scatterhist` `:stepbins` `:stephist` `:bins2d` `:histogram2d` `:histogram3d` `:density` `:bar` `:hline` `:vline` `:contour` `:pie` `:shape` `:image` `:path3d` `:scatter3d` `:surface` `:wireframe` `:contour3d` `:volume` `:mesh3d` ### show_empty_bins +```julia +show_empty_bins :: Bool +``` +Aliases: `show_empty` `showempty` `showemptybins` +Whether empty bins in a 2D histogram are colored as 0 with `true`, or transparent with `false`. + +Defaults to `false`. ### smooth +```julia +smooth :: Bool +``` +Aliases: `reg` `regression` `smooths` +Add a regression line? + +Defaults to `false`. ### stride +```julia +stride :: Any +``` +Aliases: `str` `strides` `surf_str` `surface_stride` `surfacestride` `surfstr` `wirefame_stride` `wirefamestride` +Defaults to `(1, 1)`. ### subplot +```julia +subplot :: Union{Integer, Plots.Subplot} +``` +Aliases: `sp` `splt` `subplots` `subplt` +The subplot that this series belongs to. + +Defaults to `:auto`. ### weights +```julia +weights :: AbstractVector +``` +Used in histogram types for weighted counts. + +Defaults to `nothing`. ### x +```julia +x :: Any +``` +Aliases: `xs` + +Input data (first dimension). +Defaults to `nothing`. ### xerror +```julia +xerror :: Union{Tuple{AbstractVector, AbstractVector}, AbstractVector} +``` +Aliases: `xerr` `xerrorbar` `xerrors` +`x` (horizontal) error relative to x-value. If 2-tuple of vectors, the first vector corresponds to the left error (and the second to the right). + +Defaults to `nothing`. ### y +```julia +y :: Any +``` +Aliases: `ys` +Input data (second dimension). + +Defaults to `nothing`. ### yerror +```julia +yerror :: Union{Tuple{AbstractVector, AbstractVector}, AbstractVector} +``` +Aliases: `err` `errorbar` `yerr` `yerrorbar` `yerrors` +`y` (vertical) error relative to y-value. If 2-tuple of vectors, the first vector corresponds to the bottom error (and the second to the top). -### z +Defaults to `nothing`. +### z +```julia +z :: Any +``` +Aliases: `zs` -### z_order +Input data (third dimension). May be wrapped by a `Surface` for surface and heatmap types. +Defaults to `nothing`. -### zerror +### z_order +```julia +z_order :: Union{Integer, Symbol} +``` +Aliases: `z_orders` `zorders` +`:front`, `:back`, or index of position where 1 is furthest in the background. +Defaults to `:front`. +### zerror +```julia +zerror :: Any +``` +Aliases: `zerr` `zerrorbar` `zerrors` +Defaults to `nothing`. From c10478f78a6c79ab998c657071ee933b8061b581 Mon Sep 17 00:00:00 2001 From: Andrew J <42456097+Ininterrompue@users.noreply.github.com> Date: Tue, 13 Dec 2022 13:40:32 -0800 Subject: [PATCH 03/12] Add match_dimensions --- docs/src/Attributes/attributes_series.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/src/Attributes/attributes_series.md b/docs/src/Attributes/attributes_series.md index d5581f8f1b..54ce255ab5 100644 --- a/docs/src/Attributes/attributes_series.md +++ b/docs/src/Attributes/attributes_series.md @@ -3,17 +3,6 @@ Series attributes apply to individual series, such as lines, scatters, heatmaps, etc. - - - - - -:match_dimensions => (Bool, "For heatmap types: should the first dimension of a matrix (rows) correspond to the first dimension of the plot (`x`-axis) ? Defaults to `false`, which matches the behavior of Matplotlib, Plotly, and others. Note: when passing a function for `z`, the function should still map `(x,y) -> z`."), - - - - - ### arrow ```julia arrow :: Union{Bool, Plots.Arrow} @@ -366,6 +355,17 @@ Width of the marker stroke (border) in pixels. Defaults to `1`. +### match_dimensions +```julia +match_dimensions :: Bool +``` + +For heatmap types: should the first dimension of a matrix (rows) correspond to the first dimension of the plot (x-axis)? + +Defaults to `false` (which matches the behavior of matplotlib, Plotly, and others). + +Note: when passing a function for `z`, the function should still map `(x,y) -> z`. + ### normalize ```julia normalize :: Union{Bool, Symbol} From ea5dcf172ad70f83bc416ea7bb735f56da8933f9 Mon Sep 17 00:00:00 2001 From: Andrew J <42456097+Ininterrompue@users.noreply.github.com> Date: Tue, 13 Dec 2022 13:43:22 -0800 Subject: [PATCH 04/12] Bold aliases for easier readability --- docs/src/Attributes/attributes_series.md | 100 +++++++++++------------ 1 file changed, 50 insertions(+), 50 deletions(-) diff --git a/docs/src/Attributes/attributes_series.md b/docs/src/Attributes/attributes_series.md index 54ce255ab5..e15d99530a 100644 --- a/docs/src/Attributes/attributes_series.md +++ b/docs/src/Attributes/attributes_series.md @@ -7,7 +7,7 @@ Series attributes apply to individual series, such as lines, scatters, heatmaps, ```julia arrow :: Union{Bool, Plots.Arrow} ``` -Aliases: `arrows` +**Aliases:** `arrows` Defines arrowheads that should be displayed at the end of path line segments (just before a NaN and the last non-NaN point). Used in quiverplot, streamplot, or similar. @@ -26,7 +26,7 @@ Defaults to `false`. ```julia bar_position :: Symbol ``` -Aliases: `bar_positions` `barpositions` +**Aliases:** `bar_positions` `barpositions` Choose from `:overlay` or `:stack`. (Warning: may only be partially implemented) @@ -36,7 +36,7 @@ Defaults to `:overlay`. ```julia bar_width :: Real ``` -Aliases: `bar_widths` `barwidths` +**Aliases:** `bar_widths` `barwidths` Width of bars in data coordinates. When `nothing`, chooses based on `x` (or `y` when `orientation = :h`). @@ -44,7 +44,7 @@ Width of bars in data coordinates. When `nothing`, chooses based on `x` (or `y` ```julia bins :: Union{Integer, Symbol, Tuple{Integer, Integer}, AbstractVector} ``` -Aliases: `bin` `nb` `nbin` `nbins` +**Aliases:** `bin` `nb` `nbin` `nbins` Defines the number of bins. @@ -73,7 +73,7 @@ Relevant attribute for the following series types: ```julia colorbar_entry :: Bool ``` -Aliases: `colorbar_entrys` `colorbarentrys` +**Aliases:** `colorbar_entrys` `colorbarentrys` Include this series in the color bar? Set to `false` to exclude. @@ -90,7 +90,7 @@ Defaults to `nothing`. ```julia contour_labels :: Bool ``` -Aliases: `clabels` `clabs` `contourlabels` +**Aliases:** `clabels` `clabs` `contourlabels` Show labels at the contour lines? @@ -118,7 +118,7 @@ Defaults to `Dict{Any, Any}()`. ```julia fill_z :: AbstractMatrix ``` -Aliases: `fill_zs` `fillz` `fillzs` `fz` `sc` `surfacecolor` `surfacecolour` `surfcolor` `surfcolour` +**Aliases:** `fill_zs` `fillz` `fillzs` `fz` `sc` `surfacecolor` `surfacecolour` `surfcolor` `surfcolour` Matrix of the same size as z matrix, which specifies the color of the 3D surface. @@ -128,7 +128,7 @@ Defaults to `nothing`. ```julia fillalpha :: Real ``` -Aliases: `fa` `falpha` `fillalphas` `fillopacity` `fopacity` `fα` +**Aliases:** `fa` `falpha` `fillalphas` `fillopacity` `fopacity` `fα` The alpha/opacity override for the fill area. `nothing` means it will take the alpha value of fillcolor. @@ -138,7 +138,7 @@ Defaults to `nothing`. ```julia fillcolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} ``` -Aliases: `fc` `fcolor` `fcolour` `fillcolors` `fillcolour` +**Aliases:** `fc` `fcolor` `fcolour` `fillcolors` `fillcolour` Color of the filled area of path or bar types. `:match` will take the value from `:seriescolor`. @@ -148,7 +148,7 @@ Defaults to `:match`. ```julia fillrange :: Union{Real, AbstractVector} ``` -Aliases: `fill_between` `fillbetween` `fillranges` `fillrng` `fillto` `frange` +**Aliases:** `fill_between` `fillbetween` `fillranges` `fillrng` `fillto` `frange` Fills area between fillrange and `y` for line-types, sets the base for `bar`, `sticks` types, and similar for other types. @@ -158,7 +158,7 @@ Defaults to `nothing`. ```julia fillstyle :: Symbol ``` -Aliases: `fillstyles` +**Aliases:** `fillstyles` Style of the fill area. `nothing` means solid fill. Choose from `:/`, `:\\`, `:|`, `:-`, `:+`, `:x`. @@ -168,7 +168,7 @@ Defaults to `nothing`. ```julia group :: AbstractVector ``` -Aliases: `g` `grouping` `groups` +**Aliases:** `g` `grouping` `groups` Data is split into a separate series, one for each unique value in `group`. @@ -178,7 +178,7 @@ Defaults to `nothing`. ```julia hover :: AbstractVector{AbstractString} ``` -Aliases: `hovers` +**Aliases:** `hovers` Text to display when hovering over each data point. @@ -188,7 +188,7 @@ Defaults to `nothing`. ```julia label :: AbstractString ``` -Aliases: `lab` `labels` +**Aliases:** `lab` `labels` The label for a series, which appears in a legend. If empty, no legend entry is added. @@ -198,7 +198,7 @@ Defaults to `:auto`. ```julia levels :: Union{Integer, AbstractVector} ``` -Aliases: `levs` `nlev` `nlevels` +**Aliases:** `levs` `nlev` `nlevels` Singleton for number of contours or iterable for contour values. Determines contour levels for a contour type. @@ -208,7 +208,7 @@ Defaults to `15`. ```julia line_z :: Union{Function, AbstractVector} ``` -Aliases: `line_zs` `linez` `linezs` `lz` `zline` +**Aliases:** `line_zs` `linez` `linezs` `lz` `zline` z-values for each series line segment, which correspond to the color to be used from a linecolor gradient. Note that for N points, only the first N-1 values are used (one per line-segment). @@ -218,7 +218,7 @@ Defaults to `nothing`. ```julia linealpha :: Real ``` -Aliases: `la` `lalpha` `linealphas` `lineopacity` `lopacity` `lα` +**Aliases:** `la` `lalpha` `linealphas` `lineopacity` `lopacity` `lα` The alpha/opacity override for the line. `nothing` means it will take the alpha value of linecolor. @@ -228,7 +228,7 @@ Defaults to `nothing`. ```julia linecolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} ``` -Aliases: `lc` `lcolor` `lcolour` `linecolors` `linecolour` +**Aliases:** `lc` `lcolor` `lcolour` `linecolors` `linecolour` Color of the line (for path and bar stroke). `:match` will take the value from `:seriescolor`, (though histogram/bar types use `:black` as a default). @@ -238,7 +238,7 @@ Defaults to `:auto`. ```julia linestyle :: Symbol ``` -Aliases: `linestyles` `ls` `s` `style` +**Aliases:** `linestyles` `ls` `s` `style` Style of the line (for path and bar stroke). @@ -251,7 +251,7 @@ Choose from the following: ```julia linewidth :: Real ``` -Aliases: `linewidths` `lw` `w` `width` +**Aliases:** `linewidths` `lw` `w` `width` Width of the line (in pixels). @@ -261,7 +261,7 @@ Defaults to `:auto`. ```julia marker_z :: Union{Function, AbstractVector} ``` -Aliases: `marker_zs` `markerz` `markerzs` `mz` `zcolor` +**Aliases:** `marker_zs` `markerz` `markerzs` `mz` `zcolor` z-values for each series data point, which correspond to the color to be used from a markercolor gradient (`f(x,y,z) -> z_value` or `f(x,y) -> z_value`). @@ -271,7 +271,7 @@ Defaults to `nothing`. ```julia markeralpha :: Real ``` -Aliases: `ma` `malpha` `markeralphas` `markeropacity` `mopacity` `mα` +**Aliases:** `ma` `malpha` `markeralphas` `markeropacity` `mopacity` `mα` The alpha/opacity override for the marker interior. `nothing` means it will take the alpha value of markercolor. @@ -281,7 +281,7 @@ Defaults to `nothing`. ```julia markercolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} ``` -Aliases: `markercolors` `markercolour` `mc` `mcolor` `mcolour` +**Aliases:** `markercolors` `markercolour` `mc` `mcolor` `mcolour` Color of the interior of the marker or shape. `:match` will take the value from `:seriescolor`. @@ -291,7 +291,7 @@ Defaults to `:match`. ```julia markershape :: Union{Symbol, AbstractVector, Shape} ``` -Aliases: `markershapes` `shape` +**Aliases:** `markershapes` `shape` Defaults to `:none`. @@ -306,7 +306,7 @@ Choose from the following: ```julia markersize :: Union{Real, AbstractVector} ``` -Aliases: `markersizes` `ms` `msize` +**Aliases:** `markersizes` `ms` `msize` Size (radius pixels) of the markers. @@ -316,7 +316,7 @@ Defaults to `4`. ```julia markerstrokealpha :: Real ``` -Aliases: `markerstrokealphas` `markerstrokeopacity` `msa` `msalpha` `msopacity` `msα` +**Aliases:** `markerstrokealphas` `markerstrokeopacity` `msa` `msalpha` `msopacity` `msα` The alpha/opacity override for the marker stroke (border). `nothing` means it will take the alpha value of `markerstrokecolor`. @@ -326,7 +326,7 @@ Defaults to `nothing`. ```julia markerstrokecolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} ``` -Aliases: `markerstrokecolors` `markerstrokecolour` `msc` `mscolor` `mscolour` +**Aliases:** `markerstrokecolors` `markerstrokecolour` `msc` `mscolor` `mscolour` Color of the marker stroke (border). `:match` will take the value from `:foreground_color_subplot`. @@ -336,7 +336,7 @@ Defaults to `:match`. ```julia markerstrokestyle :: Symbol ``` -Aliases: `markerstrokestyles` +**Aliases:** `markerstrokestyles` Style of the marker stroke (border). @@ -349,7 +349,7 @@ Choose from the following: ```julia markerstrokewidth :: Real ``` -Aliases: `markerstrokewidths` `msw` `mswidth` +**Aliases:** `markerstrokewidths` `msw` `mswidth` Width of the marker stroke (border) in pixels. @@ -370,7 +370,7 @@ Note: when passing a function for `z`, the function should still map `(x,y) -> z ```julia normalize :: Union{Bool, Symbol} ``` -Aliases: `norm` `normalized` `normalizes` `normed` +**Aliases:** `norm` `normalized` `normalizes` `normed` Normalizes the histogram. @@ -389,7 +389,7 @@ Can take in one of the following types: ```julia orientation :: Symbol ``` -Aliases: `dir` `direction` `orientations` +**Aliases:** `dir` `direction` `orientations` (deprecated) Horizontal or vertical orientation for bar types. Values `:h`, `:hor`, `:horizontal` correspond to horizontal (sideways, anchored to y-axis), and `:v`, `:vert`, and `:vertical` correspond to vertical. @@ -399,7 +399,7 @@ Defaults to `:vertical`. ```julia permute :: Tuple{Symbol, Symbol} ``` -Aliases: `permutes` +**Aliases:** `permutes` Permutes data and axis properties of the axes given in the tuple, e.g. `(:x, :y)`. @@ -409,7 +409,7 @@ Defaults to `:none`. ```julia primary :: Bool ``` -Aliases: `primarys` +**Aliases:** `primarys` Does this count as a "real series?" For example, you could have a path (primary) and a scatter (secondary) as two separate series, maybe with different data (see `sticks` recipe for an example). The secondary series will get the same color, etc. as the primary. @@ -419,7 +419,7 @@ Defaults to `true`. ```julia quiver :: Union{Tuple{AbstractVector, AbstractVector}, AbstractVector} ``` -Aliases: `gradient` `quiver2d` `quivers` `vectorfield` `velocity` +**Aliases:** `gradient` `quiver2d` `quivers` `vectorfield` `velocity` The directional vectors `(U, V)` which specify velocity/gradient vectors for a quiver plot. @@ -429,7 +429,7 @@ Defaults to `nothing`. ```julia ribbon :: Union{Real, AbstractVector} ``` -Aliases: `rib` `ribbons` +**Aliases:** `rib` `ribbons` Creates a fillrange around the data points. @@ -439,7 +439,7 @@ Defaults to `nothing`. ```julia series_annotations :: Union{AbstractString, Plots.PlotText, AbstractVector} ``` -Aliases: `series_ann` `series_annotation` `series_anns` `seriesann` `seriesannotation` `seriesanns` `text` `texts` `txt` `txts` +**Aliases:** `series_ann` `series_annotation` `series_anns` `seriesann` `seriesannotation` `seriesanns` `text` `texts` `txt` `txts` Annotations which are mapped to data points/positions. @@ -449,7 +449,7 @@ Defaults to `nothing`. ```julia seriesalpha :: Real ``` -Aliases: `alpha` `opacity` `seriesalphas` `α` +**Aliases:** `alpha` `opacity` `seriesalphas` `α` The alpha/opacity override for the series. `nothing` means it will take the alpha value of the color. @@ -459,7 +459,7 @@ Defaults to `nothing`. ```julia seriescolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} ``` -Aliases: `c` `cmap` `color` `colormap` `colour` `seriescolors` +**Aliases:** `c` `cmap` `color` `colormap` `colour` `seriescolors` The base color for this series. `:auto` will select a color from the subplot's `color_palette`, based on the order it was added to the subplot. Also describes the colormap for surfaces. @@ -469,7 +469,7 @@ Defaults to `:auto`. ```julia seriestype :: Symbol ``` -Aliases: `linetype` `lt` `seriestypes` `st` `t` `typ` +**Aliases:** `linetype` `lt` `seriestypes` `st` `t` `typ` Identifier of the type of visualization for this series. @@ -482,7 +482,7 @@ Choose from any series recipes which are defined, or the following: ```julia show_empty_bins :: Bool ``` -Aliases: `show_empty` `showempty` `showemptybins` +**Aliases:** `show_empty` `showempty` `showemptybins` Whether empty bins in a 2D histogram are colored as 0 with `true`, or transparent with `false`. @@ -492,7 +492,7 @@ Defaults to `false`. ```julia smooth :: Bool ``` -Aliases: `reg` `regression` `smooths` +**Aliases:** `reg` `regression` `smooths` Add a regression line? @@ -502,7 +502,7 @@ Defaults to `false`. ```julia stride :: Any ``` -Aliases: `str` `strides` `surf_str` `surface_stride` `surfacestride` `surfstr` `wirefame_stride` `wirefamestride` +**Aliases:** `str` `strides` `surf_str` `surface_stride` `surfacestride` `surfstr` `wirefame_stride` `wirefamestride` Defaults to `(1, 1)`. @@ -510,7 +510,7 @@ Defaults to `(1, 1)`. ```julia subplot :: Union{Integer, Plots.Subplot} ``` -Aliases: `sp` `splt` `subplots` `subplt` +**Aliases:** `sp` `splt` `subplots` `subplt` The subplot that this series belongs to. @@ -529,7 +529,7 @@ Defaults to `nothing`. ```julia x :: Any ``` -Aliases: `xs` +**Aliases:** `xs` Input data (first dimension). @@ -539,7 +539,7 @@ Defaults to `nothing`. ```julia xerror :: Union{Tuple{AbstractVector, AbstractVector}, AbstractVector} ``` -Aliases: `xerr` `xerrorbar` `xerrors` +**Aliases:** `xerr` `xerrorbar` `xerrors` `x` (horizontal) error relative to x-value. If 2-tuple of vectors, the first vector corresponds to the left error (and the second to the right). @@ -549,7 +549,7 @@ Defaults to `nothing`. ```julia y :: Any ``` -Aliases: `ys` +**Aliases:** `ys` Input data (second dimension). @@ -559,7 +559,7 @@ Defaults to `nothing`. ```julia yerror :: Union{Tuple{AbstractVector, AbstractVector}, AbstractVector} ``` -Aliases: `err` `errorbar` `yerr` `yerrorbar` `yerrors` +**Aliases:** `err` `errorbar` `yerr` `yerrorbar` `yerrors` `y` (vertical) error relative to y-value. If 2-tuple of vectors, the first vector corresponds to the bottom error (and the second to the top). @@ -569,7 +569,7 @@ Defaults to `nothing`. ```julia z :: Any ``` -Aliases: `zs` +**Aliases:** `zs` Input data (third dimension). May be wrapped by a `Surface` for surface and heatmap types. @@ -579,7 +579,7 @@ Defaults to `nothing`. ```julia z_order :: Union{Integer, Symbol} ``` -Aliases: `z_orders` `zorders` +**Aliases:** `z_orders` `zorders` `:front`, `:back`, or index of position where 1 is furthest in the background. @@ -589,6 +589,6 @@ Defaults to `:front`. ```julia zerror :: Any ``` -Aliases: `zerr` `zerrorbar` `zerrors` +**Aliases:** `zerr` `zerrorbar` `zerrors` Defaults to `nothing`. From c75bb49a79ac98bfcc25516b608e4ecd80c4c02e Mon Sep 17 00:00:00 2001 From: Andrew J <42456097+Ininterrompue@users.noreply.github.com> Date: Tue, 13 Dec 2022 16:03:51 -0800 Subject: [PATCH 05/12] Add TOC, cross-reference links --- docs/src/Attributes/attributes_series.md | 174 +++++++++++++++-------- 1 file changed, 117 insertions(+), 57 deletions(-) diff --git a/docs/src/Attributes/attributes_series.md b/docs/src/Attributes/attributes_series.md index e15d99530a..8add08cfe0 100644 --- a/docs/src/Attributes/attributes_series.md +++ b/docs/src/Attributes/attributes_series.md @@ -3,7 +3,67 @@ Series attributes apply to individual series, such as lines, scatters, heatmaps, etc. -### arrow +| Attribute | Aliases | +| :--- | :--- | +| [`arrow`](@ref seriesattr_) | `arrows` | +| [`bar_edges`](@ref seriesattr_bar_edges) | | +| [`bar_position`](@ref seriesattr_bar_position) | `bar_positions` `barpositions` | +| [`bar_width`](@ref seriesattr_bar_width) | `bar_widths` `barwidths` | +| [`bins`](@ref seriesattr_bins) | `bin` `nb` `nbin` `nbins` | +| [`colorbar_entry`](@ref seriesattr_colorbar_entry) | `colorbar_entrys` `colorbarentrys` | +| [`connections`](@ref seriesattr_connections) | | +| [`contour_labels`](@ref seriesattr_contour_labels) | `clabels` `clabs` `contourlabels` | +| [`contours`](@ref seriesattr_contours) | | +| [`extra_kwargs`](@ref seriesattr_extra_kwargs) | | +| [`fill_z`](@ref seriesattr_fill_z) | `fill_zs` `fillz` `fillzs` `fz` `sc` `surfacecolor` `surfacecolour` `surfcolor` `surfcolour` | +| [`fillalpha`](@ref seriesattr_fillalpha) | `fa` `falpha` `fillalphas` `fillopacity` `fopacity` `fα` | +| [`fillcolor`](@ref seriesattr_fillcolor) | `fc` `fcolor` `fcolour` `fillcolors` `fillcolour` | +| [`fillrange`](@ref seriesattr_fillrange) | `fill_between` `fillbetween` `fillranges` `fillrng` `fillto` `frange` | +| [`fillstyle`](@ref seriesattr_fillstyle) | `fillstyles` | +| [`group`](@ref seriesattr_group) | `g` `grouping` `groups` | +| [`hover`](@ref seriesattr_hover) | `hovers` | +| [`label`](@ref seriesattr_label) | `lab` `labels` | +| [`levels`](@ref seriesattr_levels) | `levs` `nlev` `nlevels` | +| [`line_z`](@ref seriesattr_line_z) | `line_zs` `linez` `linezs` `lz` `zline` | +| [`linealpha`](@ref seriesattr_linealpha) | `la` `lalpha` `linealphas` `lineopacity` `lopacity` `lα` | +| [`linecolor`](@ref seriesattr_linecolor) | `lc` `lcolor` `lcolour` `linecolors` `linecolour` | +| [`linestyle`](@ref seriesattr_linestyle) | `linestyles` `ls` `s` `style` | +| [`linewidth`](@ref seriesattr_linewidth) | `linewidths` `lw` `w` `width` | +| [`marker_z`](@ref seriesattr_marker_z) | `marker_zs` `markerz` `markerzs` `mz` `zcolor` | +| [`markeralpha`](@ref seriesattr_markeralpha) | `ma` `malpha` `markeralphas` `markeropacity` `mopacity` `mα` | +| [`markercolor`](@ref seriesattr_markercolor) | `markercolors` `markercolour` `mc` `mcolor` `mcolour` | +| [`markershape`](@ref seriesattr_markershape) | `markershapes` `shape` | +| [`markersize`](@ref seriesattr_markersize) | `markersizes` `ms` `msize` | +| [`markerstrokealpha`](@ref seriesattr_markerstrokealpha) | `markerstrokealphas` `markerstrokeopacity` `msa` `msalpha` `msopacity` `msα` | +| [`markerstrokecolor`](@ref seriesattr_markerstrokecolor) | `markerstrokecolors` `markerstrokecolour` `msc` `mscolor` `mscolour` | +| [`markerstrokestyle`](@ref seriesattr_markerstrokestyle) | `markerstrokestyles` | +| [`markerstrokewidth`](@ref seriesattr_markerstrokewidth) | `markerstrokewidths` `msw` `mswidth` | +| [`match_dimensions`](@ref seriesattr_match_dimensions) | | +| [`normalize`](@ref seriesattr_normalize) | `norm` `normalized` `normalizes` `normed` | +| [`orientation`](@ref seriesattr_orientation) | `dir` `direction` `orientations` | +| [`permute`](@ref seriesattr_permute) | `permutes` | +| [`primary`](@ref seriesattr_primary) | `primarys` | +| [`quiver`](@ref seriesattr_quiver) | `gradient` `quiver2d` `quivers` `vectorfield` `velocity` | +| [`ribbon`](@ref seriesattr_ribbon) | `rib` `ribbons` | +| [`series_annotations`](@ref seriesattr_series_annotations) | `series_ann` `series_annotation` `series_anns` `seriesann` `seriesannotation` `seriesanns` `text` `texts` `txt` `txts` | +| [`seriesalpha`](@ref seriesattr_seriesalpha) | `alpha` `opacity` `seriesalphas` `α` | +| [`seriescolor`](@ref seriesattr_seriescolor) | `c` `cmap` `color` `colormap` `colour` `seriescolors` | +| [`seriestype`](@ref seriesattr_seriestype) | `linetype` `lt` `seriestypes` `st` `t` `typ` | +| [`show_empty_bins`](@ref seriesattr_show_empty_bins) | `show_empty` `showempty` `showemptybins` | +| [`smooth`](@ref seriesattr_smooth) | `reg` `regression` `smooths` | +| [`stride`](@ref seriesattr_stride) | `str` `strides` `surf_str` `surface_stride` `surfacestride` `surfstr` `wirefame_stride` `wirefamestride` | +| [`subplot`](@ref seriesattr_subplot) | `sp` `splt` `subplots` `subplt` | +| [`weights`](@ref seriesattr_weights) | | +| [`x`](@ref seriesattr_x) | `xs` | +| [`xerror`](@ref seriesattr_xerror) | `xerr` `xerrorbar` `xerrors` | +| [`y`](@ref seriesattr_y) | `ys` | +| [`yerror`](@ref seriesattr_yerror) | `err` `errorbar` `yerr` `yerrorbar` `yerrors` | +| [`z`](@ref seriesattr_z) | `zs` | +| [`z_order`](@ref seriesattr_z_order) | `z_orders` `zorders` | +| [`zerror`](@ref seriesattr_zerror) | `zerr` `zerrorbar` `zerrors` | + + +### [arrow](@id seriesattr_arrow) ```julia arrow :: Union{Bool, Plots.Arrow} ``` @@ -13,7 +73,7 @@ Defines arrowheads that should be displayed at the end of path line segments (ju Defaults to `nothing`. -### bar_edges +### [bar_edges](@id seriesattr_bar_edges) ```julia bar_edges :: Bool ``` @@ -22,7 +82,7 @@ Align bars to edges with `true`, or centers with `false`. Defaults to `false`. -### bar_position +### [bar_position](@id seriesattr_bar_position) ```julia bar_position :: Symbol ``` @@ -32,7 +92,7 @@ Choose from `:overlay` or `:stack`. (Warning: may only be partially implemented) Defaults to `:overlay`. -### bar_width +### [bar_width](@id seriesattr_bar_width) ```julia bar_width :: Real ``` @@ -40,7 +100,7 @@ bar_width :: Real Width of bars in data coordinates. When `nothing`, chooses based on `x` (or `y` when `orientation = :h`). -### bins +### [bins](@id seriesattr_bins) ```julia bins :: Union{Integer, Symbol, Tuple{Integer, Integer}, AbstractVector} ``` @@ -69,7 +129,7 @@ Relevant attribute for the following series types: * [`histogram`](https://docs.juliaplots.org/stable/api/#Plots.histogram-Tuple) * [`histogram2d`](https://docs.juliaplots.org/stable/api/#Plots.histogram2d-Tuple) -### colorbar_entry +### [colorbar_entry](@id seriesattr_colorbar_entry) ```julia colorbar_entry :: Bool ``` @@ -79,14 +139,14 @@ Include this series in the color bar? Set to `false` to exclude. Defaults to `true`. -### connections +### [connections](@id seriesattr_connections) ```julia connections :: Any ``` Defaults to `nothing`. -### contour_labels +### [contour_labels](@id seriesattr_contour_labels) ```julia contour_labels :: Bool ``` @@ -96,7 +156,7 @@ Show labels at the contour lines? Defaults to `false`. -### contours +### [contours](@id seriesattr_contours) ```julia contours :: Bool ``` @@ -105,16 +165,16 @@ Add contours to the side-grids of 3D plots? Used in surface/wireframe. Defaults to `false`. -### extra_kwargs +### [extra_kwargs](@id seriesattr_extra_kwargs) ```julia extra_kwargs :: Symbol ``` -Specify for which element extra keyword args are collected or a KW (Dict{Symbol, Any}) to pass a map of extra keyword args which may be specific to a backend. Choose from (`:plot`, `:subplot`, `:series`), defaults to `:series`. Example: `pgfplotsx(); scatter(1:5, extra_kwargs=Dict(:subplot=>Dict("axis line shift" => "10pt"))`. +Specify for which element extra keyword args are collected or a KW (`Dict{Symbol, Any}`) to pass a map of extra keyword args which may be specific to a backend. Choose from (`:plot`, `:subplot`, `:series`), defaults to `:series`. Example: `pgfplotsx(); scatter(1:5, extra_kwargs=Dict(:subplot=>Dict("axis line shift" => "10pt"))`. Defaults to `Dict{Any, Any}()`. -### fill_z +### [fill_z](@id seriesattr_fill_z) ```julia fill_z :: AbstractMatrix ``` @@ -124,7 +184,7 @@ Matrix of the same size as z matrix, which specifies the color of the 3D surface Defaults to `nothing`. -### fillalpha +### [fillalpha](@id seriesattr_fillalpha) ```julia fillalpha :: Real ``` @@ -134,7 +194,7 @@ The alpha/opacity override for the fill area. `nothing` means it will take the a Defaults to `nothing`. -### fillcolor +### [fillcolor](@id seriesattr_fillcolor) ```julia fillcolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} ``` @@ -144,7 +204,7 @@ Color of the filled area of path or bar types. `:match` will take the value from Defaults to `:match`. -### fillrange +### [fillrange](@id seriesattr_fillrange) ```julia fillrange :: Union{Real, AbstractVector} ``` @@ -154,7 +214,7 @@ Fills area between fillrange and `y` for line-types, sets the base for `bar`, `s Defaults to `nothing`. -### fillstyle +### [fillstyle](@id seriesattr_fillstyle) ```julia fillstyle :: Symbol ``` @@ -164,7 +224,7 @@ Style of the fill area. `nothing` means solid fill. Choose from `:/`, `:\\`, `:| Defaults to `nothing`. -### group +### [group](@id seriesattr_group) ```julia group :: AbstractVector ``` @@ -174,7 +234,7 @@ Data is split into a separate series, one for each unique value in `group`. Defaults to `nothing`. -### hover +### [hover](@id seriesattr_hover) ```julia hover :: AbstractVector{AbstractString} ``` @@ -184,7 +244,7 @@ Text to display when hovering over each data point. Defaults to `nothing`. -### label +### [label](@id seriesattr_label) ```julia label :: AbstractString ``` @@ -194,7 +254,7 @@ The label for a series, which appears in a legend. If empty, no legend entry is Defaults to `:auto`. -### levels +### [levels](@id seriesattr_levels) ```julia levels :: Union{Integer, AbstractVector} ``` @@ -204,7 +264,7 @@ Singleton for number of contours or iterable for contour values. Determines cont Defaults to `15`. -### line_z +### [line_z](@id seriesattr_line_z) ```julia line_z :: Union{Function, AbstractVector} ``` @@ -214,7 +274,7 @@ z-values for each series line segment, which correspond to the color to be used Defaults to `nothing`. -### linealpha +### [linealpha](@id seriesattr_linealpha) ```julia linealpha :: Real ``` @@ -224,7 +284,7 @@ The alpha/opacity override for the line. `nothing` means it will take the alpha Defaults to `nothing`. -### linecolor +### [linecolor](@id seriesattr_linecolor) ```julia linecolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} ``` @@ -234,7 +294,7 @@ Color of the line (for path and bar stroke). `:match` will take the value from ` Defaults to `:auto`. -### linestyle +### [linestyle](@id seriesattr_linestyle) ```julia linestyle :: Symbol ``` @@ -247,7 +307,7 @@ Defaults to `:solid`. Choose from the following: * `:auto` `:solid` `:dash` `:dot` `:dashdot` `:dashdotdot` -### linewidth +### [linewidth](@id seriesattr_linewidth) ```julia linewidth :: Real ``` @@ -257,7 +317,7 @@ Width of the line (in pixels). Defaults to `:auto`. -### marker_z +### [marker_z](@id seriesattr_marker_z) ```julia marker_z :: Union{Function, AbstractVector} ``` @@ -267,7 +327,7 @@ z-values for each series data point, which correspond to the color to be used fr Defaults to `nothing`. -### markeralpha +### [markeralpha](@id seriesattr_markeralpha) ```julia markeralpha :: Real ``` @@ -277,7 +337,7 @@ The alpha/opacity override for the marker interior. `nothing` means it will take Defaults to `nothing`. -### markercolor +### [markercolor](@id seriesattr_markercolor) ```julia markercolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} ``` @@ -287,7 +347,7 @@ Color of the interior of the marker or shape. `:match` will take the value from Defaults to `:match`. -### markershape +### [markershape](@id seriesattr_markershape) ```julia markershape :: Union{Symbol, AbstractVector, Shape} ``` @@ -302,7 +362,7 @@ Choose from the following: * `:star4` `:star5` `:star6` `:star7` `:star8` * `:pentagon` `:hexagon` `:heptagon` `:octagon` -### markersize +### [markersize](@id seriesattr_markersize) ```julia markersize :: Union{Real, AbstractVector} ``` @@ -312,7 +372,7 @@ Size (radius pixels) of the markers. Defaults to `4`. -### markerstrokealpha +### [markerstrokealpha](@id seriesattr_markerstrokealpha) ```julia markerstrokealpha :: Real ``` @@ -322,7 +382,7 @@ The alpha/opacity override for the marker stroke (border). `nothing` means it wi Defaults to `nothing`. -### markerstrokecolor +### [markerstrokecolor](@id seriesattr_markerstrokecolor) ```julia markerstrokecolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} ``` @@ -332,7 +392,7 @@ Color of the marker stroke (border). `:match` will take the value from `:foregro Defaults to `:match`. -### markerstrokestyle +### [markerstrokestyle](@id seriesattr_markerstrokestyle) ```julia markerstrokestyle :: Symbol ``` @@ -345,7 +405,7 @@ Defaults to `:solid`. Choose from the following: * `:auto` `:solid` `:dash` `:dot` `:dashdot` `:dashdotdot` -### markerstrokewidth +### [markerstrokewidth](@id seriesattr_markerstrokewidth) ```julia markerstrokewidth :: Real ``` @@ -355,7 +415,7 @@ Width of the marker stroke (border) in pixels. Defaults to `1`. -### match_dimensions +### [match_dimensions](@id seriesattr_match_dimensions) ```julia match_dimensions :: Bool ``` @@ -366,7 +426,7 @@ Defaults to `false` (which matches the behavior of matplotlib, Plotly, and other Note: when passing a function for `z`, the function should still map `(x,y) -> z`. -### normalize +### [normalize](@id seriesattr_normalize) ```julia normalize :: Union{Bool, Symbol} ``` @@ -385,7 +445,7 @@ Can take in one of the following types: * `false` (default) – same as `:none` * `true` – same as `:pdf` -### orientation +### [orientation](@id seriesattr_orientation) ```julia orientation :: Symbol ``` @@ -395,7 +455,7 @@ orientation :: Symbol Defaults to `:vertical`. -### permute +### [permute](@id seriesattr_permute) ```julia permute :: Tuple{Symbol, Symbol} ``` @@ -405,7 +465,7 @@ Permutes data and axis properties of the axes given in the tuple, e.g. `(:x, :y) Defaults to `:none`. -### primary +### [primary](@id seriesattr_primary) ```julia primary :: Bool ``` @@ -415,7 +475,7 @@ Does this count as a "real series?" For example, you could have a path (primary) Defaults to `true`. -### quiver +### [quiver](@id seriesattr_quiver) ```julia quiver :: Union{Tuple{AbstractVector, AbstractVector}, AbstractVector} ``` @@ -425,7 +485,7 @@ The directional vectors `(U, V)` which specify velocity/gradient vectors for a q Defaults to `nothing`. -### ribbon +### [ribbon](@id seriesattr_ribbon) ```julia ribbon :: Union{Real, AbstractVector} ``` @@ -435,7 +495,7 @@ Creates a fillrange around the data points. Defaults to `nothing`. -### series_annotations +### [series_annotations](@id seriesattr_series_annotations) ```julia series_annotations :: Union{AbstractString, Plots.PlotText, AbstractVector} ``` @@ -445,7 +505,7 @@ Annotations which are mapped to data points/positions. Defaults to `nothing`. -### seriesalpha +### [seriesalpha](@id seriesattr_seriesalpha) ```julia seriesalpha :: Real ``` @@ -455,7 +515,7 @@ The alpha/opacity override for the series. `nothing` means it will take the alph Defaults to `nothing`. -### seriescolor +### [seriescolor](@id seriesattr_seriescolor) ```julia seriescolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} ``` @@ -465,7 +525,7 @@ The base color for this series. `:auto` will select a color from the subplot's ` Defaults to `:auto`. -### seriestype +### [seriestype](@id seriesattr_seriestype) ```julia seriestype :: Symbol ``` @@ -478,7 +538,7 @@ Defaults to `:path`. Choose from any series recipes which are defined, or the following: * `:none` `:line` `:path` `:steppre` `:stepmid` `:steppost` `:sticks` `:scatter` `:heatmap` `:hexbin` `:barbins` `:barhist` `:histogram` `:scatterbins` `:scatterhist` `:stepbins` `:stephist` `:bins2d` `:histogram2d` `:histogram3d` `:density` `:bar` `:hline` `:vline` `:contour` `:pie` `:shape` `:image` `:path3d` `:scatter3d` `:surface` `:wireframe` `:contour3d` `:volume` `:mesh3d` -### show_empty_bins +### [show_empty_bins](@id seriesattr_show_empty_bins) ```julia show_empty_bins :: Bool ``` @@ -488,7 +548,7 @@ Whether empty bins in a 2D histogram are colored as 0 with `true`, or transpare Defaults to `false`. -### smooth +### [smooth](@id seriesattr_smooth) ```julia smooth :: Bool ``` @@ -498,7 +558,7 @@ Add a regression line? Defaults to `false`. -### stride +### [stride](@id seriesattr_stride) ```julia stride :: Any ``` @@ -506,7 +566,7 @@ stride :: Any Defaults to `(1, 1)`. -### subplot +### [subplot](@id seriesattr_subplot) ```julia subplot :: Union{Integer, Plots.Subplot} ``` @@ -516,7 +576,7 @@ The subplot that this series belongs to. Defaults to `:auto`. -### weights +### [weights](@id seriesattr_weights) ```julia weights :: AbstractVector ``` @@ -525,7 +585,7 @@ Used in histogram types for weighted counts. Defaults to `nothing`. -### x +### [x](@id seriesattr_x) ```julia x :: Any ``` @@ -535,7 +595,7 @@ Input data (first dimension). Defaults to `nothing`. -### xerror +### [xerror](@id seriesattr_xerror) ```julia xerror :: Union{Tuple{AbstractVector, AbstractVector}, AbstractVector} ``` @@ -545,7 +605,7 @@ xerror :: Union{Tuple{AbstractVector, AbstractVector}, AbstractVector} Defaults to `nothing`. -### y +### [y](@id seriesattr_y) ```julia y :: Any ``` @@ -555,7 +615,7 @@ Input data (second dimension). Defaults to `nothing`. -### yerror +### [yerror](@id seriesattr_yerror) ```julia yerror :: Union{Tuple{AbstractVector, AbstractVector}, AbstractVector} ``` @@ -565,7 +625,7 @@ yerror :: Union{Tuple{AbstractVector, AbstractVector}, AbstractVector} Defaults to `nothing`. -### z +### [z](@id seriesattr_z) ```julia z :: Any ``` @@ -575,7 +635,7 @@ Input data (third dimension). May be wrapped by a `Surface` for surface and heat Defaults to `nothing`. -### z_order +### [z_order](@id seriesattr_z_order) ```julia z_order :: Union{Integer, Symbol} ``` @@ -585,7 +645,7 @@ z_order :: Union{Integer, Symbol} Defaults to `:front`. -### zerror +### [zerror](@id seriesattr_zerror) ```julia zerror :: Any ``` From 2a42fc27a7b047c2cae6f462875e2c800f205e1e Mon Sep 17 00:00:00 2001 From: Andrew J <42456097+Ininterrompue@users.noreply.github.com> Date: Tue, 13 Dec 2022 16:43:22 -0800 Subject: [PATCH 06/12] Update attributes_series.md --- docs/src/Attributes/attributes_series.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/Attributes/attributes_series.md b/docs/src/Attributes/attributes_series.md index 8add08cfe0..44d1051850 100644 --- a/docs/src/Attributes/attributes_series.md +++ b/docs/src/Attributes/attributes_series.md @@ -1,11 +1,11 @@ # Series Attributes -Series attributes apply to individual series, such as lines, scatters, heatmaps, etc. +Series attributes apply to individual series, such as lines, scatters, heatmaps, etc. The detailed documentation will contain a list of series types for which the given attribute is relevant. | Attribute | Aliases | | :--- | :--- | -| [`arrow`](@ref seriesattr_) | `arrows` | +| [`arrow`](@ref seriesattr_arrow) | `arrows` | | [`bar_edges`](@ref seriesattr_bar_edges) | | | [`bar_position`](@ref seriesattr_bar_position) | `bar_positions` `barpositions` | | [`bar_width`](@ref seriesattr_bar_width) | `bar_widths` `barwidths` | From 4ce54f0e8f838a1c3ea9a836a6ac321df64d0d2c Mon Sep 17 00:00:00 2001 From: Andrew J <42456097+Ininterrompue@users.noreply.github.com> Date: Tue, 13 Dec 2022 16:46:15 -0800 Subject: [PATCH 07/12] Update attributes_series.md --- docs/src/Attributes/attributes_series.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/src/Attributes/attributes_series.md b/docs/src/Attributes/attributes_series.md index 44d1051850..7c8e4a4041 100644 --- a/docs/src/Attributes/attributes_series.md +++ b/docs/src/Attributes/attributes_series.md @@ -3,6 +3,8 @@ Series attributes apply to individual series, such as lines, scatters, heatmaps, etc. The detailed documentation will contain a list of series types for which the given attribute is relevant. +## Contents + | Attribute | Aliases | | :--- | :--- | | [`arrow`](@ref seriesattr_arrow) | `arrows` | @@ -62,6 +64,7 @@ Series attributes apply to individual series, such as lines, scatters, heatmaps, | [`z_order`](@ref seriesattr_z_order) | `z_orders` `zorders` | | [`zerror`](@ref seriesattr_zerror) | `zerr` `zerrorbar` `zerrors` | +## Documentation ### [arrow](@id seriesattr_arrow) ```julia From f51625026cfcb690d98a0aefd19c8e81db5d5842 Mon Sep 17 00:00:00 2001 From: Andrew J <42456097+Ininterrompue@users.noreply.github.com> Date: Tue, 13 Dec 2022 17:40:26 -0800 Subject: [PATCH 08/12] Update attributes_plot.md --- docs/src/Attributes/attributes_plot.md | 327 +++++++++++++++++++++++++ 1 file changed, 327 insertions(+) diff --git a/docs/src/Attributes/attributes_plot.md b/docs/src/Attributes/attributes_plot.md index e69de29bb2..6610e8675a 100644 --- a/docs/src/Attributes/attributes_plot.md +++ b/docs/src/Attributes/attributes_plot.md @@ -0,0 +1,327 @@ + +# Plot Attributes + +A Plot contains a tree-like layout of Subplots. These attributes apply to the full Plot. + +## Contents + +| Attribute | Aliases | +| :--- | :--- | +| [`background_color`](@ref plotattr_background_color) | `background` `background_colors` `background_colour` `backgroundcolors` `backgroundcolour` `bg` `bg_color` `bg_colour` `bgcolor` `bgcolour` | +| [`background_color_outside`](@ref plotattr_background_color_outside) | `background_color_outsides` `background_colour_outside` `background_outside` `backgroundcoloroutsides` `backgroundcolouroutside` `backgroundoutside` `bg_color_outside` `bg_colour_outside` `bg_outside` `bgcolor_outside` `bgcoloroutside` `bgcolour_outside` `bgcolouroutside` `bgoutside` | +| [`display_type`](@ref plotattr_display_type) | `display_types` `displaytypes` | +| [`dpi`](@ref plotattr_dpi) | `dpis` | +| [`extra_kwargs`](@ref plotattr_extra_kwargs) | | +| [`extra_plot_kwargs`](@ref plotattr_extra_plot_kwargs) | | +| [`fontfamily`](@ref plotattr_fontfamily) | `fontfamilys` | +| [`foreground_color`](@ref plotattr_foreground_color) | `fg` `fg_color` `fg_colour` `fgcolor` `fgcolour` `foreground` `foreground_colors` `foreground_colour` `foregroundcolors` `foregroundcolour` | +| [`html_output_format`](@ref plotattr_html_output_format) | `fmt` `format` `html_format` `html_output_formats` `htmlformat` `htmloutputformats` | +| [`inset_subplots`](@ref plotattr_inset_subplots) | `floating` `inset` | +| [`layout`](@ref plotattr_layout) | `layouts` | +| [`link`](@ref plotattr_link) | `links` | +| [`overwrite_figure`](@ref plotattr_overwrite_figure) | `clearfig` `clf` `overwrite` `overwrite_figures` `overwritefigures` `reuse` | +| [`plot_title`](@ref plotattr_plot_title) | `plot_titles` `plottitles` | +| [`plot_titlefontcolor`](@ref plotattr_plot_titlefontcolor) | `plot_titlefontcolors` `plottitlefontcolors` | +| [`plot_titlefontfamily`](@ref plotattr_plot_titlefontfamily) | `plot_titlefontfamilys` `plottitlefontfamilys` | +| [`plot_titlefonthalign`](@ref plotattr_plot_titlefonthalign) | `plot_titlefonthaligns` `plottitlefonthaligns` | +| [`plot_titlefontrotation`](@ref plotattr_plot_titlefontrotation) | `plot_titlefontrotations` `plottitlefontrotations` | +| [`plot_titlefontsize`](@ref plotattr_plot_titlefontsize) | `plot_titlefontsizes` `plottitlefontsizes` | +| [`plot_titlefontvalign`](@ref plotattr_plot_titlefontvalign) | `plot_titlefontvaligns` `plottitlefontvaligns` | +| [`plot_titleindex`](@ref plotattr_plot_titleindex) | `plot_titleindexs` `plottitleindexs` | +| [`plot_titlelocation`](@ref plotattr_plot_titlelocation) | `plot_titlelocations` `plottitlelocations` | +| [`plot_titlevspan`](@ref plotattr_plot_titlevspan) | `plot_titlevspans` `plottitlevspans` | +| [`pos`](@ref plotattr_pos) | | +| [`show`](@ref plotattr_show) | `display` `gui` `shows` | +| [`size`](@ref plotattr_size) | `sizes` `windowsize` `wsize` | +| [`tex_output_standalone`](@ref plotattr_tex_output_standalone) | `tex_output_standalones` `texoutputstandalones` | +| [`thickness_scaling`](@ref plotattr_thickness_scaling) | `thickness_scalings` `thicknessscalings` | +| [`warn_on_unsupported`](@ref plotattr_warn_on_unsupported) | `warn` `warn_on_unsupporteds` `warnonunsupporteds` | +| [`window_title`](@ref plotattr_window_title) | `window_titles` `windowtitle` `windowtitles` `wtitle` | + +## Documentation + +### [background_color](@id plotattr_background_color) +```julia +background_color :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} +``` +**Aliases:** `background` `background_colors` `background_colour` `backgroundcolors` `backgroundcolour` `bg` `bg_color` `bg_colour` `bgcolor` `bgcolour` + +Base color for all backgrounds. + +Defaults to `RGB{N0f8}(1.0, 1.0, 1.0)` (white). + +### [background_color_outside](@id plotattr_background_color_outside) +```julia +background_color_outside :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} +``` +**Aliases:** `background_color_outsides` `background_colour_outside` `background_outside` `backgroundcoloroutsides` `backgroundcolouroutside` `backgroundoutside` `bg_color_outside` `bg_colour_outside` `bg_outside` `bgcolor_outside` `bgcoloroutside` `bgcolour_outside` `bgcolouroutside` `bgoutside` + +Color outside the plot area(s). `:match` matches `:background_color`. + +Defaults to `:match`. + +### [display_type](@id plotattr_display_type) +```julia +display_type :: Symbol +``` +**Aliases:** `display_types` `displaytypes` + +When supported, `display` will either open a GUI window or plot inline. Choose from `:auto`, `:gui`, or `:inline`. + +Defaults to `:auto`. + +### [dpi](@id plotattr_dpi) +```julia +dpi :: Real +``` +**Aliases:** `dpis` + +Dots per inch of output figures. + +Defaults to `100`. + +### [extra_kwargs](@id plotattr_extra_kwargs) +```julia +extra_kwargs :: Symbol +``` + +Specify for which element extra keyword args are collected or a KW (`Dict{Symbol, Any}`) to pass a map of extra keyword args which may be specific to a backend. Choose from (`:plot`, `:subplot`, `:series`), defaults to `:series`. Example: `pgfplotsx(); scatter(1:5, extra_kwargs=Dict(:subplot=>Dict("axis line shift" => "10pt"))`. + +Defaults to `:series`. + +### [extra_plot_kwargs](@id plotattr_extra_plot_kwargs) +```julia +extra_plot_kwargs :: Any +``` + +Defaults to `Dict{Any, Any}()`. + +### [fontfamily](@id plotattr_fontfamily) +```julia +fontfamily :: Union{AbstractString, Symbol} +``` +**Aliases:** `fontfamilys` + +Default font family for title, legend entries, tick labels and guides. + +Defaults to `"sans-serif"`. + +### [foreground_color](@id plotattr_foreground_color) +```julia +foreground_color :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} +``` +**Aliases:** `fg` `fg_color` `fg_colour` `fgcolor` `fgcolour` `foreground` `foreground_colors` `foreground_colour` `foregroundcolors` `foregroundcolour` + +Base color for all foregrounds. + +Defaults to `:auto`. + +### [html_output_format](@id plotattr_html_output_format) +```julia +html_output_format :: Symbol +``` +**Aliases:** `fmt` `format` `html_format` `html_output_formats` `htmlformat` `htmloutputformats` + +When writing HTML output, what is the format? `:png` and `:svg` are currently supported. + +Defaults to `:auto`. + +### [inset_subplots](@id plotattr_inset_subplots) +```julia +inset_subplots :: AbstractVector{Tuple{Any, Any}} +``` +**Aliases:** `floating` `inset` + +Optionally pass a vector of `(parent, bbox)` tuples which are the parent layout and the relative bounding box of inset subplots. + +Defaults to `nothing`. + +### [layout](@id plotattr_layout) +```julia +layout :: Union{Integer, Tuple{Integer, Integer}, AbstractLayout} +``` +**Aliases:** `layouts` + +Number of subplot, grid dimensions, layout (for example `grid(2,2)`), or the return from the `@layout` macro. This builds the layout of subplots. + +Defaults to `1`. + +### [link](@id plotattr_link) +```julia +link :: Symbol +``` +**Aliases:** `links` + +How/whether to link axis limits between subplots. + +Defaults to `:none`. + +Choose from the following: +* `:none` +* `:x` – x axes are linked by columns +* `:y` – y axes are linked by rows +* `:both` – x and y are linked +* `:all` – every subplot is linked together regardless of layout position + +### [overwrite_figure](@id plotattr_overwrite_figure) +```julia +overwrite_figure :: Bool +``` +**Aliases:** `clearfig` `clf` `overwrite` `overwrite_figures` `overwritefigures` `reuse` + +Should we reuse the same GUI window/figure when plotting (true), or open a new one (false)? + +Defaults to `true`. + +### [plot_title](@id plotattr_plot_title) +```julia +plot_title :: AbstractString +``` +**Aliases:** `plot_titles` `plottitles` + +Whole plot title (not to be confused with the title for individual subplots). + +Defaults to `""` (empty string). + +### [plot_titlefontcolor](@id plotattr_plot_titlefontcolor) +```julia +plot_titlefontcolor :: Any +``` +**Aliases:** `plot_titlefontcolors` `plottitlefontcolors` + +Defaults to `:match`. + +### [plot_titlefontfamily](@id plotattr_plot_titlefontfamily) +```julia +plot_titlefontfamily :: Any +``` +**Aliases:** `plot_titlefontfamilys` `plottitlefontfamilys` + +Defaults to `:match`. + +### [plot_titlefonthalign](@id plotattr_plot_titlefonthalign) +```julia +plot_titlefonthalign :: Any +``` +**Aliases:** `plot_titlefonthaligns` `plottitlefonthaligns` + +Defaults to `:hcenter`. + +### [plot_titlefontrotation](@id plotattr_plot_titlefontrotation) +```julia +plot_titlefontrotation :: Any +``` +**Aliases:** `plot_titlefontrotations` `plottitlefontrotations` + +Defaults to `0.0`. + +### [plot_titlefontsize](@id plotattr_plot_titlefontsize) +```julia +plot_titlefontsize :: Any +``` +**Aliases:** `plot_titlefontsizes` `plottitlefontsizes` + +Defaults to `16`. + +### [plot_titlefontvalign](@id plotattr_plot_titlefontvalign) +```julia +plot_titlefontvalign :: Any +``` +**Aliases:** `plot_titlefontvaligns` `plottitlefontvaligns` + +Defaults to `:vcenter`. + +### [plot_titleindex](@id plotattr_plot_titleindex) +```julia +plot_titleindex :: Any +``` +**Aliases:** `plot_titleindexs` `plottitleindexs` + +Defaults to `0`. + +### [plot_titlelocation](@id plotattr_plot_titlelocation) +```julia +plot_titlelocation :: Any +``` +**Aliases:** `plot_titlelocations` `plottitlelocations` + +Defaults to `:center`. + +### [plot_titlevspan](@id plotattr_plot_titlevspan) +```julia +plot_titlevspan :: Real +``` +**Aliases:** `plot_titlevspans` `plottitlevspans` + +Vertical span of the whole plot title (fraction of the plot height). + +Defaults to `0.05`. + +### [pos](@id plotattr_pos) +```julia +pos :: Tuple{Integer, Integer} +``` + +`(left_px, top_px)` position of the GUI window (note: currently unimplemented). + +Defaults to `(0, 0)`. + +### [show](@id plotattr_show) +```julia +show :: Bool +``` +**Aliases:** `display` `gui` `shows` + +Should this command open/refresh a GUI/display? Allows to display plots in scripts or functions without explicitly calling `display`. + +Defaults to `false`. + +### [size](@id plotattr_size) +```julia +size :: Tuple{Integer, Integer} +``` +**Aliases:** `sizes` `windowsize` `wsize` + +`(width_px, height_px)` of the whole Plot. + +Defaults to `(600, 400)`. + +### [tex_output_standalone](@id plotattr_tex_output_standalone) +```julia +tex_output_standalone :: Bool +``` +**Aliases:** `tex_output_standalones` `texoutputstandalones` + +When writing TeX output, should the source include a preamble for a standalone document class? + +Defaults to `false`. + +### [thickness_scaling](@id plotattr_thickness_scaling) +```julia +thickness_scaling :: Real +``` +**Aliases:** `thickness_scalings` `thicknessscalings` + +Scale for the thickness of all line elements like lines, borders, axes, grid lines, etc. + +Defaults to `1`. + +### [warn_on_unsupported](@id plotattr_warn_on_unsupported) +```julia +warn_on_unsupported :: Bool +``` +**Aliases:** `warn` `warn_on_unsupporteds` `warnonunsupporteds` + +Warn on unsupported attributes, series types, and marker shapes. + +Defaults to `true`. + +### [window_title](@id plotattr_window_title) +```julia +window_title :: AbstractString +``` +**Aliases:** `window_titles` `windowtitle` `windowtitles` `wtitle` + +Title of the standalone gui-window. + +Defaults to `"Plots.jl"`. From 34f9afe3327c1000e65a101c498b9590b13c037c Mon Sep 17 00:00:00 2001 From: Andrew J <42456097+Ininterrompue@users.noreply.github.com> Date: Tue, 13 Dec 2022 20:58:26 -0800 Subject: [PATCH 09/12] Update axis attributes --- docs/src/Attributes/attributes_axis.md | 499 +++++++++++++++++++++++++ docs/src/Attributes/attributes_plot.md | 2 +- 2 files changed, 500 insertions(+), 1 deletion(-) diff --git a/docs/src/Attributes/attributes_axis.md b/docs/src/Attributes/attributes_axis.md index e69de29bb2..04e45923dc 100644 --- a/docs/src/Attributes/attributes_axis.md +++ b/docs/src/Attributes/attributes_axis.md @@ -0,0 +1,499 @@ + +# Axis Attributes + +These attributes apply by default to all Axes in a Subplot (for example, the `subplot[:xaxis]`). + +For all attributes on this page, you can specify the x, y, or z-axis for each of these attributes by prefixing the attribute name with x, y, or z. For example, `xmirror` only sets the mirror attribute for the x-axis. + +## Contents + +| Attribute | Aliases | +| :--- | :--- | +| [`discrete_values`](@ref axisattr_discrete_values) | | +| [`draw_arrow`](@ref axisattr_draw_arrow) | | +| [`flip`](@ref axisattr_flip) | | +| [`foreground_color_axis`](@ref axisattr_foreground_color_axis) | `axiscolor` `fg_axis` `fg_color_axis` `fg_colour_axis` `fgaxis` `fgcolor_axis` `fgcoloraxis` `fgcolour_axis` `fgcolouraxis` `foreground_axis` `foreground_colour_axis` `foregroundaxis` `foregroundcolouraxis` | +| [`foreground_color_border`](@ref axisattr_foreground_color_border) | `bordercolor` `fg_border` `fg_color_border` `fg_colour_border` `fgborder` `fgcolor_border` `fgcolorborder` `fgcolour_border` `fgcolourborder` `foreground_border` `foreground_colour_border` `foregroundborder` `foregroundcolourborder` | +| [`foreground_color_grid`](@ref axisattr_foreground_color_grid) | `fg_color_grid` `fg_colour_grid` `fg_grid` `fgcolor_grid` `fgcolorgrid` `fgcolour_grid` `fgcolourgrid` `fggrid` `foreground_colour_grid` `foreground_grid` `foregroundcolourgrid` `foregroundgrid` `gridcolor` | +| [`foreground_color_guide`](@ref axisattr_foreground_color_guide) | `fg_color_guide` `fg_colour_guide` `fg_guide` `fgcolor_guide` `fgcolorguide` `fgcolour_guide` `fgcolourguide` `fgguide` `foreground_colour_guide` `foreground_guide` `foregroundcolourguide` `foregroundguide` `guidecolor` | +| [`foreground_color_minor_grid`](@ref axisattr_foreground_color_minor_grid) | `fg_color_minorgrid` `fg_colour_minor_grid` `fg_minor_grid` `fgcolor_minorgrid` `fgcolorminorgrid` `fgcolour_minorgrid` `fgcolourminorgrid` `fgminorgrid` `foreground_colour_minor_grid` `foreground_minorgrid` `foregroundcolourminorgrid` `foregroundminorgrid` `minorgridcolor` | +| [`foreground_color_text`](@ref axisattr_foreground_color_text) | `fg_color_text` `fg_colour_text` `fg_text` `fgcolor_text` `fgcolortext` `fgcolour_text` `fgcolourtext` `fgtext` `foreground_colour_text` `foreground_text` `foregroundcolourtext` `foregroundtext` `textcolor` | +| [`formatter`](@ref axisattr_formatter) | | +| [`grid`](@ref axisattr_grid) | | +| [`gridalpha`](@ref axisattr_gridalpha) | `ga` `galpha` `gopacity` `gridopacity` `gα` | +| [`gridlinewidth`](@ref axisattr_gridlinewidth) | `grid_linewidth` `grid_lw` `grid_width` `gridlinewidth` `gridlw` `gridwidth` | +| [`gridstyle`](@ref axisattr_gridstyle) | `grid_linestyle` `grid_ls` `grid_style` `gridlinestyle` `gridls` `gridstyle` | +| [`guide`](@ref axisattr_guide) | | +| [`guide_position`](@ref axisattr_guide_position) | | +| [`guidefontcolor`](@ref axisattr_guidefontcolor) | | +| [`guidefontfamily`](@ref axisattr_guidefontfamily) | | +| [`guidefonthalign`](@ref axisattr_guidefonthalign) | | +| [`guidefontrotation`](@ref axisattr_guidefontrotation) | | +| [`guidefontsize`](@ref axisattr_guidefontsize) | `labelfontsize` | +| [`guidefontvalign`](@ref axisattr_guidefontvalign) | | +| [`lims`](@ref axisattr_lims) | `lim` `limit` `limits` `range` | +| [`link`](@ref axisattr_link) | `links` | +| [`minorgrid`](@ref axisattr_minorgrid) | | +| [`minorgridalpha`](@ref axisattr_minorgridalpha) | | +| [`minorgridlinewidth`](@ref axisattr_minorgridlinewidth) | `minorgrid_linewidth` `minorgrid_lw` `minorgrid_width` `minorgridlinewidth` `minorgridlw` `minorgridwidth` | +| [`minorgridstyle`](@ref axisattr_minorgridstyle) | `minorgrid_linestyle` `minorgrid_ls` `minorgrid_style` `minorgridlinestyle` `minorgridls` `minorgridstyle` | +| [`minorticks`](@ref axisattr_minorticks) | | +| [`mirror`](@ref axisattr_mirror) | | +| [`rotation`](@ref axisattr_rotation) | `r` `rot` | +| [`scale`](@ref axisattr_scale) | | +| [`showaxis`](@ref axisattr_showaxis) | | +| [`tick_direction`](@ref axisattr_tick_direction) | `tick_dir` `tick_or` `tick_orientation` `tickdir` `tickdirection` `tickor` `tickorientation` | +| [`tickfontcolor`](@ref axisattr_tickfontcolor) | | +| [`tickfontfamily`](@ref axisattr_tickfontfamily) | | +| [`tickfonthalign`](@ref axisattr_tickfonthalign) | | +| [`tickfontrotation`](@ref axisattr_tickfontrotation) | | +| [`tickfontsize`](@ref axisattr_tickfontsize) | | +| [`tickfontvalign`](@ref axisattr_tickfontvalign) | | +| [`ticks`](@ref axisattr_ticks) | `tick` | +| [`widen`](@ref axisattr_widen) | | + +## Foreground Attributes + +### [foreground_color_axis](@id axisattr_foreground_color_axis) +```julia +foreground_color_axis :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} +``` +**Aliases:** `axiscolor` `fg_axis` `fg_color_axis` `fg_colour_axis` `fgaxis` `fgcolor_axis` `fgcoloraxis` `fgcolour_axis` `fgcolouraxis` `foreground_axis` `foreground_colour_axis` `foregroundaxis` `foregroundcolouraxis` + +Color of axis ticks. `:match` matches `:foreground_color_subplot`. + +Defaults to `:match`. + +### [foreground_color_border](@id axisattr_foreground_color_border) +```julia +foreground_color_border :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} +``` +**Aliases:** `bordercolor` `fg_border` `fg_color_border` `fg_colour_border` `fgborder` `fgcolor_border` `fgcolorborder` `fgcolour_border` `fgcolourborder` `foreground_border` `foreground_colour_border` `foregroundborder` `foregroundcolourborder` + +Color of plot area border/spines. `:match` matches `:foreground_color_subplot`. + +Defaults to `:match`. + +### [foreground_color_grid](@id axisattr_foreground_color_grid) +```julia +foreground_color_grid :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} +``` +**Aliases:** `fg_color_grid` `fg_colour_grid` `fg_grid` `fgcolor_grid` `fgcolorgrid` `fgcolour_grid` `fgcolourgrid` `fggrid` `foreground_colour_grid` `foreground_grid` `foregroundcolourgrid` `foregroundgrid` `gridcolor` + +Color of grid lines. `:match` matches `:foreground_color_subplot`. + +Defaults to `:match`. + +### [foreground_color_guide](@id axisattr_foreground_color_guide) +```julia +foreground_color_guide :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} +``` +**Aliases:** `fg_color_guide` `fg_colour_guide` `fg_guide` `fgcolor_guide` `fgcolorguide` `fgcolour_guide` `fgcolourguide` `fgguide` `foreground_colour_guide` `foreground_guide` `foregroundcolourguide` `foregroundguide` `guidecolor` + +Color of axis guides/labels. `:match` matches `:foreground_color_subplot`. + +Defaults to `:match`. + +### [foreground_color_minor_grid](@id axisattr_foreground_color_minor_grid) +```julia +foreground_color_minor_grid :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} +``` +**Aliases:** `fg_color_minorgrid` `fg_colour_minor_grid` `fg_minor_grid` `fgcolor_minorgrid` `fgcolorminorgrid` `fgcolour_minorgrid` `fgcolourminorgrid` `fgminorgrid` `foreground_colour_minor_grid` `foreground_minorgrid` `foregroundcolourminorgrid` `foregroundminorgrid` `minorgridcolor` + +Color of minor grid lines. `:match` matches `:foreground_color_subplot`. + +Defaults to `:match`. + +### [foreground_color_text](@id axisattr_foreground_color_text) +```julia +foreground_color_text :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} +``` +**Aliases:** `fg_color_text` `fg_colour_text` `fg_text` `fgcolor_text` `fgcolortext` `fgcolour_text` `fgcolourtext` `fgtext` `foreground_colour_text` `foreground_text` `foregroundcolourtext` `foregroundtext` `textcolor` + +Color of tick labels. `:match` matches `:foreground_color_subplot`. + +Defaults to `:match`. + +## Grid Attributes + +### [grid](@id axisattr_grid) +```julia +grid :: Union{Bool, AbstractString, Symbol} +``` + +Defines the grid lines. + +Defaults to `true`. + +Choose from the following: + * `true` `false` `:show` `:hide` `:yes` `:no` `:x` `:y` `:z` `:xy` ... `:all` `:none` `:off` + +### [gridalpha](@id axisattr_gridalpha) +```julia +gridalpha :: Real +``` +**Aliases:** `ga` `galpha` `gopacity` `gridopacity` `gα` + +The alpha/opacity override for the grid lines. + +Defaults to `0.1`. + +### [gridlinewidth](@id axisattr_gridlinewidth) +```julia +gridlinewidth :: Real +``` +**Aliases:** `grid_linewidth` `grid_lw` `grid_width` `gridlw` `gridwidth` + +Width of the grid lines (in pixels). + +Defaults to `0.5`. + +### [gridstyle](@id axisattr_gridstyle) +```julia +gridstyle :: Symbol +``` +**Aliases:** `grid_linestyle` `grid_ls` `grid_style` `gridlinestyle` `gridls` + +Style of the grid lines. + +Defaults to `:solid`. + +Choose from the following: +* `:auto` `:solid` `:dash` `:dot` `:dashdot` `:dashdotdot` + +### [minorgrid](@id axisattr_minorgrid) +```julia +minorgrid :: Bool +``` + +Adds minor grid lines and ticks to the plot. Set `minorticks` to change number of gridlines. + +Defaults to `false`. + +### [minorgridalpha](@id axisattr_minorgridalpha) +```julia +minorgridalpha :: Real +``` + +The alpha/opacity override for the minorgrid lines. + +Defaults to `0.05`. + +### [minorgridlinewidth](@id axisattr_minorgridlinewidth) +```julia +minorgridlinewidth :: Real +``` +**Aliases:** `minorgrid_linewidth` `minorgrid_lw` `minorgrid_width` `minorgridlinewidth` `minorgridlw` `minorgridwidth` + +Width of the minor grid lines (in pixels). + +Defaults to `0.5`. + +### [minorgridstyle](@id axisattr_minorgridstyle) +```julia +minorgridlinewidth :: Symbol +``` +**Aliases:** `minorgrid_linestyle` `minorgrid_ls` `minorgrid_style` `minorgridlinestyle` `minorgridls` `minorgridstyle` + +Style of the minor grid lines. + +Defaults to `:solid`. + +Choose from the following: +* `:auto` `:solid` `:dash` `:dot` `:dashdot` `:dashdotdot` + +## Guide (Axes Label) Attributes + +### [guide](@id axisattr_guide) +```julia +guide :: AbstractString +``` + +Axis guide (label). + +Defaults to `""` (empty string). + +### [guide_position](@id axisattr_guide_position) +```julia +guide_position :: Symbol +``` + +Position of axis guides. + +Defaults to `:auto`. + +Choose from the following: +* `:top` `:bottom` `:left` `:right` + +### [guidefontcolor](@id axisattr_guidefontcolor) +```julia +guidefontcolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} +``` + +Font color of axes guides. + +Defaults to `:match`. + +### [guidefontfamily](@id axisattr_guidefontfamily) +```julia +guidefontfamily :: Union{AbstractString, Symbol} +``` + +Font family of axes guides. + +Defaults to `:match`. + +### [guidefonthalign](@id axisattr_guidefonthalign) +```julia +guidefonthalign :: Symbol +``` + +Font horizontal alignment of axes guides. + +Defaults to `:hcenter`. + +Choose from the following: +* `:hcenter` `:left` `:right` `:center` + +### [guidefontrotation](@id axisattr_guidefontrotation) +```julia +guidefontrotation :: Real +``` + +Font rotation of axes guides. + +Defaults to `0.0`. + +### [guidefontsize](@id axisattr_guidefontsize) +```julia +guidefontsize :: Integer +``` +**Aliases:** `labelfontsize` + +Font pointsize of axes guides. + +Defaults to `11`. + +### [guidefontvalign](@id axisattr_guidefontvalign) +```julia +guidefontvalign :: Symbol +``` + +Font vertical alignment of axes guides. + +Defaults to `:vcenter`. + +Choose from the following: +* `:vcenter` `:top` `:bottom` `:center` + +## Tick Attributes + +### [minorticks](@id axisattr_minorticks) +```julia +minorticks :: Integer +``` + +Number of minor intervals between major ticks. + +Defaults to `:auto`. + +### [tick_direction](@id axisattr_tick_direction) +```julia +tick_direction :: Integer +``` +**Aliases:** `tick_dir` `tick_or` `tick_orientation` `tickdir` `tickdirection` `tickor` `tickorientation` + +Direction of the ticks. + +Defaults to `in`. + +Choose from the following: +* `:in` `:out` `:none` + +### [tickfontcolor](@id axisattr_tickfontcolor) +```julia +tickfontcolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} +``` + +Font color of tick labels. + +Defaults to `:match`. + +### [tickfontfamily](@id axisattr_tickfontfamily) +```julia +tickfontfamily :: Union{AbstractString, Symbol} +``` + +Font family of tick labels. + +Defaults to `:match`. + +### [tickfonthalign](@id axisattr_tickfonthalign) +```julia +tickfonthalign :: Symbol +``` + +Font horizontal alignment of tick labels. + +Defaults to `:hcenter`. + +Choose from the following: +* `:hcenter` `:left` `:right` `:center` + +### [tickfontrotation](@id axisattr_tickfontrotation) +```julia +tickfontrotation :: Real +``` + +Font rotation of tick labels. + +Defaults to `0.0`. + +### [tickfontsize](@id axisattr_tickfontsize) +```julia +tickfontsize :: Integer +``` + +Font pointsize of tick labels. + +Defaults to `8`. + +### [tickfontvalign](@id axisattr_tickfontvalign) +```julia +tickfontvalign :: Symbol +``` + +Font vertical alignment of tick labels. + +Defaults to `:vcenter`. + +Choose from the following: +* `:vcenter` `:top` `:bottom` `:center` + +### [ticks](@id axisattr_ticks) +```julia +ticks :: Union{Symbol, Tuple{AbstractVector{Real}, AbstractVector{AbstractString}}, AbstractVector{Real}} +``` +**Aliases:** `tick` + +Tick values `(tickvalues, ticklabels)`, or `:auto`. + +Defaults to `:auto`. + +## Other Axis Attributes + +### [discrete_values](@id axisattr_discrete_values) +```julia +discrete_values :: Any +``` + +Defaults to `Any[]`. + +### [draw_arrow](@id axisattr_draw_arrow) +```julia +draw_arrow :: Bool +``` + +Draw arrow at the end of the axis. + +Defaults to `false`. + +### [flip](@id axisattr_flip) +```julia +flip :: Bool +``` + +Flips (reverses) the axis. + +Defaults to `false`. + +### [formatter](@id axisattr_formatter) +```julia +formatter :: Union{Function, Symbol} +``` + +Choose from `:scientific`, `:plain`, `:auto`, or a method which converts a number to a string for tick labeling. + +Defaults to `:auto`. + +### [lims](@id axisattr_lims) +```julia +lims :: Union{Symbol, Tuple{Real, Real}} +``` +**Aliases:** `lim` `limit` `limits` `range` + +Force axis limits. Only finite values are used (for example, you can set only the right limit with `xlims = (-Inf, 2)`). `:round` widens the limit to the nearest round number, i.e. `[0.1,3.6]=>[0.0,4.0]`. `:symmetric` sets the limits to be symmetric around zero. Set `widen=true` to widen the specified limits (which occurs when limits are not specified). + +Defaults to `:auto`. + +### [link](@id axisattr_link) +```julia +link :: Symbol +``` +**Aliases:** `links` + +How/whether to link axis limits between subplots. + +Defaults to `Any[]`. + +Choose from the following: +* `:none` +* `:x` – x axes are linked by columns +* `:y` – y axes are linked by rows +* `:both` – x and y are linked +* `:all` – every subplot is linked together regardless of layout position + +### [mirror](@id axisattr_mirror) +```julia +mirror :: Bool +``` + +Switch the side of the tick labels (right or top). + +Defaults to `false`. + +### [rotation](@id axisattr_rotation) +```julia +rotation :: Real +``` +**Aliases:** `r` `rot` + +Degrees rotation of tick labels. + +Defaults to `0.0`. + +### [scale](@id axisattr_scale) +```julia +scale :: Symbol +``` + +Scale of the axis. + +Defaults to `:identity`. + +Choose from the following: +* `:identity` (linear scale) +* `:ln` `:log2` `:log10` +* `:asinh` +* `:sqrt` + +### [showaxis](@id axisattr_showaxis) +```julia +showaxis :: Union{Bool, AbstractString, Symbol} +``` + +Show the axis. + +Defaults to `true`. + +Choose from the following: + * `true` `false` `:show` `:hide` `:yes` `:no` `:x` `:y` `:z` `:xy` ... `:all` `:none` `:off` + +### [widen](@id axisattr_widen) +```julia +widen :: Union{Real, Symbol} +``` + +Widen the axis limits by a small factor to avoid cut-off markers and lines at the borders. If set to `true`, scale the axis limits by the default factor of `Base.RefValue{Float64}(1.06)`. A different factor may be specified by setting `widen` to a number. `:auto` widens by the default factor unless limits were manually set. See also the `scale_limits!` function for scaling axis limits in an existing plot. + +Defaults to `:auto`. diff --git a/docs/src/Attributes/attributes_plot.md b/docs/src/Attributes/attributes_plot.md index 6610e8675a..1154e8ba09 100644 --- a/docs/src/Attributes/attributes_plot.md +++ b/docs/src/Attributes/attributes_plot.md @@ -21,7 +21,7 @@ A Plot contains a tree-like layout of Subplots. These attributes apply to the fu | [`link`](@ref plotattr_link) | `links` | | [`overwrite_figure`](@ref plotattr_overwrite_figure) | `clearfig` `clf` `overwrite` `overwrite_figures` `overwritefigures` `reuse` | | [`plot_title`](@ref plotattr_plot_title) | `plot_titles` `plottitles` | -| [`plot_titlefontcolor`](@ref plotattr_plot_titlefontcolor) | `plot_titlefontcolors` `plottitlefontcolors` | +| [`plot_titlefontcolor`](@ref plotattr_plot_titlefontcolor) | `plot_titlefontcolors` `plottitlefontcolors` | | [`plot_titlefontfamily`](@ref plotattr_plot_titlefontfamily) | `plot_titlefontfamilys` `plottitlefontfamilys` | | [`plot_titlefonthalign`](@ref plotattr_plot_titlefonthalign) | `plot_titlefonthaligns` `plottitlefonthaligns` | | [`plot_titlefontrotation`](@ref plotattr_plot_titlefontrotation) | `plot_titlefontrotations` `plottitlefontrotations` | From 5d4ed4efd688e50b8c02c59d1d16c58122e8b48f Mon Sep 17 00:00:00 2001 From: Andrew J <42456097+Ininterrompue@users.noreply.github.com> Date: Wed, 14 Dec 2022 14:56:40 -0800 Subject: [PATCH 10/12] Update subplot attributes --- docs/src/Attributes/attributes_axis.md | 2 +- docs/src/Attributes/attributes_subplot.md | 847 ++++++++++++++++++++++ 2 files changed, 848 insertions(+), 1 deletion(-) diff --git a/docs/src/Attributes/attributes_axis.md b/docs/src/Attributes/attributes_axis.md index 04e45923dc..f046917653 100644 --- a/docs/src/Attributes/attributes_axis.md +++ b/docs/src/Attributes/attributes_axis.md @@ -202,7 +202,7 @@ Defaults to `:solid`. Choose from the following: * `:auto` `:solid` `:dash` `:dot` `:dashdot` `:dashdotdot` -## Guide (Axes Label) Attributes +## Guide (Axis Label) Attributes ### [guide](@id axisattr_guide) ```julia diff --git a/docs/src/Attributes/attributes_subplot.md b/docs/src/Attributes/attributes_subplot.md index e69de29bb2..a60e164023 100644 --- a/docs/src/Attributes/attributes_subplot.md +++ b/docs/src/Attributes/attributes_subplot.md @@ -0,0 +1,847 @@ + +# Subplot Attributes + +These attributes apply to settings for individual Subplots. These include attributes related to annotations, colorbars, legends, margins, and titles, as well as a few others. + +## Contents + +| Attribute | Aliases | +| :--- | :--- | +| [`annotationcolor`](@ref subplotattr_annotationcolor) | `annotationcolors` | +| [`annotationfontfamily`](@ref subplotattr_annotationfontfamily) | `annotationfontfamilys` | +| [`annotationfontsize`](@ref subplotattr_annotationfontsize) | `annotationfontsizes` | +| [`annotationhalign`](@ref subplotattr_annotationhalign) | `annotationhaligns` | +| [`annotationrotation`](@ref subplotattr_annotationrotation) | `annotationrotations` | +| [`annotations`](@ref subplotattr_annotations) | `ann` `annotate` `annotation` `anns` | +| [`annotationvalign`](@ref subplotattr_annotationvalign) | `annotationvaligns` | +| [`aspect_ratio`](@ref subplotattr_aspect_ratio) | `aspect_ratios` `aspectratio` `aspectratios` `axis_ratio` `axisratio` `ratio` | +| [`background_color_inside`](@ref subplotattr_background_color_inside) | `background_color_insides` `background_colour_inside` `background_inside` `backgroundcolorinsides` `backgroundcolourinside` `backgroundinside` `bg_color_inside` `bg_colour_inside` `bg_inside` `bgcolor_inside` `bgcolorinside` `bgcolour_inside` `bgcolourinside` `bginside` | +| [`background_color_subplot`](@ref subplotattr_background_color_subplot) | `background_color_subplots` `background_colour_subplot` `background_subplot` `backgroundcolorsubplots` `backgroundcoloursubplot` `backgroundsubplot` `bg_color_subplot` `bg_colour_subplot` `bg_subplot` `bgcolor_subplot` `bgcolorsubplot` `bgcolour_subplot` `bgcoloursubplot` `bgsubplot` | +| [`bottom_margin`](@ref subplotattr_bottom_margin) | `bottom_margins` `bottommargin` `bottommargins` | +| [`camera`](@ref subplotattr_camera) | `cam` `cameras` `view_angle` `viewangle` | +| [`clims`](@ref subplotattr_clims) | `cbar_lims` `cbarlims` `clim` `climits` `color_limits` `colorlimits` | +| [`color_palette`](@ref subplotattr_color_palette) | `color_palettes` `colorpalettes` `palette` | +| [`colorbar`](@ref subplotattr_colorbar) | `cb` `cbar` `colorbars` `colorkey` | +| [`colorbar_continuous_values`](@ref subplotattr_colorbar_continuous_values) | | +| [`colorbar_discrete_values`](@ref subplotattr_colorbar_discrete_values) | | +| [`colorbar_fontfamily`](@ref subplotattr_colorbar_fontfamily) | `colorbar_fontfamilys` `colorbarfontfamilys` | +| [`colorbar_formatter`](@ref subplotattr_colorbar_formatter) | `colorbar_formatters` `colorbarformatters` | +| [`colorbar_scale`](@ref subplotattr_colorbar_scale) | `colorbar_scales` `colorbarscales` | +| [`colorbar_tickfontcolor`](@ref subplotattr_colorbar_tickfontcolor) | `colorbar_tickfontcolors` `colorbartickfontcolors` | +| [`colorbar_tickfontfamily`](@ref subplotattr_colorbar_tickfontfamily) | `colorbar_tickfontfamilys` `colorbartickfontfamilys` | +| [`colorbar_tickfonthalign`](@ref subplotattr_colorbar_tickfonthalign) | `colorbar_tickfonthaligns` `colorbartickfonthaligns` | +| [`colorbar_tickfontrotation`](@ref subplotattr_colorbar_tickfontrotation) | `colorbar_tickfontrotations` `colorbartickfontrotations` | +| [`colorbar_tickfontsize`](@ref subplotattr_colorbar_tickfontsize) | `colorbar_tickfontsizes` `colorbartickfontsizes` | +| [`colorbar_tickfontvalign`](@ref subplotattr_colorbar_tickfontvalign) | `colorbar_tickfontvaligns` `colorbartickfontvaligns` | +| [`colorbar_ticks`](@ref subplotattr_colorbar_ticks) | | +| [`colorbar_title`](@ref subplotattr_colorbar_title) | `cb_title` `cbar_title` `cbartitle` `cbtitle` `colorbar_titles` `colorbartitle` `colorbartitles` `colorkey_title` `colorkeytitle` | +| [`colorbar_title_location`](@ref subplotattr_colorbar_title_location) | `colorbar_title_locations` `colorbartitlelocations` | +| [`colorbar_titlefontcolor`](@ref subplotattr_colorbar_titlefontcolor) | `colorbar_titlefontcolors` `colorbartitlefontcolors` | +| [`colorbar_titlefontfamily`](@ref subplotattr_colorbar_titlefontfamily) | `colorbar_titlefontfamilys` `colorbartitlefontfamilys` | +| [`colorbar_titlefonthalign`](@ref subplotattr_colorbar_titlefonthalign) | `colorbar_titlefonthaligns` `colorbartitlefonthaligns` | +| [`colorbar_titlefontrotation`](@ref subplotattr_colorbar_titlefontrotation) | `colorbar_titlefontrotations` `colorbartitlefontrotations` | +| [`colorbar_titlefontsize`](@ref subplotattr_colorbar_titlefontsize) | `colorbar_titlefontsizes` `colorbartitlefontsizes` | +| [`colorbar_titlefontvalign`](@ref subplotattr_colorbar_titlefontvalign) | `colorbar_titlefontvaligns` `colorbartitlefontvaligns` | +| [`extra_kwargs`](@ref subplotattr_extra_kwargs) | | +| [`fontfamily_subplot`](@ref subplotattr_fontfamily_subplot) | `fontfamily_subplots` `fontfamilysubplots` | +| [`foreground_color_subplot`](@ref subplotattr_foreground_color_subplot) | `fg_color_subplot` `fg_colour_subplot` `fg_subplot` `fgcolor_subplot` `fgcolorsubplot` `fgcolour_subplot` `fgcoloursubplot` `fgsubplot` `foreground_color_subplots` `foreground_colour_subplot` `foreground_subplot` `foregroundcolorsubplots` `foregroundcoloursubplot` `foregroundsubplot` | +| [`foreground_color_title`](@ref subplotattr_foreground_color_title) | `fg_color_title` `fg_colour_title` `fg_title` `fgcolor_title` `fgcolortitle` `fgcolour_title` `fgcolourtitle` `fgtitle` `foreground_color_titles` `foreground_colour_title` `foreground_title` `foregroundcolortitles` `foregroundcolourtitle` `foregroundtitle` `titlecolor` | +| [`framestyle`](@ref subplotattr_framestyle) | `axes_style` `axesstyle` `border` `border_style` `borderstyle` `box` `box_style` `boxstyle` `frame` `frame_style` `framestyle` `framestyles` | +| [`left_margin`](@ref subplotattr_left_margin) | `left_margins` `leftmargin` `leftmargins` | +| [`legend_background_color`](@ref subplotattr_legend_background_color) | `background_color_legend` `background_colour_legend` `background_legend` `backgroundcolorlegend` `backgroundcolourlegend` `backgroundlegend` `bg_color_legend` `bg_colour_legend` `bg_legend` `bgcolor_legend` `bgcolorlegend` `bgcolour_legend` `bgcolourlegend` `bglegend` `legend_background_colors` `legendbackgroundcolor` `legendbackgroundcolors` | +| [`legend_column`](@ref subplotattr_legend_column) | `legend_columns` `legendcolumn` `legendcolumns` | +| [`legend_font`](@ref subplotattr_legend_font) | `legend_fonts` `legendfont` `legendfonts` | +| [`legend_font_color`](@ref subplotattr_legend_font_color) | `legend_font_colors` `legendfontcolor` `legendfontcolors` | +| [`legend_font_family`](@ref subplotattr_legend_font_family) | `legend_font_familys` `legendfontfamily` `legendfontfamilys` | +| [`legend_font_halign`](@ref subplotattr_legend_font_halign) | `legend_font_haligns` `legendfonthalign` `legendfonthaligns` | +| [`legend_font_pointsize`](@ref subplotattr_legend_font_pointsize) | `legend_font_pointsizes` `legendfontpointsize` `legendfontpointsizes` `legendfontsize` | +| [`legend_font_rotation`](@ref subplotattr_legend_font_rotation) | `legend_font_rotations` `legendfontrotation` `legendfontrotations` | +| [`legend_font_valign`](@ref subplotattr_legend_font_valign) | `legend_font_valigns` `legendfontvalign` `legendfontvaligns` | +| [`legend_foreground_color`](@ref subplotattr_legend_foreground_color) | `fg_color_legend` `fg_colour_legend` `fg_legend` `fgcolor_legend` `fgcolorlegend` `fgcolour_legend` `fgcolourlegend` `fglegend` `foreground_color_legend` `foreground_colour_legend` `foreground_legend` `foregroundcolorlegend` `foregroundcolourlegend` `foregroundlegend` `legend_foreground_colors` `legendforegroundcolor` `legendforegroundcolors` | +| [`legend_position`](@ref subplotattr_legend_position) | `key` `leg` `legend` `legend_positions` `legendposition` `legendpositions` `legends` | +| [`legend_title`](@ref subplotattr_legend_title) | `key_title` `keytitle` `label_title` `labeltitle` `leg_title` `legend_titles` `legendtitle` `legendtitles` `legtitle` | +| [`legend_title_font`](@ref subplotattr_legend_title_font) | `legend_title_fonts` `legendtitlefont` `legendtitlefonts` | +| [`legend_title_font_color`](@ref subplotattr_legend_title_font_color) | `legend_title_font_colors` `legendtitlefontcolor` `legendtitlefontcolors` | +| [`legend_title_font_family`](@ref subplotattr_legend_title_font_family) | `legend_title_font_familys` `legendtitlefontfamily` `legendtitlefontfamilys` | +| [`legend_title_font_halign`](@ref subplotattr_legend_title_font_halign) | `legend_title_font_haligns` `legendtitlefonthalign` `legendtitlefonthaligns` | +| [`legend_title_font_pointsize`](@ref subplotattr_legend_title_font_pointsize) | `legend_title_font_pointsizes` `legendtitlefontpointsize` `legendtitlefontpointsizes` `legendtitlefontsize` | +| [`legend_title_font_rotation`](@ref subplotattr_legend_title_font_rotation) | `legend_title_font_rotations` `legendtitlefontrotation` `legendtitlefontrotations` | +| [`legend_title_font_valign`](@ref subplotattr_legend_title_font_valign) | `legend_title_font_valigns` `legendtitlefontvalign` `legendtitlefontvaligns` | +| [`margin`](@ref subplotattr_margin) | `margins` | +| [`projection`](@ref subplotattr_projection) | `proj` `projections` | +| [`projection_type`](@ref subplotattr_projection_type) | `proj_type` `projection_types` `projectiontypes` `projtype` | +| [`right_margin`](@ref subplotattr_right_margin) | `right_margins` `rightmargin` `rightmargins` | +| [`subplot_index`](@ref subplotattr_subplot_index) | `subplot_indexs` `subplotindexs` | +| [`title`](@ref subplotattr_title) | `titles` | +| [`titlefontcolor`](@ref subplotattr_titlefontcolor) | `titlefontcolors` | +| [`titlefontfamily`](@ref subplotattr_titlefontfamily) | `titlefontfamilys` | +| [`titlefonthalign`](@ref subplotattr_titlefonthalign) | `titlefonthaligns` | +| [`titlefontrotation`](@ref subplotattr_titlefontrotation) | `titlefontrotations` | +| [`titlefontsize`](@ref subplotattr_titlefontsize) | `titlefontsizes` | +| [`titlefontvalign`](@ref subplotattr_titlefontvalign) | `titlefontvaligns` | +| [`titlelocation`](@ref subplotattr_titlelocation) | `title_align` `title_alignment` `title_loc` `title_location` `title_pos` `title_position` `titlealign` `titlealignment` `titleloc` `titlelocation` `titlelocations` `titlepos` `titleposition` | +| [`top_margin`](@ref subplotattr_top_margin) | `top_margins` `topmargin` `topmargins` | + +## Annotation Attributes + +### [annotationcolor](@id subplotattr_annotationcolor) +```julia +annotationcolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} +``` +**Aliases:** `annotationcolors` + +Annotations color. + +Defaults to `:match`. + +### [annotationfontfamily](@id subplotattr_annotationfontfamily) +```julia +annotationfontfamily :: Union{AbstractString, Symbol} +``` +**Aliases:** `annotationfontfamilys` + +Font family of annotations. + +Defaults to `:match`. + +### [annotationfontsize](@id subplotattr_annotationfontsize) +```julia +annotationfontsize :: Integer +``` +**Aliases:** `annotationfontsizes` + +Font pointsize of annotations. + +Defaults to `14`. + +### [annotationhalign](@id subplotattr_annotationhalign) +```julia +annotationhalign :: Symbol +``` +**Aliases:** `annotationhaligns` + +horizontal alignment of annotations. + +Defaults to `:hcenter`. + +Choose from the following: +* `:hcenter` `:left` `:right` `:center` + +### [annotationrotation](@id subplotattr_annotationrotation) +```julia +annotationrotation :: Real +``` +**Aliases:** `annotationrotations` + +Rotation of annotations in degrees. + +Defaults to `0.0`. + +### [annotations](@id subplotattr_annotations) +```julia +annotations :: Union{Tuple{Real, Real, Union{AbstractString, Tuple, Plots.PlotText}}, AbstractVector{Tuple}} +``` +**Aliases:** `ann` `annotate` `annotation` `anns` + +`(x, y, text)` tuple(s), where text can be `String`, `PlotText` (created with `text(args...)`), or a tuple of arguments to `text` (e.g. `("Label", 8, :red, :top)`). Add one-off text annotations at the (x, y) coordinates. + +Defaults to `Any[]`. + +### [annotationvalign](@id subplotattr_annotationvalign) +```julia +annotationvalign :: Symbol +``` +**Aliases:** `annotationvaligns` + +Vertical alignment of annotations. + +Defaults to `:vcenter`. + +Choose from the following: +* `:vcenter` `:top` `:bottom` `:center` + +## Colorbar Attributes + +### [clims](@id subplotattr_clims) +```julia +clims :: Union{Function, Symbol, Tuple{Real, Real}} +``` +**Aliases:** `cbar_lims` `cbarlims` `clim` `climits` `color_limits` `colorlimits` + +Fixes the limits of the colorbar: values, `:auto`, or a function taking series data in and returning an `NTuple{2, Real}`. + +Defaults to `:auto`. + +### [colorbar](@id subplotattr_colorbar) +```julia +colorbar :: Union{Bool, Symbol} +``` +**Aliases:** `cbar_lims` `cbarlims` `clim` `climits` `color_limits` `colorlimits` + +Show the colorbar. A symbol specifies a colorbar position. + +Defaults to `:legend`. + +Choose from the following (note: only some may be supported in each backend): +* `:none` +* `:best` +* `:right` `:left` `:top` `:bottom` +* `:legend` – matches legend value + +### [colorbar_continuous_values](@id subplotattr_colorbar_continuous_values) +```julia +colorbar_continuous_values :: Any +``` + +Defaults to `Float64[]`. + +### [colorbar_discrete_values](@id subplotattr_colorbar_discrete_values) +```julia +colorbar_discrete_values :: Any +``` + +Defaults to `Any[]`. + +### [colorbar_fontfamily](@id subplotattr_colorbar_fontfamily) +```julia +colorbar_fontfamily :: Union{AbstractString, Symbol} +``` +**Aliases:** `colorbar_fontfamilys` `colorbarfontfamilys` + +Font family of colobar entries. + +Defaults to `:match`. + +### [colorbar_formatter](@id subplotattr_colorbar_formatter) +```julia +colorbar_formatter :: Union{Function, Symbol} +``` +**Aliases:** `colorbar_fontfamilys` `colorbarfontfamilys` + +Choose from `:scientific`, `:plain`, `:none`, `:auto`, or a method which converts a number to a string for tick labeling. + +Defaults to `:auto`. + +### [colorbar_scale](@id subplotattr_colorbar_scale) +```julia +colorbar_scale :: Symbol +``` +**Aliases:** `colorbar_scales` `colorbarscales` + +Scale of the colorbar axis. + +Defaults to `:identity`. + +Choose from the following: +* `:identity` +* `:ln` `:log2` `:log10` +* `:asinh` +* `:sqrt` + +### [colorbar_tickfontcolor](@id subplotattr_colorbar_tickfontcolor) +```julia +colorbar_tickfontcolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} +``` +**Aliases:** `colorbar_tickfontcolors` `colorbartickfontcolors` + +Font color of colorbar tick entries. + +Defaults to `:match`. + +### [colorbar_tickfontfamily](@id subplotattr_colorbar_tickfontfamily) +```julia +colorbar_tickfontfamily :: Union{AbstractString, Symbol} +``` +**Aliases:** `colorbar_tickfontfamilys` `colorbartickfontfamilys` + +Font family of colorbar tick labels. + +Defaults to `:match`. + +### [colorbar_tickfonthalign](@id subplotattr_colorbar_tickfonthalign) +```julia +colorbar_tickfonthalign :: Any +``` +**Aliases:** `colorbar_tickfonthaligns` `colorbartickfonthaligns` + +Defaults to `:hcenter`. + +### [colorbar_tickfontrotation](@id subplotattr_colorbar_tickfontrotation) +```julia +colorbar_tickfontrotation :: Any +``` +**Aliases:** `colorbar_tickfontrotations` `colorbartickfontrotations` + +Defaults to `0.0`. + +### [colorbar_tickfontsize](@id subplotattr_colorbar_tickfontsize) +```julia +colorbar_tickfontsize :: Integer +``` +**Aliases:** `colorbar_tickfontsizes` `colorbartickfontsizes` + +Font pointsize of colorbar tick entries. + +Defaults to `8`. + +### [colorbar_tickfontvalign](@id subplotattr_colorbar_tickfontvalign) +```julia +colorbar_tickfontvalign :: Any +``` +**Aliases:** `colorbar_tickfontvaligns` `colorbartickfontvaligns` + +Defaults to `:vcenter`. + +### [colorbar_ticks](@id subplotattr_colorbar_ticks) +```julia +colorbar_ticks :: Union{Symbol, Tuple{AbstractVector{Real}, AbstractVector{AbstractString}}, AbstractVector{Real}} +``` + +Tick values, `(tickvalues, ticklabels)`, or `:auto`. + +Defaults to `:auto`. + +### [colorbar_title](@id subplotattr_colorbar_title) +```julia +colorbar_title :: AbstractString +``` +**Aliases:** `cb_title` `cbar_title` `cbartitle` `cbtitle` `colorbar_titles` `colorbartitle` `colorbartitles` `colorkey_title` `colorkeytitle` + +Title of colorbar. + +Defaults to `""` (empty string). + +### [colorbar_title_location](@id subplotattr_colorbar_title_location) +```julia +colorbar_title_location :: Any +``` +**Aliases:** `colorbar_title_locations` `colorbartitlelocations` + +Defaults to `:center`. + +### [colorbar_titlefontcolor](@id subplotattr_colorbar_titlefontcolor) +```julia +colorbar_titlefontcolor :: Any +``` +**Aliases:** `colorbar_titlefontcolors` `colorbartitlefontcolors` + +Defaults to `:match`. + +### [colorbar_titlefontfamily](@id subplotattr_colorbar_titlefontfamily) +```julia +colorbar_titlefontfamily :: Any +``` +**Aliases:** `colorbar_titlefontfamilys` `colorbartitlefontfamilys` + +Defaults to `:match`. + +### [colorbar_titlefonthalign](@id subplotattr_colorbar_titlefonthalign) +```julia +colorbar_titlefonthalign :: Any +``` +**Aliases:** `colorbar_titlefonthaligns` `colorbartitlefonthaligns` + +Defaults to `:hcenter`. + +### [colorbar_titlefontrotation](@id subplotattr_colorbar_titlefontrotation) +```julia +colorbar_titlefontrotation :: Any +``` +**Aliases:** `colorbar_titlefontrotations` `colorbartitlefontrotations` + +Defaults to `0.0`. + +### [colorbar_titlefontsize](@id subplotattr_colorbar_titlefontsize) +```julia +colorbar_titlefontsize :: Any +``` +**Aliases:** `colorbar_titlefontsizes` `colorbartitlefontsizes` + +Defaults to `10`. + +### [colorbar_titlefontvalign](@id subplotattr_colorbar_titlefontvalign) +```julia +colorbar_titlefontvalign :: Any +``` +**Aliases:** `colorbar_titlefontvaligns` `colorbartitlefontvaligns` + +Defaults to `:vcenter`. + +## Legend Attributes + +### [legend_background_color](@id subplotattr_legend_background_color) +```julia +legend_background_color :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} +``` +**Aliases:** `background_color_legend` `background_colour_legend` `background_legend` `backgroundcolorlegend` `backgroundcolourlegend` `backgroundlegend` `bg_color_legend` `bg_colour_legend` `bg_legend` `bgcolor_legend` `bgcolorlegend` `bgcolour_legend` `bgcolourlegend` `bglegend` `legend_background_colors` `legendbackgroundcolor` `legendbackgroundcolors` + +Background color of the legend. `:match` matches :background_color_subplot`. + +Defaults to `:match`. + +### [legend_column](@id subplotattr_legend_column) +```julia +legend_column :: Integer +``` +**Aliases:** `legend_columns` `legendcolumn` `legendcolumns` + +Number of columns in the legend. `-1` stands for maximum number of columns (horizontal legend). + +Defaults to `1`. + +### [legend_font](@id subplotattr_legend_font) +```julia +legend_font :: Plots.Font +``` +**Aliases:** `legend_fonts` `legendfont` `legendfonts` + +Font of legend items. + +Defaults to `Plots.Font("sans-serif", 8, :hcenter, :vcenter, 0.0, RGB{N0f8}(0.0,0.0,0.0))`. + +### [legend_font_color](@id subplotattr_legend_font_color) +```julia +legend_font_color :: Any +``` +**Aliases:** `legend_font_colors` `legendfontcolor` `legendfontcolors` + +Defaults to `:match`. + +### [legend_font_family](@id subplotattr_legend_font_family) +```julia +legend_font_family :: Union{AbstractString, Symbol} +``` +**Aliases:** `legend_font_familys` `legendfontfamily` `legendfontfamilys` + +Font family of legend entries. + +Defaults to `:match`. + +### [legend_font_halign](@id subplotattr_legend_font_halign) +```julia +legend_font_halign :: Symbol +``` +**Aliases:** `legend_font_haligns` `legendfonthalign` `legendfonthaligns` + +Font horizontal alignment of legend entries. + +Defaults to `:hcenter`. + +Choose from the following: +* `:hcenter` `:left` `:right` `:center` + +### [legend_font_pointsize](@id subplotattr_legend_font_pointsize) +```julia +legend_font_pointsize :: Integer +``` +**Aliases:** `legend_font_pointsizes` `legendfontpointsize` `legendfontpointsizes` `legendfontsize` + +Font pointsize of legend entries. + +Defaults to `8`. + +### [legend_font_rotation](@id subplotattr_legend_font_rotation) +```julia +legend_font_rotation :: Real +``` +**Aliases:** `legend_font_rotations` `legendfontrotation` `legendfontrotations` + +Font rotation of legend entries. + +Defaults to `0.0`. + +### [legend_font_valign](@id subplotattr_legend_font_valign) +```julia +legend_font_valign :: Symbol +``` +**Aliases:** `legend_font_valigns` `legendfontvalign` `legendfontvaligns` + +Font vertical alignment of legend entries. + +Defaults to `:vcenter`. + +Choose from the following: +* `:vcenter` `:top` `:bottom` `:center` + +### [legend_foreground_color](@id subplotattr_legend_foreground_color) +```julia +legend_foreground_color :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} +``` +**Aliases:** `fg_color_legend` `fg_colour_legend` `fg_legend` `fgcolor_legend` `fgcolorlegend` `fgcolour_legend` `fgcolourlegend` `fglegend` `foreground_color_legend` `foreground_colour_legend` `foreground_legend` `foregroundcolorlegend` `foregroundcolourlegend` `foregroundlegend` `legend_foreground_colors` `legendforegroundcolor` `legendforegroundcolors` + +Foreground color of the legend. `:match` matches :foreground_color_subplot`. + +Defaults to `:match`. + +### [legend_position](@id subplotattr_legend_position) +```julia +legend_position :: Union{Bool, Symbol, Tuple{Real, Real}} +``` +**Aliases:** `key` `leg` `legend` `legend_positions` `legendposition` `legendpositions` `legends` + +Show the legend. Can also be an `(x, y)` tuple or `Symbol` (legend position) or angle `(angle, inout)` tuple. Bottom left corner of legend is placed at `(x, y)`. Choose from (`:none`, `:best`, `:inline`, `:inside`, `:legend`) or any valid combination of `:(outer ?)(top/bottom ?)(right/left ?)`, i.e.: `:top`, `:topright`, `:outerleft`, `:outerbottomright` ... (note: only some may be supported in each backend) + +Defaults to `:best`. + +### [legend_title](@id subplotattr_legend_title) +```julia +legend_title :: AbstractString +``` +**Aliases:** `key_title` `keytitle` `label_title` `labeltitle` `leg_title` `legend_titles` `legendtitle` `legendtitles` `legtitle` + +Legend title. + +Defaults to `nothing`. + +### [legend_title_font](@id subplotattr_legend_title_font) +```julia +legend_title_font :: Plots.Font +``` +**Aliases:** `legend_title_fonts` `legendtitlefont` `legendtitlefonts` + +Font of the legend title. + +Defaults to `Plots.Font("sans-serif", 11, :hcenter, :vcenter, 0.0, RGB{N0f8}(0.0,0.0,0.0))`. + +### [legend_title_font_color](@id subplotattr_legend_title_font_color) +```julia +legend_title_font_color :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} +``` +**Aliases:** `legend_title_font_colors` `legendtitlefontcolor` `legendtitlefontcolors` + +Font color of the legend title. + +Defaults to `:match`. + +### [legend_title_font_family](@id subplotattr_legend_title_font_family) +```julia +legend_title_font_family :: Union{AbstractString, Symbol} +``` +**Aliases:** `legend_title_font_familys` `legendtitlefontfamily` `legendtitlefontfamilys` + +Font family of the legend title. + +Defaults to `:match`. + +### [legend_title_font_halign](@id subplotattr_legend_title_font_halign) +```julia +legend_title_font_halign :: Symbol +``` +**Aliases:** `legend_title_font_haligns` `legendtitlefonthalign` `legendtitlefonthaligns` + +Font horizontal alignment of the legend title. + +Defaults to `:hcenter`. + +Choose from the following: +* `:hcenter` `:left` `:right` `:center` + +### [legend_title_font_pointsize](@id subplotattr_legend_title_font_pointsize) +```julia +legend_title_font_pointsize :: Integer +``` +**Aliases:** `legend_title_font_pointsizes` `legendtitlefontpointsize` `legendtitlefontpointsizes` `legendtitlefontsize` + +Font pointsize of the legend title. + +Defaults to `11`. + +### [legend_title_font_rotation](@id subplotattr_legend_title_font_rotation) +```julia +legend_title_font_rotation :: Real +``` +**Aliases:** `legend_title_font_rotations` `legendtitlefontrotation` `legendtitlefontrotations` + +Font rotation of the legend title. + +Defaults to `0.0`. + +### [legend_title_font_valign](@id subplotattr_legend_title_font_valign) +```julia +legend_title_font_valign :: Symbol +``` +**Aliases:** `legend_title_font_valigns` `legendtitlefontvalign` `legendtitlefontvaligns` + +Font vertical alignment of the legend title. + +Defaults to `:vcenter`. + +Choose from the following: +* `:vcenter` `:top` `:bottom` `:center` + +## Margin Attributes + +### [bottom_margin](@id subplotattr_bottom_margin) +```julia +bottom_margin :: Union{Real, Symbol, Tuple} +``` +**Aliases:** `bottom_margins` `bottommargin` `bottommargins` + +Specifies the extra padding on the bottom of the subplot. `:match` matches `:margin`. + +Defaults to `:match`. + +### [left_margin](@id subplotattr_left_margin) +```julia +left_margin :: Union{Real, Symbol, Tuple} +``` +**Aliases:** `left_margins` `leftmargin` `leftmargins` + +Specifies the extra padding on the left of the subplot. `:match` matches `:margin`. + +Defaults to `:match`. + +### [margin](@id subplotattr_margin) +```julia +margin :: Union{Real, Tuple} +``` +**Aliases:** `margins` + +Number multiplied by `mm`, `px`, etc... or `Tuple` `(0, :mm)`. Base for individual margins (not directly used). Specifies the extra padding around subplots. + +Defaults to `1.0mm`. + +### [right_margin](@id subplotattr_right_margin) +```julia +right_margin :: Union{Real, Symbol, Tuple} +``` +**Aliases:** `right_margins` `rightmargin` `rightmargins` + +Specifies the extra padding on the right of the subplot. `:match` matches `:margin`. + +Defaults to `:match`. + +### [top_margin](@id subplotattr_top_margin) +```julia +top_margin :: Union{Real, Symbol, Tuple} +``` +**Aliases:** `top_margins` `topmargin` `topmargins` + +Specifies the extra padding on the top of the subplot. `:match` matches `:margin`. + +Defaults to `:match`. + +## Title Attributes + +### [title](@id subplotattr_title) +```julia +title :: AbstractString +``` +**Aliases:** `titles` + +Subplot title. + +Defaults to `""` (empty string). + +### [titlefontcolor](@id subplotattr_titlefontcolor) +```julia +titlefontcolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} +``` +**Aliases:** `titlefontcolors` + +Font color of subplot title. + +Defaults to `:match`. + +### [titlefontfamily](@id subplotattr_titlefontfamily) +```julia +titlefontfamily :: Union{AbstractString, Symbol} +``` +**Aliases:** `titlefontfamilys` + +Font family of subplot title. + +Defaults to `:match`. + +### [titlefonthalign](@id subplotattr_titlefonthalign) +```julia +titlefonthalign :: Symbol +``` +**Aliases:** `titlefonthaligns` + +Font horizontal alignment of subplot title. + +Defaults to `:hcenter`. + +Choose from the following: +* `:hcenter` `:left` `:right` `:center` + +### [titlefontrotation](@id subplotattr_titlefontrotation) +```julia +titlefontrotation :: Real +``` +**Aliases:** `titlefontrotations` + +Font rotation of subplot title. + +Defaults to `0.0`. + +### [titlefontsize](@id subplotattr_titlefontsize) +```julia +titlefontsize :: Integer +``` +**Aliases:** `titlefontrotations` + +Font pointsize of subplot title. + +Defaults to `14`. + +### [titlefontvalign](@id subplotattr_titlefontvalign) +```julia +titlefontvalign :: Symbol +``` +**Aliases:** `titlefontvaligns` + +Font vertical alignment of subplot title. + +Defaults to `:vcenter`. + +Choose from the following: +* `:vcenter` `:top` `:bottom` `:center` + +### [titlelocation](@id subplotattr_titlelocation) +```julia +titlelocation :: Symbol +``` +**Aliases:** `title_align` `title_alignment` `title_loc` `title_location` `title_pos` `title_position` `titlealign` `titlealignment` `titleloc` `titlelocation` `titlelocations` `titlepos` `titleposition` + +Position of subplot title. + +Defaults to `:center`. + +Choose from the following: +* `:left` `:center` `:right` + +## 3D-Specific Attributes + +### [camera](@id subplotattr_camera) +```julia +camera :: Tuple{Real, Real} +``` +**Aliases:** `cam` `cameras` `view_angle` `viewangle` + +Sets the view angle `(azimuthal, elevation)` for 3D plots. + +Defaults to `(30, 30)`. + +### [projection](@id subplotattr_projection) +```julia +projection :: Union{AbstractString, Symbol} +``` +**Aliases:** `proj` `projections` + +`3d` or `polar`. + +Defaults to `:none`. + +### [projection_type](@id subplotattr_projection_type) +```julia +projection_type :: Symbol +``` +**Aliases:** `proj_type` `projection_types` `projectiontypes` `projtype` + +3d plots projection type: :auto (backend dependent), :persp(ective), :ortho(graphic). + +Defaults to `:auto`. + +## Other Subplot Attributes + +### [aspect_ratio](@id subplotattr_aspect_ratio) +```julia +aspect_ratio :: Union{Real, Symbol} +``` +**Aliases:** `aspect_ratios` `aspectratio` `aspectratios` `axis_ratio` `axisratio` `ratio` + +Plot area is resized so that 1 y-unit is the same size as `aspect_ratio` x-units. With `:none`, images inherit aspect ratio of the plot area. Use `:equal` for unit aspect ratio. + +Defaults to `:auto`. + +### [background_color_inside](@id subplotattr_background_color_inside) +```julia +background_color_inside :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} +``` +**Aliases:** `background_color_insides` `background_colour_inside` `background_inside` `backgroundcolorinsides` `backgroundcolourinside` `backgroundinside` `bg_color_inside` `bg_colour_inside` `bg_inside` `bgcolor_inside` `bgcolorinside` `bgcolour_inside` `bgcolourinside` `bginside` + +Background color inside the plot area (under the grid).`:match` matches :background_color_subplot`. + +Defaults to `:match`. + +### [background_color_subplot](@id subplotattr_background_color_subplot) +```julia +background_color_subplot :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} +``` +**Aliases:** `background_color_subplots` `background_colour_subplot` `background_subplot` `backgroundcolorsubplots` `backgroundcoloursubplot` `backgroundsubplot` `bg_color_subplot` `bg_colour_subplot` `bg_subplot` `bgcolor_subplot` `bgcolorsubplot` `bgcolour_subplot` `bgcoloursubplot` `bgsubplot` + +Base background color of the subplot.`:match` matches `:background_color`. + +Defaults to `:match`. + +### [color_palette](@id subplotattr_color_palette) +```julia +color_palette :: Union{Symbol, AbstractVector{Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant}}} +``` +**Aliases:** `color_palettes` `colorpalettes` `palette` + +Iterable (cycle through) or color gradient (generate list from gradient) or `:auto` (generate a color list using `Colors.distiguishable_colors` and custom seed colors chosen to contrast with the background). The color palette is a color list from which series colors are automatically chosen. + +Defaults to `:auto`. + +### [extra_kwargs](@id subplotattr_extra_kwargs) +```julia +extra_kwargs :: Symbol +``` + +Specify for which element extra keyword args are collected or a KW (`Dict{Symbol, Any}`) to pass a map of extra keyword args which may be specific to a backend. Choose from `:plot`, `:subplot`, `:series`, defaults to `:series`. Example: `pgfplotsx(); scatter(1:5, extra_kwargs=Dict(:subplot=>Dict("axis line shift" => "10pt"))`. + +Defaults to `Dict{Any, Any}()`. + +### [fontfamily_subplot](@id subplotattr_fontfamily_subplot) +```julia +fontfamily_subplot :: Any +``` +**Aliases:** `fontfamily_subplots` `fontfamilysubplots` + +Defaults to `:match`. + +### [foreground_color_subplot](@id subplotattr_foreground_color_subplot) +```julia +foreground_color_subplot :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} +``` +**Aliases:** `fg_color_subplot` `fg_colour_subplot` `fg_subplot` `fgcolor_subplot` `fgcolorsubplot` `fgcolour_subplot` `fgcoloursubplot` `fgsubplot` `foreground_color_subplots` `foreground_colour_subplot` `foreground_subplot` `foregroundcolorsubplots` `foregroundcoloursubplot` `foregroundsubplot` + +Base foreground color of the subplot. `:match` matches :foreground_color`. + +Defaults to `:match`. + +### [foreground_color_title](@id subplotattr_foreground_color_title) +```julia +foreground_color_title :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} +``` +**Aliases:** `fg_color_title` `fg_colour_title` `fg_title` `fgcolor_title` `fgcolortitle` `fgcolour_title` `fgcolourtitle` `fgtitle` `foreground_color_titles` `foreground_colour_title` `foreground_title` `foregroundcolortitles` `foregroundcolourtitle` `foregroundtitle` `titlecolor` + +Color of subplot title. `:match` matches :foreground_color_subplot`. + +Defaults to `:match`. + +### [framestyle](@id subplotattr_framestyle) +```julia +framestyle :: Symbol +``` +**Aliases:** `axes_style` `axesstyle` `border` `border_style` `borderstyle` `box` `box_style` `boxstyle` `frame` `frame_style` `framestyle` `framestyles` + +Style of the axes frame. + +Defaults to `:axes`. + +Choose from the following: +* `:box` `:semi` `:axes` `:origin` `:zerolines` `:grid` `:none` + +### [subplot_index](@id subplotattr_subplot_index) +```julia +subplot_index :: Integer +``` +**Aliases:** `subplot_indexs` `subplotindexs` + +Internal (not set by user). Specifies the index of this subplot in the Plot's `plt.subplot` list. + +Defaults to `-1`. From badc36505e3be2517c87cb3925b7e0a2ccb29bc1 Mon Sep 17 00:00:00 2001 From: Andrew J <42456097+Ininterrompue@users.noreply.github.com> Date: Wed, 14 Dec 2022 15:17:17 -0800 Subject: [PATCH 11/12] Update make.jl --- docs/make.jl | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/make.jl b/docs/make.jl index 0c4de7dab5..2628b2a4a6 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -656,14 +656,17 @@ function main() "Histograms" => "series_types/histogram.md", ], ], + "Attributes" => [ + "Introduction" => "Attributes/attributes.md", + "Series Attributes" => "Attributes/attributes_series.md", + "Plot Attributes" => "Attributes/attributes_plot.md", + "Subplot Attributes" => "Attributes/attributes_subplot.md", + "Axis Attributes" => "Attributes/attributes_axis.md", + "Supported Attributes" => "generated/supported.md", + ], "Manual" => [ "Input Data" => "input_data.md", "Output" => "output.md", - "Attributes" => "attributes.md", - "Series Attributes" => "generated/attributes_series.md", - "Plot Attributes" => "generated/attributes_plot.md", - "Subplot Attributes" => "generated/attributes_subplot.md", - "Axis Attributes" => "generated/attributes_axis.md", "Layouts" => "layouts.md", "Recipes" => [ "Overview" => "recipes.md", @@ -684,7 +687,6 @@ function main() "Animations" => "animations.md", "Themes" => "generated/plotthemes.md", "Backends" => "backends.md", - "Supported Attributes" => "generated/supported.md", ], "Learning" => "learning.md", "Contributing" => "contributing.md", From 8ca1f7b7114ba2bff8fa237b9cca829a67052250 Mon Sep 17 00:00:00 2001 From: Andrew J <42456097+Ininterrompue@users.noreply.github.com> Date: Thu, 15 Dec 2022 12:58:02 -0800 Subject: [PATCH 12/12] update make.jl --- docs/make.jl | 57 +- docs/src/Attributes/attributes_axis.md | 499 ------------- docs/src/Attributes/attributes_plot.md | 327 --------- docs/src/Attributes/attributes_series.md | 657 ----------------- docs/src/Attributes/attributes_subplot.md | 847 ---------------------- 5 files changed, 39 insertions(+), 2348 deletions(-) delete mode 100644 docs/src/Attributes/attributes_axis.md delete mode 100644 docs/src/Attributes/attributes_plot.md delete mode 100644 docs/src/Attributes/attributes_series.md delete mode 100644 docs/src/Attributes/attributes_subplot.md diff --git a/docs/make.jl b/docs/make.jl index 2628b2a4a6..fae93309dc 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -311,7 +311,7 @@ function make_attr_df(ktype::Symbol, defs::KW) aliases = sort(collect(keys(filter(p -> p.second == k, Plots._keyAliases)))) df.Attribute[i] = string(k) - df.Aliases[i] = join(aliases, ", ") + df.Aliases[i] = join(aliases, " ") df.Default[i] = show_default(def) df.Type[i] = string(type) df.Description[i] = string(desc) @@ -326,14 +326,13 @@ show_default(x::Symbol) = surround_backticks(":$x") function generate_attr_markdown(c) attribute_texts = Dict( - :Series => "These attributes apply to individual series (lines, scatters, heatmaps, etc)", - :Plot => "These attributes apply to the full Plot. (A Plot contains a tree-like layout of Subplots)", - :Subplot => "These attributes apply to settings for individual Subplots.", + :Series => "Series attributes apply to individual series, such as lines, scatters, heatmaps, etc. The detailed documentation may also contain a list of series types for which the given attribute is relevant.", + :Plot => "A Plot contains a tree-like layout of Subplots. These attributes apply to the full Plot.", + :Subplot => "These attributes apply to settings for individual Subplots. These include attributes related to annotations, colorbars, legends, margins, and titles, as well as a few others.", :Axis => """ - These attributes apply by default to all Axes in a Subplot (for example the `subplot[:xaxis]`). + These attributes apply by default to all Axes in a Subplot (for example, the `subplot[:xaxis]`). !!! info - You can also specific the x, y, or z axis for each of these attributes by prefixing the attribute name with x, y, or z - (for example `xmirror` only sets the mirror attribute for the x axis). + For all attributes on this page, you can specify the x, y, or z-axis for each of these attributes by prefixing the attribute name with x, y, or z. For example, `xmirror` only sets the mirror attribute for the x-axis. """, ) attribute_defaults = Dict( @@ -352,17 +351,39 @@ function generate_attr_markdown(c) ```@meta EditURL = "$(edit_url())" ``` - ### $c + # $c Attributes $(attribute_texts[c]) - ```@raw html - $(to_html(df)) - ``` + ## Contents - $(autogenerated()) - """ - ) + | Attribute | Aliases | + | :-------- | :------ | + """) + for row in eachrow(df) + write(md, """ + | [`$(row.Attribute)`](@ref $(cstr)_$(row.Attribute)) | $(row.Aliases) | + """) + end + write(md, """ + ## Documentation + + """) + for row in eachrow(df) + write(md, """ + ### [$(row.Attribute)](@id $(cstr)_$(row.Attribute)) + ```julia + $(row.Attribute) :: $(row.Type) + ``` + **Aliases:** $(row.Aliases) + + Defaults to $(row.Default). + + $(row.Description) + + """) + end + write(md, "$(autogenerated())") end end @@ -658,10 +679,10 @@ function main() ], "Attributes" => [ "Introduction" => "Attributes/attributes.md", - "Series Attributes" => "Attributes/attributes_series.md", - "Plot Attributes" => "Attributes/attributes_plot.md", - "Subplot Attributes" => "Attributes/attributes_subplot.md", - "Axis Attributes" => "Attributes/attributes_axis.md", + "Series Attributes" => "generated/attributes_series.md", + "Plot Attributes" => "generated/attributes_plot.md", + "Subplot Attributes" => "generated/attributes_subplot.md", + "Axis Attributes" => "generated/attributes_axis.md", "Supported Attributes" => "generated/supported.md", ], "Manual" => [ diff --git a/docs/src/Attributes/attributes_axis.md b/docs/src/Attributes/attributes_axis.md deleted file mode 100644 index f046917653..0000000000 --- a/docs/src/Attributes/attributes_axis.md +++ /dev/null @@ -1,499 +0,0 @@ - -# Axis Attributes - -These attributes apply by default to all Axes in a Subplot (for example, the `subplot[:xaxis]`). - -For all attributes on this page, you can specify the x, y, or z-axis for each of these attributes by prefixing the attribute name with x, y, or z. For example, `xmirror` only sets the mirror attribute for the x-axis. - -## Contents - -| Attribute | Aliases | -| :--- | :--- | -| [`discrete_values`](@ref axisattr_discrete_values) | | -| [`draw_arrow`](@ref axisattr_draw_arrow) | | -| [`flip`](@ref axisattr_flip) | | -| [`foreground_color_axis`](@ref axisattr_foreground_color_axis) | `axiscolor` `fg_axis` `fg_color_axis` `fg_colour_axis` `fgaxis` `fgcolor_axis` `fgcoloraxis` `fgcolour_axis` `fgcolouraxis` `foreground_axis` `foreground_colour_axis` `foregroundaxis` `foregroundcolouraxis` | -| [`foreground_color_border`](@ref axisattr_foreground_color_border) | `bordercolor` `fg_border` `fg_color_border` `fg_colour_border` `fgborder` `fgcolor_border` `fgcolorborder` `fgcolour_border` `fgcolourborder` `foreground_border` `foreground_colour_border` `foregroundborder` `foregroundcolourborder` | -| [`foreground_color_grid`](@ref axisattr_foreground_color_grid) | `fg_color_grid` `fg_colour_grid` `fg_grid` `fgcolor_grid` `fgcolorgrid` `fgcolour_grid` `fgcolourgrid` `fggrid` `foreground_colour_grid` `foreground_grid` `foregroundcolourgrid` `foregroundgrid` `gridcolor` | -| [`foreground_color_guide`](@ref axisattr_foreground_color_guide) | `fg_color_guide` `fg_colour_guide` `fg_guide` `fgcolor_guide` `fgcolorguide` `fgcolour_guide` `fgcolourguide` `fgguide` `foreground_colour_guide` `foreground_guide` `foregroundcolourguide` `foregroundguide` `guidecolor` | -| [`foreground_color_minor_grid`](@ref axisattr_foreground_color_minor_grid) | `fg_color_minorgrid` `fg_colour_minor_grid` `fg_minor_grid` `fgcolor_minorgrid` `fgcolorminorgrid` `fgcolour_minorgrid` `fgcolourminorgrid` `fgminorgrid` `foreground_colour_minor_grid` `foreground_minorgrid` `foregroundcolourminorgrid` `foregroundminorgrid` `minorgridcolor` | -| [`foreground_color_text`](@ref axisattr_foreground_color_text) | `fg_color_text` `fg_colour_text` `fg_text` `fgcolor_text` `fgcolortext` `fgcolour_text` `fgcolourtext` `fgtext` `foreground_colour_text` `foreground_text` `foregroundcolourtext` `foregroundtext` `textcolor` | -| [`formatter`](@ref axisattr_formatter) | | -| [`grid`](@ref axisattr_grid) | | -| [`gridalpha`](@ref axisattr_gridalpha) | `ga` `galpha` `gopacity` `gridopacity` `gα` | -| [`gridlinewidth`](@ref axisattr_gridlinewidth) | `grid_linewidth` `grid_lw` `grid_width` `gridlinewidth` `gridlw` `gridwidth` | -| [`gridstyle`](@ref axisattr_gridstyle) | `grid_linestyle` `grid_ls` `grid_style` `gridlinestyle` `gridls` `gridstyle` | -| [`guide`](@ref axisattr_guide) | | -| [`guide_position`](@ref axisattr_guide_position) | | -| [`guidefontcolor`](@ref axisattr_guidefontcolor) | | -| [`guidefontfamily`](@ref axisattr_guidefontfamily) | | -| [`guidefonthalign`](@ref axisattr_guidefonthalign) | | -| [`guidefontrotation`](@ref axisattr_guidefontrotation) | | -| [`guidefontsize`](@ref axisattr_guidefontsize) | `labelfontsize` | -| [`guidefontvalign`](@ref axisattr_guidefontvalign) | | -| [`lims`](@ref axisattr_lims) | `lim` `limit` `limits` `range` | -| [`link`](@ref axisattr_link) | `links` | -| [`minorgrid`](@ref axisattr_minorgrid) | | -| [`minorgridalpha`](@ref axisattr_minorgridalpha) | | -| [`minorgridlinewidth`](@ref axisattr_minorgridlinewidth) | `minorgrid_linewidth` `minorgrid_lw` `minorgrid_width` `minorgridlinewidth` `minorgridlw` `minorgridwidth` | -| [`minorgridstyle`](@ref axisattr_minorgridstyle) | `minorgrid_linestyle` `minorgrid_ls` `minorgrid_style` `minorgridlinestyle` `minorgridls` `minorgridstyle` | -| [`minorticks`](@ref axisattr_minorticks) | | -| [`mirror`](@ref axisattr_mirror) | | -| [`rotation`](@ref axisattr_rotation) | `r` `rot` | -| [`scale`](@ref axisattr_scale) | | -| [`showaxis`](@ref axisattr_showaxis) | | -| [`tick_direction`](@ref axisattr_tick_direction) | `tick_dir` `tick_or` `tick_orientation` `tickdir` `tickdirection` `tickor` `tickorientation` | -| [`tickfontcolor`](@ref axisattr_tickfontcolor) | | -| [`tickfontfamily`](@ref axisattr_tickfontfamily) | | -| [`tickfonthalign`](@ref axisattr_tickfonthalign) | | -| [`tickfontrotation`](@ref axisattr_tickfontrotation) | | -| [`tickfontsize`](@ref axisattr_tickfontsize) | | -| [`tickfontvalign`](@ref axisattr_tickfontvalign) | | -| [`ticks`](@ref axisattr_ticks) | `tick` | -| [`widen`](@ref axisattr_widen) | | - -## Foreground Attributes - -### [foreground_color_axis](@id axisattr_foreground_color_axis) -```julia -foreground_color_axis :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} -``` -**Aliases:** `axiscolor` `fg_axis` `fg_color_axis` `fg_colour_axis` `fgaxis` `fgcolor_axis` `fgcoloraxis` `fgcolour_axis` `fgcolouraxis` `foreground_axis` `foreground_colour_axis` `foregroundaxis` `foregroundcolouraxis` - -Color of axis ticks. `:match` matches `:foreground_color_subplot`. - -Defaults to `:match`. - -### [foreground_color_border](@id axisattr_foreground_color_border) -```julia -foreground_color_border :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} -``` -**Aliases:** `bordercolor` `fg_border` `fg_color_border` `fg_colour_border` `fgborder` `fgcolor_border` `fgcolorborder` `fgcolour_border` `fgcolourborder` `foreground_border` `foreground_colour_border` `foregroundborder` `foregroundcolourborder` - -Color of plot area border/spines. `:match` matches `:foreground_color_subplot`. - -Defaults to `:match`. - -### [foreground_color_grid](@id axisattr_foreground_color_grid) -```julia -foreground_color_grid :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} -``` -**Aliases:** `fg_color_grid` `fg_colour_grid` `fg_grid` `fgcolor_grid` `fgcolorgrid` `fgcolour_grid` `fgcolourgrid` `fggrid` `foreground_colour_grid` `foreground_grid` `foregroundcolourgrid` `foregroundgrid` `gridcolor` - -Color of grid lines. `:match` matches `:foreground_color_subplot`. - -Defaults to `:match`. - -### [foreground_color_guide](@id axisattr_foreground_color_guide) -```julia -foreground_color_guide :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} -``` -**Aliases:** `fg_color_guide` `fg_colour_guide` `fg_guide` `fgcolor_guide` `fgcolorguide` `fgcolour_guide` `fgcolourguide` `fgguide` `foreground_colour_guide` `foreground_guide` `foregroundcolourguide` `foregroundguide` `guidecolor` - -Color of axis guides/labels. `:match` matches `:foreground_color_subplot`. - -Defaults to `:match`. - -### [foreground_color_minor_grid](@id axisattr_foreground_color_minor_grid) -```julia -foreground_color_minor_grid :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} -``` -**Aliases:** `fg_color_minorgrid` `fg_colour_minor_grid` `fg_minor_grid` `fgcolor_minorgrid` `fgcolorminorgrid` `fgcolour_minorgrid` `fgcolourminorgrid` `fgminorgrid` `foreground_colour_minor_grid` `foreground_minorgrid` `foregroundcolourminorgrid` `foregroundminorgrid` `minorgridcolor` - -Color of minor grid lines. `:match` matches `:foreground_color_subplot`. - -Defaults to `:match`. - -### [foreground_color_text](@id axisattr_foreground_color_text) -```julia -foreground_color_text :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} -``` -**Aliases:** `fg_color_text` `fg_colour_text` `fg_text` `fgcolor_text` `fgcolortext` `fgcolour_text` `fgcolourtext` `fgtext` `foreground_colour_text` `foreground_text` `foregroundcolourtext` `foregroundtext` `textcolor` - -Color of tick labels. `:match` matches `:foreground_color_subplot`. - -Defaults to `:match`. - -## Grid Attributes - -### [grid](@id axisattr_grid) -```julia -grid :: Union{Bool, AbstractString, Symbol} -``` - -Defines the grid lines. - -Defaults to `true`. - -Choose from the following: - * `true` `false` `:show` `:hide` `:yes` `:no` `:x` `:y` `:z` `:xy` ... `:all` `:none` `:off` - -### [gridalpha](@id axisattr_gridalpha) -```julia -gridalpha :: Real -``` -**Aliases:** `ga` `galpha` `gopacity` `gridopacity` `gα` - -The alpha/opacity override for the grid lines. - -Defaults to `0.1`. - -### [gridlinewidth](@id axisattr_gridlinewidth) -```julia -gridlinewidth :: Real -``` -**Aliases:** `grid_linewidth` `grid_lw` `grid_width` `gridlw` `gridwidth` - -Width of the grid lines (in pixels). - -Defaults to `0.5`. - -### [gridstyle](@id axisattr_gridstyle) -```julia -gridstyle :: Symbol -``` -**Aliases:** `grid_linestyle` `grid_ls` `grid_style` `gridlinestyle` `gridls` - -Style of the grid lines. - -Defaults to `:solid`. - -Choose from the following: -* `:auto` `:solid` `:dash` `:dot` `:dashdot` `:dashdotdot` - -### [minorgrid](@id axisattr_minorgrid) -```julia -minorgrid :: Bool -``` - -Adds minor grid lines and ticks to the plot. Set `minorticks` to change number of gridlines. - -Defaults to `false`. - -### [minorgridalpha](@id axisattr_minorgridalpha) -```julia -minorgridalpha :: Real -``` - -The alpha/opacity override for the minorgrid lines. - -Defaults to `0.05`. - -### [minorgridlinewidth](@id axisattr_minorgridlinewidth) -```julia -minorgridlinewidth :: Real -``` -**Aliases:** `minorgrid_linewidth` `minorgrid_lw` `minorgrid_width` `minorgridlinewidth` `minorgridlw` `minorgridwidth` - -Width of the minor grid lines (in pixels). - -Defaults to `0.5`. - -### [minorgridstyle](@id axisattr_minorgridstyle) -```julia -minorgridlinewidth :: Symbol -``` -**Aliases:** `minorgrid_linestyle` `minorgrid_ls` `minorgrid_style` `minorgridlinestyle` `minorgridls` `minorgridstyle` - -Style of the minor grid lines. - -Defaults to `:solid`. - -Choose from the following: -* `:auto` `:solid` `:dash` `:dot` `:dashdot` `:dashdotdot` - -## Guide (Axis Label) Attributes - -### [guide](@id axisattr_guide) -```julia -guide :: AbstractString -``` - -Axis guide (label). - -Defaults to `""` (empty string). - -### [guide_position](@id axisattr_guide_position) -```julia -guide_position :: Symbol -``` - -Position of axis guides. - -Defaults to `:auto`. - -Choose from the following: -* `:top` `:bottom` `:left` `:right` - -### [guidefontcolor](@id axisattr_guidefontcolor) -```julia -guidefontcolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} -``` - -Font color of axes guides. - -Defaults to `:match`. - -### [guidefontfamily](@id axisattr_guidefontfamily) -```julia -guidefontfamily :: Union{AbstractString, Symbol} -``` - -Font family of axes guides. - -Defaults to `:match`. - -### [guidefonthalign](@id axisattr_guidefonthalign) -```julia -guidefonthalign :: Symbol -``` - -Font horizontal alignment of axes guides. - -Defaults to `:hcenter`. - -Choose from the following: -* `:hcenter` `:left` `:right` `:center` - -### [guidefontrotation](@id axisattr_guidefontrotation) -```julia -guidefontrotation :: Real -``` - -Font rotation of axes guides. - -Defaults to `0.0`. - -### [guidefontsize](@id axisattr_guidefontsize) -```julia -guidefontsize :: Integer -``` -**Aliases:** `labelfontsize` - -Font pointsize of axes guides. - -Defaults to `11`. - -### [guidefontvalign](@id axisattr_guidefontvalign) -```julia -guidefontvalign :: Symbol -``` - -Font vertical alignment of axes guides. - -Defaults to `:vcenter`. - -Choose from the following: -* `:vcenter` `:top` `:bottom` `:center` - -## Tick Attributes - -### [minorticks](@id axisattr_minorticks) -```julia -minorticks :: Integer -``` - -Number of minor intervals between major ticks. - -Defaults to `:auto`. - -### [tick_direction](@id axisattr_tick_direction) -```julia -tick_direction :: Integer -``` -**Aliases:** `tick_dir` `tick_or` `tick_orientation` `tickdir` `tickdirection` `tickor` `tickorientation` - -Direction of the ticks. - -Defaults to `in`. - -Choose from the following: -* `:in` `:out` `:none` - -### [tickfontcolor](@id axisattr_tickfontcolor) -```julia -tickfontcolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} -``` - -Font color of tick labels. - -Defaults to `:match`. - -### [tickfontfamily](@id axisattr_tickfontfamily) -```julia -tickfontfamily :: Union{AbstractString, Symbol} -``` - -Font family of tick labels. - -Defaults to `:match`. - -### [tickfonthalign](@id axisattr_tickfonthalign) -```julia -tickfonthalign :: Symbol -``` - -Font horizontal alignment of tick labels. - -Defaults to `:hcenter`. - -Choose from the following: -* `:hcenter` `:left` `:right` `:center` - -### [tickfontrotation](@id axisattr_tickfontrotation) -```julia -tickfontrotation :: Real -``` - -Font rotation of tick labels. - -Defaults to `0.0`. - -### [tickfontsize](@id axisattr_tickfontsize) -```julia -tickfontsize :: Integer -``` - -Font pointsize of tick labels. - -Defaults to `8`. - -### [tickfontvalign](@id axisattr_tickfontvalign) -```julia -tickfontvalign :: Symbol -``` - -Font vertical alignment of tick labels. - -Defaults to `:vcenter`. - -Choose from the following: -* `:vcenter` `:top` `:bottom` `:center` - -### [ticks](@id axisattr_ticks) -```julia -ticks :: Union{Symbol, Tuple{AbstractVector{Real}, AbstractVector{AbstractString}}, AbstractVector{Real}} -``` -**Aliases:** `tick` - -Tick values `(tickvalues, ticklabels)`, or `:auto`. - -Defaults to `:auto`. - -## Other Axis Attributes - -### [discrete_values](@id axisattr_discrete_values) -```julia -discrete_values :: Any -``` - -Defaults to `Any[]`. - -### [draw_arrow](@id axisattr_draw_arrow) -```julia -draw_arrow :: Bool -``` - -Draw arrow at the end of the axis. - -Defaults to `false`. - -### [flip](@id axisattr_flip) -```julia -flip :: Bool -``` - -Flips (reverses) the axis. - -Defaults to `false`. - -### [formatter](@id axisattr_formatter) -```julia -formatter :: Union{Function, Symbol} -``` - -Choose from `:scientific`, `:plain`, `:auto`, or a method which converts a number to a string for tick labeling. - -Defaults to `:auto`. - -### [lims](@id axisattr_lims) -```julia -lims :: Union{Symbol, Tuple{Real, Real}} -``` -**Aliases:** `lim` `limit` `limits` `range` - -Force axis limits. Only finite values are used (for example, you can set only the right limit with `xlims = (-Inf, 2)`). `:round` widens the limit to the nearest round number, i.e. `[0.1,3.6]=>[0.0,4.0]`. `:symmetric` sets the limits to be symmetric around zero. Set `widen=true` to widen the specified limits (which occurs when limits are not specified). - -Defaults to `:auto`. - -### [link](@id axisattr_link) -```julia -link :: Symbol -``` -**Aliases:** `links` - -How/whether to link axis limits between subplots. - -Defaults to `Any[]`. - -Choose from the following: -* `:none` -* `:x` – x axes are linked by columns -* `:y` – y axes are linked by rows -* `:both` – x and y are linked -* `:all` – every subplot is linked together regardless of layout position - -### [mirror](@id axisattr_mirror) -```julia -mirror :: Bool -``` - -Switch the side of the tick labels (right or top). - -Defaults to `false`. - -### [rotation](@id axisattr_rotation) -```julia -rotation :: Real -``` -**Aliases:** `r` `rot` - -Degrees rotation of tick labels. - -Defaults to `0.0`. - -### [scale](@id axisattr_scale) -```julia -scale :: Symbol -``` - -Scale of the axis. - -Defaults to `:identity`. - -Choose from the following: -* `:identity` (linear scale) -* `:ln` `:log2` `:log10` -* `:asinh` -* `:sqrt` - -### [showaxis](@id axisattr_showaxis) -```julia -showaxis :: Union{Bool, AbstractString, Symbol} -``` - -Show the axis. - -Defaults to `true`. - -Choose from the following: - * `true` `false` `:show` `:hide` `:yes` `:no` `:x` `:y` `:z` `:xy` ... `:all` `:none` `:off` - -### [widen](@id axisattr_widen) -```julia -widen :: Union{Real, Symbol} -``` - -Widen the axis limits by a small factor to avoid cut-off markers and lines at the borders. If set to `true`, scale the axis limits by the default factor of `Base.RefValue{Float64}(1.06)`. A different factor may be specified by setting `widen` to a number. `:auto` widens by the default factor unless limits were manually set. See also the `scale_limits!` function for scaling axis limits in an existing plot. - -Defaults to `:auto`. diff --git a/docs/src/Attributes/attributes_plot.md b/docs/src/Attributes/attributes_plot.md deleted file mode 100644 index 1154e8ba09..0000000000 --- a/docs/src/Attributes/attributes_plot.md +++ /dev/null @@ -1,327 +0,0 @@ - -# Plot Attributes - -A Plot contains a tree-like layout of Subplots. These attributes apply to the full Plot. - -## Contents - -| Attribute | Aliases | -| :--- | :--- | -| [`background_color`](@ref plotattr_background_color) | `background` `background_colors` `background_colour` `backgroundcolors` `backgroundcolour` `bg` `bg_color` `bg_colour` `bgcolor` `bgcolour` | -| [`background_color_outside`](@ref plotattr_background_color_outside) | `background_color_outsides` `background_colour_outside` `background_outside` `backgroundcoloroutsides` `backgroundcolouroutside` `backgroundoutside` `bg_color_outside` `bg_colour_outside` `bg_outside` `bgcolor_outside` `bgcoloroutside` `bgcolour_outside` `bgcolouroutside` `bgoutside` | -| [`display_type`](@ref plotattr_display_type) | `display_types` `displaytypes` | -| [`dpi`](@ref plotattr_dpi) | `dpis` | -| [`extra_kwargs`](@ref plotattr_extra_kwargs) | | -| [`extra_plot_kwargs`](@ref plotattr_extra_plot_kwargs) | | -| [`fontfamily`](@ref plotattr_fontfamily) | `fontfamilys` | -| [`foreground_color`](@ref plotattr_foreground_color) | `fg` `fg_color` `fg_colour` `fgcolor` `fgcolour` `foreground` `foreground_colors` `foreground_colour` `foregroundcolors` `foregroundcolour` | -| [`html_output_format`](@ref plotattr_html_output_format) | `fmt` `format` `html_format` `html_output_formats` `htmlformat` `htmloutputformats` | -| [`inset_subplots`](@ref plotattr_inset_subplots) | `floating` `inset` | -| [`layout`](@ref plotattr_layout) | `layouts` | -| [`link`](@ref plotattr_link) | `links` | -| [`overwrite_figure`](@ref plotattr_overwrite_figure) | `clearfig` `clf` `overwrite` `overwrite_figures` `overwritefigures` `reuse` | -| [`plot_title`](@ref plotattr_plot_title) | `plot_titles` `plottitles` | -| [`plot_titlefontcolor`](@ref plotattr_plot_titlefontcolor) | `plot_titlefontcolors` `plottitlefontcolors` | -| [`plot_titlefontfamily`](@ref plotattr_plot_titlefontfamily) | `plot_titlefontfamilys` `plottitlefontfamilys` | -| [`plot_titlefonthalign`](@ref plotattr_plot_titlefonthalign) | `plot_titlefonthaligns` `plottitlefonthaligns` | -| [`plot_titlefontrotation`](@ref plotattr_plot_titlefontrotation) | `plot_titlefontrotations` `plottitlefontrotations` | -| [`plot_titlefontsize`](@ref plotattr_plot_titlefontsize) | `plot_titlefontsizes` `plottitlefontsizes` | -| [`plot_titlefontvalign`](@ref plotattr_plot_titlefontvalign) | `plot_titlefontvaligns` `plottitlefontvaligns` | -| [`plot_titleindex`](@ref plotattr_plot_titleindex) | `plot_titleindexs` `plottitleindexs` | -| [`plot_titlelocation`](@ref plotattr_plot_titlelocation) | `plot_titlelocations` `plottitlelocations` | -| [`plot_titlevspan`](@ref plotattr_plot_titlevspan) | `plot_titlevspans` `plottitlevspans` | -| [`pos`](@ref plotattr_pos) | | -| [`show`](@ref plotattr_show) | `display` `gui` `shows` | -| [`size`](@ref plotattr_size) | `sizes` `windowsize` `wsize` | -| [`tex_output_standalone`](@ref plotattr_tex_output_standalone) | `tex_output_standalones` `texoutputstandalones` | -| [`thickness_scaling`](@ref plotattr_thickness_scaling) | `thickness_scalings` `thicknessscalings` | -| [`warn_on_unsupported`](@ref plotattr_warn_on_unsupported) | `warn` `warn_on_unsupporteds` `warnonunsupporteds` | -| [`window_title`](@ref plotattr_window_title) | `window_titles` `windowtitle` `windowtitles` `wtitle` | - -## Documentation - -### [background_color](@id plotattr_background_color) -```julia -background_color :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} -``` -**Aliases:** `background` `background_colors` `background_colour` `backgroundcolors` `backgroundcolour` `bg` `bg_color` `bg_colour` `bgcolor` `bgcolour` - -Base color for all backgrounds. - -Defaults to `RGB{N0f8}(1.0, 1.0, 1.0)` (white). - -### [background_color_outside](@id plotattr_background_color_outside) -```julia -background_color_outside :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} -``` -**Aliases:** `background_color_outsides` `background_colour_outside` `background_outside` `backgroundcoloroutsides` `backgroundcolouroutside` `backgroundoutside` `bg_color_outside` `bg_colour_outside` `bg_outside` `bgcolor_outside` `bgcoloroutside` `bgcolour_outside` `bgcolouroutside` `bgoutside` - -Color outside the plot area(s). `:match` matches `:background_color`. - -Defaults to `:match`. - -### [display_type](@id plotattr_display_type) -```julia -display_type :: Symbol -``` -**Aliases:** `display_types` `displaytypes` - -When supported, `display` will either open a GUI window or plot inline. Choose from `:auto`, `:gui`, or `:inline`. - -Defaults to `:auto`. - -### [dpi](@id plotattr_dpi) -```julia -dpi :: Real -``` -**Aliases:** `dpis` - -Dots per inch of output figures. - -Defaults to `100`. - -### [extra_kwargs](@id plotattr_extra_kwargs) -```julia -extra_kwargs :: Symbol -``` - -Specify for which element extra keyword args are collected or a KW (`Dict{Symbol, Any}`) to pass a map of extra keyword args which may be specific to a backend. Choose from (`:plot`, `:subplot`, `:series`), defaults to `:series`. Example: `pgfplotsx(); scatter(1:5, extra_kwargs=Dict(:subplot=>Dict("axis line shift" => "10pt"))`. - -Defaults to `:series`. - -### [extra_plot_kwargs](@id plotattr_extra_plot_kwargs) -```julia -extra_plot_kwargs :: Any -``` - -Defaults to `Dict{Any, Any}()`. - -### [fontfamily](@id plotattr_fontfamily) -```julia -fontfamily :: Union{AbstractString, Symbol} -``` -**Aliases:** `fontfamilys` - -Default font family for title, legend entries, tick labels and guides. - -Defaults to `"sans-serif"`. - -### [foreground_color](@id plotattr_foreground_color) -```julia -foreground_color :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} -``` -**Aliases:** `fg` `fg_color` `fg_colour` `fgcolor` `fgcolour` `foreground` `foreground_colors` `foreground_colour` `foregroundcolors` `foregroundcolour` - -Base color for all foregrounds. - -Defaults to `:auto`. - -### [html_output_format](@id plotattr_html_output_format) -```julia -html_output_format :: Symbol -``` -**Aliases:** `fmt` `format` `html_format` `html_output_formats` `htmlformat` `htmloutputformats` - -When writing HTML output, what is the format? `:png` and `:svg` are currently supported. - -Defaults to `:auto`. - -### [inset_subplots](@id plotattr_inset_subplots) -```julia -inset_subplots :: AbstractVector{Tuple{Any, Any}} -``` -**Aliases:** `floating` `inset` - -Optionally pass a vector of `(parent, bbox)` tuples which are the parent layout and the relative bounding box of inset subplots. - -Defaults to `nothing`. - -### [layout](@id plotattr_layout) -```julia -layout :: Union{Integer, Tuple{Integer, Integer}, AbstractLayout} -``` -**Aliases:** `layouts` - -Number of subplot, grid dimensions, layout (for example `grid(2,2)`), or the return from the `@layout` macro. This builds the layout of subplots. - -Defaults to `1`. - -### [link](@id plotattr_link) -```julia -link :: Symbol -``` -**Aliases:** `links` - -How/whether to link axis limits between subplots. - -Defaults to `:none`. - -Choose from the following: -* `:none` -* `:x` – x axes are linked by columns -* `:y` – y axes are linked by rows -* `:both` – x and y are linked -* `:all` – every subplot is linked together regardless of layout position - -### [overwrite_figure](@id plotattr_overwrite_figure) -```julia -overwrite_figure :: Bool -``` -**Aliases:** `clearfig` `clf` `overwrite` `overwrite_figures` `overwritefigures` `reuse` - -Should we reuse the same GUI window/figure when plotting (true), or open a new one (false)? - -Defaults to `true`. - -### [plot_title](@id plotattr_plot_title) -```julia -plot_title :: AbstractString -``` -**Aliases:** `plot_titles` `plottitles` - -Whole plot title (not to be confused with the title for individual subplots). - -Defaults to `""` (empty string). - -### [plot_titlefontcolor](@id plotattr_plot_titlefontcolor) -```julia -plot_titlefontcolor :: Any -``` -**Aliases:** `plot_titlefontcolors` `plottitlefontcolors` - -Defaults to `:match`. - -### [plot_titlefontfamily](@id plotattr_plot_titlefontfamily) -```julia -plot_titlefontfamily :: Any -``` -**Aliases:** `plot_titlefontfamilys` `plottitlefontfamilys` - -Defaults to `:match`. - -### [plot_titlefonthalign](@id plotattr_plot_titlefonthalign) -```julia -plot_titlefonthalign :: Any -``` -**Aliases:** `plot_titlefonthaligns` `plottitlefonthaligns` - -Defaults to `:hcenter`. - -### [plot_titlefontrotation](@id plotattr_plot_titlefontrotation) -```julia -plot_titlefontrotation :: Any -``` -**Aliases:** `plot_titlefontrotations` `plottitlefontrotations` - -Defaults to `0.0`. - -### [plot_titlefontsize](@id plotattr_plot_titlefontsize) -```julia -plot_titlefontsize :: Any -``` -**Aliases:** `plot_titlefontsizes` `plottitlefontsizes` - -Defaults to `16`. - -### [plot_titlefontvalign](@id plotattr_plot_titlefontvalign) -```julia -plot_titlefontvalign :: Any -``` -**Aliases:** `plot_titlefontvaligns` `plottitlefontvaligns` - -Defaults to `:vcenter`. - -### [plot_titleindex](@id plotattr_plot_titleindex) -```julia -plot_titleindex :: Any -``` -**Aliases:** `plot_titleindexs` `plottitleindexs` - -Defaults to `0`. - -### [plot_titlelocation](@id plotattr_plot_titlelocation) -```julia -plot_titlelocation :: Any -``` -**Aliases:** `plot_titlelocations` `plottitlelocations` - -Defaults to `:center`. - -### [plot_titlevspan](@id plotattr_plot_titlevspan) -```julia -plot_titlevspan :: Real -``` -**Aliases:** `plot_titlevspans` `plottitlevspans` - -Vertical span of the whole plot title (fraction of the plot height). - -Defaults to `0.05`. - -### [pos](@id plotattr_pos) -```julia -pos :: Tuple{Integer, Integer} -``` - -`(left_px, top_px)` position of the GUI window (note: currently unimplemented). - -Defaults to `(0, 0)`. - -### [show](@id plotattr_show) -```julia -show :: Bool -``` -**Aliases:** `display` `gui` `shows` - -Should this command open/refresh a GUI/display? Allows to display plots in scripts or functions without explicitly calling `display`. - -Defaults to `false`. - -### [size](@id plotattr_size) -```julia -size :: Tuple{Integer, Integer} -``` -**Aliases:** `sizes` `windowsize` `wsize` - -`(width_px, height_px)` of the whole Plot. - -Defaults to `(600, 400)`. - -### [tex_output_standalone](@id plotattr_tex_output_standalone) -```julia -tex_output_standalone :: Bool -``` -**Aliases:** `tex_output_standalones` `texoutputstandalones` - -When writing TeX output, should the source include a preamble for a standalone document class? - -Defaults to `false`. - -### [thickness_scaling](@id plotattr_thickness_scaling) -```julia -thickness_scaling :: Real -``` -**Aliases:** `thickness_scalings` `thicknessscalings` - -Scale for the thickness of all line elements like lines, borders, axes, grid lines, etc. - -Defaults to `1`. - -### [warn_on_unsupported](@id plotattr_warn_on_unsupported) -```julia -warn_on_unsupported :: Bool -``` -**Aliases:** `warn` `warn_on_unsupporteds` `warnonunsupporteds` - -Warn on unsupported attributes, series types, and marker shapes. - -Defaults to `true`. - -### [window_title](@id plotattr_window_title) -```julia -window_title :: AbstractString -``` -**Aliases:** `window_titles` `windowtitle` `windowtitles` `wtitle` - -Title of the standalone gui-window. - -Defaults to `"Plots.jl"`. diff --git a/docs/src/Attributes/attributes_series.md b/docs/src/Attributes/attributes_series.md deleted file mode 100644 index 7c8e4a4041..0000000000 --- a/docs/src/Attributes/attributes_series.md +++ /dev/null @@ -1,657 +0,0 @@ - -# Series Attributes - -Series attributes apply to individual series, such as lines, scatters, heatmaps, etc. The detailed documentation will contain a list of series types for which the given attribute is relevant. - -## Contents - -| Attribute | Aliases | -| :--- | :--- | -| [`arrow`](@ref seriesattr_arrow) | `arrows` | -| [`bar_edges`](@ref seriesattr_bar_edges) | | -| [`bar_position`](@ref seriesattr_bar_position) | `bar_positions` `barpositions` | -| [`bar_width`](@ref seriesattr_bar_width) | `bar_widths` `barwidths` | -| [`bins`](@ref seriesattr_bins) | `bin` `nb` `nbin` `nbins` | -| [`colorbar_entry`](@ref seriesattr_colorbar_entry) | `colorbar_entrys` `colorbarentrys` | -| [`connections`](@ref seriesattr_connections) | | -| [`contour_labels`](@ref seriesattr_contour_labels) | `clabels` `clabs` `contourlabels` | -| [`contours`](@ref seriesattr_contours) | | -| [`extra_kwargs`](@ref seriesattr_extra_kwargs) | | -| [`fill_z`](@ref seriesattr_fill_z) | `fill_zs` `fillz` `fillzs` `fz` `sc` `surfacecolor` `surfacecolour` `surfcolor` `surfcolour` | -| [`fillalpha`](@ref seriesattr_fillalpha) | `fa` `falpha` `fillalphas` `fillopacity` `fopacity` `fα` | -| [`fillcolor`](@ref seriesattr_fillcolor) | `fc` `fcolor` `fcolour` `fillcolors` `fillcolour` | -| [`fillrange`](@ref seriesattr_fillrange) | `fill_between` `fillbetween` `fillranges` `fillrng` `fillto` `frange` | -| [`fillstyle`](@ref seriesattr_fillstyle) | `fillstyles` | -| [`group`](@ref seriesattr_group) | `g` `grouping` `groups` | -| [`hover`](@ref seriesattr_hover) | `hovers` | -| [`label`](@ref seriesattr_label) | `lab` `labels` | -| [`levels`](@ref seriesattr_levels) | `levs` `nlev` `nlevels` | -| [`line_z`](@ref seriesattr_line_z) | `line_zs` `linez` `linezs` `lz` `zline` | -| [`linealpha`](@ref seriesattr_linealpha) | `la` `lalpha` `linealphas` `lineopacity` `lopacity` `lα` | -| [`linecolor`](@ref seriesattr_linecolor) | `lc` `lcolor` `lcolour` `linecolors` `linecolour` | -| [`linestyle`](@ref seriesattr_linestyle) | `linestyles` `ls` `s` `style` | -| [`linewidth`](@ref seriesattr_linewidth) | `linewidths` `lw` `w` `width` | -| [`marker_z`](@ref seriesattr_marker_z) | `marker_zs` `markerz` `markerzs` `mz` `zcolor` | -| [`markeralpha`](@ref seriesattr_markeralpha) | `ma` `malpha` `markeralphas` `markeropacity` `mopacity` `mα` | -| [`markercolor`](@ref seriesattr_markercolor) | `markercolors` `markercolour` `mc` `mcolor` `mcolour` | -| [`markershape`](@ref seriesattr_markershape) | `markershapes` `shape` | -| [`markersize`](@ref seriesattr_markersize) | `markersizes` `ms` `msize` | -| [`markerstrokealpha`](@ref seriesattr_markerstrokealpha) | `markerstrokealphas` `markerstrokeopacity` `msa` `msalpha` `msopacity` `msα` | -| [`markerstrokecolor`](@ref seriesattr_markerstrokecolor) | `markerstrokecolors` `markerstrokecolour` `msc` `mscolor` `mscolour` | -| [`markerstrokestyle`](@ref seriesattr_markerstrokestyle) | `markerstrokestyles` | -| [`markerstrokewidth`](@ref seriesattr_markerstrokewidth) | `markerstrokewidths` `msw` `mswidth` | -| [`match_dimensions`](@ref seriesattr_match_dimensions) | | -| [`normalize`](@ref seriesattr_normalize) | `norm` `normalized` `normalizes` `normed` | -| [`orientation`](@ref seriesattr_orientation) | `dir` `direction` `orientations` | -| [`permute`](@ref seriesattr_permute) | `permutes` | -| [`primary`](@ref seriesattr_primary) | `primarys` | -| [`quiver`](@ref seriesattr_quiver) | `gradient` `quiver2d` `quivers` `vectorfield` `velocity` | -| [`ribbon`](@ref seriesattr_ribbon) | `rib` `ribbons` | -| [`series_annotations`](@ref seriesattr_series_annotations) | `series_ann` `series_annotation` `series_anns` `seriesann` `seriesannotation` `seriesanns` `text` `texts` `txt` `txts` | -| [`seriesalpha`](@ref seriesattr_seriesalpha) | `alpha` `opacity` `seriesalphas` `α` | -| [`seriescolor`](@ref seriesattr_seriescolor) | `c` `cmap` `color` `colormap` `colour` `seriescolors` | -| [`seriestype`](@ref seriesattr_seriestype) | `linetype` `lt` `seriestypes` `st` `t` `typ` | -| [`show_empty_bins`](@ref seriesattr_show_empty_bins) | `show_empty` `showempty` `showemptybins` | -| [`smooth`](@ref seriesattr_smooth) | `reg` `regression` `smooths` | -| [`stride`](@ref seriesattr_stride) | `str` `strides` `surf_str` `surface_stride` `surfacestride` `surfstr` `wirefame_stride` `wirefamestride` | -| [`subplot`](@ref seriesattr_subplot) | `sp` `splt` `subplots` `subplt` | -| [`weights`](@ref seriesattr_weights) | | -| [`x`](@ref seriesattr_x) | `xs` | -| [`xerror`](@ref seriesattr_xerror) | `xerr` `xerrorbar` `xerrors` | -| [`y`](@ref seriesattr_y) | `ys` | -| [`yerror`](@ref seriesattr_yerror) | `err` `errorbar` `yerr` `yerrorbar` `yerrors` | -| [`z`](@ref seriesattr_z) | `zs` | -| [`z_order`](@ref seriesattr_z_order) | `z_orders` `zorders` | -| [`zerror`](@ref seriesattr_zerror) | `zerr` `zerrorbar` `zerrors` | - -## Documentation - -### [arrow](@id seriesattr_arrow) -```julia -arrow :: Union{Bool, Plots.Arrow} -``` -**Aliases:** `arrows` - -Defines arrowheads that should be displayed at the end of path line segments (just before a NaN and the last non-NaN point). Used in quiverplot, streamplot, or similar. - -Defaults to `nothing`. - -### [bar_edges](@id seriesattr_bar_edges) -```julia -bar_edges :: Bool -``` - -Align bars to edges with `true`, or centers with `false`. - -Defaults to `false`. - -### [bar_position](@id seriesattr_bar_position) -```julia -bar_position :: Symbol -``` -**Aliases:** `bar_positions` `barpositions` - -Choose from `:overlay` or `:stack`. (Warning: may only be partially implemented) - -Defaults to `:overlay`. - -### [bar_width](@id seriesattr_bar_width) -```julia -bar_width :: Real -``` -**Aliases:** `bar_widths` `barwidths` - -Width of bars in data coordinates. When `nothing`, chooses based on `x` (or `y` when `orientation = :h`). - -### [bins](@id seriesattr_bins) -```julia -bins :: Union{Integer, Symbol, Tuple{Integer, Integer}, AbstractVector} -``` -**Aliases:** `bin` `nb` `nbin` `nbins` - -Defines the number of bins. - -Defaults to `:auto`, the Freedman-Diaconis rule. - -Can take in one of the following types: -* `Integer` – defines the approximate number of bins to aim for. Not guaranteed to give the exact value. - * `bins=10` gives a 1D histogram with about 10 bins. - * `bins=10` gives a 2D histogram with about 10 bins for each dimension. -* `Tuple{Integer, Integer}` – for two-dimensional histograms, defines the approximate number of bins per dimension. Not guaranteed to give the exact values. - * `bins=(10, 20)` gives a 2D histogram with about 10 bins for the `x` dimension and about 20 bins for the `y` dimension. -* `Symbol` – defines the auto-binning algorithm to use. - * `:sturges` – [Sturges' rule](https://en.wikipedia.org/wiki/Histogram#Sturges'_formula) - * `:sqrt` – [Square root rule](https://en.wikipedia.org/wiki/Histogram#Square-root_choice) - * `:rice` – [Rice rule](https://en.wikipedia.org/wiki/Histogram#Rice_rule) - * `:scott` – [Scott's normal reference rule](https://en.wikipedia.org/wiki/Histogram#Scott's_normal_reference_rule) - * `:fd` (default) – [Freedman-Diaconis' rule](https://en.wikipedia.org/wiki/Histogram#Freedman%E2%80%93Diaconis'_choice) -* `AbstractVector` – defines a vector of values for bin edges. - * `bins=range(-10, 10, length=21)` gives a histogram with bins starting from -10, ending at 10, and containing 21 break values, giving 20 bins. - -Relevant attribute for the following series types: -* [`histogram`](https://docs.juliaplots.org/stable/api/#Plots.histogram-Tuple) -* [`histogram2d`](https://docs.juliaplots.org/stable/api/#Plots.histogram2d-Tuple) - -### [colorbar_entry](@id seriesattr_colorbar_entry) -```julia -colorbar_entry :: Bool -``` -**Aliases:** `colorbar_entrys` `colorbarentrys` - -Include this series in the color bar? Set to `false` to exclude. - -Defaults to `true`. - -### [connections](@id seriesattr_connections) -```julia -connections :: Any -``` - -Defaults to `nothing`. - -### [contour_labels](@id seriesattr_contour_labels) -```julia -contour_labels :: Bool -``` -**Aliases:** `clabels` `clabs` `contourlabels` - -Show labels at the contour lines? - -Defaults to `false`. - -### [contours](@id seriesattr_contours) -```julia -contours :: Bool -``` - -Add contours to the side-grids of 3D plots? Used in surface/wireframe. - -Defaults to `false`. - -### [extra_kwargs](@id seriesattr_extra_kwargs) -```julia -extra_kwargs :: Symbol -``` - -Specify for which element extra keyword args are collected or a KW (`Dict{Symbol, Any}`) to pass a map of extra keyword args which may be specific to a backend. Choose from (`:plot`, `:subplot`, `:series`), defaults to `:series`. Example: `pgfplotsx(); scatter(1:5, extra_kwargs=Dict(:subplot=>Dict("axis line shift" => "10pt"))`. - -Defaults to `Dict{Any, Any}()`. - -### [fill_z](@id seriesattr_fill_z) -```julia -fill_z :: AbstractMatrix -``` -**Aliases:** `fill_zs` `fillz` `fillzs` `fz` `sc` `surfacecolor` `surfacecolour` `surfcolor` `surfcolour` - -Matrix of the same size as z matrix, which specifies the color of the 3D surface. - -Defaults to `nothing`. - -### [fillalpha](@id seriesattr_fillalpha) -```julia -fillalpha :: Real -``` -**Aliases:** `fa` `falpha` `fillalphas` `fillopacity` `fopacity` `fα` - -The alpha/opacity override for the fill area. `nothing` means it will take the alpha value of fillcolor. - -Defaults to `nothing`. - -### [fillcolor](@id seriesattr_fillcolor) -```julia -fillcolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} -``` -**Aliases:** `fc` `fcolor` `fcolour` `fillcolors` `fillcolour` - -Color of the filled area of path or bar types. `:match` will take the value from `:seriescolor`. - -Defaults to `:match`. - -### [fillrange](@id seriesattr_fillrange) -```julia -fillrange :: Union{Real, AbstractVector} -``` -**Aliases:** `fill_between` `fillbetween` `fillranges` `fillrng` `fillto` `frange` - -Fills area between fillrange and `y` for line-types, sets the base for `bar`, `sticks` types, and similar for other types. - -Defaults to `nothing`. - -### [fillstyle](@id seriesattr_fillstyle) -```julia -fillstyle :: Symbol -``` -**Aliases:** `fillstyles` - -Style of the fill area. `nothing` means solid fill. Choose from `:/`, `:\\`, `:|`, `:-`, `:+`, `:x`. - -Defaults to `nothing`. - -### [group](@id seriesattr_group) -```julia -group :: AbstractVector -``` -**Aliases:** `g` `grouping` `groups` - -Data is split into a separate series, one for each unique value in `group`. - -Defaults to `nothing`. - -### [hover](@id seriesattr_hover) -```julia -hover :: AbstractVector{AbstractString} -``` -**Aliases:** `hovers` - -Text to display when hovering over each data point. - -Defaults to `nothing`. - -### [label](@id seriesattr_label) -```julia -label :: AbstractString -``` -**Aliases:** `lab` `labels` - -The label for a series, which appears in a legend. If empty, no legend entry is added. - -Defaults to `:auto`. - -### [levels](@id seriesattr_levels) -```julia -levels :: Union{Integer, AbstractVector} -``` -**Aliases:** `levs` `nlev` `nlevels` - -Singleton for number of contours or iterable for contour values. Determines contour levels for a contour type. - -Defaults to `15`. - -### [line_z](@id seriesattr_line_z) -```julia -line_z :: Union{Function, AbstractVector} -``` -**Aliases:** `line_zs` `linez` `linezs` `lz` `zline` - -z-values for each series line segment, which correspond to the color to be used from a linecolor gradient. Note that for N points, only the first N-1 values are used (one per line-segment). - -Defaults to `nothing`. - -### [linealpha](@id seriesattr_linealpha) -```julia -linealpha :: Real -``` -**Aliases:** `la` `lalpha` `linealphas` `lineopacity` `lopacity` `lα` - -The alpha/opacity override for the line. `nothing` means it will take the alpha value of linecolor. - -Defaults to `nothing`. - -### [linecolor](@id seriesattr_linecolor) -```julia -linecolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} -``` -**Aliases:** `lc` `lcolor` `lcolour` `linecolors` `linecolour` - -Color of the line (for path and bar stroke). `:match` will take the value from `:seriescolor`, (though histogram/bar types use `:black` as a default). - -Defaults to `:auto`. - -### [linestyle](@id seriesattr_linestyle) -```julia -linestyle :: Symbol -``` -**Aliases:** `linestyles` `ls` `s` `style` - -Style of the line (for path and bar stroke). - -Defaults to `:solid`. - -Choose from the following: -* `:auto` `:solid` `:dash` `:dot` `:dashdot` `:dashdotdot` - -### [linewidth](@id seriesattr_linewidth) -```julia -linewidth :: Real -``` -**Aliases:** `linewidths` `lw` `w` `width` - -Width of the line (in pixels). - -Defaults to `:auto`. - -### [marker_z](@id seriesattr_marker_z) -```julia -marker_z :: Union{Function, AbstractVector} -``` -**Aliases:** `marker_zs` `markerz` `markerzs` `mz` `zcolor` - -z-values for each series data point, which correspond to the color to be used from a markercolor gradient (`f(x,y,z) -> z_value` or `f(x,y) -> z_value`). - -Defaults to `nothing`. - -### [markeralpha](@id seriesattr_markeralpha) -```julia -markeralpha :: Real -``` -**Aliases:** `ma` `malpha` `markeralphas` `markeropacity` `mopacity` `mα` - -The alpha/opacity override for the marker interior. `nothing` means it will take the alpha value of markercolor. - -Defaults to `nothing`. - -### [markercolor](@id seriesattr_markercolor) -```julia -markercolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} -``` -**Aliases:** `markercolors` `markercolour` `mc` `mcolor` `mcolour` - -Color of the interior of the marker or shape. `:match` will take the value from `:seriescolor`. - -Defaults to `:match`. - -### [markershape](@id seriesattr_markershape) -```julia -markershape :: Union{Symbol, AbstractVector, Shape} -``` -**Aliases:** `markershapes` `shape` - -Defaults to `:none`. - -Choose from the following: -* `:none` `:auto` `:cross` `:xcross` `:vline` `:hline` `:+` `:x` -* `:circle` `:rect` `:diamond` -* `:utriangle` `:dtriangle` `:rtriangle` `:ltriangle` -* `:star4` `:star5` `:star6` `:star7` `:star8` -* `:pentagon` `:hexagon` `:heptagon` `:octagon` - -### [markersize](@id seriesattr_markersize) -```julia -markersize :: Union{Real, AbstractVector} -``` -**Aliases:** `markersizes` `ms` `msize` - -Size (radius pixels) of the markers. - -Defaults to `4`. - -### [markerstrokealpha](@id seriesattr_markerstrokealpha) -```julia -markerstrokealpha :: Real -``` -**Aliases:** `markerstrokealphas` `markerstrokeopacity` `msa` `msalpha` `msopacity` `msα` - -The alpha/opacity override for the marker stroke (border). `nothing` means it will take the alpha value of `markerstrokecolor`. - -Defaults to `nothing`. - -### [markerstrokecolor](@id seriesattr_markerstrokecolor) -```julia -markerstrokecolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} -``` -**Aliases:** `markerstrokecolors` `markerstrokecolour` `msc` `mscolor` `mscolour` - -Color of the marker stroke (border). `:match` will take the value from `:foreground_color_subplot`. - -Defaults to `:match`. - -### [markerstrokestyle](@id seriesattr_markerstrokestyle) -```julia -markerstrokestyle :: Symbol -``` -**Aliases:** `markerstrokestyles` - -Style of the marker stroke (border). - -Defaults to `:solid`. - -Choose from the following: -* `:auto` `:solid` `:dash` `:dot` `:dashdot` `:dashdotdot` - -### [markerstrokewidth](@id seriesattr_markerstrokewidth) -```julia -markerstrokewidth :: Real -``` -**Aliases:** `markerstrokewidths` `msw` `mswidth` - -Width of the marker stroke (border) in pixels. - -Defaults to `1`. - -### [match_dimensions](@id seriesattr_match_dimensions) -```julia -match_dimensions :: Bool -``` - -For heatmap types: should the first dimension of a matrix (rows) correspond to the first dimension of the plot (x-axis)? - -Defaults to `false` (which matches the behavior of matplotlib, Plotly, and others). - -Note: when passing a function for `z`, the function should still map `(x,y) -> z`. - -### [normalize](@id seriesattr_normalize) -```julia -normalize :: Union{Bool, Symbol} -``` -**Aliases:** `norm` `normalized` `normalizes` `normed` - -Normalizes the histogram. - -Defaults to `false`. - -Can take in one of the following types: -* `Symbol` – defines the normalization scheme. - * `:none` – no normalization - * `:pdf` – normalize to a discrete PDF, where the total area of the bins is 1 - * `:density` – the area of each bin, rather than the height, is equal to the counts (useful for uneven bin sizes) -* `Bool` – defines the normalization scheme. - * `false` (default) – same as `:none` - * `true` – same as `:pdf` - -### [orientation](@id seriesattr_orientation) -```julia -orientation :: Symbol -``` -**Aliases:** `dir` `direction` `orientations` - -(deprecated) Horizontal or vertical orientation for bar types. Values `:h`, `:hor`, `:horizontal` correspond to horizontal (sideways, anchored to y-axis), and `:v`, `:vert`, and `:vertical` correspond to vertical. - -Defaults to `:vertical`. - -### [permute](@id seriesattr_permute) -```julia -permute :: Tuple{Symbol, Symbol} -``` -**Aliases:** `permutes` - -Permutes data and axis properties of the axes given in the tuple, e.g. `(:x, :y)`. - -Defaults to `:none`. - -### [primary](@id seriesattr_primary) -```julia -primary :: Bool -``` -**Aliases:** `primarys` - -Does this count as a "real series?" For example, you could have a path (primary) and a scatter (secondary) as two separate series, maybe with different data (see `sticks` recipe for an example). The secondary series will get the same color, etc. as the primary. - -Defaults to `true`. - -### [quiver](@id seriesattr_quiver) -```julia -quiver :: Union{Tuple{AbstractVector, AbstractVector}, AbstractVector} -``` -**Aliases:** `gradient` `quiver2d` `quivers` `vectorfield` `velocity` - -The directional vectors `(U, V)` which specify velocity/gradient vectors for a quiver plot. - -Defaults to `nothing`. - -### [ribbon](@id seriesattr_ribbon) -```julia -ribbon :: Union{Real, AbstractVector} -``` -**Aliases:** `rib` `ribbons` - -Creates a fillrange around the data points. - -Defaults to `nothing`. - -### [series_annotations](@id seriesattr_series_annotations) -```julia -series_annotations :: Union{AbstractString, Plots.PlotText, AbstractVector} -``` -**Aliases:** `series_ann` `series_annotation` `series_anns` `seriesann` `seriesannotation` `seriesanns` `text` `texts` `txt` `txts` - -Annotations which are mapped to data points/positions. - -Defaults to `nothing`. - -### [seriesalpha](@id seriesattr_seriesalpha) -```julia -seriesalpha :: Real -``` -**Aliases:** `alpha` `opacity` `seriesalphas` `α` - -The alpha/opacity override for the series. `nothing` means it will take the alpha value of the color. - -Defaults to `nothing`. - -### [seriescolor](@id seriesattr_seriescolor) -```julia -seriescolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} -``` -**Aliases:** `c` `cmap` `color` `colormap` `colour` `seriescolors` - -The base color for this series. `:auto` will select a color from the subplot's `color_palette`, based on the order it was added to the subplot. Also describes the colormap for surfaces. - -Defaults to `:auto`. - -### [seriestype](@id seriesattr_seriestype) -```julia -seriestype :: Symbol -``` -**Aliases:** `linetype` `lt` `seriestypes` `st` `t` `typ` - -Identifier of the type of visualization for this series. - -Defaults to `:path`. - -Choose from any series recipes which are defined, or the following: -* `:none` `:line` `:path` `:steppre` `:stepmid` `:steppost` `:sticks` `:scatter` `:heatmap` `:hexbin` `:barbins` `:barhist` `:histogram` `:scatterbins` `:scatterhist` `:stepbins` `:stephist` `:bins2d` `:histogram2d` `:histogram3d` `:density` `:bar` `:hline` `:vline` `:contour` `:pie` `:shape` `:image` `:path3d` `:scatter3d` `:surface` `:wireframe` `:contour3d` `:volume` `:mesh3d` - -### [show_empty_bins](@id seriesattr_show_empty_bins) -```julia -show_empty_bins :: Bool -``` -**Aliases:** `show_empty` `showempty` `showemptybins` - -Whether empty bins in a 2D histogram are colored as 0 with `true`, or transparent with `false`. - -Defaults to `false`. - -### [smooth](@id seriesattr_smooth) -```julia -smooth :: Bool -``` -**Aliases:** `reg` `regression` `smooths` - -Add a regression line? - -Defaults to `false`. - -### [stride](@id seriesattr_stride) -```julia -stride :: Any -``` -**Aliases:** `str` `strides` `surf_str` `surface_stride` `surfacestride` `surfstr` `wirefame_stride` `wirefamestride` - -Defaults to `(1, 1)`. - -### [subplot](@id seriesattr_subplot) -```julia -subplot :: Union{Integer, Plots.Subplot} -``` -**Aliases:** `sp` `splt` `subplots` `subplt` - -The subplot that this series belongs to. - -Defaults to `:auto`. - -### [weights](@id seriesattr_weights) -```julia -weights :: AbstractVector -``` - -Used in histogram types for weighted counts. - -Defaults to `nothing`. - -### [x](@id seriesattr_x) -```julia -x :: Any -``` -**Aliases:** `xs` - -Input data (first dimension). - -Defaults to `nothing`. - -### [xerror](@id seriesattr_xerror) -```julia -xerror :: Union{Tuple{AbstractVector, AbstractVector}, AbstractVector} -``` -**Aliases:** `xerr` `xerrorbar` `xerrors` - -`x` (horizontal) error relative to x-value. If 2-tuple of vectors, the first vector corresponds to the left error (and the second to the right). - -Defaults to `nothing`. - -### [y](@id seriesattr_y) -```julia -y :: Any -``` -**Aliases:** `ys` - -Input data (second dimension). - -Defaults to `nothing`. - -### [yerror](@id seriesattr_yerror) -```julia -yerror :: Union{Tuple{AbstractVector, AbstractVector}, AbstractVector} -``` -**Aliases:** `err` `errorbar` `yerr` `yerrorbar` `yerrors` - -`y` (vertical) error relative to y-value. If 2-tuple of vectors, the first vector corresponds to the bottom error (and the second to the top). - -Defaults to `nothing`. - -### [z](@id seriesattr_z) -```julia -z :: Any -``` -**Aliases:** `zs` - -Input data (third dimension). May be wrapped by a `Surface` for surface and heatmap types. - -Defaults to `nothing`. - -### [z_order](@id seriesattr_z_order) -```julia -z_order :: Union{Integer, Symbol} -``` -**Aliases:** `z_orders` `zorders` - -`:front`, `:back`, or index of position where 1 is furthest in the background. - -Defaults to `:front`. - -### [zerror](@id seriesattr_zerror) -```julia -zerror :: Any -``` -**Aliases:** `zerr` `zerrorbar` `zerrors` - -Defaults to `nothing`. diff --git a/docs/src/Attributes/attributes_subplot.md b/docs/src/Attributes/attributes_subplot.md deleted file mode 100644 index a60e164023..0000000000 --- a/docs/src/Attributes/attributes_subplot.md +++ /dev/null @@ -1,847 +0,0 @@ - -# Subplot Attributes - -These attributes apply to settings for individual Subplots. These include attributes related to annotations, colorbars, legends, margins, and titles, as well as a few others. - -## Contents - -| Attribute | Aliases | -| :--- | :--- | -| [`annotationcolor`](@ref subplotattr_annotationcolor) | `annotationcolors` | -| [`annotationfontfamily`](@ref subplotattr_annotationfontfamily) | `annotationfontfamilys` | -| [`annotationfontsize`](@ref subplotattr_annotationfontsize) | `annotationfontsizes` | -| [`annotationhalign`](@ref subplotattr_annotationhalign) | `annotationhaligns` | -| [`annotationrotation`](@ref subplotattr_annotationrotation) | `annotationrotations` | -| [`annotations`](@ref subplotattr_annotations) | `ann` `annotate` `annotation` `anns` | -| [`annotationvalign`](@ref subplotattr_annotationvalign) | `annotationvaligns` | -| [`aspect_ratio`](@ref subplotattr_aspect_ratio) | `aspect_ratios` `aspectratio` `aspectratios` `axis_ratio` `axisratio` `ratio` | -| [`background_color_inside`](@ref subplotattr_background_color_inside) | `background_color_insides` `background_colour_inside` `background_inside` `backgroundcolorinsides` `backgroundcolourinside` `backgroundinside` `bg_color_inside` `bg_colour_inside` `bg_inside` `bgcolor_inside` `bgcolorinside` `bgcolour_inside` `bgcolourinside` `bginside` | -| [`background_color_subplot`](@ref subplotattr_background_color_subplot) | `background_color_subplots` `background_colour_subplot` `background_subplot` `backgroundcolorsubplots` `backgroundcoloursubplot` `backgroundsubplot` `bg_color_subplot` `bg_colour_subplot` `bg_subplot` `bgcolor_subplot` `bgcolorsubplot` `bgcolour_subplot` `bgcoloursubplot` `bgsubplot` | -| [`bottom_margin`](@ref subplotattr_bottom_margin) | `bottom_margins` `bottommargin` `bottommargins` | -| [`camera`](@ref subplotattr_camera) | `cam` `cameras` `view_angle` `viewangle` | -| [`clims`](@ref subplotattr_clims) | `cbar_lims` `cbarlims` `clim` `climits` `color_limits` `colorlimits` | -| [`color_palette`](@ref subplotattr_color_palette) | `color_palettes` `colorpalettes` `palette` | -| [`colorbar`](@ref subplotattr_colorbar) | `cb` `cbar` `colorbars` `colorkey` | -| [`colorbar_continuous_values`](@ref subplotattr_colorbar_continuous_values) | | -| [`colorbar_discrete_values`](@ref subplotattr_colorbar_discrete_values) | | -| [`colorbar_fontfamily`](@ref subplotattr_colorbar_fontfamily) | `colorbar_fontfamilys` `colorbarfontfamilys` | -| [`colorbar_formatter`](@ref subplotattr_colorbar_formatter) | `colorbar_formatters` `colorbarformatters` | -| [`colorbar_scale`](@ref subplotattr_colorbar_scale) | `colorbar_scales` `colorbarscales` | -| [`colorbar_tickfontcolor`](@ref subplotattr_colorbar_tickfontcolor) | `colorbar_tickfontcolors` `colorbartickfontcolors` | -| [`colorbar_tickfontfamily`](@ref subplotattr_colorbar_tickfontfamily) | `colorbar_tickfontfamilys` `colorbartickfontfamilys` | -| [`colorbar_tickfonthalign`](@ref subplotattr_colorbar_tickfonthalign) | `colorbar_tickfonthaligns` `colorbartickfonthaligns` | -| [`colorbar_tickfontrotation`](@ref subplotattr_colorbar_tickfontrotation) | `colorbar_tickfontrotations` `colorbartickfontrotations` | -| [`colorbar_tickfontsize`](@ref subplotattr_colorbar_tickfontsize) | `colorbar_tickfontsizes` `colorbartickfontsizes` | -| [`colorbar_tickfontvalign`](@ref subplotattr_colorbar_tickfontvalign) | `colorbar_tickfontvaligns` `colorbartickfontvaligns` | -| [`colorbar_ticks`](@ref subplotattr_colorbar_ticks) | | -| [`colorbar_title`](@ref subplotattr_colorbar_title) | `cb_title` `cbar_title` `cbartitle` `cbtitle` `colorbar_titles` `colorbartitle` `colorbartitles` `colorkey_title` `colorkeytitle` | -| [`colorbar_title_location`](@ref subplotattr_colorbar_title_location) | `colorbar_title_locations` `colorbartitlelocations` | -| [`colorbar_titlefontcolor`](@ref subplotattr_colorbar_titlefontcolor) | `colorbar_titlefontcolors` `colorbartitlefontcolors` | -| [`colorbar_titlefontfamily`](@ref subplotattr_colorbar_titlefontfamily) | `colorbar_titlefontfamilys` `colorbartitlefontfamilys` | -| [`colorbar_titlefonthalign`](@ref subplotattr_colorbar_titlefonthalign) | `colorbar_titlefonthaligns` `colorbartitlefonthaligns` | -| [`colorbar_titlefontrotation`](@ref subplotattr_colorbar_titlefontrotation) | `colorbar_titlefontrotations` `colorbartitlefontrotations` | -| [`colorbar_titlefontsize`](@ref subplotattr_colorbar_titlefontsize) | `colorbar_titlefontsizes` `colorbartitlefontsizes` | -| [`colorbar_titlefontvalign`](@ref subplotattr_colorbar_titlefontvalign) | `colorbar_titlefontvaligns` `colorbartitlefontvaligns` | -| [`extra_kwargs`](@ref subplotattr_extra_kwargs) | | -| [`fontfamily_subplot`](@ref subplotattr_fontfamily_subplot) | `fontfamily_subplots` `fontfamilysubplots` | -| [`foreground_color_subplot`](@ref subplotattr_foreground_color_subplot) | `fg_color_subplot` `fg_colour_subplot` `fg_subplot` `fgcolor_subplot` `fgcolorsubplot` `fgcolour_subplot` `fgcoloursubplot` `fgsubplot` `foreground_color_subplots` `foreground_colour_subplot` `foreground_subplot` `foregroundcolorsubplots` `foregroundcoloursubplot` `foregroundsubplot` | -| [`foreground_color_title`](@ref subplotattr_foreground_color_title) | `fg_color_title` `fg_colour_title` `fg_title` `fgcolor_title` `fgcolortitle` `fgcolour_title` `fgcolourtitle` `fgtitle` `foreground_color_titles` `foreground_colour_title` `foreground_title` `foregroundcolortitles` `foregroundcolourtitle` `foregroundtitle` `titlecolor` | -| [`framestyle`](@ref subplotattr_framestyle) | `axes_style` `axesstyle` `border` `border_style` `borderstyle` `box` `box_style` `boxstyle` `frame` `frame_style` `framestyle` `framestyles` | -| [`left_margin`](@ref subplotattr_left_margin) | `left_margins` `leftmargin` `leftmargins` | -| [`legend_background_color`](@ref subplotattr_legend_background_color) | `background_color_legend` `background_colour_legend` `background_legend` `backgroundcolorlegend` `backgroundcolourlegend` `backgroundlegend` `bg_color_legend` `bg_colour_legend` `bg_legend` `bgcolor_legend` `bgcolorlegend` `bgcolour_legend` `bgcolourlegend` `bglegend` `legend_background_colors` `legendbackgroundcolor` `legendbackgroundcolors` | -| [`legend_column`](@ref subplotattr_legend_column) | `legend_columns` `legendcolumn` `legendcolumns` | -| [`legend_font`](@ref subplotattr_legend_font) | `legend_fonts` `legendfont` `legendfonts` | -| [`legend_font_color`](@ref subplotattr_legend_font_color) | `legend_font_colors` `legendfontcolor` `legendfontcolors` | -| [`legend_font_family`](@ref subplotattr_legend_font_family) | `legend_font_familys` `legendfontfamily` `legendfontfamilys` | -| [`legend_font_halign`](@ref subplotattr_legend_font_halign) | `legend_font_haligns` `legendfonthalign` `legendfonthaligns` | -| [`legend_font_pointsize`](@ref subplotattr_legend_font_pointsize) | `legend_font_pointsizes` `legendfontpointsize` `legendfontpointsizes` `legendfontsize` | -| [`legend_font_rotation`](@ref subplotattr_legend_font_rotation) | `legend_font_rotations` `legendfontrotation` `legendfontrotations` | -| [`legend_font_valign`](@ref subplotattr_legend_font_valign) | `legend_font_valigns` `legendfontvalign` `legendfontvaligns` | -| [`legend_foreground_color`](@ref subplotattr_legend_foreground_color) | `fg_color_legend` `fg_colour_legend` `fg_legend` `fgcolor_legend` `fgcolorlegend` `fgcolour_legend` `fgcolourlegend` `fglegend` `foreground_color_legend` `foreground_colour_legend` `foreground_legend` `foregroundcolorlegend` `foregroundcolourlegend` `foregroundlegend` `legend_foreground_colors` `legendforegroundcolor` `legendforegroundcolors` | -| [`legend_position`](@ref subplotattr_legend_position) | `key` `leg` `legend` `legend_positions` `legendposition` `legendpositions` `legends` | -| [`legend_title`](@ref subplotattr_legend_title) | `key_title` `keytitle` `label_title` `labeltitle` `leg_title` `legend_titles` `legendtitle` `legendtitles` `legtitle` | -| [`legend_title_font`](@ref subplotattr_legend_title_font) | `legend_title_fonts` `legendtitlefont` `legendtitlefonts` | -| [`legend_title_font_color`](@ref subplotattr_legend_title_font_color) | `legend_title_font_colors` `legendtitlefontcolor` `legendtitlefontcolors` | -| [`legend_title_font_family`](@ref subplotattr_legend_title_font_family) | `legend_title_font_familys` `legendtitlefontfamily` `legendtitlefontfamilys` | -| [`legend_title_font_halign`](@ref subplotattr_legend_title_font_halign) | `legend_title_font_haligns` `legendtitlefonthalign` `legendtitlefonthaligns` | -| [`legend_title_font_pointsize`](@ref subplotattr_legend_title_font_pointsize) | `legend_title_font_pointsizes` `legendtitlefontpointsize` `legendtitlefontpointsizes` `legendtitlefontsize` | -| [`legend_title_font_rotation`](@ref subplotattr_legend_title_font_rotation) | `legend_title_font_rotations` `legendtitlefontrotation` `legendtitlefontrotations` | -| [`legend_title_font_valign`](@ref subplotattr_legend_title_font_valign) | `legend_title_font_valigns` `legendtitlefontvalign` `legendtitlefontvaligns` | -| [`margin`](@ref subplotattr_margin) | `margins` | -| [`projection`](@ref subplotattr_projection) | `proj` `projections` | -| [`projection_type`](@ref subplotattr_projection_type) | `proj_type` `projection_types` `projectiontypes` `projtype` | -| [`right_margin`](@ref subplotattr_right_margin) | `right_margins` `rightmargin` `rightmargins` | -| [`subplot_index`](@ref subplotattr_subplot_index) | `subplot_indexs` `subplotindexs` | -| [`title`](@ref subplotattr_title) | `titles` | -| [`titlefontcolor`](@ref subplotattr_titlefontcolor) | `titlefontcolors` | -| [`titlefontfamily`](@ref subplotattr_titlefontfamily) | `titlefontfamilys` | -| [`titlefonthalign`](@ref subplotattr_titlefonthalign) | `titlefonthaligns` | -| [`titlefontrotation`](@ref subplotattr_titlefontrotation) | `titlefontrotations` | -| [`titlefontsize`](@ref subplotattr_titlefontsize) | `titlefontsizes` | -| [`titlefontvalign`](@ref subplotattr_titlefontvalign) | `titlefontvaligns` | -| [`titlelocation`](@ref subplotattr_titlelocation) | `title_align` `title_alignment` `title_loc` `title_location` `title_pos` `title_position` `titlealign` `titlealignment` `titleloc` `titlelocation` `titlelocations` `titlepos` `titleposition` | -| [`top_margin`](@ref subplotattr_top_margin) | `top_margins` `topmargin` `topmargins` | - -## Annotation Attributes - -### [annotationcolor](@id subplotattr_annotationcolor) -```julia -annotationcolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} -``` -**Aliases:** `annotationcolors` - -Annotations color. - -Defaults to `:match`. - -### [annotationfontfamily](@id subplotattr_annotationfontfamily) -```julia -annotationfontfamily :: Union{AbstractString, Symbol} -``` -**Aliases:** `annotationfontfamilys` - -Font family of annotations. - -Defaults to `:match`. - -### [annotationfontsize](@id subplotattr_annotationfontsize) -```julia -annotationfontsize :: Integer -``` -**Aliases:** `annotationfontsizes` - -Font pointsize of annotations. - -Defaults to `14`. - -### [annotationhalign](@id subplotattr_annotationhalign) -```julia -annotationhalign :: Symbol -``` -**Aliases:** `annotationhaligns` - -horizontal alignment of annotations. - -Defaults to `:hcenter`. - -Choose from the following: -* `:hcenter` `:left` `:right` `:center` - -### [annotationrotation](@id subplotattr_annotationrotation) -```julia -annotationrotation :: Real -``` -**Aliases:** `annotationrotations` - -Rotation of annotations in degrees. - -Defaults to `0.0`. - -### [annotations](@id subplotattr_annotations) -```julia -annotations :: Union{Tuple{Real, Real, Union{AbstractString, Tuple, Plots.PlotText}}, AbstractVector{Tuple}} -``` -**Aliases:** `ann` `annotate` `annotation` `anns` - -`(x, y, text)` tuple(s), where text can be `String`, `PlotText` (created with `text(args...)`), or a tuple of arguments to `text` (e.g. `("Label", 8, :red, :top)`). Add one-off text annotations at the (x, y) coordinates. - -Defaults to `Any[]`. - -### [annotationvalign](@id subplotattr_annotationvalign) -```julia -annotationvalign :: Symbol -``` -**Aliases:** `annotationvaligns` - -Vertical alignment of annotations. - -Defaults to `:vcenter`. - -Choose from the following: -* `:vcenter` `:top` `:bottom` `:center` - -## Colorbar Attributes - -### [clims](@id subplotattr_clims) -```julia -clims :: Union{Function, Symbol, Tuple{Real, Real}} -``` -**Aliases:** `cbar_lims` `cbarlims` `clim` `climits` `color_limits` `colorlimits` - -Fixes the limits of the colorbar: values, `:auto`, or a function taking series data in and returning an `NTuple{2, Real}`. - -Defaults to `:auto`. - -### [colorbar](@id subplotattr_colorbar) -```julia -colorbar :: Union{Bool, Symbol} -``` -**Aliases:** `cbar_lims` `cbarlims` `clim` `climits` `color_limits` `colorlimits` - -Show the colorbar. A symbol specifies a colorbar position. - -Defaults to `:legend`. - -Choose from the following (note: only some may be supported in each backend): -* `:none` -* `:best` -* `:right` `:left` `:top` `:bottom` -* `:legend` – matches legend value - -### [colorbar_continuous_values](@id subplotattr_colorbar_continuous_values) -```julia -colorbar_continuous_values :: Any -``` - -Defaults to `Float64[]`. - -### [colorbar_discrete_values](@id subplotattr_colorbar_discrete_values) -```julia -colorbar_discrete_values :: Any -``` - -Defaults to `Any[]`. - -### [colorbar_fontfamily](@id subplotattr_colorbar_fontfamily) -```julia -colorbar_fontfamily :: Union{AbstractString, Symbol} -``` -**Aliases:** `colorbar_fontfamilys` `colorbarfontfamilys` - -Font family of colobar entries. - -Defaults to `:match`. - -### [colorbar_formatter](@id subplotattr_colorbar_formatter) -```julia -colorbar_formatter :: Union{Function, Symbol} -``` -**Aliases:** `colorbar_fontfamilys` `colorbarfontfamilys` - -Choose from `:scientific`, `:plain`, `:none`, `:auto`, or a method which converts a number to a string for tick labeling. - -Defaults to `:auto`. - -### [colorbar_scale](@id subplotattr_colorbar_scale) -```julia -colorbar_scale :: Symbol -``` -**Aliases:** `colorbar_scales` `colorbarscales` - -Scale of the colorbar axis. - -Defaults to `:identity`. - -Choose from the following: -* `:identity` -* `:ln` `:log2` `:log10` -* `:asinh` -* `:sqrt` - -### [colorbar_tickfontcolor](@id subplotattr_colorbar_tickfontcolor) -```julia -colorbar_tickfontcolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} -``` -**Aliases:** `colorbar_tickfontcolors` `colorbartickfontcolors` - -Font color of colorbar tick entries. - -Defaults to `:match`. - -### [colorbar_tickfontfamily](@id subplotattr_colorbar_tickfontfamily) -```julia -colorbar_tickfontfamily :: Union{AbstractString, Symbol} -``` -**Aliases:** `colorbar_tickfontfamilys` `colorbartickfontfamilys` - -Font family of colorbar tick labels. - -Defaults to `:match`. - -### [colorbar_tickfonthalign](@id subplotattr_colorbar_tickfonthalign) -```julia -colorbar_tickfonthalign :: Any -``` -**Aliases:** `colorbar_tickfonthaligns` `colorbartickfonthaligns` - -Defaults to `:hcenter`. - -### [colorbar_tickfontrotation](@id subplotattr_colorbar_tickfontrotation) -```julia -colorbar_tickfontrotation :: Any -``` -**Aliases:** `colorbar_tickfontrotations` `colorbartickfontrotations` - -Defaults to `0.0`. - -### [colorbar_tickfontsize](@id subplotattr_colorbar_tickfontsize) -```julia -colorbar_tickfontsize :: Integer -``` -**Aliases:** `colorbar_tickfontsizes` `colorbartickfontsizes` - -Font pointsize of colorbar tick entries. - -Defaults to `8`. - -### [colorbar_tickfontvalign](@id subplotattr_colorbar_tickfontvalign) -```julia -colorbar_tickfontvalign :: Any -``` -**Aliases:** `colorbar_tickfontvaligns` `colorbartickfontvaligns` - -Defaults to `:vcenter`. - -### [colorbar_ticks](@id subplotattr_colorbar_ticks) -```julia -colorbar_ticks :: Union{Symbol, Tuple{AbstractVector{Real}, AbstractVector{AbstractString}}, AbstractVector{Real}} -``` - -Tick values, `(tickvalues, ticklabels)`, or `:auto`. - -Defaults to `:auto`. - -### [colorbar_title](@id subplotattr_colorbar_title) -```julia -colorbar_title :: AbstractString -``` -**Aliases:** `cb_title` `cbar_title` `cbartitle` `cbtitle` `colorbar_titles` `colorbartitle` `colorbartitles` `colorkey_title` `colorkeytitle` - -Title of colorbar. - -Defaults to `""` (empty string). - -### [colorbar_title_location](@id subplotattr_colorbar_title_location) -```julia -colorbar_title_location :: Any -``` -**Aliases:** `colorbar_title_locations` `colorbartitlelocations` - -Defaults to `:center`. - -### [colorbar_titlefontcolor](@id subplotattr_colorbar_titlefontcolor) -```julia -colorbar_titlefontcolor :: Any -``` -**Aliases:** `colorbar_titlefontcolors` `colorbartitlefontcolors` - -Defaults to `:match`. - -### [colorbar_titlefontfamily](@id subplotattr_colorbar_titlefontfamily) -```julia -colorbar_titlefontfamily :: Any -``` -**Aliases:** `colorbar_titlefontfamilys` `colorbartitlefontfamilys` - -Defaults to `:match`. - -### [colorbar_titlefonthalign](@id subplotattr_colorbar_titlefonthalign) -```julia -colorbar_titlefonthalign :: Any -``` -**Aliases:** `colorbar_titlefonthaligns` `colorbartitlefonthaligns` - -Defaults to `:hcenter`. - -### [colorbar_titlefontrotation](@id subplotattr_colorbar_titlefontrotation) -```julia -colorbar_titlefontrotation :: Any -``` -**Aliases:** `colorbar_titlefontrotations` `colorbartitlefontrotations` - -Defaults to `0.0`. - -### [colorbar_titlefontsize](@id subplotattr_colorbar_titlefontsize) -```julia -colorbar_titlefontsize :: Any -``` -**Aliases:** `colorbar_titlefontsizes` `colorbartitlefontsizes` - -Defaults to `10`. - -### [colorbar_titlefontvalign](@id subplotattr_colorbar_titlefontvalign) -```julia -colorbar_titlefontvalign :: Any -``` -**Aliases:** `colorbar_titlefontvaligns` `colorbartitlefontvaligns` - -Defaults to `:vcenter`. - -## Legend Attributes - -### [legend_background_color](@id subplotattr_legend_background_color) -```julia -legend_background_color :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} -``` -**Aliases:** `background_color_legend` `background_colour_legend` `background_legend` `backgroundcolorlegend` `backgroundcolourlegend` `backgroundlegend` `bg_color_legend` `bg_colour_legend` `bg_legend` `bgcolor_legend` `bgcolorlegend` `bgcolour_legend` `bgcolourlegend` `bglegend` `legend_background_colors` `legendbackgroundcolor` `legendbackgroundcolors` - -Background color of the legend. `:match` matches :background_color_subplot`. - -Defaults to `:match`. - -### [legend_column](@id subplotattr_legend_column) -```julia -legend_column :: Integer -``` -**Aliases:** `legend_columns` `legendcolumn` `legendcolumns` - -Number of columns in the legend. `-1` stands for maximum number of columns (horizontal legend). - -Defaults to `1`. - -### [legend_font](@id subplotattr_legend_font) -```julia -legend_font :: Plots.Font -``` -**Aliases:** `legend_fonts` `legendfont` `legendfonts` - -Font of legend items. - -Defaults to `Plots.Font("sans-serif", 8, :hcenter, :vcenter, 0.0, RGB{N0f8}(0.0,0.0,0.0))`. - -### [legend_font_color](@id subplotattr_legend_font_color) -```julia -legend_font_color :: Any -``` -**Aliases:** `legend_font_colors` `legendfontcolor` `legendfontcolors` - -Defaults to `:match`. - -### [legend_font_family](@id subplotattr_legend_font_family) -```julia -legend_font_family :: Union{AbstractString, Symbol} -``` -**Aliases:** `legend_font_familys` `legendfontfamily` `legendfontfamilys` - -Font family of legend entries. - -Defaults to `:match`. - -### [legend_font_halign](@id subplotattr_legend_font_halign) -```julia -legend_font_halign :: Symbol -``` -**Aliases:** `legend_font_haligns` `legendfonthalign` `legendfonthaligns` - -Font horizontal alignment of legend entries. - -Defaults to `:hcenter`. - -Choose from the following: -* `:hcenter` `:left` `:right` `:center` - -### [legend_font_pointsize](@id subplotattr_legend_font_pointsize) -```julia -legend_font_pointsize :: Integer -``` -**Aliases:** `legend_font_pointsizes` `legendfontpointsize` `legendfontpointsizes` `legendfontsize` - -Font pointsize of legend entries. - -Defaults to `8`. - -### [legend_font_rotation](@id subplotattr_legend_font_rotation) -```julia -legend_font_rotation :: Real -``` -**Aliases:** `legend_font_rotations` `legendfontrotation` `legendfontrotations` - -Font rotation of legend entries. - -Defaults to `0.0`. - -### [legend_font_valign](@id subplotattr_legend_font_valign) -```julia -legend_font_valign :: Symbol -``` -**Aliases:** `legend_font_valigns` `legendfontvalign` `legendfontvaligns` - -Font vertical alignment of legend entries. - -Defaults to `:vcenter`. - -Choose from the following: -* `:vcenter` `:top` `:bottom` `:center` - -### [legend_foreground_color](@id subplotattr_legend_foreground_color) -```julia -legend_foreground_color :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} -``` -**Aliases:** `fg_color_legend` `fg_colour_legend` `fg_legend` `fgcolor_legend` `fgcolorlegend` `fgcolour_legend` `fgcolourlegend` `fglegend` `foreground_color_legend` `foreground_colour_legend` `foreground_legend` `foregroundcolorlegend` `foregroundcolourlegend` `foregroundlegend` `legend_foreground_colors` `legendforegroundcolor` `legendforegroundcolors` - -Foreground color of the legend. `:match` matches :foreground_color_subplot`. - -Defaults to `:match`. - -### [legend_position](@id subplotattr_legend_position) -```julia -legend_position :: Union{Bool, Symbol, Tuple{Real, Real}} -``` -**Aliases:** `key` `leg` `legend` `legend_positions` `legendposition` `legendpositions` `legends` - -Show the legend. Can also be an `(x, y)` tuple or `Symbol` (legend position) or angle `(angle, inout)` tuple. Bottom left corner of legend is placed at `(x, y)`. Choose from (`:none`, `:best`, `:inline`, `:inside`, `:legend`) or any valid combination of `:(outer ?)(top/bottom ?)(right/left ?)`, i.e.: `:top`, `:topright`, `:outerleft`, `:outerbottomright` ... (note: only some may be supported in each backend) - -Defaults to `:best`. - -### [legend_title](@id subplotattr_legend_title) -```julia -legend_title :: AbstractString -``` -**Aliases:** `key_title` `keytitle` `label_title` `labeltitle` `leg_title` `legend_titles` `legendtitle` `legendtitles` `legtitle` - -Legend title. - -Defaults to `nothing`. - -### [legend_title_font](@id subplotattr_legend_title_font) -```julia -legend_title_font :: Plots.Font -``` -**Aliases:** `legend_title_fonts` `legendtitlefont` `legendtitlefonts` - -Font of the legend title. - -Defaults to `Plots.Font("sans-serif", 11, :hcenter, :vcenter, 0.0, RGB{N0f8}(0.0,0.0,0.0))`. - -### [legend_title_font_color](@id subplotattr_legend_title_font_color) -```julia -legend_title_font_color :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} -``` -**Aliases:** `legend_title_font_colors` `legendtitlefontcolor` `legendtitlefontcolors` - -Font color of the legend title. - -Defaults to `:match`. - -### [legend_title_font_family](@id subplotattr_legend_title_font_family) -```julia -legend_title_font_family :: Union{AbstractString, Symbol} -``` -**Aliases:** `legend_title_font_familys` `legendtitlefontfamily` `legendtitlefontfamilys` - -Font family of the legend title. - -Defaults to `:match`. - -### [legend_title_font_halign](@id subplotattr_legend_title_font_halign) -```julia -legend_title_font_halign :: Symbol -``` -**Aliases:** `legend_title_font_haligns` `legendtitlefonthalign` `legendtitlefonthaligns` - -Font horizontal alignment of the legend title. - -Defaults to `:hcenter`. - -Choose from the following: -* `:hcenter` `:left` `:right` `:center` - -### [legend_title_font_pointsize](@id subplotattr_legend_title_font_pointsize) -```julia -legend_title_font_pointsize :: Integer -``` -**Aliases:** `legend_title_font_pointsizes` `legendtitlefontpointsize` `legendtitlefontpointsizes` `legendtitlefontsize` - -Font pointsize of the legend title. - -Defaults to `11`. - -### [legend_title_font_rotation](@id subplotattr_legend_title_font_rotation) -```julia -legend_title_font_rotation :: Real -``` -**Aliases:** `legend_title_font_rotations` `legendtitlefontrotation` `legendtitlefontrotations` - -Font rotation of the legend title. - -Defaults to `0.0`. - -### [legend_title_font_valign](@id subplotattr_legend_title_font_valign) -```julia -legend_title_font_valign :: Symbol -``` -**Aliases:** `legend_title_font_valigns` `legendtitlefontvalign` `legendtitlefontvaligns` - -Font vertical alignment of the legend title. - -Defaults to `:vcenter`. - -Choose from the following: -* `:vcenter` `:top` `:bottom` `:center` - -## Margin Attributes - -### [bottom_margin](@id subplotattr_bottom_margin) -```julia -bottom_margin :: Union{Real, Symbol, Tuple} -``` -**Aliases:** `bottom_margins` `bottommargin` `bottommargins` - -Specifies the extra padding on the bottom of the subplot. `:match` matches `:margin`. - -Defaults to `:match`. - -### [left_margin](@id subplotattr_left_margin) -```julia -left_margin :: Union{Real, Symbol, Tuple} -``` -**Aliases:** `left_margins` `leftmargin` `leftmargins` - -Specifies the extra padding on the left of the subplot. `:match` matches `:margin`. - -Defaults to `:match`. - -### [margin](@id subplotattr_margin) -```julia -margin :: Union{Real, Tuple} -``` -**Aliases:** `margins` - -Number multiplied by `mm`, `px`, etc... or `Tuple` `(0, :mm)`. Base for individual margins (not directly used). Specifies the extra padding around subplots. - -Defaults to `1.0mm`. - -### [right_margin](@id subplotattr_right_margin) -```julia -right_margin :: Union{Real, Symbol, Tuple} -``` -**Aliases:** `right_margins` `rightmargin` `rightmargins` - -Specifies the extra padding on the right of the subplot. `:match` matches `:margin`. - -Defaults to `:match`. - -### [top_margin](@id subplotattr_top_margin) -```julia -top_margin :: Union{Real, Symbol, Tuple} -``` -**Aliases:** `top_margins` `topmargin` `topmargins` - -Specifies the extra padding on the top of the subplot. `:match` matches `:margin`. - -Defaults to `:match`. - -## Title Attributes - -### [title](@id subplotattr_title) -```julia -title :: AbstractString -``` -**Aliases:** `titles` - -Subplot title. - -Defaults to `""` (empty string). - -### [titlefontcolor](@id subplotattr_titlefontcolor) -```julia -titlefontcolor :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} -``` -**Aliases:** `titlefontcolors` - -Font color of subplot title. - -Defaults to `:match`. - -### [titlefontfamily](@id subplotattr_titlefontfamily) -```julia -titlefontfamily :: Union{AbstractString, Symbol} -``` -**Aliases:** `titlefontfamilys` - -Font family of subplot title. - -Defaults to `:match`. - -### [titlefonthalign](@id subplotattr_titlefonthalign) -```julia -titlefonthalign :: Symbol -``` -**Aliases:** `titlefonthaligns` - -Font horizontal alignment of subplot title. - -Defaults to `:hcenter`. - -Choose from the following: -* `:hcenter` `:left` `:right` `:center` - -### [titlefontrotation](@id subplotattr_titlefontrotation) -```julia -titlefontrotation :: Real -``` -**Aliases:** `titlefontrotations` - -Font rotation of subplot title. - -Defaults to `0.0`. - -### [titlefontsize](@id subplotattr_titlefontsize) -```julia -titlefontsize :: Integer -``` -**Aliases:** `titlefontrotations` - -Font pointsize of subplot title. - -Defaults to `14`. - -### [titlefontvalign](@id subplotattr_titlefontvalign) -```julia -titlefontvalign :: Symbol -``` -**Aliases:** `titlefontvaligns` - -Font vertical alignment of subplot title. - -Defaults to `:vcenter`. - -Choose from the following: -* `:vcenter` `:top` `:bottom` `:center` - -### [titlelocation](@id subplotattr_titlelocation) -```julia -titlelocation :: Symbol -``` -**Aliases:** `title_align` `title_alignment` `title_loc` `title_location` `title_pos` `title_position` `titlealign` `titlealignment` `titleloc` `titlelocation` `titlelocations` `titlepos` `titleposition` - -Position of subplot title. - -Defaults to `:center`. - -Choose from the following: -* `:left` `:center` `:right` - -## 3D-Specific Attributes - -### [camera](@id subplotattr_camera) -```julia -camera :: Tuple{Real, Real} -``` -**Aliases:** `cam` `cameras` `view_angle` `viewangle` - -Sets the view angle `(azimuthal, elevation)` for 3D plots. - -Defaults to `(30, 30)`. - -### [projection](@id subplotattr_projection) -```julia -projection :: Union{AbstractString, Symbol} -``` -**Aliases:** `proj` `projections` - -`3d` or `polar`. - -Defaults to `:none`. - -### [projection_type](@id subplotattr_projection_type) -```julia -projection_type :: Symbol -``` -**Aliases:** `proj_type` `projection_types` `projectiontypes` `projtype` - -3d plots projection type: :auto (backend dependent), :persp(ective), :ortho(graphic). - -Defaults to `:auto`. - -## Other Subplot Attributes - -### [aspect_ratio](@id subplotattr_aspect_ratio) -```julia -aspect_ratio :: Union{Real, Symbol} -``` -**Aliases:** `aspect_ratios` `aspectratio` `aspectratios` `axis_ratio` `axisratio` `ratio` - -Plot area is resized so that 1 y-unit is the same size as `aspect_ratio` x-units. With `:none`, images inherit aspect ratio of the plot area. Use `:equal` for unit aspect ratio. - -Defaults to `:auto`. - -### [background_color_inside](@id subplotattr_background_color_inside) -```julia -background_color_inside :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} -``` -**Aliases:** `background_color_insides` `background_colour_inside` `background_inside` `backgroundcolorinsides` `backgroundcolourinside` `backgroundinside` `bg_color_inside` `bg_colour_inside` `bg_inside` `bgcolor_inside` `bgcolorinside` `bgcolour_inside` `bgcolourinside` `bginside` - -Background color inside the plot area (under the grid).`:match` matches :background_color_subplot`. - -Defaults to `:match`. - -### [background_color_subplot](@id subplotattr_background_color_subplot) -```julia -background_color_subplot :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} -``` -**Aliases:** `background_color_subplots` `background_colour_subplot` `background_subplot` `backgroundcolorsubplots` `backgroundcoloursubplot` `backgroundsubplot` `bg_color_subplot` `bg_colour_subplot` `bg_subplot` `bgcolor_subplot` `bgcolorsubplot` `bgcolour_subplot` `bgcoloursubplot` `bgsubplot` - -Base background color of the subplot.`:match` matches `:background_color`. - -Defaults to `:match`. - -### [color_palette](@id subplotattr_color_palette) -```julia -color_palette :: Union{Symbol, AbstractVector{Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant}}} -``` -**Aliases:** `color_palettes` `colorpalettes` `palette` - -Iterable (cycle through) or color gradient (generate list from gradient) or `:auto` (generate a color list using `Colors.distiguishable_colors` and custom seed colors chosen to contrast with the background). The color palette is a color list from which series colors are automatically chosen. - -Defaults to `:auto`. - -### [extra_kwargs](@id subplotattr_extra_kwargs) -```julia -extra_kwargs :: Symbol -``` - -Specify for which element extra keyword args are collected or a KW (`Dict{Symbol, Any}`) to pass a map of extra keyword args which may be specific to a backend. Choose from `:plot`, `:subplot`, `:series`, defaults to `:series`. Example: `pgfplotsx(); scatter(1:5, extra_kwargs=Dict(:subplot=>Dict("axis line shift" => "10pt"))`. - -Defaults to `Dict{Any, Any}()`. - -### [fontfamily_subplot](@id subplotattr_fontfamily_subplot) -```julia -fontfamily_subplot :: Any -``` -**Aliases:** `fontfamily_subplots` `fontfamilysubplots` - -Defaults to `:match`. - -### [foreground_color_subplot](@id subplotattr_foreground_color_subplot) -```julia -foreground_color_subplot :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} -``` -**Aliases:** `fg_color_subplot` `fg_colour_subplot` `fg_subplot` `fgcolor_subplot` `fgcolorsubplot` `fgcolour_subplot` `fgcoloursubplot` `fgsubplot` `foreground_color_subplots` `foreground_colour_subplot` `foreground_subplot` `foregroundcolorsubplots` `foregroundcoloursubplot` `foregroundsubplot` - -Base foreground color of the subplot. `:match` matches :foreground_color`. - -Defaults to `:match`. - -### [foreground_color_title](@id subplotattr_foreground_color_title) -```julia -foreground_color_title :: Union{Integer, Symbol, ColorSchemes.ColorScheme, Colorant} -``` -**Aliases:** `fg_color_title` `fg_colour_title` `fg_title` `fgcolor_title` `fgcolortitle` `fgcolour_title` `fgcolourtitle` `fgtitle` `foreground_color_titles` `foreground_colour_title` `foreground_title` `foregroundcolortitles` `foregroundcolourtitle` `foregroundtitle` `titlecolor` - -Color of subplot title. `:match` matches :foreground_color_subplot`. - -Defaults to `:match`. - -### [framestyle](@id subplotattr_framestyle) -```julia -framestyle :: Symbol -``` -**Aliases:** `axes_style` `axesstyle` `border` `border_style` `borderstyle` `box` `box_style` `boxstyle` `frame` `frame_style` `framestyle` `framestyles` - -Style of the axes frame. - -Defaults to `:axes`. - -Choose from the following: -* `:box` `:semi` `:axes` `:origin` `:zerolines` `:grid` `:none` - -### [subplot_index](@id subplotattr_subplot_index) -```julia -subplot_index :: Integer -``` -**Aliases:** `subplot_indexs` `subplotindexs` - -Internal (not set by user). Specifies the index of this subplot in the Plot's `plt.subplot` list. - -Defaults to `-1`.