PlotlyBase.Plot
— TypePlot(d, y; ...)
Plot(d, y, l; kwargs...)
-
Construct a plot from df
, passing the provided value y as a keyword argument. See docstring for other method for more information.
diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index 77695c5..71c8c60 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-01-15T11:09:53","documenter_version":"1.2.1"}} \ No newline at end of file +{"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-01-19T13:24:42","documenter_version":"1.2.1"}} \ No newline at end of file diff --git a/dev/api/index.html b/dev/api/index.html index 7cfb3c0..3c65334 100644 --- a/dev/api/index.html +++ b/dev/api/index.html @@ -99,7 +99,11 @@ Plot(d, x, y, l; kwargs...)
Construct a plot from df
, passing the provided values of x and y as keyword arguments. See docstring for other method for more information.
PlotlyBase.Plot
— TypePlot(d, y; ...)
Plot(d, y, l; kwargs...)
-
Construct a plot from df
, passing the provided value y as a keyword argument. See docstring for other method for more information.
PlotlyBase.Plot
— TypePlot(df; ...)
+
Construct a plot from df
, passing the provided value y as a keyword argument. See docstring for other method for more information.
PlotlyBase.Plot
— TypePlot(f, x0, x1; ...)
+Plot(f, x0, x1, l; config, kwargs...)
+
Construct a plot of f
from x0
to x1
, using the layout l
. All keyword arguments are applied to the constructed trace.
PlotlyBase.Plot
— TypePlot(fs, x0, x1; ...)
+Plot(fs, x0, x1, l; config, kwargs...)
+
For each function in f
in fs
, construct a scatter trace that plots f
from x0
to x1
, using the layout l
. All keyword arguments are applied to all constructed traces.
PlotlyBase.Plot
— TypePlot(df; ...)
Plot(
df,
l;
@@ -115,25 +119,21 @@
line_dash,
kw...
)
-
Construct a plot using the columns of df
if possible. For each keyword argument, if the value of the argument is a Symbol and the df
has a column whose name matches the value, replace the value with the column of the df
.
If group
is passed and is a Symbol that is one of the column names of df
, then call by(df, group)
and construct one trace per SubDataFrame, passing all other keyword arguments. This means all keyword arguments are passed applied to all traces
All keyword arguments are passed directly to the trace constructor, with the following exceptions:
category_orders
: A mapping from DataFrame column name to a vector of values that appear in that column. Wherever the column is used in the chart (facets, x, y, etc.) the chart elements tied to the column will be sorted according to the vector of values specified here. This ordering can be partial, in which case all elements that appear in the DataFrame, but not in the vector of values specified here, will be included after values explicitly listed here.labels
: A mapping from column names (symbols) to text that should appear on the chart. This can be used to customize the title of axes, title of legend, etc.facet_row
: A symbol denoting which DataFrame column should be used to create facetted subplots in the vertical direction.facet_col
: A symbol denoting which DataFrame column should be used to create facetted subplots in the horizontal direction.symbol
: A symbol noting which column should be used for the marker symbol. The values of this column are not used directly, but rather a new trace will be created for each unique value in this column. Each trace will have a different marker symbol, such as circle, diamond, square, etc.color
: Similar to symbol
, but for the color of a traceline_dash
: Similar to symbol
, but for the line style of a trace.PlotlyBase.Plot
— TypePlot(f, x0, x1; ...)
-Plot(f, x0, x1, l; config, kwargs...)
-
Construct a plot of f
from x0
to x1
, using the layout l
. All keyword arguments are applied to the constructed trace.
PlotlyBase.Plot
— TypePlot(fs, x0, x1; ...)
-Plot(fs, x0, x1, l; config, kwargs...)
-
For each function in f
in fs
, construct a scatter trace that plots f
from x0
to x1
, using the layout l
. All keyword arguments are applied to all constructed traces.
PlotlyBase.Plot
— MethodPlot(y; ...)
+
Construct a plot using the columns of df
if possible. For each keyword argument, if the value of the argument is a Symbol and the df
has a column whose name matches the value, replace the value with the column of the df
.
If group
is passed and is a Symbol that is one of the column names of df
, then call by(df, group)
and construct one trace per SubDataFrame, passing all other keyword arguments. This means all keyword arguments are passed applied to all traces
All keyword arguments are passed directly to the trace constructor, with the following exceptions:
category_orders
: A mapping from DataFrame column name to a vector of values that appear in that column. Wherever the column is used in the chart (facets, x, y, etc.) the chart elements tied to the column will be sorted according to the vector of values specified here. This ordering can be partial, in which case all elements that appear in the DataFrame, but not in the vector of values specified here, will be included after values explicitly listed here.labels
: A mapping from column names (symbols) to text that should appear on the chart. This can be used to customize the title of axes, title of legend, etc.facet_row
: A symbol denoting which DataFrame column should be used to create facetted subplots in the vertical direction.facet_col
: A symbol denoting which DataFrame column should be used to create facetted subplots in the horizontal direction.symbol
: A symbol noting which column should be used for the marker symbol. The values of this column are not used directly, but rather a new trace will be created for each unique value in this column. Each trace will have a different marker symbol, such as circle, diamond, square, etc.color
: Similar to symbol
, but for the color of a traceline_dash
: Similar to symbol
, but for the line style of a trace.PlotlyBase.Plot
— MethodPlot(y; ...)
Plot(y, l; kwargs...)
Build a scatter plot and set y
to y. All keyword arguments are passed directly as keyword arguments to the constructed scatter.
PlotlyBase.Plot
— MethodPlot(x, y; ...)
Plot(x, y, l; kind, config, kwargs...)
-
Build a plot of with one trace of type kind
and set x
to x and y
to y. All keyword arguments are passed directly as keyword arguments to the constructed trace.
NOTE: If y
is a matrix, one trace is constructed for each column of y
NOTE: If x
and y
are both matrices, they must have the same number of columns (say N
). Then N
traces are constructed, where the i
th column of x
is paired with the i
th column of y
.
PlotlyBase.PlotConfig
— TypePlotConfig(;kwargs...)
Configuration options to be sent to the frontend to control aspects of how the plot is rendered. The acceptable keyword arguments are:
scrollZoom
: Determines whether mouse wheel or two-finger scroll zooms is enable. Turned on by default for gl3d, geo and mapbox subplots (as these subplot types do not have zoombox via pan), but turned off by default for cartesian subplots. Set scrollZoom
to false to disable scrolling for all subplots.editable
: Determines whether the graph is editable or not. Sets all pieces of edits
unless a separate edits
config item overrides individual parts.staticPlot
: Determines whether the graphs are interactive or not. If false, no interactivity, for export or image generation.toImageButtonOptions
: Statically override options for toImage modebar button allowed keys are format, filename, width, heightdisplayModeBar
: Determines the mode bar display mode. If true, the mode bar is always visible. If false, the mode bar is always hidden. If hover, the mode bar is visible while the mouse cursor is on the graph container.modeBarButtonsToRemove
: Remove mode bar buttons by namemodeBarButtonsToAdd
: Add mode bar button using config objects. To enable predefined modebar buttons e.g. shape drawing, hover and spikelines, simply provide their string name(s). This could include: v1hovermode, hoverclosest, hovercompare, togglehover, togglespikelines, drawline, drawopenpath, drawclosedpath, drawcircle, drawrect and eraseshape. Please note that these predefined buttons will only be shown if they are compatible with all trace types used in a graph.modeBarButtons
: Define fully custom mode bar buttons as nested array where the outer arrays represents button groups, and the inner arrays have buttons config objects or names of default buttons.showLink
: Determines whether a link to Chart Studio Cloud is displayed at the bottom right corner of resulting graphs. Use with sendData
and linkText
.plotlyServerURL
: When set it determines base URL for the 'Edit in Chart Studio' showEditInChartStudio
/showSendToCloud
mode bar button and the showLink/sendData on-graph link. To enable sending your data to Chart Studio Cloud, you need to set both plotlyServerURL
to 'https://chart-studio.plotly.com' and also set showSendToCloud
to true.linkText
: Sets the text appearing in the showLink
link.showEditInChartStudio
: Same as showSendToCloud
, but use a pencil icon instead of a floppy-disk. Note that if both showSendToCloud
and showEditInChartStudio
are turned, only showEditInChartStudio
will be honored.locale
: Which localization should we use? Should be a string like 'en' or 'en-US'.displaylogo
: Determines whether or not the plotly logo is displayed on the end of the mode bar.responsive
: Determines whether to change the layout size when window is resized.doubleClickDelay
: Sets the delay for registering a double-click in ms. This is the time interval (in ms) between first mousedown and 2nd mouseup to constitute a double-click. This setting propagates to all on-subplot double clicks (except for geo and mapbox) and on-legend double clicks.PlotlyBase.Spec
— TypeParameters
kind
Subplot type. One of
secondary_y
: If true, create a secondary y-axis positioned on the right side of the subplot. Only valid if kind="xy".
colspan
: number of subplot columns for this subplot to span.
rowspan
: number of subplot rows for this subplot to span.
l
: padding left of cell
r
: padding right of cell
t
: padding right of cell
b
: padding bottom of cell
PlotlyBase.Subplots
— TypeParameters
rows
: Number of rows in the subplot grid. Must be greater than zero.cols
: Number of columns in the subplot grid. Must be greater than zero.shared_xaxes
: Assign shared (linked) x-axes for 2D cartesian subplotsshared_yaxes
: Assign shared (linked) y-axes for 2D cartesian subplotsstart_cell
: Choose the starting cell in the subplot grid used to set the domains_grid of the subplots.horizontal_spacing
: Space between subplot columns in normalized plot coordinates. Must be a float between 0 and 1. Applies to all columns (use "specs" subplot-dependents spacing)vertical_spacing
: Space between subplot rows in normalized plot coordinates. Must be a float between 0 and 1. Applies to all rows (use "specs" subplot-dependents spacing)subplot_titles
: Title of each subplot as a list in row-major ordering. Empty strings ("") can be included in the list if no subplot title is desired in that space so that the titles are properly indexed.specs
: Per subplot specifications of subplot type, row/column spanning, and spacing.Spec
. See docs for Spec
for more informationhorizontal_spacing
and vertical_spacing
to adjust the spacing in between the subplots.insets
: Inset specifications. Insets are subplots that overlay grid subplotsInset
. See docs for Inset
for more infocolumn_widths
: Array of length cols
of the relative widths of each column of suplots. Values are normalized internally and used to distribute overall width of the figure (excluding padding) among the columns.row_heights
: Array of length rows
of the relative heights of each row of subplots. Values are normalized internally and used to distribute overall height of the figure (excluding padding) among the rowscolumn_titles
: list of length cols
of titles to place above the top subplot in each column.row_titles
: list of length rows
of titles to place on the right side of each row of subplots.x_title
: Title to place below the bottom row of subplots, centered horizontallyy_title
: Title to place to the left of the left column of subplots, centered verticallyPlotlyJS.make_subplots
— FunctionParameters
rows
: Number of rows in the subplot grid. Must be greater than zero.cols
: Number of columns in the subplot grid. Must be greater than zero.shared_xaxes
: Assign shared (linked) x-axes for 2D cartesian subplotsshared_yaxes
: Assign shared (linked) y-axes for 2D cartesian subplotsstart_cell
: Choose the starting cell in the subplot grid used to set the domains_grid of the subplots.horizontal_spacing
: Space between subplot columns in normalized plot coordinates. Must be a float between 0 and 1. Applies to all columns (use "specs" subplot-dependents spacing)vertical_spacing
: Space between subplot rows in normalized plot coordinates. Must be a float between 0 and 1. Applies to all rows (use "specs" subplot-dependents spacing)subplot_titles
: Title of each subplot as a list in row-major ordering. Empty strings ("") can be included in the list if no subplot title is desired in that space so that the titles are properly indexed.specs
: Per subplot specifications of subplot type, row/column spanning, and spacing.Spec
. See docs for Spec
for more informationhorizontal_spacing
and vertical_spacing
to adjust the spacing in between the subplots.insets
: Inset specifications. Insets are subplots that overlay grid subplotsInset
. See docs for Inset
for more infocolumn_widths
: Array of length cols
of the relative widths of each column of suplots. Values are normalized internally and used to distribute overall width of the figure (excluding padding) among the columns.row_heights
: Array of length rows
of the relative heights of each row of subplots. Values are normalized internally and used to distribute overall height of the figure (excluding padding) among the rowscolumn_titles
: list of length cols
of titles to place above the top subplot in each column.row_titles
: list of length rows
of titles to place on the right side of each row of subplots.x_title
: Title to place below the bottom row of subplots, centered horizontallyy_title
: Title to place to the left of the left column of subplots, centered verticallyPlotlyJS.savefig
— Methodsavefig(
+
Build a plot of with one trace of type kind
and set x
to x and y
to y. All keyword arguments are passed directly as keyword arguments to the constructed trace.
NOTE: If y
is a matrix, one trace is constructed for each column of y
NOTE: If x
and y
are both matrices, they must have the same number of columns (say N
). Then N
traces are constructed, where the i
th column of x
is paired with the i
th column of y
.
PlotlyBase.PlotConfig
— TypePlotConfig(;kwargs...)
Configuration options to be sent to the frontend to control aspects of how the plot is rendered. The acceptable keyword arguments are:
scrollZoom
: Determines whether mouse wheel or two-finger scroll zooms is enable. Turned on by default for gl3d, geo and mapbox subplots (as these subplot types do not have zoombox via pan), but turned off by default for cartesian subplots. Set scrollZoom
to false to disable scrolling for all subplots.editable
: Determines whether the graph is editable or not. Sets all pieces of edits
unless a separate edits
config item overrides individual parts.staticPlot
: Determines whether the graphs are interactive or not. If false, no interactivity, for export or image generation.toImageButtonOptions
: Statically override options for toImage modebar button allowed keys are format, filename, width, heightdisplayModeBar
: Determines the mode bar display mode. If true, the mode bar is always visible. If false, the mode bar is always hidden. If hover, the mode bar is visible while the mouse cursor is on the graph container.modeBarButtonsToRemove
: Remove mode bar buttons by namemodeBarButtonsToAdd
: Add mode bar button using config objects. To enable predefined modebar buttons e.g. shape drawing, hover and spikelines, simply provide their string name(s). This could include: v1hovermode, hoverclosest, hovercompare, togglehover, togglespikelines, drawline, drawopenpath, drawclosedpath, drawcircle, drawrect and eraseshape. Please note that these predefined buttons will only be shown if they are compatible with all trace types used in a graph.modeBarButtons
: Define fully custom mode bar buttons as nested array where the outer arrays represents button groups, and the inner arrays have buttons config objects or names of default buttons.showLink
: Determines whether a link to Chart Studio Cloud is displayed at the bottom right corner of resulting graphs. Use with sendData
and linkText
.plotlyServerURL
: When set it determines base URL for the 'Edit in Chart Studio' showEditInChartStudio
/showSendToCloud
mode bar button and the showLink/sendData on-graph link. To enable sending your data to Chart Studio Cloud, you need to set both plotlyServerURL
to 'https://chart-studio.plotly.com' and also set showSendToCloud
to true.linkText
: Sets the text appearing in the showLink
link.showEditInChartStudio
: Same as showSendToCloud
, but use a pencil icon instead of a floppy-disk. Note that if both showSendToCloud
and showEditInChartStudio
are turned, only showEditInChartStudio
will be honored.locale
: Which localization should we use? Should be a string like 'en' or 'en-US'.displaylogo
: Determines whether or not the plotly logo is displayed on the end of the mode bar.responsive
: Determines whether to change the layout size when window is resized.doubleClickDelay
: Sets the delay for registering a double-click in ms. This is the time interval (in ms) between first mousedown and 2nd mouseup to constitute a double-click. This setting propagates to all on-subplot double clicks (except for geo and mapbox) and on-legend double clicks.PlotlyBase.Spec
— TypeParameters
kind
Subplot type. One of
secondary_y
: If true, create a secondary y-axis positioned on the right side of the subplot. Only valid if kind="xy".
colspan
: number of subplot columns for this subplot to span.
rowspan
: number of subplot rows for this subplot to span.
l
: padding left of cell
r
: padding right of cell
t
: padding right of cell
b
: padding bottom of cell
PlotlyBase.Subplots
— TypeParameters
rows
: Number of rows in the subplot grid. Must be greater than zero.cols
: Number of columns in the subplot grid. Must be greater than zero.shared_xaxes
: Assign shared (linked) x-axes for 2D cartesian subplotsshared_yaxes
: Assign shared (linked) y-axes for 2D cartesian subplotsstart_cell
: Choose the starting cell in the subplot grid used to set the domains_grid of the subplots.horizontal_spacing
: Space between subplot columns in normalized plot coordinates. Must be a float between 0 and 1. Applies to all columns (use "specs" subplot-dependents spacing)vertical_spacing
: Space between subplot rows in normalized plot coordinates. Must be a float between 0 and 1. Applies to all rows (use "specs" subplot-dependents spacing)subplot_titles
: Title of each subplot as a list in row-major ordering. Empty strings ("") can be included in the list if no subplot title is desired in that space so that the titles are properly indexed.specs
: Per subplot specifications of subplot type, row/column spanning, and spacing.Spec
. See docs for Spec
for more informationhorizontal_spacing
and vertical_spacing
to adjust the spacing in between the subplots.insets
: Inset specifications. Insets are subplots that overlay grid subplotsInset
. See docs for Inset
for more infocolumn_widths
: Array of length cols
of the relative widths of each column of suplots. Values are normalized internally and used to distribute overall width of the figure (excluding padding) among the columns.row_heights
: Array of length rows
of the relative heights of each row of subplots. Values are normalized internally and used to distribute overall height of the figure (excluding padding) among the rowscolumn_titles
: list of length cols
of titles to place above the top subplot in each column.row_titles
: list of length rows
of titles to place on the right side of each row of subplots.x_title
: Title to place below the bottom row of subplots, centered horizontallyy_title
: Title to place to the left of the left column of subplots, centered verticallyPlotlyJS.make_subplots
— FunctionParameters
rows
: Number of rows in the subplot grid. Must be greater than zero.cols
: Number of columns in the subplot grid. Must be greater than zero.shared_xaxes
: Assign shared (linked) x-axes for 2D cartesian subplotsshared_yaxes
: Assign shared (linked) y-axes for 2D cartesian subplotsstart_cell
: Choose the starting cell in the subplot grid used to set the domains_grid of the subplots.horizontal_spacing
: Space between subplot columns in normalized plot coordinates. Must be a float between 0 and 1. Applies to all columns (use "specs" subplot-dependents spacing)vertical_spacing
: Space between subplot rows in normalized plot coordinates. Must be a float between 0 and 1. Applies to all rows (use "specs" subplot-dependents spacing)subplot_titles
: Title of each subplot as a list in row-major ordering. Empty strings ("") can be included in the list if no subplot title is desired in that space so that the titles are properly indexed.specs
: Per subplot specifications of subplot type, row/column spanning, and spacing.Spec
. See docs for Spec
for more informationhorizontal_spacing
and vertical_spacing
to adjust the spacing in between the subplots.insets
: Inset specifications. Insets are subplots that overlay grid subplotsInset
. See docs for Inset
for more infocolumn_widths
: Array of length cols
of the relative widths of each column of suplots. Values are normalized internally and used to distribute overall width of the figure (excluding padding) among the columns.row_heights
: Array of length rows
of the relative heights of each row of subplots. Values are normalized internally and used to distribute overall height of the figure (excluding padding) among the rowscolumn_titles
: list of length cols
of titles to place above the top subplot in each column.row_titles
: list of length rows
of titles to place on the right side of each row of subplots.x_title
: Title to place below the bottom row of subplots, centered horizontallyy_title
: Title to place to the left of the left column of subplots, centered verticallyPlotlyJS.savefig
— Methodsavefig(
io::IO,
p::Plot;
width::Union{Nothing,Int}=nothing,
height::Union{Nothing,Int}=nothing,
scale::Union{Nothing,Real}=nothing,
format::String="png"
-)
Save a plot p
to the io stream io
. They keyword argument format
determines the type of data written to the figure and must be one of png, jpeg, webp, svg, pdf, eps, json, or html. scale
sets the image scale. width
and height
set the dimensions, in pixels. Defaults are taken from p.layout
, or supplied by plotly
PlotlyJS.savefig
— Methodsavefig(
+)
Save a plot p
to the io stream io
. They keyword argument format
determines the type of data written to the figure and must be one of png, jpeg, webp, svg, pdf, eps, json, or html. scale
sets the image scale. width
and height
set the dimensions, in pixels. Defaults are taken from p.layout
, or supplied by plotly
PlotlyJS.savefig
— Methodsavefig(
p::Plot, fn::AbstractString;
format::Union{Nothing,String}=nothing,
width::Union{Nothing,Int}=nothing,
height::Union{Nothing,Int}=nothing,
scale::Union{Nothing,Real}=nothing,
-)
Save a plot p
to a file named fn
. If format
is given and is one of png, jpeg, webp, svg, pdf, eps, json, or html; it will be the format of the file. By default the format is guessed from the extension of fn
. scale
sets the image scale. width
and height
set the dimensions, in pixels. Defaults are taken from p.layout
, or supplied by plotly
Settings
This document was generated with Documenter.jl version 1.2.1 on Monday 15 January 2024. Using Julia version 1.10.0.