Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

start section about plot objects #353

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

start section about plot objects #353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"
ImageIO = "82e4d734-157c-48bb-816b-45c225c6df19"
ImageMagick = "6218d12a-5da1-5696-b52f-db25d2ecc6d1"
Images = "916415d5-f1e6-5110-898d-aaa5f9f070e0"
InspectDR = "d0351b0e-4b05-5898-87b3-e2a8edfddd1d"
JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
Expand Down
5 changes: 4 additions & 1 deletion docs/gallery/inspectdr/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# InspectDR

!!! warn
`InspectDR` currently does not precompile on julia 1.10+.

To switch to the `InspectDR` backend, you can use:

```julia
using Plots
inspectdr()
# inspectdr()
```

The demos are generated from `Plots._examples`. Empty demos are features that this backend does not support.
Expand Down
6 changes: 3 additions & 3 deletions docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -578,10 +578,10 @@ function main()
pgfplotsx()
unicodeplots()
gaston()
inspectdr()
# inspectdr()

# NOTE: for a faster representative test build use `PLOTDOCS_BACKENDS='GR' PLOTDOCS_EXAMPLES='1'`
default_backends = "GR PythonPlot PlotlyJS PGFPlotsX UnicodePlots Gaston InspectDR"
default_backends = "GR PythonPlot PlotlyJS PGFPlotsX UnicodePlots Gaston"
backends = get(ENV, "PLOTDOCS_BACKENDS", default_backends)
backends = backends == "ALL" ? default_backends : backends
@info "selected backends: $backends"
Expand Down Expand Up @@ -680,7 +680,7 @@ function main()
],
"Overview" => "ecosystem.md",
],
"Advanced Topics" => ["Internals" => "pipeline.md"],
"Advanced Topics" => ["Plot objects" => "plot_objects.md","Plotting pipeline" => "pipeline.md"],
"Gallery" => gallery,
"User Gallery" => user_gallery,
"API" => "api.md",
Expand Down
4 changes: 0 additions & 4 deletions docs/src/backends.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,10 +384,6 @@ gaston(); backendplot() #hide

Fast plotting with a responsive GUI (optional). Target: quickly identify design/simulation issues & glitches in order to shorten design iterations.

```@example backends
inspectdr(); backendplot(n = 2) #hide
```

Pros:

- Relatively short load times / time to first plot.
Expand Down
11 changes: 11 additions & 0 deletions docs/src/plot_objects.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# [Plot objects](@id object)

The [`plot`](@ref) function returns a bespoke julia type called [`Plot`](@ref).
The plot object.
It holds all the attributes of the plot itself its [`Subplot`](@ref)s and [`Series`](@ref).

```@docs
Plot
Subplot
Series
```
Loading