API Documentation

PlotlySupply.get_default_legend_position — Method

get_default_legend_position()

Return the package-wide default legend position used by high-level constructors.

source

PlotlySupply.get_default_template — Method

get_default_template()

Return the package-wide default Plotly template symbol used by high-level constructors.

source

PlotlySupply.plot! — Method

plot!(sf::SubplotFigure, x, y; kwargs...)

MATLAB-like alias for plot_scatter! when working with SubplotFigure.

source

PlotlySupply.plot_contour! — Method

function plot_contour!(
	fig,
	x::Union{AbstractRange, Vector, SubArray},
	y::Union{AbstractRange, Vector, SubArray},
	U::Union{Array, SubArray};
	xlabel::String = "",
	ylabel::String = "",
	xrange::Vector = [0, 0],
	yrange::Vector = [0, 0],
	zrange::Vector = [0, 0],
	width::Int = 0,
	height::Int = 0,
	colorscale::String = "",
	title::String = "",
	fontsize::Int = 0,
	equalar::Bool = false,
	xscale::String = "",
	yscale::String = "",
)

Adds new contour traces to an existing figure.

Arguments

fig: Existing plot figure to append to
x: x-coordinate values
y: y-coordinate values
U: Matrix of values

Keywords

xlabel: Label for the x-axis (default: "")
ylabel: Label for the y-axis (default: "")
xrange: Range for the x-axis (default: [0, 0])
yrange: Range for the y-axis (default: [0, 0])
zrange: Range for the z-axis (default: [0, 0])
width: Width of the plot (default: 0)
height: Height of the plot (default: 0)
colorscale: Color scale for the contour plot (default: "")
title: Title for the contour (default: "")
fontsize: Font size for plot text (default: 0, uses Plotly default)
equalar: Whether to set equal aspect ratio (default: false)
xscale: X-axis scale type ("log" for logarithmic, default: "")
yscale: Y-axis scale type ("log" for logarithmic, default: "")

source

PlotlySupply.plot_contour — Method

function plot_contour(
	x::Union{AbstractRange, Vector, SubArray},
	y::Union{AbstractRange, Vector, SubArray},
	U::Union{Array, SubArray};
	xlabel::String = "",
	ylabel::String = "",
	xrange::Vector = [0, 0],
	yrange::Vector = [0, 0],
	zrange::Vector = [0, 0],
	width::Int = 0,
	height::Int = 0,
	colorscale::String = "",
	title::String = "",
	fontsize::Int = 0,
	equalar::Bool = false,
	xscale::String = "",
	yscale::String = "",
)

Plots contour data.

Arguments

x: x-axis coordinate data
y: y-axis coordinate data
U: 2D data for contours

Keywords

xlabel: Label for the x-axis (default: "")
ylabel: Label for the y-axis (default: "")
xrange: Range for the x-axis (default: [0, 0])
yrange: Range for the y-axis (default: [0, 0])
zrange: Range for the z-axis (default: [0, 0])
colorscale: Color scale for the contour plot (default: "")
title: Title of the figure (default: "")
width: Width of the plot (default: 0)
height: Height of the plot (default: 0)
equalar: Whether to set equal aspect ratio (default: false)
fontsize: Font size for plot text (default: 0, uses Plotly default)
xscale: X-axis scale type ("log" for logarithmic, default: "")
yscale: Y-axis scale type ("log" for logarithmic, default: "")

source

PlotlySupply.plot_contour — Method

function plot_contour(
	U::Union{Array, SubArray};
	xlabel::String = "",
	ylabel::String = "",
	xrange::Vector = [0, 0],
	yrange::Vector = [0, 0],
	zrange::Vector = [0, 0],
	width::Int = 0,
	height::Int = 0,
	colorscale::String = "",
	title::String = "",
	fontsize::Int = 0,
	equalar::Bool = false,
	xscale::String = "",
	yscale::String = "",
)

Plots contour data (axes not specified).

Arguments

U: 2D data for contours

Keywords

xlabel: Label for the x-axis (default: "")
ylabel: Label for the y-axis (default: "")
xrange: Range for the x-axis (default: [0, 0])
yrange: Range for the y-axis (default: [0, 0])
zrange: Range for the z-axis (default: [0, 0])
colorscale: Color scale for the contour plot (default: "")
title: Title of the figure (default: "")
width: Width of the plot (default: 0)
height: Height of the plot (default: 0)
equalar: Whether to set equal aspect ratio (default: false)
fontsize: Font size for plot text (default: 0, uses Plotly default)
xscale: X-axis scale type ("log" for logarithmic, default: "")
yscale: Y-axis scale type ("log" for logarithmic, default: "")

source

PlotlySupply.plot_heatmap! — Method

function plot_heatmap!(
	fig,
	x::Union{AbstractRange, Vector, SubArray},
	y::Union{AbstractRange, Vector, SubArray},
	U::Union{Array, SubArray};
	xlabel::String = "",
	ylabel::String = "",
	xrange::Vector = [0, 0],
	yrange::Vector = [0, 0],
	zrange::Vector = [0, 0],
	width::Int = 0,
	height::Int = 0,
	colorscale::String = "",
	title::String = "",
	fontsize::Int = 0,
	equalar::Bool = false,
	xscale::String = "",
	yscale::String = "",
)

Adds new heatmap traces to an existing figure.

Arguments

fig: Existing plot figure to append to
x: x-coordinate values
y: y-coordinate values
U: Matrix of values

Keywords

xlabel: Label for the x-axis (default: "")
ylabel: Label for the y-axis (default: "")
xrange: Range for the x-axis (default: [0, 0])
yrange: Range for the y-axis (default: [0, 0])
zrange: Range for the z-axis (default: [0, 0])
width: Width of the plot (default: 0)
height: Height of the plot (default: 0)
colorscale: Color scale for the heatmap (default: "")
title: Title for the heatmap (default: "")
fontsize: Font size for plot text (default: 0, uses Plotly default)
equalar: Whether to set equal aspect ratio (default: false)
xscale: X-axis scale type ("log" for logarithmic, default: "")
yscale: Y-axis scale type ("log" for logarithmic, default: "")

