ModeUtils
|
Functions to manipulate StyleParam Mode
|
Align
|
Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
|
AngleRef
|
|
AngularUnit
|
|
AnnotationAlignment
|
|
ArrowHead
|
|
ArrowSide
|
|
AspectMode
|
|
AutoRange
|
Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided and it has a value for both the lower and upper bound, `autorange` is set to "false". Using "min" applies autorange only to set the minimum. Using "max" applies autorange only to set the maximum. Using "min reversed" applies autorange only to set the minimum on a reversed axis. Using "max reversed" applies autorange only to set the maximum on a reversed axis. Using "reversed" applies autorange on both ends and reverses the axis direction.
|
AutoTypeNumbers
|
|
AxisConstraint
|
If the axis needs to be compressed (either due to its own `scaleanchor` and `scaleratio` or those of the other axis), determines how that happens: by increasing the "range", or by decreasing the "domain". Default is "domain" for axes containing image traces, "range" otherwise.
|
AxisConstraintDirection
|
|
AxisType
|
Sets the axis type. By default (Auto), plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
|
BackOff
|
|
BarMode
|
For bar and histogram plots only. This sets how multiple bar objects are plotted together. In other words, this defines how bars at the same location
appear on the plot. If set to 'stack' the bars are stacked on top of one another. If set to 'group', the bars are plotted next to one another, centered
around the shared location. If set to 'overlay', the bars are simply plotted over one another, you may need to set the opacity to see this.
|
BarNorm
|
|
BoxMean
|
|
BoxMode
|
|
BoxPoints
|
|
BoxSizeMode
|
Sets the upper and lower bound for the boxes quartiles means box is drawn between Q1 and Q3 SD means the box is drawn between Mean +- Standard Deviation
|
BranchValues
|
|
Calendar
|
Sets the calendar system to use with `x y z` date data. Default: "gregorian"
|
CameraProjectionType
|
|
CategoryArrangement
|
|
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.
|
CategoryTickAnchor
|
|
CheaterType
|
|
ClickMode
|
|
ClickToShow
|
|
ColorComponentBound
|
|
ColorModel
|
|
Colorscale
|
The colorscale must be a collection containing a mapping of a normalized value (between 0.0 and 1.0) to it's color. At minimum, a mapping for the lowest (0.0) and highest (1.0) values are required.
|
ConeAnchor
|
Sets the cones' anchor with respect to their x/y/z positions. Note that "cm" denote the cone's center of mass which corresponds to 1/4 from the tail to tip.
|
ConeSizeMode
|
Sets the cones' anchor with respect to their x/y/z positions. Note that "cm" denote the cone's center of mass which corresponds to 1/4 from the tail to tip.
|
ConnectorMode
|
The shape of connector lines in Waterfall charts.
|
ConstrainText
|
|
ConstraintOperation
|
|
ContourColoring
|
|
ContourType
|
|
CoordinateType
|
|
CumulativeDirection
|
Only applies if cumulative is enabled. If "increasing" (default) we sum all prior bins, so the result increases from left to right.
If "decreasing" we sum later bins so the result decreases from left to right. default: "increasing"
|
Currentbin
|
Only applies if cumulative is enabled. Sets whether the current bin is included, excluded, or has half of its value included in
the current cumulative value. "include" is the default for compatibility with various other tools, however it introduces
a half-bin bias to the results. "exclude" makes the opposite half-bin bias, and "half" removes it.
|
Delaunayaxis
|
Sets the Delaunay axis, which is the axis that is perpendicular to the surface of the Delaunay triangulation.
It has an effect if `i`, `j`, `k` are not provided and `alphahull` is set to indicate Delaunay triangulation.
Default is "z"
|
Direction
|
Specifies the direction at which succeeding sectors follow one another.
|
DoubleClick
|
|
DragMode
|
Sets this figure's behavior when a user performs a mouse 'drag' in the plot area. When set to 'zoom', a portion of the plot will be highlighted,
when the viewer exits the drag, this highlighted section will be zoomed in on. When set to 'pan', data in the plot will move along with the viewers
dragging motions. A user can always depress the 'shift' key to access the whatever functionality has not been set as the default. In 3D plots, the
default drag mode is 'rotate' which rotates the scene.
|
DrawDirection
|
|
DrawingStyle
|
Dash: Sets the drawing style of the lines segments in this trace.
Sets the style of the lines. Set to a dash string type or a dash length in px.
|
EntryWidthMode
|
|
ErrorType
|
|
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.
|
Fill
|
Sets the area to fill with a solid color. (default: "none" )
|
FillRule
|
|
FontFamily
|
Names of installed font families
|
FunnelMode
|
|
GeoFitBounds
|
Used for the Layout.geo field. Determines if this subplot's view settings are auto-computed to fit trace data. On scoped maps, setting `fitbounds` leads to `center.lon` and `center.lat` getting auto-filled. On maps with a non-clipped projection, setting `fitbounds` leads to `center.lon`, `center.lat`, and `projection.rotation.lon` getting auto-filled. On maps with a clipped projection, setting `fitbounds` leads to `center.lon`, `center.lat`, `projection.rotation.lon`, `projection.rotation.lat`, `lonaxis.range` and `lonaxis.range` getting auto-filled. If "locations", only the trace's visible locations are considered in the `fitbounds` computations. If "geojson", the entire trace input `geojson` (if provided) is considered in the `fitbounds` computations, Defaults to "false".
|
GeoProjectionType
|
|
GeoResolution
|
Used for the Layout.geo field. Sets the resolution of the base layers. The values have units of km/mm e.g. 110 corresponds to a scale ratio of 1:110,000,000.
|
GeoScope
|
|
GradientType
|
|
GroupNorm
|
|
HistFunc
|
Sets the binning function used for this histogram trace. The default value is 'count' where the histogram values are computed
by counting the number of values lying inside each bin. With 'histfunc' set to 'sum', 'avg', 'min' or 'max', the histogram values
are computed using the sum, the average, the minimum or the 'maximum' of the values lying inside each bin respectively.
default: Count
|
HistNorm
|
Sets the type of normalization for this histogram trace. By default ('histnorm' set to '') the height of each bar
displays the frequency of occurrence, i.e., the number of times this value was found in the corresponding bin.
If set to 'percent', the height of each bar displays the percentage of total occurrences found within the corresponding bin.
If set to 'probability', the height of each bar displays the probability that an event will fall into the corresponding bin.
If set to 'density', the height of each bar is equal to the number of occurrences in a bin divided by the size of the bin
interval such that summing the area of all bins will yield the total number of occurrences. If set to 'probability density',
the height of each bar is equal to the number of probability that an event will fall into the corresponding bin divided by
the size of the bin interval such that summing the area of all bins will yield 1.
default: None
|
HorizontalAlign
|
|
HoverInfo
|
|
HoverMode
|
Sets this figure's behavior when a user hovers over it. When set to 'x', all data sharing the same 'x' coordinate will be shown on screen
with corresponding trace labels. When set to 'y' all data sharing the same 'y' coordinates will be shown on the screen with corresponding
trace labels. When set to 'closest', information about the data point closest to where the viewer is hovering will appear.
|
HoverOn
|
|
IcicleCount
|
|
ImageFormat
|
|
IndicatorAlignment
|
|
IndicatorDeltaPosition
|
|
IndicatorGaugeShape
|
|
IndicatorMode
|
|
InsideTextAnchor
|
|
InsideTextOrientation
|
|
IntensityMode
|
|
JitterPoints
|
|
Layer
|
Specifies whether shapes are drawn below or above traces. Default is Above
|
LayoutGridPattern
|
Pattern to use for autogenerating Axis Ids when not specifically specifying subplot axes IDs in LayoutGrids
|
LayoutGridRowOrder
|
Determines whether the rows of a LayoutGrid are enumerated from the top or the bottom.
|
LayoutGridXSide
|
Sets where the x axis labels and titles go on a layout grid.
|
LayoutGridYSide
|
Sets where the y axis labels and titles go on a layout grid.
|
LayoutImageSizing
|
Specifies whether shapes are drawn below or above traces. Default is Above
|
LinearAxisId
|
|
LocationFormat
|
Determines the set of locations used to match entries in `locations` to regions on the map. Default: ISO-3
|
MapboxLayerSourceType
|
|
MapboxLayerSymbolPlacement
|
|
MapboxLayerType
|
|
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: open-street-map, white-bg, carto-positron, carto-darkmatter, stamen-terrain, stamen-toner, stamen-watercolor
The built-in Mapbox styles are: basic, streets, outdoors, light, dark, satellite, satellite-streets Mapbox style URLs are of the form: mapbox://mapbox.mapbox--
|
MarkerSizeMode
|
|
MarkerSymbol
|
|
MarkerSymbol3D
|
|
Method
|
|
Mirror
|
Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If "true", the axis lines are mirrored.
If "ticks", the axis lines and ticks are mirrored. If "false", mirroring is disable. If "all", axis lines are mirrored on all shared-axes subplots. If "allticks", axis lines and ticks are mirrored on all shared-axes subplots.
|
Mode
|
|
ModeBarButton
|
|
NewSelectionMode
|
|
Orientation
|
|
PathbarEdgeShape
|
|
PatternFillMode
|
|
PatternShape
|
|
PeriodAlignment
|
|
PolarGridShape
|
Sets the method used to compute the sample's Q1 and Q3 quartiles
|
QuartileMethod
|
Sets the method used to compute the sample's Q1 and Q3 quartiles
|
Range
|
Defines a Range between min and max value
|
RangeMode
|
If "normal", the range is computed in relation to the extrema of the input data. If "tozero"`, the range extends to 0, regardless of the input data If "nonnegative", the range is non-negative, regardless of the input data.
|
RangebreakPattern
|
Determines a pattern on the time line that generates breaks.
|
RangesliderRangeMode
|
|
ScaleAnchor
|
|
ScaleMode
|
|
ScatterMode
|
|
ScrollZoom
|
|
SelectDirection
|
|
SelectionType
|
|
Shape
|
Determines the line shape. With "spline" the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.
|
ShapeSizeMode
|
|
ShapeType
|
Specifies the shape type to be drawn. If "line", a line is drawn from (`x0`,`y0`) to (`x1`,`y1`) If "circle", a circle is drawn from ((`x0`+`x1`)/2, (`y0`+`y1`)/2))
with radius (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 -`y0`)|) If "rect", a rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`), (`x1`,`y1`), (`x0`,`y1`), (`x0`,`y0`)
If "path", draw a custom SVG path using `path`.
|
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.
|
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.
|
Side
|
|
SmoothAlg
|
Choose between algorithms ('best' or 'fast') to smooth data linked to 'z'. The default value is false corresponding to no smoothing.
|
SortAlgorithm
|
|
SpanMode
|
|
SpikeMode
|
Determines the drawing mode for the spike line
|
SpikeSnap
|
Determines whether spikelines are stuck to the cursor or to the closest datapoints.
|
StackGaps
|
|
SubPlotId
|
|
SurfaceAxis
|
|
SurfacePattern
|
Sets the surface pattern of the iso-surface 3-D sections. The default pattern of the surface is `all` meaning that the rest of surface elements would be shaded. The check options (either 1 or 2) could be used to draw half of the squares on the surface. Using various combinations of capital `A`, `B`, `C`, `D` and `E` may also be used to reduce the number of triangles on the iso-surfaces and creating other patterns of interest.
|
SymbolStyle
|
|
TextAngle
|
|
TextInfo
|
Determines which trace information appear on the graph and on hover (HoverInfo)
|
TextPosition
|
Sets the positions of the `text` elements. Note that not all options work for every type of trace, e.g. Pie Charts only support "inside" | "outside" | "auto" | "none"
- Cartesian plots: Sets the positions of the `text` elements with respects to the (x,y) coordinates.
- Pie Charts and derivatives: Specifies the location of the text with respects to the sector.
|
TickAutoMargin
|
|
TickLabelMode
|
|
TickLabelOverflow
|
|
TickLabelPosition
|
|
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). If "sync", the number of ticks will sync with the overlayed axis set by `overlaying` property.
|
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.
|
TilingFlip
|
|
TimeStep
|
|
TimeStepMode
|
Determines whether spikelines are stuck to the cursor or to the closest datapoints.
|
TraceGroupClickOptions
|
|
TraceItemClickOptions
|
|
TraceItemSizing
|
|
TraceOrder
|
|
TransitionEasing
|
|
TransitionOrdering
|
|
TreemapTilingPacking
|
|
TriangulationAlgorithm
|
|
UniformTextMode
|
|
UnitMode
|
|
UpdateMenuDirection
|
|
UpdateMenuType
|
|
UpdateMethod
|
|
VerticalAlign
|
|
ViolinMode
|
|
ViolinSide
|
|
Visible
|
Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
|
WaterfallMeasure
|
How to compute differences between bars in Waterfall Charts
|
WaterfallMode
|
|
XAnchorPosition
|
|
YAnchorPosition
|
|