add use_iframe to settings and fix docs

joshday · joshday · commit 72e016e7142a · 2024-12-03T12:03:13.000-05:00
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,6 +1,8 @@
 using Documenter
 using PlotlyLight
 
+PlotlyLight.settings.use_iframe = true
+
 makedocs(
     sitename = "PlotlyLight",
     modules = [PlotlyLight],
diff --git a/docs/src/settings.md b/docs/src/settings.md
@@ -3,13 +3,15 @@
 Occasionally the `PlotlyLight.preset`s aren't enough.  Low level user-configurable settings are available in `PlotlyLight.settings`:
 
 ```julia
-PlotlyLight.settings.src::Cobweb.Node           # plotly.js script loader
-PlotlyLight.settings.div::Cobweb.Node           # The plot-div
-PlotlyLight.settings.layout::EasyConfig.Config  # default `layout` for all plots
-PlotlyLight.settings.config::EasyConfig.Config  # default `config` for all plots
-PlotlyLight.settings.reuse_preview::Bool        # In the REPL, open plots in same page (true, the default) or different pages.
-PlotlyLight.settings.style::Dict{String,String} # CSS styles for the plot <div>
-PlotlyLight.settings.inject_head::Cobweb.Node   # Code to inject at the bottom the <head>
+settings.src::Cobweb.Node           # plotly.js script loader
+settings.div::Cobweb.Node           # The plot-div
+settings.layout::EasyConfig.Config  # default `layout` for all plots
+settings.config::EasyConfig.Config  # default `config` for all plots
+settings.reuse_preview::Bool        # In the REPL, open plots in same page (true, the default) or different pages.
+settings.page_css::Cobweb.Node      # CSS to inject at the top of the page
+settings.use_iframe::Bool           # Use an iframe to display the plot (default=false)
+settings.iframe_style::String       # style attributes for the iframe
+settings.src_inject::Vector         # Code (typically scripts) to inject into the html
 ```
 
-Check out e.g. `PlotlyLight.Settings().src` to examine default values.
+Check out e.g. `PlotlyLight.Settings()` to examine default values.
diff --git a/src/PlotlyLight.jl b/src/PlotlyLight.jl
@@ -44,6 +44,7 @@ Base.@kwdef mutable struct Settings
     config::Config          = Config(responsive=true, displaylogo=false)
     reuse_preview::Bool     = true
     page_css::Cobweb.Node   = h.style("html, body { padding: 0px; margin: 0px; }")
+    use_iframe::Bool        = false
     iframe_style            = "display:block; border:none; min-height:350px; min-width:350px; width:100%; height:100%"
     src_inject::Vector      = []
 end
@@ -157,7 +158,7 @@ function html_iframe(o::Plot, id=rand_id(), kw...)
 end
 
 function Base.show(io::IO, ::MIME"text/html", o::Plot)
-    get(io, :jupyter, false) ?
+    (get(io, :jupyter, false) || settings.use_iframe) ?
         show(io, MIME("text/html"), html_iframe(o)) :
         show(io, MIME("text/html"), html_div(o))
 end