source

PlotlySupply.plot_heatmap — Method

function plot_heatmap(
	x::Union{AbstractRange, Vector, SubArray},
	y::Union{AbstractRange, Vector, SubArray},
	U::Union{Array, SubArray};
	xlabel::String = "",
	ylabel::String = "",
	xrange::Vector = [0, 0],
	yrange::Vector = [0, 0],
	zrange::Vector = [0, 0],
	width::Int = 0,
	height::Int = 0,
	colorscale::String = "",
	title::String = "",
	fontsize::Int = 0,
	equalar::Bool = false,
	xscale::String = "",
	yscale::String = "",
)

Plots heatmap (holographic) data.

Arguments

x: x-axis coordinate data
y: y-axis coordinate data
U: 2D hologram data

Keywords

xlabel: Label for the x-axis (default: "")
ylabel: Label for the y-axis (default: "")
xrange: Range for the x-axis (default: [0, 0])
yrange: Range for the y-axis (default: [0, 0])
zrange: Range for the z-axis (default: [0, 0])
colorscale: Color scale for the heatmap (default: "")
title: Title of the figure (default: "")
width: Width of the plot (default: 0)
height: Height of the plot (default: 0)
equalar: Whether to set equal aspect ratio (default: false)
fontsize: Font size for plot text (default: 0, uses Plotly default)
xscale: X-axis scale type ("log" for logarithmic, default: "")
yscale: Y-axis scale type ("log" for logarithmic, default: "")

source

PlotlySupply.plot_heatmap — Method

function plot_heatmap(
	U::Union{Array, SubArray};
	xlabel::String = "",
	ylabel::String = "",
	xrange::Vector = [0, 0],
	yrange::Vector = [0, 0],
	zrange::Vector = [0, 0],
	width::Int = 0,
	height::Int = 0,
	colorscale::String = "",
	title::String = "",
	fontsize::Int = 0,
	equalar::Bool = false,
	xscale::String = "",
	yscale::String = "",
)

Plots heatmap (holographic) data (axes not specified).

Arguments

U: 2D hologram data

Keywords

xlabel: Label for the x-axis (default: "")
ylabel: Label for the y-axis (default: "")
xrange: Range for the x-axis (default: [0, 0])
yrange: Range for the y-axis (default: [0, 0])
zrange: Range for the z-axis (default: [0, 0])
colorscale: Color scale for the heatmap (default: "")
title: Title of the figure (default: "")
width: Width of the plot (default: 0)
height: Height of the plot (default: 0)
equalar: Whether to set equal aspect ratio (default: false)
fontsize: Font size for plot text (default: 0, uses Plotly default)
xscale: X-axis scale type ("log" for logarithmic, default: "")
yscale: Y-axis scale type ("log" for logarithmic, default: "")

source

PlotlySupply.plot_quiver! — Method

function plot_quiver!(
	fig,
	x::Union{AbstractRange, Vector, SubArray},
	y::Union{AbstractRange, Vector, SubArray},
	u::Union{AbstractRange, Vector, SubArray},
	v::Union{AbstractRange, Vector, SubArray};
	color::String = "RoyalBlue",
	sizeref::Real = 1,
	xlabel::String = "",
	ylabel::String = "",
	xrange::Vector = [0, 0],
	yrange::Vector = [0, 0],
	width::Int = 0,
	height::Int = 0,
	title::String = "",
	fontsize::Int = 0,
	grid::Bool = true,
)

Adds new quiver plot traces to an existing figure.

Arguments

fig: Existing plot figure to append to
x: x-coordinate values
y: y-coordinate values
u: x-component of vector field
v: y-component of vector field

Keywords

color: Color of the arrows (default: "RoyalBlue")
sizeref: Reference scaling for arrow length (default: 1)
xlabel: Label for the x-axis (default: "")
ylabel: Label for the y-axis (default: "")
xrange: Range for the x-axis (default: [0, 0])
yrange: Range for the y-axis (default: [0, 0])
width: Width of the figure in pixels (default: 0)
height: Height of the figure in pixels (default: 0)
title: Title of the figure (default: "")
fontsize: Font size for plot text (default: 0, uses Plotly default)
grid: Whether to show the grid or not (default: true)

source

PlotlySupply.plot_quiver — Method

function plot_quiver(
	x::Union{AbstractRange, Vector, SubArray},
	y::Union{AbstractRange, Vector, SubArray},
	u::Union{AbstractRange, Vector, SubArray},
	v::Union{AbstractRange, Vector, SubArray};
	color::String = "RoyalBlue",
	sizeref::Real = 1,
	xlabel::String = "",
	ylabel::String = "",
	xrange::Vector = [0, 0],
	yrange::Vector = [0, 0],
	width::Int = 0,
	height::Int = 0,
	title::String = "",
	fontsize::Int = 0,
	grid::Bool = true,
)

Plots a 2D quiver (vector field) diagram using arrow segments.

Arguments

x: x-coordinates of vector origins
y: y-coordinates of vector origins
u: x-components of vector directions
v: y-components of vector directions

Keywords

color: Arrow color (default: "RoyalBlue")
sizeref: Reference scaling for arrow length (default: 1)
xlabel: Label for the x-axis (default: "")
ylabel: Label for the y-axis (default: "")
xrange: Range for the x-axis (default: [0, 0])
yrange: Range for the y-axis (default: [0, 0])
width: Width of the figure in pixels (default: 0)
height: Height of the figure in pixels (default: 0)
title: Title of the figure (default: "")
grid: Whether to show the grid or not (default: true)
fontsize: Font size for plot text (default: 0, uses Plotly default)

