Other Enumerations

An error that occurs during the decoding of a value from the CSV representation.

Sets the title’s horizontal alignment with respect to its x position.

left means that the title starts at x, right means that the title ends at x and center means that the title’s center is at x. auto divides xref by three and calculates the xanchor value automatically based on the value of x.

Sets the title’s vertical alignment with respect to its y position.

top means that the title’s cap line is at y, bottom means that the title’s baseline is at y and middle means that the title’s midline is at y. auto divides yref by three and calculates the yanchor value automatically based on the value of y.

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.

Sets the orientation of the modebar.

Specifies whether new shapes are drawn below or above traces.

The easing function used for the transition

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

Sets the default calendar system to use for interpreting and displaying dates throughout the plot.

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, then autorange is set to false.

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. Applies only to linear axes.

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).

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.

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.

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.

Same as showtickprefix but for tick suffixes.

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.

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.

Sets the layer on which this axis is displayed.

If above traces, this axis is displayed above all the subplot’s traces If below traces, this axis is displayed below all the subplot’s traces, but above the grid lines. Useful when used together with scatter-like traces with cliponaxis set to false to show markers and/or text nodes above this axis.

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.

Sets the horizontal alignment of the text within the box.

Has an effect only if text spans two or more lines (i.e. text contains one or more
HTML tags) or if an explicit width is set to override the text width.

Sets the vertical alignment of the text within the box.

Has an effect only if an explicit height is set to override the text height.

Sets the positions of the text elements with respects to the (x,y) coordinates.

Sets the annotation’s x coordinate axis.

If set to a x axis id (e.g. x or x2), the x position refers to a x coordinate. If set to paper, the x position refers to the distance from the left of the plotting area in normalized coordinates where 0 (1) corresponds to the left (right). If set to a x axis ID followed by domain (separated by a space), the position behaves like for paper, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., x2 domain refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis.

Sets the annotation’s y coordinate axis.

If set to a y axis id (e.g. y or y2), the y position refers to a y coordinate. If set to paper, the y position refers to the distance from the bottom of the plotting area in normalized coordinates where 0 (1) corresponds to the bottom (top). If set to a y axis ID followed by domain (separated by a space), the position behaves like for paper, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., y2 domain refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis.

Sets the anchor for the x position

Sets the anchor for the y position.

Determines whether this slider length is set in units of plot fraction or in *pixels.

Use len to set the value.

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.

Determines where tick labels are drawn.

Determines the location of color bar’s title with respect to the color bar.

Note that the title’s location used to be set by the now deprecated titleside attribute.

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).

Only relevant when the axis type is date.

Sets the alignment of data points on the x axis.

Only relevant when the axis type is date.

Sets the alignment of data points on the y axis.

Sets the area to fill with a solid color.

Defaults to none unless this trace is stacked, then it gets tonexty (tonextx) if orientation is v (h) Use with fillcolor if not none. tozerox and tozeroy fill to x=0 and y=0 respectively. tonextx and tonexty fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like tozerox and tozeroy. toself connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. tonext fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like toself if there is no trace before it. tonext should not be used if one trace does not enclose the other. Traces in a stackgroup will only fill to (or be filled to) other traces in the same group. With multiple stackgroups or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

Sets the marker symbol type.

Adding 100 is equivalent to appending -open to a symbol name. Adding 200 is equivalent to appending -dot to a symbol name. Adding 300 is equivalent to appending -open-dot or dot-open to a symbol name.

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.

Specifies the location of the text.

inside positions text inside, next to the bar end (rotated and scaled if needed). outside positions text outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. auto tries to position text inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside.

Determines if texts are kept at center or start/end points in textposition inside mode.

Constrain the size of text inside or outside a bar to be no larger than the bar itself.

If array, the heatmap’s x coordinates are given by x (the default behavior when x is provided).

If scaled, the heatmap’s x coordinates are given by x0 and dx (the default behavior when x is not provided).

Specifies the binning function used for this histogram trace.

If count, the histogram values are computed by counting the number of values lying inside each bin. If sum, avg, min, max, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.

Specifies the type of normalization used for this histogram trace.

If *, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If *percent / probability, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If density, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If probability density, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).

Sets the constraint operation.

= keeps regions equal to value < and <= keep regions less than value > and >= keep regions greater than value [], (), [), and (] keep regions inside value[0] to value[1] ], *)(, *[ keep regions outside value[0] to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed for consistency with filter transforms.

Determines the line shape.

With spline the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.

Sets the area to fill with a solid color.

Use with fillcolor if not none. scatterternary has a subset of the options available to scatter. toself connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. tonext fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like toself if there is no trace before it. tonext should not be used if one trace does not enclose the other.

Sets the dash style of the lines.

Specifies the ordering logic for the categories in the dimension.

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.

Sets the unit of input theta values.

Has an effect only when on linear angular axes.

An empty dummy shorthand for a non-utilized generic Plotable type.

This type is a placeholder that can be used in cases where you don’t use all generic types provided by a particular trace. It (hopefully) improves readability and clarifies intent of the source code in these situations.

For example, the Box trace requires specification of three generic types for YData, XData and QData.

let box = Box<[Double], Unused, Unused>(
    y: [1.9, 2.1, 2.2, 2.1]
)

Most of the time one uses either one of XY or Q, but not both at the same time. To create an instance, one would have to come up with some dummy type for XData and QData that conforms to the Plotable protocol. This very likely confuses the potential reader because the corresponding XData/QData attribute is never set and never used.