Plotly.NET
Chart Type
Provides a set of static methods for creating and styling charts.
Static members
| Static member | Description |
Full Usage:
Chart.Grid(?SubPlotTitles, ?SubPlotTitleFont, ?SubPlotTitleOffset, ?SubPlots, ?XAxes, ?YAxes, ?RowOrder, ?Pattern, ?XGap, ?YGap, ?Domain, ?XSide, ?YSide)
Parameters:
'a
-
A collection of titles for the individual subplots.
?SubPlotTitleFont : Font
-
The font of the subplot titles
?SubPlotTitleOffset : float
-
A vertical offset applied to each subplot title, moving it upwards if positive and vice versa
?SubPlots : (LinearAxisId * LinearAxisId)[][]
-
Used for freeform grids, where some axes may be shared across subplots but others are not. Each entry should be a cartesian subplot id, like "xy" or "x3y2", or "" to leave that cell empty. You may reuse x axes within the same column, and y axes within the same row. Non-cartesian subplots and traces that support `domain` can place themselves in this grid separately using the `gridcell` attribute.
?XAxes : LinearAxisId[]
-
Used with `yaxes` when the x and y axes are shared across columns and rows. Each entry should be an y axis id like "y", "y2", etc., or "" to not put a y axis in that row. Entries other than "" must be unique. Ignored if `subplots` is present. If missing but `xaxes` is present, will generate consecutive IDs.
?YAxes : LinearAxisId[]
-
Used with `yaxes` when the x and y axes are shared across columns and rows. Each entry should be an x axis id like "x", "x2", etc., or "" to not put an x axis in that column. Entries other than "" must be unique. Ignored if `subplots` is present. If missing but `yaxes` is present, will generate consecutive IDs.
?RowOrder : LayoutGridRowOrder
-
Is the first row the top or the bottom? Note that columns are always enumerated from left to right.
?Pattern : LayoutGridPattern
-
If no `subplots`, `xaxes`, or `yaxes` are given but we do have `rows` and `columns`, we can generate defaults using consecutive axis IDs, in two ways: "coupled" gives one x axis per column and one y axis per row. "independent" uses a new xy pair for each cell, left-to-right across each row then iterating rows according to `roworder`.
?XGap : float
-
Horizontal space between grid cells, expressed as a fraction of the total width available to one cell. Defaults to 0.1 for coupled-axes grids and 0.2 for independent grids.
?YGap : float
-
Vertical space between grid cells, expressed as a fraction of the total height available to one cell. Defaults to 0.1 for coupled-axes grids and 0.3 for independent grids.
?Domain : Domain
-
Sets the domains of this grid subplot (in plot fraction). The first and last cells end exactly at the domain edges, with no grout around the edges.
?XSide : LayoutGridXSide
-
Sets where the x axis labels and titles go. "bottom" means the very bottom of the grid. "bottom plot" is the lowest plot that each x axis is used in. "top" and "top plot" are similar.
?YSide : LayoutGridYSide
-
Sets where the y axis labels and titles go. "left" means the very left edge of the grid. "left plot" is the leftmost plot that each y axis is used in. "right" and "right plot" are similar.
Returns: 'b -> GenericChart
|
Creates a subplot grid with the the dimensions of the input 2D sequence containing the charts to render in the respective cells. ATTENTION: when the individual rows do not have the same amount of charts, they will be filled with dummy charts TO THE RIGHT. prevent this behaviour by using Chart.Invisible at the cells that should be empty. For each input chart, a corresponding subplot cell is created in the grid. The following limitations apply to the individual grid cells: - only one pair of 2D cartesian axes is allowed per cell. If there are multiple x or y axes on an input chart, the first one is used, and the rest is discarded (meaning, it is removed from the combined layout). if you need multiple axes per grid cell, create a custom grid by manually creating axes with custom domains instead. The new id of the axes corresponds to the number of the grid cell, e.g. the third grid cell will contain xaxis3 and yaxis3 - For other subplot layouts (Cartesian3D, Polar, Ternary, Geo, Mapbox, Smith), the same rule applies: only one subplot per grid cell, the first one is used, the rest is discarded. The new id of the subplot layout corresponds to the number of the grid cell, e.g. the third grid cell will contain scene3 etc. - The Domain of traces that calculate their position by domain only (e.g. Pie traces) are replaced by a domain pointing to the new grid position. - If SubPlotTitles are provided, they are used as the titles of the individual cells in ascending order. If the number of titles is less than the number of subplots, the remaining subplots are left without a title.
|
Full Usage:
Chart.Grid(nRows, nCols, ?SubPlotTitles, ?SubPlotTitleFont, ?SubPlotTitleOffset, ?SubPlots, ?XAxes, ?YAxes, ?RowOrder, ?Pattern, ?XGap, ?YGap, ?Domain, ?XSide, ?YSide)
Parameters:
int
-
The number of rows in the grid. If you provide a 2D `subplots` array or a `yaxes` array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots.
nCols : int
-
The number of columns in the grid. If you provide a 2D `subplots` array, the length of its longest row is used as the default. If you give an `xaxes` array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots.
?SubPlotTitles : 'a
-
A collection of titles for the individual subplots.
?SubPlotTitleFont : Font
-
The font of the subplot titles
?SubPlotTitleOffset : float
-
A vertical offset applied to each subplot title, moving it upwards if positive and vice versa
?SubPlots : (LinearAxisId * LinearAxisId)[][]
-
Used for freeform grids, where some axes may be shared across subplots but others are not. Each entry should be a cartesian subplot id, like "xy" or "x3y2", or "" to leave that cell empty. You may reuse x axes within the same column, and y axes within the same row. Non-cartesian subplots and traces that support `domain` can place themselves in this grid separately using the `gridcell` attribute.
?XAxes : LinearAxisId[]
-
Used with `yaxes` when the x and y axes are shared across columns and rows. Each entry should be an y axis id like "y", "y2", etc., or "" to not put a y axis in that row. Entries other than "" must be unique. Ignored if `subplots` is present. If missing but `xaxes` is present, will generate consecutive IDs.
?YAxes : LinearAxisId[]
-
Used with `yaxes` when the x and y axes are shared across columns and rows. Each entry should be an x axis id like "x", "x2", etc., or "" to not put an x axis in that column. Entries other than "" must be unique. Ignored if `subplots` is present. If missing but `yaxes` is present, will generate consecutive IDs.
?RowOrder : LayoutGridRowOrder
-
Is the first row the top or the bottom? Note that columns are always enumerated from left to right.
?Pattern : LayoutGridPattern
-
If no `subplots`, `xaxes`, or `yaxes` are given but we do have `rows` and `columns`, we can generate defaults using consecutive axis IDs, in two ways: "coupled" gives one x axis per column and one y axis per row. "independent" uses a new xy pair for each cell, left-to-right across each row then iterating rows according to `roworder`.
?XGap : float
-
Horizontal space between grid cells, expressed as a fraction of the total width available to one cell. Defaults to 0.1 for coupled-axes grids and 0.2 for independent grids.
?YGap : float
-
Vertical space between grid cells, expressed as a fraction of the total height available to one cell. Defaults to 0.1 for coupled-axes grids and 0.3 for independent grids.
?Domain : Domain
-
Sets the domains of this grid subplot (in plot fraction). The first and last cells end exactly at the domain edges, with no grout around the edges.
?XSide : LayoutGridXSide
-
Sets where the x axis labels and titles go. "bottom" means the very bottom of the grid. "bottom plot" is the lowest plot that each x axis is used in. "top" and "top plot" are similar.
?YSide : LayoutGridYSide
-
Sets where the y axis labels and titles go. "left" means the very left edge of the grid. "left plot" is the leftmost plot that each y axis is used in. "right" and "right plot" are similar.
Returns: 'b -> GenericChart
|
Creates a subplot grid with the given dimensions (nRows x nCols) for the input charts. The default row order is from top to bottom. For each input chart, a corresponding subplot cell is created in the grid. The following limitations apply to the individual grid cells: - only one pair of 2D cartesian axes is allowed per cell. If there are multiple x or y axes on an input chart, the first one is used, and the rest is discarded (meaning, it is removed from the combined layout). if you need multiple axes per grid cell, create a custom grid by manually creating axes with custom domains instead. The new id of the axes corresponds to the number of the grid cell, e.g. the third grid cell will contain xaxis3 and yaxis3 - For other subplot layouts (Cartesian3D, Polar, Ternary, Geo, Mapbox, Smith), the same rule applies: only one subplot per grid cell, the first one is used, the rest is discarded. The new id of the subplot layout corresponds to the number of the grid cell, e.g. the third grid cell will contain scene3 etc. - The Domain of traces that calculate their position by domain only (e.g. Pie traces) are replaced by a domain pointing to the new grid position. - If SubPlotTitles are provided, they are used as the titles of the individual cells in ascending order. If the number of titles is less than the number of subplots, the remaining subplots are left without a title.
|
|
|
Full Usage:
Chart.SingleStack(?SubPlotTitles, ?SubPlotTitleFont, ?SubPlotTitleOffset, ?SubPlots, ?XAxes, ?YAxes, ?RowOrder, ?Pattern, ?XGap, ?YGap, ?Domain, ?XSide, ?YSide)
Parameters:
'a
?SubPlotTitleFont : Font
?SubPlotTitleOffset : float
?SubPlots : (LinearAxisId * LinearAxisId)[][]
?XAxes : LinearAxisId[]
?YAxes : LinearAxisId[]
?RowOrder : LayoutGridRowOrder
?Pattern : LayoutGridPattern
?XGap : float
?YGap : float
?Domain : Domain
?XSide : LayoutGridXSide
?YSide : LayoutGridYSide
Returns: 'b -> GenericChart
|
Creates a chart stack (a subplot grid with one column) from the input charts. For each input chart, a corresponding subplot cell is created in the column. The following limitations apply to the individual grid cells: - only one pair of 2D cartesian axes is allowed per cell. If there are multiple x or y axes on an input chart, the first one is used, and the rest is discarded (meaning, it is removed from the combined layout). if you need multiple axes per grid cell, create a custom grid by manually creating axes with custom domains instead. The new id of the axes corresponds to the number of the grid cell, e.g. the third grid cell will contain xaxis3 and yaxis3 - For other subplot layouts (Cartesian3D, Polar, Ternary, Geo, Mapbox, Smith), the same rule applies: only one subplot per grid cell, the first one is used, the rest is discarded. The new id of the subplot layout corresponds to the number of the grid cell, e.g. the third grid cell will contain scene3 etc. - The Domain of traces that calculate their position by domain only (e.g. Pie traces) are replaced by a domain pointing to the new grid position. - If SubPlotTitles are provided, they are used as the titles of the individual cells in ascending order. If the number of titles is less than the number of subplots, the remaining subplots are left without a title. A collection of titles for the individual subplots. The font of the subplot titles A vertical offset applied to each subplot title, moving it upwards if positive and vice versa Used for freeform grids, where some axes may be shared across subplots but others are not. Each entry should be a cartesian subplot id, like "xy" or "x3y2", or "" to leave that cell empty. You may reuse x axes within the same column, and y axes within the same row. Non-cartesian subplots and traces that support `domain` can place themselves in this grid separately using the `gridcell` attribute. Used with `yaxes` when the x and y axes are shared across columns and rows. Each entry should be an y axis id like "y", "y2", etc., or "" to not put a y axis in that row. Entries other than "" must be unique. Ignored if `subplots` is present. If missing but `xaxes` is present, will generate consecutive IDs. Used with `yaxes` when the x and y axes are shared across columns and rows. Each entry should be an x axis id like "x", "x2", etc., or "" to not put an x axis in that column. Entries other than "" must be unique. Ignored if `subplots` is present. If missing but `yaxes` is present, will generate consecutive IDs. Is the first row the top or the bottom? Note that columns are always enumerated from left to right. If no `subplots`, `xaxes`, or `yaxes` are given but we do have `rows` and `columns`, we can generate defaults using consecutive axis IDs, in two ways: "coupled" gives one x axis per column and one y axis per row. "independent" uses a new xy pair for each cell, left-to-right across each row then iterating rows according to `roworder`. Horizontal space between grid cells, expressed as a fraction of the total width available to one cell. Defaults to 0.1 for coupled-axes grids and 0.2 for independent grids. Vertical space between grid cells, expressed as a fraction of the total height available to one cell. Defaults to 0.1 for coupled-axes grids and 0.3 for independent grids. Sets the domains of this grid subplot (in plot fraction). The first and last cells end exactly at the domain edges, with no grout around the edges. Sets where the x axis labels and titles go. "bottom" means the very bottom of the grid. "bottom plot" is the lowest plot that each x axis is used in. "top" and "top plot" are similar. Sets where the y axis labels and titles go. "left" means the very left edge of the grid. "left plot" is the leftmost plot that each y axis is used in. "right" and "right plot" are similar.
|
|
|
Full Usage:
Chart.saveHtml (path, ?OpenInBrowser)
Parameters:
string
-
The path to save the chart html at.
?OpenInBrowser : bool
-
Whether or not to open the generated file in the browser (default: false)
Returns: GenericChart -> unit
|
|
Full Usage:
Chart.setAAxis (aAxis, id, ?Combine)
Parameters:
LinearAxis
-
The a Axis to set on the target ternary object on the chart's layout
id : SubPlotId
-
The target ternary id with which the a Axis should be set.(default is 1)
?Combine : bool
-
Whether or not to combine the objects if there is already an axis set (default is false)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.setAngularAxis (angularAxis, id, ?Combine)
Parameters:
AngularAxis
-
The AngularAxis to set on the target polar object on the chart's layout
id : SubPlotId
-
The target polar id with which the AngularAxis should be set.(default is 1)
?Combine : bool
-
Whether or not to combine the objects if there is already an axis set (default is false)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.setAxis (axis, id, ?SceneAxis, ?Combine)
Parameters:
LinearAxis
-
The x axis to set on the chart's layout
id : SubPlotId
-
The target axis id with which the axis should be set.
?SceneAxis : SubPlotId
-
If set on a scene, define whether it is the x, y or z axis. default is x.
?Combine : bool
-
Whether or not to combine the objects if there is already an axis set (default is false)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.setBAxis (bAxis, id, ?Combine)
Parameters:
LinearAxis
-
The b Axis to set on the target ternary object on the chart's layout
id : SubPlotId
-
The target ternary id with which the b Axis should be set.(default is 1)
?Combine : bool
-
Whether or not to combine the objects if there is already an axis set (default is false)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.setCAxis (cAxis, id, ?Combine)
Parameters:
LinearAxis
-
The c Axis to set on the target ternary object on the chart's layout
id : SubPlotId
-
The target ternary id with which the c Axis should be set.(default is 1)
?Combine : bool
-
Whether or not to combine the objects if there is already an axis set (default is false)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.setColorBar (colorBar, ?Combine)
Parameters:
ColorBar
-
The new ColorBar for the chart's trace(s)
?Combine : bool
-
Whether or not to combine the objects if there is already a ColorBar object set (default is false)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.setConfig config
Parameters:
Config
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.setDisplayOptions displayOpts
Parameters:
DisplayOptions
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.setGeo (geo, id, ?Combine)
Parameters:
Geo
-
The Geo object to set on the chart's layout
id : SubPlotId
-
The target Geo id with which the Geo object should be set.
?Combine : bool
-
Whether or not to combine the objects if there is already an Geo set (default is false)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.setImaginaryAxis (imaginaryAxis, id, ?Combine)
Parameters:
ImaginaryAxis
-
The ImaginaryAxis to set on the target polar object on the chart's layout
id : SubPlotId
-
The target polar id with which the ImaginaryAxis should be set.(default is 1)
?Combine : bool
-
Whether or not to combine the objects if there is already an axis set (default is false)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.setLayout layout
Parameters:
Layout
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.setLayoutGrid (layoutGrid, ?Combine)
Parameters:
LayoutGrid
-
The new LayoutGrid for the chart's layout
?Combine : bool
-
Whether or not to combine the objects if there is already a ColorBar object set (default is false)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.setLegend (legend, id, ?Combine)
Parameters:
Legend
-
The Legend to set on the chart's layout
id : SubPlotId
-
The target Legend id with which the Legend should be set.
?Combine : bool
-
Whether or not to combine the objects if there is already an Legend set (default is false)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.setLine (line, ?Combine)
Parameters:
Line
-
The new Line for the chart's trace(s)
?Combine : bool
-
Whether or not to combine the objects if there is already a Line (default is false)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.setMapbox (mapbox, id, ?Combine)
Parameters:
Mapbox
-
The Mapbox object to set on the chart's layout
id : SubPlotId
-
The target Mapbox id with which the Mapbox object should be set.
?Combine : bool
-
Whether or not to combine the objects if there is already an Mapbox set (default is false)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.setMarker (marker, ?Combine)
Parameters:
Marker
-
The new marker for the chart's trace(s)
?Combine : bool
-
Whether or not to combine the objects if there is already a marker (default is false)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.setPolar (polar, id, ?Combine)
Parameters:
Polar
-
The Polar object to set on the chart's layout
id : SubPlotId
-
The target polar id with which the Polar object should be set.
?Combine : bool
-
Whether or not to combine the objects if there is already an Polar set (default is false)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.setRadialAxis (radialAxis, id, ?Combine)
Parameters:
RadialAxis
-
The RadialAxis to set on the target polar object on the chart's layout
id : SubPlotId
-
The target polar id with which the RadialAxis should be set.(default is 1)
?Combine : bool
-
Whether or not to combine the objects if there is already an axis set (default is false)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.setRealAxis (realAxis, id, ?Combine)
Parameters:
RealAxis
-
The RealAxis to set on the target smith object on the chart's layout
id : SubPlotId
-
The target smith id with which the RealAxis should be set.(default is 1)
?Combine : bool
-
Whether or not to combine the objects if there is already an axis set (default is false)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.setScene (scene, id, ?Combine)
Parameters:
Scene
-
The Scene object to set on the chart's layout
id : SubPlotId
-
The target scene id with which the Scene object should be set.
?Combine : bool
-
Whether or not to combine the objects if there is already an Scene set (default is false)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.setSmith (smith, id, ?Combine)
Parameters:
Smith
-
The Smith object to set on the chart's layout
id : SubPlotId
-
The target smith id with which the Smith object should be set.
?Combine : bool
-
Whether or not to combine the objects if there is already an Smith set (default is false)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.setTernary (ternary, id, ?Combine)
Parameters:
Ternary
-
The Ternary object to set on the chart's layout
id : SubPlotId
-
The target Ternary id with which the Ternary object should be set.
?Combine : bool
-
Whether or not to combine the objects if there is already an Ternary set (default is false)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.setXError (xError, ?Combine)
Parameters:
Error
-
The new Error in the x dimension for the chart's trace(s)
?Combine : bool
-
Whether or not to combine the objects if there is already an Error object set (default is false)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.setYError (yError, ?Combine)
Parameters:
Error
-
The new Error in the x dimension for the chart's trace(s)
?Combine : bool
-
Whether or not to combine the objects if there is already an Error object set (default is false)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.setZError (zError, ?Combine)
Parameters:
Error
-
The new Error in the x dimension for the chart's trace(s)
?Combine : bool
-
Whether or not to combine the objects if there is already an Error object set (default is false)
Returns: GenericChart -> GenericChart
|
|
|
|
Full Usage:
Chart.withAAxis (aAxis, ?Id)
Parameters:
LinearAxis
-
The new a axis for the chart layout's ternary object
?Id : int
-
The target ternary id on which the a axis should be set. Default is 1.
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withAdditionalHeadTags additionalHeadTags ch
Parameters:
XmlNode list
ch : GenericChart
Returns: GenericChart
|
|
Full Usage:
Chart.withAngularAxis (angularAxis, ?Id)
Parameters:
AngularAxis
-
The new AngularAxis for the chart layout's polar object
?Id : int
-
The target polar id on which the AngularAxis should be set. Default is 1.
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withAnnotation (annotation, ?Append)
Parameters:
Annotation
?Append : bool
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withAnnotations (annotations, ?Append)
Parameters:
Annotation seq
-
The annotations to add to the input charts layout
?Append : bool
-
If true, the input annotations will be appended to existing annotations, otherwise existing annotations will be removed (default: true)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withAxisAnchor (?X, ?Y)
Parameters:
int
-
The new x axis anchor id for the chart's cartesian and/or carpet trace(s)
?Y : int
-
The new x axis anchor id for the chart's cartesian and/or carpet trace(s)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withBAxis (bAxis, ?Id)
Parameters:
LinearAxis
-
The new b axis for the chart layout's ternary object
?Id : int
-
The target ternary id on which the b axis should be set. Default is 1.
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withCAxis (cAxis, ?Id)
Parameters:
LinearAxis
-
The new c axis for the chart layout's ternary object
?Id : int
-
The target ternary id on which the c axis should be set. Default is 1.
Returns: GenericChart -> GenericChart
|
|
|
|
Full Usage:
Chart.withColorAxisAnchor id
Parameters:
int
-
The new color axis id for the chart's trace(s)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withColorBar colorbar
Parameters:
ColorBar
-
The new ColorBar for the chart's trace(s)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withColorBarStyle (?TitleText, ?TitleFont, ?TitleStandoff, ?Title, ?BGColor, ?BorderColor, ?BorderWidth, ?DTick, ?ExponentFormat, ?LabelAlias, ?Len, ?LenMode, ?MinExponent, ?NTicks, ?Orientation, ?OutlineColor, ?OutlineWidth, ?SeparateThousands, ?ShowExponent, ?ShowTickLabels, ?ShowTickPrefix, ?ShowTickSuffix, ?Thickness, ?ThicknessMode, ?Tick0, ?TickAngle, ?TickColor, ?TickFont, ?TickFormat, ?TickFormatStops, ?TickLabelOverflow, ?TickLabelPosition, ?TickLabelStep, ?TickLen, ?TickMode, ?TickPrefix, ?Ticks, ?TickSuffix, ?TickText, ?TickVals, ?TickWidth, ?X, ?XAnchor, ?XPad, ?XRef, ?Y, ?YAnchor, ?YPad, ?YRef)
Parameters:
string
?TitleFont : Font
?TitleStandoff : int
?Title : Title
-
Sets the ColorBar title.
?BGColor : Color
-
Sets the color of padded area.
?BorderColor : Color
-
Sets the axis line color.
?BorderWidth : float
-
Sets the width (in px) or the border enclosing this color bar.
?DTick : IConvertible
-
Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L?ExponentFormat : ExponentFormat
-
Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.
?LabelAlias : DynamicObj
-
Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.
?Len : float
-
Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
?LenMode : UnitMode
-
Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot "fraction" or in "pixels. Use `len` to set the value.
?MinExponent : float
-
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is "SI" or "B".
?NTicks : int
-
Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
?Orientation : Orientation
-
Sets the orientation of the colorbar.
?OutlineColor : Color
-
Sets the axis line color.
?OutlineWidth : float
-
Sets the width (in px) of the axis line.
?SeparateThousands : bool
-
If "true", even 4-digit integers are separated
?ShowExponent : ShowExponent
-
If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.
?ShowTickLabels : bool
-
Determines whether or not the tick labels are drawn.
?ShowTickPrefix : ShowTickOption
-
If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.
?ShowTickSuffix : ShowTickOption
-
Same as `showtickprefix` but for tick suffixes.
?Thickness : float
-
Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
?ThicknessMode : UnitMode
-
Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot "fraction" or in "pixels". Use `thickness` to set the value.
?Tick0 : IConvertible
-
Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L>f<" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
?TickAngle : int
-
Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
?TickColor : Color
-
Sets the tick color.
?TickFont : Font
-
Sets the color bar's tick label font
?TickFormat : string
-
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: "%h" for half of the year as a decimal number as well as "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
?TickFormatStops : TickFormatStop seq
-
Set rules for customizing TickFormat on different zoom levels
?TickLabelOverflow : TickLabelOverflow
-
Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is "hide past domain". In other cases the default is "hide past div".
?TickLabelPosition : TickLabelPosition
-
Determines where tick labels are drawn.
?TickLabelStep : int
-
Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` "log" or "multicategory", or when `tickmode` is "array".
?TickLen : float
-
Sets the tick length (in px).
?TickMode : TickMode
-
Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).
?TickPrefix : string
-
Sets a tick label prefix.
?Ticks : TickOptions
-
Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.
?TickSuffix : string
-
Sets a tick label suffix.
?TickText : 'a seq
-
Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
?TickVals : 'b seq
-
Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
?TickWidth : float
-
Sets the tick width (in px).
?X : float
-
Sets the x position of the color bar (in plot fraction).
?XAnchor : HorizontalAlign
-
Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
?XPad : float
-
Sets the amount of padding (in px) along the x direction.
?XRef : string
-
Sets the container `x` refers to. "container" spans the entire `width` of the plot. "paper" refers to the width of the plotting area only.
?Y : float
-
Sets the y position of the color bar (in plot fraction).
?YAnchor : VerticalAlign
-
Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
?YPad : float
-
Sets the amount of padding (in px) along the y direction.
?YRef : string
-
Sets the container `y` refers to. "container" spans the entire `height` of the plot. "paper" refers to the height of the plotting area only.
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withConfig config
Parameters:
Config
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withConfigStyle (?StaticPlot, ?TypesetMath, ?PlotlyServerUrl, ?Editable, ?Edits, ?EditSelection, ?Autosizable, ?Responsive, ?FillFrame, ?FrameMargins, ?ScrollZoom, ?DoubleClick, ?DoubleClickDelay, ?ShowAxisDragHandles, ?ShowAxisRangeEntryBoxes, ?ShowTips, ?ShowLink, ?LinkText, ?SendData, ?ShowSources, ?DisplayModeBar, ?ShowSendToCloud, ?ShowEditInChartStudio, ?ModeBarButtonsToRemove, ?ModeBarButtonsToAdd, ?ModeBarButtons, ?ToImageButtonOptions, ?Displaylogo, ?Watermark, ?plotGlPixelRatio, ?SetBackground, ?TopojsonURL, ?MapboxAccessToken, ?Logging, ?NotifyOnLogging, ?QueueLength, ?GlobalTransforms, ?Locale, ?Locales)
Parameters:
bool
-
Determines whether the graphs are interactive or not. If *false*, no interactivity, for export or image generation.
?TypesetMath : bool
-
Determines whether math should be typeset or not, when MathJax (either v2 or v3) is present on the page.
?PlotlyServerUrl : string
-
When set it determines base URL form 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.
?Editable : bool
-
Determines whether the graph is editable or not. Sets all pieces of `edits` unless a separate `edits` config item overrides individual parts.
?Edits : Edits
-
Determines if the main anchor of the annotation is editable. The main anchor corresponds to the text (if no arrow) or the arrow (which drags the whole thing leaving the arrow length and direction unchanged).
?EditSelection : bool
-
Enables moving selections.
?Autosizable : bool
-
Determines whether the graphs are plotted with respect to layout.autosize:true and infer its container size.
?Responsive : bool
-
Determines whether to change the layout size when window is resized. In v3, this option will be removed and will always be true.
?FillFrame : bool
-
When `layout.autosize` is turned on, determines whether the grap fills the container (the default) or the screen (if set to *true*).
?FrameMargins : float
-
When `layout.autosize` is turned on, set the frame margins in fraction of the graph size.'
?ScrollZoom : 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.
?DoubleClick : DoubleClick
-
Sets the double click interaction mode. Has an effect only in cartesian plots. If *false*, double click is disable. If *reset*, double click resets the axis ranges to their initial values. If *autosize*, double click set the axis ranges to their autorange values. If *reset+autosize*, the odd double clicks resets the axis ranges to their initial values and even double clicks set the axis ranges to their autorange values.
?DoubleClickDelay : int
-
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.
?ShowAxisDragHandles : bool
-
Set to *false* to omit cartesian axis pan/zoom drag handles.
?ShowAxisRangeEntryBoxes : bool
-
Set to *false* to omit direct range entry at the pan/zoom drag points, note that `showAxisDragHandles` must be enabled to have an effect.
?ShowTips : bool
-
Determines whether or not tips are shown while interacting with the resulting graphs.
?ShowLink : bool
-
Determines whether a link to Chart Studio Cloud is displayed at the bottom right corner of resulting graphs. Use with `sendData` and `linkText`.
?LinkText : string
-
Sets the text appearing in the `showLink` link.
?SendData : bool
-
If *showLink* is true, does it contain data just link to a Chart Studio Cloud file?
?ShowSources : obj
-
Adds a source-displaying function to show sources on the resulting graphs.
?DisplayModeBar : bool
-
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.
?ShowSendToCloud : bool
-
Should we include a ModeBar button, labeled "Edit in Chart Studio that sends this chart to chart-studio.plotly.com (formerly plot.ly) or another plotly server as specified by `plotlyServerURL` for editing, export, etc? Prior to version 1.43.0 this button was included by default, now it is opt-in using this flag. Note that this button can (depending on `plotlyServerURL` being set) send your data to an external server. However that server does not persist your data until you arrive at the Chart Studio and explicitly click "Save".
?ShowEditInChartStudio : bool
-
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.
?ModeBarButtonsToRemove : ModeBarButton seq
-
Remove mode bar buttons by name. See ./components/modebar/buttons.js for the list of names.
?ModeBarButtonsToAdd : ModeBarButton seq
-
Add mode bar button using config objects. See ./components/modebar/buttons.js for list of arguments. 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 : ModeBarButton seq seq
-
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. See ./components/modebar/buttons.js for more info.'
?ToImageButtonOptions : ToImageButtonOptions
-
Statically override options for toImage modebar button allowed keys are format, filename, width, height, scale', see ../components/modebar/buttons.js
?Displaylogo : bool
-
Determines whether or not the plotly logo is displayed on the end of the mode bar.
?Watermark : bool
-
watermark the images with the company\'s logo
?plotGlPixelRatio : float
-
Set the pixel ratio during WebGL image export. This config option was formerly named `plot3dPixelRatio` which is now deprecated.
?SetBackground : obj
-
Set function to add the background color (i.e. `layout.paper_color`) to a different container. This function take the graph div as first argument and the current background color as second argument. Alternatively, set to string *opaque* to ensure there is white behind it.
?TopojsonURL : string
-
Set the URL to topojson used in geo charts. By default, the topojson files are fetched from cdn.plot.ly. For example, set this option to: ?MapboxAccessToken : string
-
Mapbox access token (required to plot mapbox trace types). If using an Mapbox Atlas server, set this option to \'\' so that plotly.js won\'t attempt to authenticate to the public Mapbox server.
?Logging : int
-
Turn all console logging on or off (errors will be thrown). This should ONLY be set via Plotly.setPlotConfig Available levels: 0: no logs 1: warnings and errors, but not informational messages 2: verbose logs
?NotifyOnLogging : int
-
Turn all console logging on or off (errors will be thrown). This should ONLY be set via Plotly.setPlotConfig Available levels: 0: no logs 1: warnings and errors, but not informational messages 2: verbose logs
?QueueLength : int
-
Sets the length of the undo/redo queue.
?GlobalTransforms : obj
-
Set global transform to be applied to all traces with no specification needed
?Locale : string
-
Which localization should we use? Should be a string like \'en\' or \'en-US\'.
?Locales : obj
-
Localization definitions
Locales can be provided either here (specific to one chart) or globally
by registering them as modules.
Should be an object of objects {locale: {dictionary: {...}, format: {...}}}'
{
da: {
dictionary: {\'Reset axes\': \'Nulstil aksler\', ...},
format: {months: [...], shortMonths: [...]}',
},
...
}
All parts are optional. When looking for translation or format fields, we
look first for an exact match in a config locale, then in a registered
module. If those fail, we strip off any regionalization (\'en-US\' -> \'en\')
and try each (config, registry) again. The final fallback for translation
is untranslated (which is US English) and for formats is the base English
(the only consequence being the last fallback date format %x is DD/MM/YYYY
instead of MM/DD/YYYY). Currently `grouping` and `currency` are ignored
for our automatic number formatting, but can be used in custom formats.
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withDescription chartDescription ch
Parameters:
XmlNode list
-
The chart description to add to the given chart's DisplayOptions object
ch : GenericChart
-
The chart to add a description to
Returns: GenericChart
|
|
Full Usage:
Chart.withDisplayOptions displayOpts
Parameters:
DisplayOptions
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withDisplayOptionsStyle (?AdditionalHeadTags, ?ChartDescription, ?PlotlyJSReference)
Parameters:
XmlNode list
-
Additional tags that will be included in the document's head
?ChartDescription : XmlNode list
?PlotlyJSReference : PlotlyJSReference
-
Sets how plotly is referenced in the head of html docs. When CDN, a script tag that references the plotly.js CDN is included in the output. When Full, a script tag containing the plotly.js source code (~3MB) is included in the output. HTML files generated with this option are fully self-contained and can be used offline
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withGeo (geo, ?Id)
Parameters:
Geo
-
The new Geo for the chart's layout
?Id : int
-
The target geo id on which the Geo should be set. Default is 1.
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withGeoProjection (projectionType, ?Rotation, ?Parallels, ?Scale, ?Id)
Parameters:
GeoProjectionType
-
Sets the type of projection
?Rotation : GeoProjectionRotation
-
Sets the rotation applied to the map
?Parallels : float * float
-
For conic projection types only. Sets the parallels (tangent, secant) where the cone intersects the sphere.
?Scale : float
-
Zooms in or out on the map view. A scale of "1" corresponds to the largest zoom level that fits the map's lon and lat ranges.
?Id : int
-
the target geo id
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withGeoStyle (?FitBounds, ?Resolution, ?Scope, ?Projection, ?Center, ?Visible, ?Domain, ?ShowCoastLines, ?CoastLineColor, ?CoastLineWidth, ?ShowLand, ?LandColor, ?ShowOcean, ?OceanColor, ?ShowLakes, ?LakeColor, ?ShowRivers, ?RiverColor, ?RiverWidth, ?ShowCountries, ?CountryColor, ?CountryWidth, ?ShowSubunits, ?SubunitColor, ?SubunitWidth, ?ShowFrame, ?FrameColor, ?FrameWidth, ?BgColor, ?LatAxis, ?LonAxis, ?Id)
Parameters:
GeoFitBounds
-
Determines if and how this subplot's view settings are auto-computed to fit trace data
?Resolution : GeoResolution
-
Sets the resolution of the base layers
?Scope : GeoScope
-
Set the scope of the map.
?Projection : GeoProjection
-
Determines the type of projection used to display the map
?Center : float * float
-
Sets the (lon,lat) coordinates of the map's center. By default, the map's longitude center lies at the middle of the longitude range for scoped projection and above `projection.rotation.lon` otherwise. For all projection types, the map's latitude center lies at the middle of the latitude range by default.
?Visible : bool
-
Whether or not the base layers are visible
?Domain : Domain
-
The domain of this geo subplot
?ShowCoastLines : bool
-
Sets whether or not the coastlines are drawn.
?CoastLineColor : Color
-
Sets the coastline color.
?CoastLineWidth : float
-
Sets the coastline stroke width (in px).
?ShowLand : bool
-
Sets whether or not land masses are filled in color.
?LandColor : Color
-
Sets the land mass color.
?ShowOcean : bool
-
Sets whether or not oceans are filled in color.
?OceanColor : Color
-
Sets the ocean color
?ShowLakes : bool
-
Sets whether or not lakes are drawn.
?LakeColor : Color
-
Sets the color of the lakes.
?ShowRivers : bool
-
Sets whether or not rivers are drawn.
?RiverColor : Color
-
Sets color of the rivers.
?RiverWidth : float
-
Sets the stroke width (in px) of the rivers.
?ShowCountries : bool
-
Sets whether or not country boundaries are drawn.
?CountryColor : Color
-
Sets line color of the country boundaries.
?CountryWidth : float
-
Sets line width (in px) of the country boundaries.
?ShowSubunits : bool
-
Sets whether or not boundaries of subunits within countries (e.g. states, provinces) are drawn.
?SubunitColor : Color
-
Sets the color of the subunits boundaries.
?SubunitWidth : float
-
Sets the stroke width (in px) of the subunits boundaries.
?ShowFrame : bool
-
Sets whether or not a frame is drawn around the map.
?FrameColor : Color
-
Sets the color the frame.
?FrameWidth : float
-
Sets the stroke width (in px) of the frame.
?BgColor : Color
-
Set the background color of the map
?LatAxis : LinearAxis
-
Sets the latitudinal axis for this geo trace
?LonAxis : LinearAxis
-
Sets the longitudinal axis for this geo trace
?Id : int
-
the target geo id
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withHeadTags additionalHeadTags ch
Parameters:
XmlNode list
ch : GenericChart
Returns: GenericChart
|
|
Full Usage:
Chart.withImaginaryAxis (imaginaryAxis, ?Id)
Parameters:
ImaginaryAxis
-
The new ImaginaryAxis for the chart layout's smith object
?Id : int
-
The target smith id on which the ImaginaryAxis should be set. Default is 1.
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withLayout layout
Parameters:
Layout
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withLayoutGrid layoutGrid
Parameters:
LayoutGrid
-
The new LayoutGrid for the chart's layout
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withLayoutGridStyle (?SubPlots, ?XAxes, ?YAxes, ?Rows, ?Columns, ?RowOrder, ?Pattern, ?XGap, ?YGap, ?Domain, ?XSide, ?YSide)
Parameters:
(LinearAxisId * LinearAxisId)[][]
-
Used for freeform grids, where some axes may be shared across subplots but others are not. Each entry should be a cartesian subplot id, like "xy" or "x3y2", or "" to leave that cell empty. You may reuse x axes within the same column, and y axes within the same row. Non-cartesian subplots and traces that support `domain` can place themselves in this grid separately using the `gridcell` attribute.
?XAxes : LinearAxisId[]
-
Used with `yaxes` when the x and y axes are shared across columns and rows. Each entry should be an y axis id like "y", "y2", etc., or "" to not put a y axis in that row. Entries other than "" must be unique. Ignored if `subplots` is present. If missing but `xaxes` is present, will generate consecutive IDs.
?YAxes : LinearAxisId[]
-
Used with `yaxes` when the x and y axes are shared across columns and rows. Each entry should be an x axis id like "x", "x2", etc., or "" to not put an x axis in that column. Entries other than "" must be unique. Ignored if `subplots` is present. If missing but `yaxes` is present, will generate consecutive IDs.
?Rows : int
-
The number of rows in the grid. If you provide a 2D `subplots` array or a `yaxes` array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots.
?Columns : int
-
The number of columns in the grid. If you provide a 2D `subplots` array, the length of its longest row is used as the default. If you give an `xaxes` array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots.
?RowOrder : LayoutGridRowOrder
-
Is the first row the top or the bottom? Note that columns are always enumerated from left to right.
?Pattern : LayoutGridPattern
-
If no `subplots`, `xaxes`, or `yaxes` are given but we do have `rows` and `columns`, we can generate defaults using consecutive axis IDs, in two ways: "coupled" gives one x axis per column and one y axis per row. "independent" uses a new xy pair for each cell, left-to-right across each row then iterating rows according to `roworder`.
?XGap : float
-
Horizontal space between grid cells, expressed as a fraction of the total width available to one cell. Defaults to 0.1 for coupled-axes grids and 0.2 for independent grids.
?YGap : float
-
Vertical space between grid cells, expressed as a fraction of the total height available to one cell. Defaults to 0.1 for coupled-axes grids and 0.3 for independent grids.
?Domain : Domain
-
Sets the domains of this grid subplot (in plot fraction). The first and last cells end exactly at the domain edges, with no grout around the edges.
?XSide : LayoutGridXSide
-
Sets where the x axis labels and titles go. "bottom" means the very bottom of the grid. "bottom plot" is the lowest plot that each x axis is used in. "top" and "top plot" are similar.
?YSide : LayoutGridYSide
-
Sets where the y axis labels and titles go. "left" means the very left edge of the grid. "left plot" is the leftmost plot that each y axis is used in. "right" and "right plot" are similar.
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withLayoutImage (image, ?Append)
Parameters:
LayoutImage
?Append : bool
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withLayoutImages (images, ?Append)
Parameters:
LayoutImage seq
-
The images to add to the input charts layout
?Append : bool
-
If true, the input images will be appended to existing annotations, otherwise existing annotations will be removed (default: true)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withLayoutStyle (?Title, ?ShowLegend, ?Margin, ?AutoSize, ?Width, ?Height, ?Font, ?UniformText, ?Separators, ?PaperBGColor, ?PlotBGColor, ?AutoTypeNumbers, ?Colorscale, ?Colorway, ?ModeBar, ?HoverMode, ?ClickMode, ?DragMode, ?SelectDirection, ?ActiveSelection, ?NewSelection, ?HoverDistance, ?SpikeDistance, ?Hoverlabel, ?Transition, ?DataRevision, ?UIRevision, ?EditRevision, ?SelectRevision, ?Template, ?Meta, ?Computed, ?Grid, ?Calendar, ?MinReducedHeight, ?MinReducedWidth, ?NewShape, ?ActiveShape, ?HideSources, ?ScatterGap, ?ScatterMode, ?BarGap, ?BarGroupGap, ?BarMode, ?BarNorm, ?ExtendPieColors, ?HiddenLabels, ?PieColorWay, ?BoxGap, ?BoxGroupGap, ?BoxMode, ?ViolinGap, ?ViolinGroupGap, ?ViolinMode, ?WaterfallGap, ?WaterfallGroupGap, ?WaterfallMode, ?FunnelGap, ?FunnelGroupGap, ?FunnelMode, ?ExtendFunnelAreaColors, ?FunnelAreaColorWay, ?ExtendSunBurstColors, ?SunBurstColorWay, ?ExtendTreeMapColors, ?TreeMapColorWay, ?ExtendIcicleColors, ?IcicleColorWay, ?Annotations, ?Shapes, ?Selections, ?Images, ?Sliders, ?UpdateMenus)
Parameters:
Title
-
Sets the title of the layout.
?ShowLegend : bool
-
Determines whether or not a legend is drawn. Default is `true` if there is a trace to show and any of these: a) Two or more traces would by default be shown in the legend. b) One pie trace is shown in the legend. c) One trace is explicitly given with `showlegend: true`.
?Margin : Margin
-
Sets the margins around the layout.
?AutoSize : bool
-
Determines whether or not a layout width or height that has been left undefined by the user is initialized on each relayout. Note that, regardless of this attribute, an undefined layout width or height is always initialized on the first call to plot.
?Width : int
-
Sets the plot's width (in px).
?Height : int
-
Sets the plot's height (in px).
?Font : Font
-
Sets the global font. Note that fonts used in traces and other layout components inherit from the global font.
?UniformText : UniformText
-
Determines how the font size for various text elements are uniformed between each trace type.
?Separators : string
-
Sets the decimal and thousand separators. For example, ". " puts a '.' before decimals and a space between thousands. In English locales, dflt is ".," but other locales may alter this default.
?PaperBGColor : Color
-
Sets the background color of the paper where the graph is drawn.
?PlotBGColor : Color
-
Sets the background color of the plotting area in-between x and y axes.
?AutoTypeNumbers : AutoTypeNumbers
-
Using "strict" a numeric string in trace data is not converted to a number. Using "convert types" a numeric string in trace data may be treated as a number during automatic axis `type` detection. This is the default value; however it could be overridden for individual axes.
?Colorscale : DefaultColorScales
-
Sets the default colorscales that are used by plots using autocolorscale.
?Colorway : Color
-
Sets the default trace colors.
?ModeBar : ModeBar
-
Sets the modebar of the layout.
?HoverMode : HoverMode
-
Determines the mode of hover interactions. If "closest", a single hoverlabel will appear for the "closest" point within the `hoverdistance`. If "x" (or "y"), multiple hoverlabels will appear for multiple points at the "closest" x- (or y-) coordinate within the `hoverdistance`, with the caveat that no more than one hoverlabel will appear per trace. If "x unified" (or "y unified"), a single hoverlabel will appear multiple points at the closest x- (or y-) coordinate within the `hoverdistance` with the caveat that no more than one hoverlabel will appear per trace. In this mode, spikelines are enabled by default perpendicular to the specified axis. If false, hover interactions are disabled.
?ClickMode : ClickMode
-
Determines the mode of single click interactions. "event" is the default value and emits the `plotly_click` event. In addition this mode emits the `plotly_selected` event in drag modes "lasso" and "select", but with no event data attached (kept for compatibility reasons). The "select" flag enables selecting single data points via click. This mode also supports persistent selections, meaning that pressing Shift while clicking, adds to / subtracts from an existing selection. "select" with `hovermode`: "x" can be confusing, consider explicitly setting `hovermode`: "closest" when using this feature. Selection events are sent accordingly as long as "event" flag is set as well. When the "event" flag is missing, `plotly_click` and `plotly_selected` events are not fired.
?DragMode : DragMode
-
Determines the mode of drag interactions. "select" and "lasso" apply only to scatter traces with markers or text. "orbit" and "turntable" apply only to 3D scenes.
?SelectDirection : SelectDirection
-
When `dragmode` is set to "select", this limits the selection of the drag to horizontal, vertical or diagonal. "h" only allows horizontal selection, "v" only vertical, "d" only diagonal and "any" sets no limit.
?ActiveSelection : ActiveSelection
-
Sets the styling of the active selection
?NewSelection : NewSelection
-
Controls the behavior of newly drawn selections
?HoverDistance : int
-
Sets the default distance (in pixels) to look for data to add hover labels (-1 means no cutoff, 0 means no looking for data). This is only a real distance for hovering on point-like objects, like scatter points. For area-like objects (bars, scatter fills, etc) hovering is on inside the area and off outside, but these objects will not supersede hover on point-like objects in case of conflict.
?SpikeDistance : int
-
Sets the default distance (in pixels) to look for data to draw spikelines to (-1 means no cutoff, 0 means no looking for data). As with hoverdistance, distance does not apply to area-like objects. In addition, some objects can be hovered on but will not generate spikelines, such as scatter fills.
?Hoverlabel : Hoverlabel
-
Sets the style ov hover labels.
?Transition : Transition
-
Sets transition options used during Plotly.react updates.
?DataRevision : string
-
If provided, a changed value tells `Plotly.react` that one or more data arrays has changed. This way you can modify arrays in-place rather than making a complete new copy for an incremental change. If NOT provided, `Plotly.react` assumes that data arrays are being treated as immutable, thus any data array with a different identity from its predecessor contains new data.
?UIRevision : string
-
Used to allow user interactions with the plot to persist after `Plotly.react` calls that are unaware of these interactions. If `uirevision` is omitted, or if it is given and it changed from the previous `Plotly.react` call, the exact new figure is used. If `uirevision` is truthy and did NOT change, any attribute that has been affected by user interactions and did not receive a different value in the new figure will keep the interaction value. `layout.uirevision` attribute serves as the default for `uirevision` attributes in various sub-containers. For finer control you can set these sub-attributes directly. For example, if your app separately controls the data on the x and y axes you might set `xaxis.uirevision="time"` and `yaxis.uirevision="cost"`. Then if only the y data is changed, you can update `yaxis.uirevision="quantity"` and the y axis range will reset but the x axis range will retain any user-driven zoom.
?EditRevision : string
-
Controls persistence of user-driven changes in `editable: true` configuration, other than trace names and axis titles. Defaults to `layout.uirevision`.
?SelectRevision : string
-
Controls persistence of user-driven changes in `editable: true` configuration, other than trace names and axis titles. Defaults to `layout.uirevision`.
?Template : DynamicObj
-
Default attributes to be applied to the plot. Templates can be created from existing plots using `Plotly.makeTemplate`, or created manually. They should be objects with format: `{layout: layoutTemplate, data: {[type]: [traceTemplate, ...]}, ...}` `layoutTemplate` and `traceTemplate` are objects matching the attribute structure of `layout` and a data trace. Trace templates are applied cyclically to traces of each type. Container arrays (eg `annotations`) have special handling: An object ending in `defaults` (eg `annotationdefaults`) is applied to each array item. But if an item has a `templateitemname` key we look in the template array for an item with matching `name` and apply that instead. If no matching `name` is found we mark the item invisible. Any named template item not referenced is appended to the end of the array, so you can use this for a watermark annotation or a logo image, for example. To omit one of these items on the plot, make an item with matching `templateitemname` and `visible: false`.
?Meta : string
-
Assigns extra meta information that can be used in various `text` attributes. Attributes such as the graph, axis and colorbar `title.text`, annotation `text` `trace.name` in legend items, `rangeselector`, `updatemenus` and `sliders` `label` text all support `meta`. One can access `meta` fields using template strings: `%{meta[i]}` where `i` is the index of the `meta` item in question. `meta` can also be an object for example `{key: value}` which can be accessed %{meta[key]}.
?Computed : string
-
Placeholder for exporting automargin-impacting values namely `margin.t`, `margin.b`, `margin.l` and `margin.r` in "full-json" mode.
?Grid : LayoutGrid
-
Sets the layout grid for arranging multiple plots
?Calendar : Calendar
-
Sets the default calendar system to use for interpreting and displaying dates throughout the plot.
?MinReducedHeight : int
-
Minimum height of the plot with margin.automargin applied (in px)
?MinReducedWidth : int
-
Minimum width of the plot with margin.automargin applied (in px)
?NewShape : NewShape
-
Controls the behavior of newly drawn shapes
?ActiveShape : ActiveShape
-
Sets the styling of the active shape
?HideSources : bool
-
Determines whether or not a text link citing the data source is placed at the bottom-right cored of the figure. Has only an effect only on graphs that have been generated via forked graphs from the Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise).
?ScatterGap : float
-
Sets the gap (in plot fraction) between scatter points of adjacent location coordinates. Defaults to `bargap`.
?ScatterMode : ScatterMode
-
Determines how scatter points at the same location coordinate are displayed on the graph. With "group", the scatter points are plotted next to one another centered around the shared location. With "overlay", the scatter points are plotted over one another, you might need to reduce "opacity" to see multiple scatter points.
?BarGap : float
-
Sets the gap (in plot fraction) between bars of adjacent location coordinates.
?BarGroupGap : float
-
Sets the gap (in plot fraction) between bars of adjacent location coordinates.
?BarMode : BarMode
-
Determines how bars at the same location coordinate are displayed on the graph. With "stack", the bars are stacked on top of one another With "relative", the bars are stacked on top of one another, with negative values below the axis, positive values above With "group", the bars are plotted next to one another centered around the shared location. With "overlay", the bars are plotted over one another, you might need to an "opacity" to see multiple bars.
?BarNorm : BarNorm
-
Sets the normalization for bar traces on the graph. With "fraction", the value of each bar is divided by the sum of all values at that location coordinate. "percent" is the same but multiplied by 100 to show percentages.
?ExtendPieColors : bool
-
If `true`, the pie slice colors (whether given by `piecolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.
?HiddenLabels : 'a seq
-
If `true`, the pie slice colors (whether given by `piecolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.
?PieColorWay : Color
-
Sets the default pie slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendpiecolors`.
?BoxGap : float
-
Sets the gap (in plot fraction) between boxes of adjacent location coordinates. Has no effect on traces that have "width" set.
?BoxGroupGap : float
-
Sets the gap (in plot fraction) between boxes of the same location coordinate. Has no effect on traces that have "width" set.
?BoxMode : BoxMode
-
Sets the gap (in plot fraction) between boxes of the same location coordinate. Has no effect on traces that have "width" set.
?ViolinGap : float
-
Sets the gap (in plot fraction) between boxes of the same location coordinate. Has no effect on traces that have "width" set.
?ViolinGroupGap : float
-
Sets the gap (in plot fraction) between violins of the same location coordinate. Has no effect on traces that have "width" set.
?ViolinMode : ViolinMode
-
Determines how violins at the same location coordinate are displayed on the graph. If "group", the violins are plotted next to one another centered around the shared location. If "overlay", the violins are plotted over one another, you might need to set "opacity" to see them multiple violins. Has no effect on traces that have "width" set.
?WaterfallGap : float
-
Sets the gap (in plot fraction) between bars of adjacent location coordinates.
?WaterfallGroupGap : float
-
Sets the gap (in plot fraction) between bars of the same location coordinate.
?WaterfallMode : WaterfallMode
-
Determines how bars at the same location coordinate are displayed on the graph. With "group", the bars are plotted next to one another centered around the shared location. With "overlay", the bars are plotted over one another, you might need to an "opacity" to see multiple bars.
?FunnelGap : float
-
Sets the gap (in plot fraction) between bars of adjacent location coordinates.
?FunnelGroupGap : float
-
Sets the gap (in plot fraction) between bars of adjacent location coordinates.
?FunnelMode : FunnelMode
-
Determines how bars at the same location coordinate are displayed on the graph. With "stack", the bars are stacked on top of one another With "group", the bars are plotted next to one another centered around the shared location. With "overlay", the bars are plotted over one another, you might need to an "opacity" to see multiple bars.
?ExtendFunnelAreaColors : bool
-
If `true`, the funnelarea slice colors (whether given by `funnelareacolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.
?FunnelAreaColorWay : Color
-
Sets the default funnelarea slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendfunnelareacolors`.
?ExtendSunBurstColors : bool
-
If `true`, the sunburst slice colors (whether given by `sunburstcolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.
?SunBurstColorWay : Color
-
If `true`, the sunburst slice colors (whether given by `sunburstcolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.
?ExtendTreeMapColors : bool
-
If `true`, the treemap slice colors (whether given by `treemapcolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.
?TreeMapColorWay : Color
-
Sets the default treemap slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendtreemapcolors`.
?ExtendIcicleColors : bool
-
If `true`, the icicle slice colors (whether given by `iciclecolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.
?IcicleColorWay : Color
-
Sets the default icicle slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendiciclecolors`.
?Annotations : Annotation seq
-
A collection containing all Annotations of this layout. An annotation is a text element that can be placed anywhere in the plot. It can be positioned with respect to relative coordinates in the plot or with respect to the actual data coordinates of the graph. Annotations can be shown with or without an arrow.
?Shapes : Shape seq
-
A collection containing all Shapes of this layout.
?Selections : Selection seq
-
A collection containing all Selections of this layout.
?Images : LayoutImage seq
-
A collection containing all Images of this layout.
?Sliders : Slider seq
-
A collection containing all Sliders of this layout.
?UpdateMenus : UpdateMenu seq
-
A collection containing all UpdateMenus of this layout.
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withLegend (legend, ?Id)
Parameters:
Legend
-
The Legend to set on the chart's layout
?Id : int
-
The target Legend id with which the Legend should be set. Default is 1.
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withLegendAnchor id
Parameters:
int
-
The new Legend id for the chart's trace(s)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withLegendStyle (?BGColor, ?BorderColor, ?BorderWidth, ?EntryWidth, ?EntryWidthMode, ?Font, ?GroupClick, ?GroupTitleFont, ?ItemClick, ?ItemDoubleClick, ?ItemSizing, ?ItemWidth, ?Orientation, ?Title, ?TraceGroupGap, ?TraceOrder, ?UIRevision, ?VerticalAlign, ?Visible, ?X, ?XAnchor, ?XRef, ?Y, ?YAnchor, ?YRef, ?Id)
Parameters:
Color
-
Sets the legend background color. Defaults to `layout.paper_bgcolor`.
?BorderColor : Color
-
Sets the color of the border enclosing the legend.
?BorderWidth : float
-
Sets the width (in px) of the border enclosing the legend.
?EntryWidth : float
-
Sets the width (in px or fraction) of the legend. Use 0 to size the entry based on the text width, when `entrywidthmode` is set to "pixels".
?EntryWidthMode : EntryWidthMode
-
Determines what entrywidth means.
?Font : Font
-
Sets the font used to text the legend items.
?GroupClick : TraceGroupClickOptions
-
Determines the behavior on legend group item click. "toggleitem" toggles the visibility of the individual item clicked on the graph. "togglegroup" toggles the visibility of all items in the same legendgroup as the item clicked on the graph.
?GroupTitleFont : Font
-
Sets the font for group titles in legend. Defaults to `legend.font` with its size increased about 10%.
?ItemClick : TraceItemClickOptions
-
Determines the behavior on legend item click. "toggle" toggles the visibility of the item clicked on the graph. "toggleothers" makes the clicked item the sole visible item on the graph. "false" disables legend item click interactions.
?ItemDoubleClick : TraceItemClickOptions
-
Determines the behavior on legend item double-click. "toggle" toggles the visibility of the item clicked on the graph. "toggleothers" makes the clicked item the sole visible item on the graph. "false" disables legend item double-click interactions.
?ItemSizing : TraceItemSizing
-
Determines if the legend items symbols scale with their corresponding "trace" attributes or remain "constant" independent of the symbol size on the graph.
?ItemWidth : int
-
Sets the width (in px) of the legend item symbols (the part other than the title.text).
?Orientation : Orientation
-
Sets the orientation of the legend.
?Title : Title
-
Sets the title of the legend.
?TraceGroupGap : float
-
Sets the amount of vertical space (in px) between legend groups.
?TraceOrder : TraceOrder
-
Determines the order at which the legend items are displayed. If "normal", the items are displayed top-to-bottom in the same order as the input data. If "reversed", the items are displayed in the opposite order as "normal". If "grouped", the items are displayed in groups (when a trace `legendgroup` is provided). if "grouped+reversed", the items are displayed in the opposite order as "grouped".
?UIRevision : string
-
Controls persistence of legend-driven changes in trace and pie label visibility. Defaults to `layout.uirevision`.
?VerticalAlign : VerticalAlign
-
Sets the vertical alignment of the symbols with respect to their associated text.
?Visible : bool
-
Determines whether or not this legend is visible.
?X : float
-
Sets the x position (in normalized coordinates) of the legend. Defaults to "1.02" for vertical legends and defaults to "0" for horizontal legends.
?XAnchor : XAnchorPosition
-
Sets the legend's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the legend. Value "auto" anchors legends to the right for `x` values greater than or equal to 2/3, anchors legends to the left for `x` values less than or equal to 1/3 and anchors legends with respect to their center otherwise.
?XRef : string
-
Sets the container `x` refers to. "container" spans the entire `width` of the plot. "paper" refers to the width of the plotting area only.
?Y : float
-
Sets the y position (in normalized coordinates) of the legend. Defaults to "1" for vertical legends, defaults to "-0.1" for horizontal legends on graphs w/o range sliders and defaults to "1.1" for horizontal legends on graph with one or multiple range sliders.
?YAnchor : YAnchorPosition
-
Sets the legend's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the legend. Value "auto" anchors legends at their bottom for `y` values less than or equal to 1/3, anchors legends to at their top for `y` values greater than or equal to 2/3 and anchors legends with respect to their middle otherwise.
?YRef : string
-
Sets the container `y` refers to. "container" spans the entire `height` of the plot. "paper" refers to the height of the plotting area only.
?Id : int
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withLine line
Parameters:
Line
-
The new line for the chart's trace(s)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withLineStyle (?BackOff, ?AutoColorScale, ?CAuto, ?CMax, ?CMid, ?CMin, ?Color, ?ColorAxis, ?Colorscale, ?ReverseScale, ?ShowScale, ?ColorBar, ?Dash, ?Shape, ?Simplify, ?Smoothing, ?Width, ?MultiWidth, ?OutlierColor, ?OutlierWidth)
Parameters:
BackOff
-
Sets the line back off from the end point of the nth line segment (in px). This option is useful e.g. to avoid overlap with arrowhead markers. With "auto" the lines would trim before markers if `marker.angleref` is set to "previous".
?AutoColorScale : bool
-
Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `line.colorscale`. Has an effect only if in `line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
?CAuto : bool
-
Determines whether or not the color domain is computed with respect to the input data (here in `line.color`) or the bounds set in `line.cmin` and `line.cmax` Has an effect only if in `line.color`is set to a numerical array. Defaults to `false` when `line.cmin` and `line.cmax` are set by the user.
?CMax : float
-
Sets the upper bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmin` must be set as well.
?CMid : float
-
Sets the mid-point of the color domain by scaling `line.cmin` and/or `line.cmax` to be equidistant to this point. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color`. Has no effect when `line.cauto` is `false`.
?CMin : float
-
Sets the lower bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmax` must be set as well.
?Color : Color
-
Sets the line color.
?ColorAxis : SubPlotId
-
Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
?Colorscale : Colorscale
-
Sets the line colorscale
?ReverseScale : bool
-
Reverses the color mapping if true.
?ShowScale : bool
-
Whether or not to show the color bar
?ColorBar : ColorBar
-
Sets the colorbar.
?Dash : DrawingStyle
-
Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
?Shape : Shape
-
Determines the line shape. With "spline" the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.
?Simplify : bool
-
Simplifies lines by removing nearly-collinear points. When transitioning lines, it may be desirable to disable this so that the number of points along the resulting SVG path is unaffected.
?Smoothing : float
-
Has an effect only if `shape` is set to "spline" Sets the amount of smoothing. "0" corresponds to no smoothing (equivalent to a "linear" shape).
?Width : float
-
Sets the line width (in px).
?MultiWidth : float seq
-
Sets the individual line width (in px).
?OutlierColor : Color
-
Sets the color of the outline of outliers
?OutlierWidth : float
-
Sets the width of the outline of outliers
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withMapbox (mapbox, ?Id)
Parameters:
Mapbox
-
The Mapbox to set on the chart's layout
?Id : int
-
The target mapbox id on which the Mapbox should be set. Default is 1.
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withMapboxStyle (?Domain, ?AccessToken, ?Style, ?Center, ?Zoom, ?Bearing, ?Pitch, ?Layers, ?Id)
Parameters:
Domain
-
Sets the domain of the Mapbox subplot
?AccessToken : string
-
Sets the mapbox access token to be used for this mapbox map. Alternatively, the mapbox access token can be set in the configuration options under `mapboxAccessToken`. Note that accessToken are only required when `style` (e.g with values : basic, streets, outdoors, light, dark, satellite, satellite-streets ) and/or a layout layer references the Mapbox server.
?Style : MapboxStyle
-
Defines the map layers that are rendered by default below the trace layers defined in `data`, which are themselves by default rendered below the layers defined in `layout.mapbox.layers`. These layers can be defined either explicitly as a Mapbox Style object which can contain multiple layer definitions that load data from any public or private Tile Map Service (TMS or XYZ) or Web Map Service (WMS) or implicitly by using one of the built-in style objects which use WMSes which do not require any access tokens, or by using a default Mapbox style or custom Mapbox style URL, both of which require a Mapbox access token Note that Mapbox access token can be set in the `accesstoken` attribute or in the `mapboxAccessToken` config option. Mapbox Style objects are of the form described in the Mapbox GL JS documentation available at https://docs.mapbox.com/mapbox-gl-js/style-spec The built-in plotly.js styles objects are: carto-darkmatter, carto-positron, open-street-map, stamen-terrain, stamen-toner, stamen-watercolor, white-bg The built-in Mapbox styles are: basic, streets, outdoors, light, dark, satellite, satellite-streets Mapbox style URLs are of the form: mapbox://mapbox.mapbox/name/version
?Center : float * float
-
Sets the (lon,lat) coordinates of the center of the map view
?Zoom : float
-
Sets the zoom level of the map (mapbox.zoom).
?Bearing : float
-
Sets the bearing angle of the map in degrees counter-clockwise from North (mapbox.bearing).
?Pitch : float
-
Sets the pitch angle of the map (in degrees, where "0" means perpendicular to the surface of the map) (mapbox.pitch).
?Layers : MapboxLayer seq
-
Sets the layers of this Mapbox
?Id : int
-
The target mapbox id
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withMargin margin
Parameters:
Margin
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withMarginSize (?Left, ?Right, ?Top, ?Bottom, ?Pad, ?Autoexpand)
Parameters:
'a
?Right : 'b
?Top : 'c
?Bottom : 'd
?Pad : 'e
?Autoexpand : 'f
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withMarker marker
Parameters:
Marker
-
The new marker for the chart's trace(s)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withMarkerStyle (?Angle, ?AngleRef, ?AutoColorScale, ?CAuto, ?CMax, ?CMid, ?CMin, ?Color, ?Colors, ?ColorAxis, ?ColorBar, ?Colorscale, ?CornerRadius, ?Gradient, ?Outline, ?MaxDisplayed, ?Opacity, ?MultiOpacity, ?Pattern, ?ReverseScale, ?ShowScale, ?Size, ?MultiSize, ?SizeMin, ?SizeMode, ?SizeRef, ?StandOff, ?MultiStandOff, ?Symbol, ?MultiSymbol, ?Symbol3D, ?MultiSymbol3D, ?OutlierColor, ?OutlierWidth)
Parameters:
float
-
Sets the marker angle in respect to `angleref`.
?AngleRef : AngleRef
-
Sets the reference for marker angle. With "previous", angle 0 points along the line from the previous point to this one. With "up", angle 0 points toward the top of the screen.
?AutoColorScale : bool
-
Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
?CAuto : bool
-
Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.
?CMax : float
-
Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.
?CMid : float
-
Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`.
?CMin : float
-
Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.
?Color : Color
-
Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
?Colors : Color seq
-
Sets the color of each sector. If not specified, the default trace color set is used to pick the sector colors.
?ColorAxis : SubPlotId
-
Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
?ColorBar : ColorBar
-
Sets the marker's color bar.
?Colorscale : Colorscale
-
Sets the colorscale. Has an effect only if colors is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
?CornerRadius : int
-
Sets the maximum rounding of corners (in px).
?Gradient : Gradient
-
Sets the marker's gradient
?Outline : Line
-
Sets the marker's outline.
?MaxDisplayed : int
-
Sets a maximum number of points to be drawn on the graph. "0" corresponds to no limit.
?Opacity : float
-
Sets the marker opacity.
?MultiOpacity : float seq
-
Sets the individual marker opacity.
?Pattern : Pattern
-
Sets the pattern within the marker.
?ReverseScale : bool
-
Reverses the color mapping if true. Has an effect only if in `marker.color`is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.
?ShowScale : bool
-
Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.
?Size : int
-
Sets the marker's size.
?MultiSize : int seq
-
Sets the individual marker's size.
?SizeMin : int
-
Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
?SizeMode : MarkerSizeMode
-
Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.
?SizeRef : int
-
Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.
?StandOff : float
-
Moves the marker away from the data point in the direction of `angle` (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.
?MultiStandOff : float seq
-
Moves the marker away from the data point in the direction of `angle` (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.
?Symbol : MarkerSymbol
-
Sets the marker symbol.
?MultiSymbol : MarkerSymbol seq
-
Sets the individual marker symbols.
?Symbol3D : MarkerSymbol3D
-
Sets the marker symbol for 3d traces.
?MultiSymbol3D : MarkerSymbol3D seq
-
Sets the individual marker symbols for 3d traces.
?OutlierColor : Color
-
Sets the color of the outlier sample points.
?OutlierWidth : int
-
Sets the width of the outlier sample points.
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withMathTex (?AppendTags, ?MathJaxVersion)
Parameters:
bool
?MathJaxVersion : int
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withPolar (polar, ?Id)
Parameters:
Polar
-
The new Polar for the chart's layout
?Id : int
-
The target polar id on which the polar object should be set. Default is 1.
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withPolarStyle (?Domain, ?Sector, ?Hole, ?BGColor, ?RadialAxis, ?AngularAxis, ?GridShape, ?UIRevision, ?Id)
Parameters:
Domain
-
Sets the domain of this polar subplot
?Sector : float * float
-
Sets angular span of this polar subplot with two angles (in degrees). Sector are assumed to be spanned in the counterclockwise direction with "0" corresponding to rightmost limit of the polar subplot.
?Hole : float
-
Sets the fraction of the radius to cut out of the polar subplot.
?BGColor : Color
-
Set the background color of the subplot
?RadialAxis : RadialAxis
-
Sets the radial axis of the polar subplot.
?AngularAxis : AngularAxis
-
Sets the angular axis of the polar subplot.
?GridShape : PolarGridShape
-
Determines if the radial axis grid lines and angular axis line are drawn as "circular" sectors or as "linear" (polygon) sectors. Has an effect only when the angular axis has `type` "category". Note that `radialaxis.angle` is snapped to the angle of the closest vertex when `gridshape` is "circular" (so that radial axis scale is the same as the data scale).
?UIRevision : string
-
Controls persistence of user-driven changes in axis attributes, if not overridden in the individual axes. Defaults to `layout.uirevision`.
?Id : int
-
The target polar id
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withRadialAxis (radialAxis, ?Id)
Parameters:
RadialAxis
-
The new RadialAxis for the chart layout's polar object
?Id : int
-
The target polar id on which the RadialAxis should be set. Default is 1.
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withRealAxis (realAxis, ?Id)
Parameters:
RealAxis
-
The new RealAxis for the chart layout's smith object
?Id : int
-
The target smith id on which the RealAxis should be set. Default is 1.
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withScene (scene, ?Id)
Parameters:
Scene
-
The Scene to set on the chart's layout
?Id : int
-
The target scene id on which the scene should be set. Default is 1.
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withSceneStyle (?Annotations, ?AspectMode, ?AspectRatio, ?BGColor, ?Camera, ?Domain, ?DragMode, ?HoverMode, ?UIRevision, ?XAxis, ?YAxis, ?ZAxis, ?Id)
Parameters:
Annotation seq
-
An annotation is a text element that can be placed anywhere in the plot. It can be positioned with respect to relative coordinates in the plot or with respect to the actual data coordinates of the graph. Annotations can be shown with or without an arrow.
?AspectMode : AspectMode
-
If "cube", this scene's axes are drawn as a cube, regardless of the axes' ranges. If "data", this scene's axes are drawn in proportion with the axes' ranges. If "manual", this scene's axes are drawn in proportion with the input of "aspectratio" (the default behavior if "aspectratio" is provided). If "auto", this scene's axes are drawn using the results of "data" except when one axis is more than four times the size of the two others, where in that case the results of "cube" are used.
?AspectRatio : AspectRatio
-
Sets this scene's axis aspectratio.
?BGColor : Color
-
Sets this scene's background color.
?Camera : Camera
-
Sets this scene's camera
?Domain : Domain
-
Sets this scene's domain
?DragMode : DragMode
-
Determines the mode of drag interactions for this scene.
?HoverMode : HoverMode
-
Determines the mode of hover interactions for this scene.
?UIRevision : string
-
Controls persistence of user-driven changes in camera attributes. Defaults to `layout.uirevision`.
?XAxis : LinearAxis
-
Sets this scene's xaxis
?YAxis : LinearAxis
-
Sets this scene's yaxis
?ZAxis : LinearAxis
-
Sets this scene's zaxis
?Id : int
-
The target scene id
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withSelection (selection, ?Append)
Parameters:
Selection
?Append : bool
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withSelections (selections, ?Append)
Parameters:
Selection seq
-
The selections to add to the input charts layout
?Append : bool
-
If true, the input selections will be appended to existing annotations, otherwise existing annotations will be removed (default: true)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withShape (shape, ?Append)
Parameters:
Shape
?Append : bool
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withShapes (shapes, ?Append)
Parameters:
Shape seq
-
The shapes to add to the input charts layout
?Append : bool
-
If true, the input annotations will be appended to existing annotations, otherwise existing annotations will be removed (default: true)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withSize (width, height)
Parameters:
float
height : float
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withSize (?Width, ?Height)
Parameters:
int
?Height : int
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withSlider slider
Parameters:
Slider
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withSliders sliders
Parameters:
Slider seq
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withSmith (smith, ?Id)
Parameters:
Smith
-
The new Smith for the chart's layout
?Id : int
-
The target smith id on which the smith object should be set. Default is 1.
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withSmithStyle (?BGColor, ?Domain, ?ImaginaryAxis, ?RealAxis, ?Id)
Parameters:
Color
?Domain : Domain
?ImaginaryAxis : ImaginaryAxis
?RealAxis : RealAxis
?Id : int
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withTemplate template
Parameters:
Template
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withTernary (ternary, ?Id)
Parameters:
Ternary
-
The Ternary to set on the chart's layout
?Id : int
-
The target ternary id on which the Ternary should be set. Default is 1.
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withTernaryStyle (?AAxis, ?BAxis, ?CAxis, ?Domain, ?Sum, ?BGColor, ?Id)
Parameters:
LinearAxis
-
Sets the ternary A Axis
?BAxis : LinearAxis
-
Sets the ternary B Axis
?CAxis : LinearAxis
-
Sets the ternary C Axis
?Domain : Domain
-
Sets the ternary domain
?Sum : 'a
-
The number each triplet should sum to, and the maximum range of each axis
?BGColor : Color
-
Sets the background color of the ternary layout.
?Id : int
-
The target Ternary id
Returns: GenericChart -> GenericChart
|
|
|
|
Full Usage:
Chart.withTitle (title, ?TitleFont)
Parameters:
string
?TitleFont : Font
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withTraceInfo (?Name, ?Visible, ?ShowLegend, ?LegendRank, ?LegendGroup, ?LegendGroupTitle)
Parameters:
string
-
Sets the name of the chart's trace(s). When the chart is a multichart (it contains multiple traces), the name is suffixed by '_%i' where %i is the index of the trace.
?Visible : Visible
-
Whether or not the chart's traces are visible
?ShowLegend : bool
-
Determines whether or not item(s) corresponding to this chart's trace(s) is/are shown in the legend.
?LegendRank : int
-
Sets the legend rank for the chart's trace(s). Items and groups with smaller ranks are presented on top/left side while with `"reversed" `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items.
?LegendGroup : string
-
Sets the legend group for the chart's trace(s). Traces part of the same legend group hide/show at the same time when toggling legend items.
?LegendGroupTitle : Title
-
Sets the title for the chart's trace legend group
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withUpdateMenu (updateMenu, ?Append)
Parameters:
UpdateMenu
?Append : bool
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withUpdateMenus (updateMenus, ?Append)
Parameters:
UpdateMenu seq
-
The updatmenus to add to the input charts layout
?Append : bool
-
If true, the input images will be appended to existing annotations, otherwise existing annotations will be removed (default: true)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withXAxis (xAxis, ?Id)
Parameters:
LinearAxis
-
The x axis to set on the chart's layout
?Id : SubPlotId
-
The target axis id with which the axis should be set. Default is 1.
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withXAxisRangeSlider (rangeSlider, ?Id)
Parameters:
RangeSlider
?Id : SubPlotId
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withXAxisStyle (?TitleText, ?TitleFont, ?TitleStandoff, ?Title, ?Color, ?AxisType, ?MinMax, ?Mirror, ?ShowSpikes, ?SpikeColor, ?SpikeThickness, ?ShowLine, ?LineColor, ?ShowGrid, ?GridColor, ?GridDash, ?ZeroLine, ?ZeroLineColor, ?Anchor, ?Side, ?Overlaying, ?Domain, ?Position, ?CategoryOrder, ?CategoryArray, ?RangeSlider, ?RangeSelector, ?BackgroundColor, ?ShowBackground, ?Id)
Parameters:
string
-
Sets the text of the axis title.
?TitleFont : Font
-
Sets the font of the axis title.
?TitleStandoff : int
-
Sets the standoff distance (in px) between the axis labels and the title text.
?Title : Title
-
Sets the Title (use this for more finegrained control than the other title-associated arguments)
?Color : Color
-
Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors.
?AxisType : AxisType
-
Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
?MinMax : 'a * 'b
-
Tuple of (Min*Max value). Sets the range of this axis (the axis will go from Min to Max). If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2).
?Mirror : Mirror
-
Determines if and how the axis lines or/and ticks are mirrored to the opposite side of the plotting area.
?ShowSpikes : bool
-
Determines whether or not spikes (aka droplines) are drawn for this axis.
?SpikeColor : Color
-
Sets the spike color. If not set, will use the series color
?SpikeThickness : int
-
Sets the width (in px) of the zero line.
?ShowLine : bool
-
Determines whether or not a line bounding this axis is drawn.
?LineColor : Color
-
Sets the axis line color.
?ShowGrid : bool
-
Determines whether or not grid lines are drawn. If "true", the grid lines are drawn at every tick mark.
?GridColor : Color
-
Sets the color of the grid lines.
?GridDash : DrawingStyle
-
Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
?ZeroLine : bool
-
Determines whether or not a line is drawn at along the 0 value of this axis. If "true", the zero line is drawn on top of the grid lines.
?ZeroLineColor : Color
-
Sets the line color of the zero line.
?Anchor : LinearAxisId
-
If set to an opposite-letter axis id (e.g. `x2`, `y`), this axis is bound to the corresponding opposite-letter axis. If set to "free", this axis' position is determined by `position`.
?Side : Side
-
Determines whether a x (y) axis is positioned at the "bottom" ("left") or "top" ("right") of the plotting area.
?Overlaying : LinearAxisId
-
If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis, with traces and axes visible for both axes. If "false", this axis does not overlay any same-letter axes. In this case, for axes with overlapping domains only the highest-numbered axis will be visible.
?Domain : float * float
-
Tuple of (X*Y fractions). Sets the domain of this axis (in plot fraction).
?Position : float
-
Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if `anchor` is set to "free".
?CategoryOrder : CategoryOrder
-
Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to "total ascending" or "total descending" if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values.
?CategoryArray : 'c seq
-
Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.
?RangeSlider : RangeSlider
-
Sets a range slider for this axis
?RangeSelector : RangeSelector
-
Sets a range selector for this axis. This object contains toggable presets for the rangeslider.
?BackgroundColor : Color
-
Sets the background color of this axis' wall. (Only has an effect on 3D scenes)
?ShowBackground : bool
-
Sets whether or not this axis' wall has a background color. (Only has an effect on 3D scenes)
?Id : SubPlotId
-
The target axis id on which the styles should be applied. Default is 1.
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withXError xError
Parameters:
Error
-
The new error for the chart's trace(s)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withXErrorStyle (?Visible, ?Type, ?Symmetric, ?Array, ?Arrayminus, ?Value, ?Valueminus, ?Traceref, ?Tracerefminus, ?Copy_ystyle, ?Color, ?Thickness, ?Width)
Parameters:
bool
-
Determines whether or not this set of error bars is visible.
?Type : ErrorType
-
Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the square of the underlying data. If "data", the bar lengths are set with data set `array`.
?Symmetric : bool
-
Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
?Array : 'a seq
-
Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
?Arrayminus : 'b seq
-
Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
?Value : float
-
Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.
?Valueminus : float
-
Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
?Traceref : int
-
?Tracerefminus : int
-
?Copy_ystyle : bool
-
?Color : Color
-
Sets the stoke color of the error bars.
?Thickness : float
-
Sets the thickness (in px) of the error bars.
?Width : float
-
Sets the width (in px) of the cross-bar at both ends of the error bars.
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withYAxis (yAxis, ?Id)
Parameters:
LinearAxis
-
The y axis to set on the chart's layout
?Id : SubPlotId
-
The target axis id with which the axis should be set. Default is 1.
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withYAxisStyle (?TitleText, ?TitleFont, ?TitleStandoff, ?Title, ?Color, ?AxisType, ?MinMax, ?Mirror, ?ShowSpikes, ?SpikeColor, ?SpikeThickness, ?ShowLine, ?LineColor, ?ShowGrid, ?GridColor, ?GridDash, ?ZeroLine, ?ZeroLineColor, ?Anchor, ?Side, ?Overlaying, ?AutoShift, ?Shift, ?Domain, ?Position, ?CategoryOrder, ?CategoryArray, ?RangeSlider, ?RangeSelector, ?BackgroundColor, ?ShowBackground, ?Id)
Parameters:
string
-
Sets the text of the axis title.
?TitleFont : Font
-
Sets the font of the axis title.
?TitleStandoff : int
-
Sets the standoff distance (in px) between the axis labels and the title text.
?Title : Title
-
Sets the Title (use this for more finegrained control than the other title-associated arguments)
?Color : Color
-
Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors.
?AxisType : AxisType
-
Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
?MinMax : 'a * 'b
-
Tuple of (Min*Max value). Sets the range of this axis (the axis will go from Min to Max). If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2).
?Mirror : Mirror
-
Determines if and how the axis lines or/and ticks are mirrored to the opposite side of the plotting area.
?ShowSpikes : bool
-
Determines whether or not spikes (aka droplines) are drawn for this axis.
?SpikeColor : Color
-
Sets the spike color. If not set, will use the series color
?SpikeThickness : int
-
Sets the width (in px) of the zero line.
?ShowLine : bool
-
Determines whether or not a line bounding this axis is drawn.
?LineColor : Color
-
Sets the axis line color.
?ShowGrid : bool
-
Determines whether or not grid lines are drawn. If "true", the grid lines are drawn at every tick mark.
?GridColor : Color
-
Sets the color of the grid lines.
?GridDash : DrawingStyle
-
Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
?ZeroLine : bool
-
Determines whether or not a line is drawn at along the 0 value of this axis. If "true", the zero line is drawn on top of the grid lines.
?ZeroLineColor : Color
-
Sets the line color of the zero line.
?Anchor : LinearAxisId
-
If set to an opposite-letter axis id (e.g. `x2`, `y`), this axis is bound to the corresponding opposite-letter axis. If set to "free", this axis' position is determined by `position`.
?Side : Side
-
Determines whether a x (y) axis is positioned at the "bottom" ("left") or "top" ("right") of the plotting area.
?Overlaying : LinearAxisId
-
If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis, with traces and axes visible for both axes. If "false", this axis does not overlay any same-letter axes. In this case, for axes with overlapping domains only the highest-numbered axis will be visible.
?AutoShift : bool
-
Automatically reposition the axis to avoid overlap with other axes with the same `overlaying` value. This repositioning will account for any `shift` amount applied to other axes on the same side with `autoshift` is set to true. Only has an effect if `anchor` is set to "free".
?Shift : int
-
Moves the axis a given number of pixels from where it would have been otherwise. Accepts both positive and negative values, which will shift the axis either right or left, respectively. If `autoshift` is set to true, then this defaults to a padding of -3 if `side` is set to "left". and defaults to +3 if `side` is set to "right". Defaults to 0 if `autoshift` is set to false. Only has an effect if `anchor` is set to "free".
?Domain : float * float
-
Tuple of (X*Y fractions). Sets the domain of this axis (in plot fraction).
?Position : float
-
Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if `anchor` is set to "free".
?CategoryOrder : CategoryOrder
-
Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to "total ascending" or "total descending" if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values.
?CategoryArray : 'c seq
-
Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.
?RangeSlider : RangeSlider
-
Sets a range slider for this axis
?RangeSelector : RangeSelector
-
Sets a range selector for this axis. This object contains toggable presets for the rangeslider.
?BackgroundColor : Color
-
Sets the background color of this axis' wall. (Only has an effect on 3D scenes)
?ShowBackground : bool
-
Sets whether or not this axis' wall has a background color. (Only has an effect on 3D scenes)
?Id : SubPlotId
-
The target axis id on which the styles should be applied. Default is 1.
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withYError yError
Parameters:
Error
-
The new error for the chart's trace(s)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withYErrorStyle (?Visible, ?Type, ?Symmetric, ?Array, ?Arrayminus, ?Value, ?Valueminus, ?Traceref, ?Tracerefminus, ?Copy_ystyle, ?Color, ?Thickness, ?Width)
Parameters:
bool
-
Determines whether or not this set of error bars is visible.
?Type : ErrorType
-
Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the square of the underlying data. If "data", the bar lengths are set with data set `array`.
?Symmetric : bool
-
Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
?Array : 'a seq
-
Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
?Arrayminus : 'b seq
-
Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
?Value : float
-
Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.
?Valueminus : float
-
Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
?Traceref : int
-
?Tracerefminus : int
-
?Copy_ystyle : bool
-
?Color : Color
-
Sets the stoke color of the error bars.
?Thickness : float
-
Sets the thickness (in px) of the error bars.
?Width : float
-
Sets the width (in px) of the cross-bar at both ends of the error bars.
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withZAxis (zAxis, ?Id)
Parameters:
LinearAxis
-
The z axis to set on the chart's layout
?Id : int
-
The target scene id on which the axis should be set. Default is 1.
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withZAxisStyle (?TitleText, ?TitleFont, ?TitleStandoff, ?Title, ?Color, ?AxisType, ?MinMax, ?Mirror, ?ShowSpikes, ?SpikeColor, ?SpikeThickness, ?ShowLine, ?LineColor, ?ShowGrid, ?GridColor, ?ZeroLine, ?ZeroLineColor, ?Anchor, ?Side, ?Overlaying, ?Domain, ?Position, ?CategoryOrder, ?CategoryArray, ?RangeSlider, ?RangeSelector, ?BackgroundColor, ?ShowBackground, ?Id)
Parameters:
string
-
Sets the text of the axis title.
?TitleFont : Font
-
Sets the font of the axis title.
?TitleStandoff : int
-
Sets the standoff distance (in px) between the axis labels and the title text.
?Title : Title
-
Sets the Title (use this for more finegrained control than the other title-associated arguments)
?Color : Color
-
Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors.
?AxisType : AxisType
-
Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
?MinMax : 'a * 'b
-
Tuple of (Min*Max value). Sets the range of this axis (the axis will go from Min to Max). If the axis `type` is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2).
?Mirror : Mirror
-
Determines if and how the axis lines or/and ticks are mirrored to the opposite side of the plotting area.
?ShowSpikes : bool
-
Determines whether or not spikes (aka droplines) are drawn for this axis.
?SpikeColor : Color
-
Sets the spike color. If not set, will use the series color
?SpikeThickness : int
-
Sets the width (in px) of the zero line.
?ShowLine : bool
-
Determines whether or not a line bounding this axis is drawn.
?LineColor : Color
-
Sets the axis line color.
?ShowGrid : bool
-
Determines whether or not grid lines are drawn. If "true", the grid lines are drawn at every tick mark.
?GridColor : Color
-
Sets the color of the grid lines.
?ZeroLine : bool
-
Determines whether or not a line is drawn at along the 0 value of this axis. If "true", the zero line is drawn on top of the grid lines.
?ZeroLineColor : Color
-
Sets the line color of the zero line.
?Anchor : LinearAxisId
-
If set to an opposite-letter axis id (e.g. `x2`, `y`), this axis is bound to the corresponding opposite-letter axis. If set to "free", this axis' position is determined by `position`.
?Side : Side
-
Determines whether a x (y) axis is positioned at the "bottom" ("left") or "top" ("right") of the plotting area.
?Overlaying : LinearAxisId
-
If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis, with traces and axes visible for both axes. If "false", this axis does not overlay any same-letter axes. In this case, for axes with overlapping domains only the highest-numbered axis will be visible.
?Domain : float * float
-
Tuple of (X*Y fractions). Sets the domain of this axis (in plot fraction).
?Position : float
-
Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if `anchor` is set to "free".
?CategoryOrder : CategoryOrder
-
Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set `categoryorder` to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to "array" to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to "total ascending" or "total descending" if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values.
?CategoryArray : 'c seq
-
Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`.
?RangeSlider : RangeSlider
-
Sets a range slider for this axis
?RangeSelector : RangeSelector
-
Sets a range selector for this axis. This object contains toggable presets for the rangeslider.
?BackgroundColor : Color
-
Sets the background color of this axis' wall. (Only has an effect on 3D scenes)
?ShowBackground : bool
-
Sets whether or not this axis' wall has a background color. (Only has an effect on 3D scenes)
?Id : int
-
The target scene id on which the axis styles should be applied. Default is 1.
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withZError zError
Parameters:
Error
-
The new error for the chart's trace(s)
Returns: GenericChart -> GenericChart
|
|
Full Usage:
Chart.withZErrorStyle (?Visible, ?Type, ?Symmetric, ?Array, ?Arrayminus, ?Value, ?Valueminus, ?Traceref, ?Tracerefminus, ?Copy_ystyle, ?Color, ?Thickness, ?Width)
Parameters:
bool
-
Determines whether or not this set of error bars is visible.
?Type : ErrorType
-
Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the square of the underlying data. If "data", the bar lengths are set with data set `array`.
?Symmetric : bool
-
Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
?Array : 'a seq
-
Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
?Arrayminus : 'b seq
-
Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
?Value : float
-
Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.
?Valueminus : float
-
Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
?Traceref : int
-
?Tracerefminus : int
-
?Copy_ystyle : bool
-
?Color : Color
-
Sets the stoke color of the error bars.
?Thickness : float
-
Sets the thickness (in px) of the error bars.
?Width : float
-
Sets the width (in px) of the cross-bar at both ends of the error bars.
Returns: GenericChart -> GenericChart
|
|