source

PlotlySupply.plot_quiver3d! — Method

function plot_quiver3d!(
	fig,
	x::Union{AbstractRange, Vector, SubArray},
	y::Union{AbstractRange, Vector, SubArray},
	z::Union{AbstractRange, Vector, SubArray},
	u::Union{AbstractRange, Vector, SubArray},
	v::Union{AbstractRange, Vector, SubArray},
	w::Union{AbstractRange, Vector, SubArray};
	sizeref::Real = 1,
	xrange::Vector = [0, 0],
	yrange::Vector = [0, 0],
	zrange::Vector = [0, 0],
	width::Int = 0,
	height::Int = 0,
	color::String = "",
	colorscale::String = "",
	xlabel::String = "",
	ylabel::String = "",
	zlabel::String = "",
	aspectmode::String = "auto",
	title::String = "",
	fontsize::Int = 0,
	perspective::Bool = true,
	grid::Bool = true,
	showaxis::Bool = true,
)

Adds new 3D quiver plot traces to an existing figure.

Arguments

fig: Existing plot figure to append to
x: x-coordinate values
y: y-coordinate values
z: z-coordinate values
u: x-component of vector field
v: y-component of vector field
w: z-component of vector field

Keywords

sizeref: Reference scaling for arrow length (default: 1)
xrange: Range for the x-axis (default: [0, 0])
yrange: Range for the y-axis (default: [0, 0])
zrange: Range for the z-axis (default: [0, 0])
width: Width of the figure in pixels (default: 0)
height: Height of the figure in pixels (default: 0)
color: Color of the arrows (default: "")
colorscale: Colorscale for magnitude visualization (default: "")
xlabel: Label for the x-axis (default: "")
ylabel: Label for the y-axis (default: "")
zlabel: Label for the z-axis (default: "")
aspectmode: Aspect mode for 3D view (default: "auto")
title: Title of the plot (default: "")
fontsize: Font size for plot text (default: 0, uses Plotly default)
perspective: If false, uses orthographic projection (default: true)
grid: Whether to show grid lines (default: true)
showaxis: Whether to show axis lines and labels (default: true)

source

PlotlySupply.plot_quiver3d — Method

plot_quiver3d(
	x::Union{AbstractRange, Vector, SubArray},
	y::Union{AbstractRange, Vector, SubArray},
	z::Union{AbstractRange, Vector, SubArray},
	u::Union{AbstractRange, Vector, SubArray},
	v::Union{AbstractRange, Vector, SubArray},
	w::Union{AbstractRange, Vector, SubArray};
	sizeref::Real = 1,
	xrange::Vector = [0, 0],
	yrange::Vector = [0, 0],
	zrange::Vector = [0, 0],
	width::Int = 0,
	height::Int = 0,
	color::Union{String, Vector{String}} = "",
	colorscale::String = "",
	xlabel::String = "",
	ylabel::String = "",
	zlabel::String = "",
	aspectmode::String = "auto",
	title::String = "",
	fontsize::Int = 0,
	perspective::Bool = true,
	grid::Bool = true,
	showaxis::Bool = true,
)

Generates a 3D vector field (quiver plot) using cones via PlotlyBase.

Arguments

x, y, z: Coordinates of vector origins.
u, v, w: Components of the vector field at the corresponding positions.

Keyword Arguments

sizeref: Scaling factor for cone size (default: 1).
xrange, yrange, zrange: Axis limits in the form [min, max]. If [0, 0], auto-scaling is used.
width, height: Dimensions of the figure in pixels.
color: If specified, sets a uniform color for all vectors.
colorscale: Name of the Plotly colorscale to use when color is not specified (default: "").
xlabel, ylabel, zlabel: Labels for x, y, z axes.
aspectmode: Aspect mode for 3D rendering. Options include "auto", "cube", "data".
title: Title of the plot.
perspective: If false, uses orthographic projection. Defaults to perspective view.
grid: Controls visibility of grid lines.
showaxis: Controls visibility of axis lines and labels.
fontsize: Font size for plot text (default: 0, uses Plotly default).

Returns

A Plot object containing the 3D quiver plot.

Notes

By default, the vector field is visualized using cones with magnitude scaling via sizeref.
If color is specified, all cones are displayed in a uniform color without a color bar.

source

PlotlySupply.plot_scatter! — Method

function plot_scatter!(
	fig,
	x::Union{AbstractRange, Vector, SubArray},
	y::Union{AbstractRange, Vector, SubArray};
	xlabel::String = "",
	ylabel::String = "",
	xrange::Vector = [0, 0],
	yrange::Vector = [0, 0],
	width::Int = 0,
	height::Int = 0,
	mode::Union{String, Vector{String}} = "lines",
	dash::Union{String, Vector{String}} = "",
	color::Union{String, Vector{String}} = "",
	legend::Union{String, Vector{String}} = "",
	title::String = "",
	fontsize::Int = 0,
	grid::Bool = true,
	xscale::String = "",
	yscale::String = "",
	marker_size::Union{Int, Vector{Int}} = 0,
	marker_symbol::Union{String, Vector{String}} = "",
	linewidth::Union{Real, Vector{<:Real}} = 0,
	showlegend::Union{Nothing, Bool, Vector{Bool}} = nothing,
)

Adds new scatter traces to an existing figure.

Arguments

fig: Existing plot figure to append to
x: x-coordinate data (can be vector of vectors)
y: y-coordinate data (can be vector of vectors)

Keywords

xlabel: Label for the x-axis (default: "")
ylabel: Label for the y-axis (default: "")
xrange: Range for the x-axis (default: [0, 0])
yrange: Range for the y-axis (default: [0, 0])
width: Width of the plot (default: 0)
height: Height of the plot (default: 0)
mode: Plotting mode (default: "lines", can be vector)
dash: line style (default: "", can be vector)
color: Color of the plot lines (default: "", can be vector)
legend: Name of the plot lines (default: "", can be vector)
title: Title of the figure (default: "")
fontsize: Font size for plot text (default: 0, uses Plotly default)
grid: Whether to show the grid or not (default: true)
xscale: X-axis scale type ("log" for logarithmic, default: "")
yscale: Y-axis scale type ("log" for logarithmic, default: "")
marker_size: Marker size in pixels (default: 0, can be vector)
marker_symbol: Marker symbol name (default: "", can be vector)
linewidth: Line width in pixels (default: 0, can be vector)
showlegend: Whether to show legend entry (default: nothing, can be vector)

source

PlotlySupply.plot_scatter! — Method

function plot_scatter!(
	fig,
	y::Union{AbstractRange, Vector, SubArray};
	xlabel::String = "",
	ylabel::String = "",
	xrange::Vector = [0, 0],
	yrange::Vector = [0, 0],
	width::Int = 0,
	height::Int = 0,
	mode::Union{String, Vector{String}} = "lines",
	dash::Union{String, Vector{String}} = "",
	color::Union{String, Vector{String}} = "",
	legend::Union{String, Vector{String}} = "",
	title::String = "",
	fontsize::Int = 0,
	grid::Bool = true,
	xscale::String = "",
	yscale::String = "",
	marker_size::Union{Int, Vector{Int}} = 0,
	marker_symbol::Union{String, Vector{String}} = "",
	linewidth::Union{Real, Vector{<:Real}} = 0,
	showlegend::Union{Nothing, Bool, Vector{Bool}} = nothing,
)

Adds new scatter traces to an existing figure (x-axis not specified, uses indices).

Arguments

fig: Existing plot figure to append to
y: y-coordinate data (can be vector of vectors)

Keywords

xlabel: Label for the x-axis (default: "")
ylabel: Label for the y-axis (default: "")
xrange: Range for the x-axis (default: [0, 0])
yrange: Range for the y-axis (default: [0, 0])
width: Width of the plot (default: 0)
height: Height of the plot (default: 0)
mode: Plotting mode (default: "lines", can be vector)
dash: line style (default: "", can be vector)
color: Color of the plot lines (default: "", can be vector)
legend: Name of the plot lines (default: "", can be vector)
title: Title of the figure (default: "")
fontsize: Font size for plot text (default: 0, uses Plotly default)
grid: Whether to show the grid or not (default: true)
xscale: X-axis scale type ("log" for logarithmic, default: "")
yscale: Y-axis scale type ("log" for logarithmic, default: "")
marker_size: Marker size in pixels (default: 0, can be vector)
marker_symbol: Marker symbol name (default: "", can be vector)
linewidth: Line width in pixels (default: 0, can be vector)
showlegend: Whether to show legend entry (default: nothing, can be vector)

source

PlotlySupply.plot_scatter — Method

function plot_scatter(
	x::Union{AbstractRange, Vector, SubArray},
	y::Union{AbstractRange, Vector, SubArray};
	xlabel::String = "",
	ylabel::String = "",
	xrange::Vector = [0, 0],
	yrange::Vector = [0, 0],
	width::Int = 0,
	height::Int = 0,
	mode::Union{String, Vector{String}} = "lines",
	dash::Union{String, Vector{String}} = "",
	color::Union{String, Vector{String}} = "",
	legend::Union{String, Vector{String}} = "",
	title::String = "",
	fontsize::Int = 0,
	grid::Bool = true,
	xscale::String = "",
	yscale::String = "",
	marker_size::Union{Int, Vector{Int}} = 0,
	marker_symbol::Union{String, Vector{String}} = "",
	showlegend::Union{Nothing, Bool, Vector{Bool}} = nothing,
)

Plots a rectangular (Cartesian) plot.

Arguments

x: x-coordinate data (can be vector of vectors)
y: y-coordinate data (can be vector of vectors)

Keywords

xlabel: Label for the x-axis (default: "")
ylabel: Label for the y-axis (default: "")
xrange: Range for the x-axis (default: [0, 0])
yrange: Range for the y-axis (default: [0, 0])
width: Width of the plot (default: 0)
height: Height of the plot (default: 0)
mode: Plotting mode (default: "lines", can be vector)
dash: line style ("dash", "dashdot", or "dot", default: "", can be vector)
color: Color of the plot lines (default: "", can be vector)
legend: Name of the plot lines (default: "", can be vector)
title: Title of the figure (default: "")
grid: Whether to show the grid or not (default: true)
fontsize: Font size for plot text (default: 0, uses Plotly default)
xscale: X-axis scale type ("log" for logarithmic, default: "")
yscale: Y-axis scale type ("log" for logarithmic, default: "")
marker_size: Marker size in pixels (default: 0, can be vector)
marker_symbol: Marker symbol name (default: "", can be vector)
showlegend: Whether to show legend entry (default: nothing, can be vector)

source

PlotlySupply.plot_scatter — Method

function plot_scatter(
	y::Union{AbstractRange, Vector, SubArray};
	xlabel::String = "",
	ylabel::String = "",
	xrange::Vector = [0, 0],
	yrange::Vector = [0, 0],
	width::Int = 0,
	height::Int = 0,
	mode::Union{String, Vector{String}} = "lines",
	dash::Union{String, Vector{String}} = "",
	color::Union{String, Vector{String}} = "",
	legend::Union{String, Vector{String}} = "",
	title::String = "",
	fontsize::Int = 0,
	grid::Bool = true,
	xscale::String = "",
	yscale::String = "",
	marker_size::Union{Int, Vector{Int}} = 0,
	marker_symbol::Union{String, Vector{String}} = "",
	linewidth::Union{Real, Vector{<:Real}} = 0,
	showlegend::Union{Nothing, Bool, Vector{Bool}} = nothing,
)

Plots a rectangular (Cartesian) plot (x-axis not specified).

Arguments

y: y-coordinate data (can be vector of vectors)

Keywords

xlabel: Label for the x-axis (default: "")
ylabel: Label for the y-axis (default: "")
xrange: Range for the x-axis (default: [0, 0])
yrange: Range for the y-axis (default: [0, 0])
width: Width of the plot (default: 0)
height: Height of the plot (default: 0)
mode: Plotting mode (default: "lines", can be vector)
dash: line style ("dash", "dashdot", or "dot", default: "", can be vector)
color: Color of the plot lines (default: "", can be vector)
legend: Name of the plot lines (default: "", can be vector)
title: Title of the figure (default: "")
grid: Whether to show the grid or not (default: true)
fontsize: Font size for plot text (default: 0, uses Plotly default)
xscale: X-axis scale type ("log" for logarithmic, default: "")
yscale: Y-axis scale type ("log" for logarithmic, default: "")
marker_size: Marker size in pixels (default: 0, can be vector)
marker_symbol: Marker symbol name (default: "", can be vector)
linewidth: Line width in pixels (default: 0, can be vector)
showlegend: Whether to show legend entry (default: nothing, can be vector)

source

PlotlySupply.plot_scatter3d! — Method

function plot_scatter3d!(
	fig,
	x::Union{AbstractRange, Vector, SubArray},
	y::Union{AbstractRange, Vector, SubArray},
	z::Union{AbstractRange, Vector, SubArray};
	xrange::Vector = [0, 0],
	yrange::Vector = [0, 0],
	zrange::Vector = [0, 0],
	width::Int = 0,
	height::Int = 0,
	mode::Union{String, Vector{String}} = "lines",
	color::Union{String, Vector{String}} = "",
	legend::Union{String, Vector{String}} = "",
	xlabel::String = "",
	ylabel::String = "",
	zlabel::String = "",
	aspectmode::String = "auto",
	title::String = "",
	fontsize::Int = 0,
	perspective::Bool = true,
	grid::Bool = true,
	showaxis::Bool = true,
	marker_size::Union{Int, Vector{Int}} = 0,
	marker_symbol::Union{String, Vector{String}} = "",
	linewidth::Union{Real, Vector{<:Real}} = 0,
	showlegend::Union{Nothing, Bool, Vector{Bool}} = nothing,
)

Adds new 3D scatter traces to an existing figure.

Arguments

fig: Existing plot figure to append to
x: x-coordinate data (can be vector of vectors)
y: y-coordinate data (can be vector of vectors)
z: z-coordinate data (can be vector of vectors)

Keywords

xrange: Range for the x-axis (default: [0, 0])
yrange: Range for the y-axis (default: [0, 0])
zrange: Range for the z-axis (default: [0, 0])
width: Width of the figure in pixels (default: 0)
height: Height of the figure in pixels (default: 0)
mode: Plotting mode (default: "lines", can be vector)
color: Color of the plot (default: "", can be vector)
legend: Legend name (default: "", can be vector)
xlabel: Label for the x-axis (default: "")
ylabel: Label for the y-axis (default: "")
zlabel: Label for the z-axis (default: "")
aspectmode: Aspect mode for 3D view (default: "auto")
title: Title of the plot (default: "")
fontsize: Font size for plot text (default: 0, uses Plotly default)
perspective: If false, uses orthographic projection (default: true)
grid: Whether to show grid lines (default: true)
showaxis: Whether to show axis lines and labels (default: true)
marker_size: Marker size in pixels (default: 0, can be vector)
marker_symbol: Marker symbol name (default: "", can be vector)
linewidth: Line width in pixels (default: 0, can be vector)
showlegend: Whether to show legend entry (default: nothing, can be vector)

source

PlotlySupply.plot_scatter3d — Method

plot_scatter3d(
	x::Union{AbstractRange, Vector, SubArray},
	y::Union{AbstractRange, Vector, SubArray},
	z::Union{AbstractRange, Vector, SubArray};
	xrange::Vector = [0, 0],
	yrange::Vector = [0, 0],
	zrange::Vector = [0, 0],
	width::Int = 0,
	height::Int = 0,
	mode::Union{String, Vector{String}} = "lines",
	color::Union{String, Vector{String}} = "",
	legend::Union{String, Vector{String}} = "",
	xlabel::String = "",
	ylabel::String = "",
	zlabel::String = "",
	aspectmode::String = "auto",
	title::String = "",
	fontsize::Int = 0,
	perspective::Bool = true,
	grid::Bool = true,
	showaxis::Bool = true,
	linewidth::Union{Real, Vector{<:Real}} = 0,
)

Plots a 3D scatter or line plot using PlotlyBase, with options for customizing appearance and handling multiple curves.

Arguments

x, y, z: Coordinate vectors. If z is a Vector{Vector} (i.e., multiple datasets), x and y must also be Vector{Vector} of the same length.

Keyword Arguments

xrange, yrange, zrange: Axis limits in the form [min, max]. If [0, 0], auto-scaling is used.
width, height: Plot dimensions in pixels.
mode: Drawing mode ("lines", "markers", "lines+markers"). Can be a vector for multiple traces.
color: Line color(s). Can be a single string or a vector of strings for multiple traces.
legend: Trace label(s) for the legend. Can be a string or a vector.
xlabel, ylabel, zlabel: Axis labels. Defaults are "x", "y", and "z".
aspectmode: Aspect mode for 3D view. Options include "auto", "cube", and "data".
title: Title of the plot.
perspective: If false, uses orthographic projection. Defaults to perspective projection.
grid: Whether to show grid lines.
showaxis: Whether to show axis lines and labels.
fontsize: Font size for plot text (default: 0, uses Plotly default).
linewidth: Line width in pixels (default: 0, can be vector).

Returns

A Plot object containing the 3D scatter or line plot.

Notes

This function supports plotting multiple lines by passing Vector{Vector} types to x, y, and z. In this case, corresponding vectors of mode, color, and legend will be used.

source

PlotlySupply.plot_scatterpolar! — Method

function plot_scatterpolar!(
	fig,
	theta::Union{AbstractRange, Vector, SubArray},
	r::Union{AbstractRange, Vector, SubArray};
	trange::Vector = [0, 0],
	rrange::Vector = [0, 0],
	width::Int = 0,
	height::Int = 0,
	mode::Union{String, Vector{String}} = "lines",
	dash::Union{String, Vector{String}} = "",
	color::Union{String, Vector{String}} = "",
	legend::Union{String, Vector{String}} = "",
	title::String = "",
	fontsize::Int = 0,
	grid::Bool = true,
	marker_size::Union{Int, Vector{Int}} = 0,
	marker_symbol::Union{String, Vector{String}} = "",
	linewidth::Union{Real, Vector{<:Real}} = 0,
	showlegend::Union{Nothing, Bool, Vector{Bool}} = nothing,
)

Adds new polar scatter traces to an existing figure.

Arguments

fig: Existing plot figure to append to
theta: Angular coordinates
r: Radial coordinates

Keywords

trange: Range for the angular axis (default: [0, 0])
rrange: Range for the radial axis (default: [0, 0])
width: Width of the plot (default: 0)
height: Height of the plot (default: 0)
mode: Plotting mode (default: "lines", can be vector)
dash: line style (default: "", can be vector)
color: Color of the plot (default: "", can be vector)
legend: Legend name (default: "", can be vector)
title: Title of the figure (default: "")
fontsize: Font size for plot text (default: 0, uses Plotly default)
grid: Whether to show the grid or not (default: true)
marker_size: Marker size in pixels (default: 0, can be vector)
marker_symbol: Marker symbol name (default: "", can be vector)
linewidth: Line width in pixels (default: 0, can be vector)
showlegend: Whether to show legend entry (default: nothing, can be vector)

source

PlotlySupply.plot_scatterpolar — Method

function plot_scatterpolar(
	theta::Union{AbstractRange, Vector, SubArray},
	r::Union{AbstractRange, Vector, SubArray};
	trange::Vector = [0, 0],
	rrange::Vector = [0, 0],
	width::Int = 0,
	height::Int = 0,
	mode::Union{String, Vector{String}} = "lines",
	dash::Union{String, Vector{String}} = "",
	color::Union{String, Vector{String}} = "",
	legend::Union{String, Vector{String}} = "",
	title::String = "",
	fontsize::Int = 0,
	grid::Bool = true,
	marker_size::Union{Int, Vector{Int}} = 0,
	marker_symbol::Union{String, Vector{String}} = "",
	linewidth::Union{Real, Vector{<:Real}} = 0,
	showlegend::Union{Nothing, Bool, Vector{Bool}} = nothing,
)

Plots a polar plot.

Arguments

theta: Angular coordinate data (can be vector of vectors)
r: Radial coordinate data (can be vector of vectors)

Keywords

trange: Range for the angular axis (default: [0, 0])
rrange: Range for the radial axis (default: [0, 0])
width: Width of the plot (default: 0)
height: Height of the plot (default: 0)
mode: Plotting mode (default: "lines", can be vector)
dash: line style ("dash", "dashdot", or "dot", default: "", can be vector)
color: Color of the plot lines (default: "", can be vector)
legend: Name of the plot lines (default: "", can be vector)
title: Title of the figure (default: "")
grid: Whether to show the grid or not (default: true)
fontsize: Font size for plot text (default: 0, uses Plotly default)
marker_size: Marker size in pixels (default: 0, can be vector)
marker_symbol: Marker symbol name (default: "", can be vector)
linewidth: Line width in pixels (default: 0, can be vector)
showlegend: Whether to show legend entry (default: nothing, can be vector)

source

PlotlySupply.plot_stem! — Method

function plot_stem!(
	fig,
	x::Union{AbstractRange, Vector, SubArray},
	y::Union{AbstractRange, Vector, SubArray};
	xlabel::String = "",
	ylabel::String = "",
	xrange::Vector = [0, 0],
	yrange::Vector = [0, 0],
	width::Int = 0,
	height::Int = 0,
	color::Union{String, Vector{String}} = "",
	legend::Union{String, Vector{String}} = "",
	title::String = "",
	fontsize::Int = 0,
	grid::Bool = true,
	xscale::String = "",
	yscale::String = "",
	showlegend::Union{Nothing, Bool, Vector{Bool}} = nothing,
)

Adds new stem plot traces to an existing figure.

Arguments

fig: Existing plot figure to append to
x: x-coordinate data (can be vector of vectors)
y: y-coordinate data (can be vector of vectors)

Keywords

xlabel: Label for the x-axis (default: "")
ylabel: Label for the y-axis (default: "")
xrange: Range for the x-axis (default: [0, 0])
yrange: Range for the y-axis (default: [0, 0])
width: Width of the plot (default: 0)
height: Height of the plot (default: 0)
color: Color of the plot lines (default: "", can be vector)
legend: Name of the plot lines (default: "", can be vector)
title: Title of the figure (default: "")
fontsize: Font size for plot text (default: 0, uses Plotly default)
grid: Whether to show the grid or not (default: true)
xscale: X-axis scale type ("log" for logarithmic, default: "")
yscale: Y-axis scale type ("log" for logarithmic, default: "")
showlegend: Whether to show legend entry (default: nothing, can be vector)

source

PlotlySupply.plot_stem! — Method

function plot_stem!(
	fig,
	y::Union{AbstractRange, Vector, SubArray};
	xlabel::String = "",
	ylabel::String = "",
	xrange::Vector = [0, 0],
	yrange::Vector = [0, 0],
	width::Int = 0,
	height::Int = 0,
	color::Union{String, Vector{String}} = "",
	legend::Union{String, Vector{String}} = "",
	title::String = "",
	fontsize::Int = 0,
	grid::Bool = true,
	xscale::String = "",
	yscale::String = "",
	showlegend::Union{Nothing, Bool, Vector{Bool}} = nothing,
)

Adds new stem plot traces to an existing figure (x-axis not specified, uses indices).

Arguments

fig: Existing plot figure to append to
y: y-coordinate data (can be vector of vectors)

Keywords

xlabel: Label for the x-axis (default: "")
ylabel: Label for the y-axis (default: "")
xrange: Range for the x-axis (default: [0, 0])
yrange: Range for the y-axis (default: [0, 0])
width: Width of the plot (default: 0)
height: Height of the plot (default: 0)
color: Color of the plot lines (default: "", can be vector)
legend: Name of the plot lines (default: "", can be vector)
title: Title of the figure (default: "")
fontsize: Font size for plot text (default: 0, uses Plotly default)
grid: Whether to show the grid or not (default: true)
xscale: X-axis scale type ("log" for logarithmic, default: "")
yscale: Y-axis scale type ("log" for logarithmic, default: "")
showlegend: Whether to show legend entry (default: nothing, can be vector)

source

PlotlySupply.plot_stem — Method

function plot_stem(
	x::Union{AbstractRange, Vector, SubArray},
	y::Union{AbstractRange, Vector, SubArray};
	xlabel::String = "",
	ylabel::String = "",
	xrange::Vector = [0, 0],
	yrange::Vector = [0, 0],
	width::Int = 0,
	height::Int = 0,
	color::Union{String, Vector{String}} = "",
	legend::Union{String, Vector{String}} = "",
	title::String = "",
	fontsize::Int = 0,
	grid::Bool = true,
	xscale::String = "",
	yscale::String = "",
	showlegend::Union{Nothing, Bool, Vector{Bool}} = nothing,
)

Plots a rectangular stem plot.

Arguments

x: x-coordinate data (can be vector of vectors)
y: y-coordinate data (can be vector of vectors)

Keywords

xlabel: Label for the x-axis (default: "")
ylabel: Label for the y-axis (default: "")
xrange: Range for the x-axis (default: [0, 0])
yrange: Range for the y-axis (default: [0, 0])
width: Width of the plot (default: 0)
height: Height of the plot (default: 0)
color: Color of the plot lines (default: "", can be vector)
legend: Name of the plot lines (default: "", can be vector)
title: Title of the figure (default: "")
grid: Whether to show the grid or not (default: true)
fontsize: Font size for plot text (default: 0, uses Plotly default)
xscale: X-axis scale type ("log" for logarithmic, default: "")
yscale: Y-axis scale type ("log" for logarithmic, default: "")
showlegend: Whether to show legend entry (default: nothing, can be vector)

source

PlotlySupply.plot_stem — Method

function plot_stem(
	y::Union{AbstractRange, Vector, SubArray};
	xlabel::String = "",
	ylabel::String = "",
	xrange::Vector = [0, 0],
	yrange::Vector = [0, 0],
	width::Int = 0,
	height::Int = 0,
	color::Union{String, Vector{String}} = "",
	legend::Union{String, Vector{String}} = "",
	title::String = "",
	fontsize::Int = 0,
	grid::Bool = true,
	xscale::String = "",
	yscale::String = "",
	showlegend::Union{Nothing, Bool, Vector{Bool}} = nothing,
)

Plots a rectangular stem plot (x-axis not specified).

Arguments

y: y-coordinate data (can be vector of vectors)

Keywords

xlabel: Label for the x-axis (default: "")
ylabel: Label for the y-axis (default: "")
xrange: Range for the x-axis (default: [0, 0])
yrange: Range for the y-axis (default: [0, 0])
width: Width of the plot (default: 0)
height: Height of the plot (default: 0)
color: Color of the plot lines (default: "", can be vector)
legend: Name of the plot lines (default: "", can be vector)
title: Title of the figure (default: "")
grid: Whether to show the grid or not (default: true)
fontsize: Font size for plot text (default: 0, uses Plotly default)
xscale: X-axis scale type ("log" for logarithmic, default: "")
yscale: Y-axis scale type ("log" for logarithmic, default: "")
showlegend: Whether to show legend entry (default: nothing, can be vector)

source

PlotlySupply.plot_surface! — Method

function plot_surface!(
	fig,
	X::Union{AbstractRange, Array, SubArray},
	Y::Union{AbstractRange, Array, SubArray},
	Z::Union{SubArray, Array};
	surfacecolor::Array = [],
	xrange::Vector = [0, 0],
	yrange::Vector = [0, 0],
	zrange::Vector = [0, 0],
	width::Int = 0,
	height::Int = 0,
	xlabel::String = "",
	ylabel::String = "",
	zlabel::String = "",
	aspectmode::String = "auto",
	colorscale::String = "",
	title::String = "",
	fontsize::Int = 0,
	grid::Bool = true,
	showaxis::Bool = true,
)

Adds new surface traces to an existing figure.

Arguments

fig: Existing plot figure to append to
X: X-coordinates
Y: Y-coordinates
Z: Z-coordinates

Keywords

surfacecolor: Color values for each surface point (default: [])
xrange: Range for the x-axis (default: [0, 0])
yrange: Range for the y-axis (default: [0, 0])
zrange: Range for the z-axis (default: [0, 0])
width: Width of the figure in pixels (default: 0)
height: Height of the figure in pixels (default: 0)
xlabel: Label for the x-axis (default: "")
ylabel: Label for the y-axis (default: "")
zlabel: Label for the z-axis (default: "")
aspectmode: Aspect mode setting (default: "auto")
colorscale: Color scale for the surface (default: "")
title: Title of the figure (default: "")
grid: Whether to display grid lines (default: true)
showaxis: Whether to show axis lines and labels (default: true)
shared_coloraxis: If true, uses a shared coloraxis (single colorbar) for multiple surfaces (default: false)
fontsize: Font size for plot text (default: 0, uses Plotly default)

source

PlotlySupply.plot_surface — Method

function plot_surface(
	X::Array,
	Y::Array,
	Z::Array;
	surfacecolor::Array = [],
	xrange::Vector = [0, 0],
	yrange::Vector = [0, 0],
	zrange::Vector = [0, 0],
	width::Int = 0,
	height::Int = 0,
	xlabel::String = "",
	ylabel::String = "",
	zlabel::String = "",
	aspectmode::String = "auto",
	colorscale::String = "",
	title::String = "",
	fontsize::Int = 0,
	grid::Bool = true,
	showaxis::Bool = true,
)

Plots a 3D surface using x, y, z coordinate grids.

Arguments

X: Grid of x-coordinates
Y: Grid of y-coordinates
Z: Grid of z-values defining the surface height

Keywords

surfacecolor: Color values for each surface point (default: [])
xrange: Range for the x-axis (default: [0, 0])
yrange: Range for the y-axis (default: [0, 0])
zrange: Range for the z-axis (default: [0, 0])
width: Width of the figure in pixels (default: 0)
height: Height of the figure in pixels (default: 0)
xlabel: Label for the x-axis (default: "x")
ylabel: Label for the y-axis (default: "y")
zlabel: Label for the z-axis (default: "z")
aspectmode: Aspect mode setting (default: "auto")
colorscale: Color scale for the surface (default: "")
title: Title of the figure (default: "")
grid: Whether to display grid lines (default: true)
showaxis: Whether to show axis lines and labels (default: true)
shared_coloraxis: If true, uses a shared coloraxis (single colorbar) for multiple surfaces (default: false)
fontsize: Font size for plot text (default: 0, uses Plotly default)

source

PlotlySupply.plot_surface — Method

plot_surface(
	Z::Array;
	surfacecolor::Array = [],
	xrange::Vector = [0, 0],
	yrange::Vector = [0, 0],
	zrange::Vector = [0, 0],
	width::Int = 0,
	height::Int = 0,
	xlabel::String = "",
	ylabel::String = "",
	zlabel::String = "",
	aspectmode::String = "auto",
	colorscale::String = "",
	title::String = "",
	fontsize::Int = 0,
	grid::Bool = true,
	showaxis::Bool = true,
)

Plots a 3D surface given a matrix of height values Z, using the array indices as x and y coordinates.

Arguments

Z::Array: 2D array representing surface height. The dimensions of Z define the surface grid, with x and y coordinates automatically generated as 0:size(Z, 1)-1 and 0:size(Z, 2)-1.

Keyword Arguments

surfacecolor::Array: Optional array for surface coloring. If empty, Z is used for coloring.
xrange::Vector: [xmin, xmax] range for the x-axis. [0, 0] disables manual range.
yrange::Vector: [ymin, ymax] range for the y-axis.
zrange::Vector: [zmin, zmax] range for the z-axis.
width::Int: Width of the figure in pixels. 0 uses default.
height::Int: Height of the figure in pixels. 0 uses default.
xlabel::String: Label for x-axis (defaults to "x" if empty).
ylabel::String: Label for y-axis (defaults to "y" if empty).
zlabel::String: Label for z-axis (defaults to "z" if empty).
aspectmode::String: 3D scene aspect mode ("auto", "cube", "data").
colorscale::String: Colorscale name (e.g., "", "Viridis").
title::String: Plot title.
grid::Bool: If false, disables grid lines.
showaxis::Bool: If false, hides all axes.
shared_coloraxis::Bool: If true, uses a shared coloraxis (single colorbar) for multiple surfaces.
fontsize::Int: Font size for plot text (default: 0, uses Plotly default).

Returns

A Plot object.

Notes

This function is a convenience wrapper for plot_surface(X, Y, Z; ...), where X and Y are index grids derived from the shape of Z.

source

PlotlySupply.set_default_legend_position! — Function

set_default_legend_position!(position = :topright)

Set the package-wide default legend position. Accepted symbols include :topright, :top, :topleft, :right, :center, :left, :bottomright, :bottom, and :bottomleft.

source

PlotlySupply.set_default_template! — Function

set_default_template!(template = "plotly_white")

Set the package-wide default Plotly template used by high-level constructors. Invalid values fall back to :plotly_white.

source

PlotlySupply.set_legend! — Method

set_legend!(fig; position=:topright, kwargs...)

Set legend placement and styling with simple position symbols such as :top, :topright, :left, :bottomleft, or :outside_right.

source

PlotlySupply.set_template! — Function

set_template!(fig, template = "plotly_white")

Applies a visual template to a figure.

Arguments

fig: A PlotlyBase.Plot or a PlotlySupply.SyncPlot.
template: Template name string or symbol.

Notes

This modifies the figure in-place using relayout!.
Available templates include plotly, ggplot2, seaborn, simple_white, plotly_dark, etc.

source

PlotlySupply.subplot! — Method

subplot!(sf, row, col)
subplot!(sf, index)

Set the active subplot cell in a SubplotFigure.

source

PlotlySupply.subplot_legends! — Method

subplot_legends!(fig; kwargs...)

Attach each subplot to its own legend box and place that legend inside the subplot domain. This avoids Plotly's default behavior where all legends are clustered in one place.

source

PlotlySupply.subplots — Method

subplots(rows, cols; kwargs...)

Create a MATLAB-like subplot canvas and return a SubplotFigure. Use subplot!(sf, row, col) to change the active cell and plot!(sf, x, y) to append traces.

source