Chart-Plotly
view release on metacpan or search on metacpan
lib/Chart/Plotly/Trace/Box.pm view on Meta::CPAN
is => "rw",
isa => "Str|ArrayRef[Str]",
documentation =>
"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
);
has hoverinfosrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
);
has hoverlabel => ( is => "rw",
isa => "Maybe[HashRef]|Chart::Plotly::Trace::Box::Hoverlabel", );
has hoveron => ( is => "rw",
isa => "Str",
documentation => "Do the hover effects highlight individual boxes or sample points or both?",
);
has hovertemplate => (
is => "rw",
isa => "Str|ArrayRef[Str]",
documentation =>
"Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}....
);
has hovertemplatesrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
);
has hovertext => ( is => "rw",
isa => "Str|ArrayRef[Str]",
documentation => "Same as `text`.",
);
has hovertextsrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `hovertext`.",
);
has ids => (
is => "rw",
isa => "ArrayRef|PDL",
documentation =>
"Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
);
has idssrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `ids`.",
);
has jitter => (
is => "rw",
isa => "Num",
documentation =>
"Sets the amount of jitter in the sample points drawn. If *0*, the sample points align along the distribution axis. If *1*, the sample points are drawn in a random jitter of width equal to the width of the box(es).",
);
has legendgroup => (
is => "rw",
isa => "Str",
documentation =>
"Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.",
);
has legendgrouptitle => ( is => "rw",
isa => "Maybe[HashRef]|Chart::Plotly::Trace::Box::Legendgrouptitle", );
has legendrank => (
is => "rw",
isa => "Num",
documentation =>
"Sets the legend rank for this trace. 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 th...
);
has line => ( is => "rw",
isa => "Maybe[HashRef]|Chart::Plotly::Trace::Box::Line", );
has lowerfence => (
is => "rw",
isa => "ArrayRef|PDL",
documentation =>
"Sets the lower fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `lowerfence` is not provided but a sample (in `y` or `x`) is set, we compute the low...
);
has lowerfencesrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `lowerfence`.",
);
has marker => ( is => "rw",
isa => "Maybe[HashRef]|Chart::Plotly::Trace::Box::Marker", );
has mean => (
is => "rw",
isa => "ArrayRef|PDL",
documentation =>
"Sets the mean values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `mean` is not provided but a sample (in `y` or `x`) is set, we compute the mean for each bo...
);
has meansrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `mean`.",
);
has median => (is => "rw",
isa => "ArrayRef|PDL",
documentation => "Sets the median values. There should be as many items as the number of boxes desired.",
);
has mediansrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `median`.",
);
has pmeta => (
is => "rw",
isa => "Any|ArrayRef[Any]",
documentation =>
"Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `lab...
);
has metasrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `meta`.",
);
has name => (
is => "rw",
isa => "Str",
documentation =>
"Sets the trace name. The trace name appear as the legend item and on hover. For box traces, the name will also be used for the position coordinate, if `x` and `x0` (`y` and `y0` if horizontal) are missing and the position axis is categorical",
);
has notched => (
is => "rw",
isa => "Bool",
documentation =>
"Determines whether or not notches are drawn. Notches displays a confidence interval around the median. We compute the confidence interval as median +/- 1.57 * IQR / sqrt(N), where IQR is the interquartile range and N is the sample size. If two...
);
has notchspan => (
is => "rw",
isa => "ArrayRef|PDL",
documentation =>
"Sets the notch span from the boxes' `median` values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `notchspan` is not provided but a sample (in `y` or `x`) is ...
);
has notchspansrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `notchspan`.",
);
has notchwidth => (
is => "rw",
isa => "Num",
documentation =>
"Sets the width of the notches relative to the box' width. For example, with 0, the notches are as wide as the box(es).",
);
has offsetgroup => (
is => "rw",
isa => "Str",
documentation =>
"Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.",
);
has opacity => ( is => "rw",
isa => "Num",
documentation => "Sets the opacity of the trace.",
);
has orientation => (
is => "rw",
isa => enum( [ "v", "h" ] ),
documentation =>
"Sets the orientation of the box(es). If *v* (*h*), the distribution is visualized along the vertical (horizontal).",
);
has pointpos => (
is => "rw",
isa => "Num",
documentation =>
"Sets the position of the sample points in relation to the box(es). If *0*, the sample points are places over the center of the box(es). Positive (negative) values correspond to positions to the right (left) for vertical boxes and above (below)...
);
has q1 => (is => "rw",
isa => "ArrayRef|PDL",
documentation => "Sets the Quartile 1 values. There should be as many items as the number of boxes desired.",
);
has q1src => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `q1`.",
);
has q3 => (is => "rw",
isa => "ArrayRef|PDL",
documentation => "Sets the Quartile 3 values. There should be as many items as the number of boxes desired.",
);
has q3src => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `q3`.",
);
has quartilemethod => (
is => "rw",
isa => enum( [ "linear", "exclusive", "inclusive" ] ),
documentation =>
"Sets the method used to compute the sample's Q1 and Q3 quartiles. The *linear* method uses the 25th percentile for Q1 and 75th percentile for Q3 as computed using method #10 (listed on http://jse.amstat.org/v14n3/langford.html). The *exclusive...
);
has sd => (
is => "rw",
isa => "ArrayRef|PDL",
documentation =>
"Sets the standard deviation values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `sd` is not provided but a sample (in `y` or `x`) is set, we compute the stan...
);
has sdsrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `sd`.",
);
has selected => ( is => "rw",
isa => "Maybe[HashRef]|Chart::Plotly::Trace::Box::Selected", );
has selectedpoints => (
is => "rw",
isa => "Any",
documentation =>
"Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array val...
);
has showlegend => (
is => "rw",
isa => "Bool",
documentation => "Determines whether or not an item corresponding to this trace is shown in the legend.",
);
has stream => ( is => "rw",
isa => "Maybe[HashRef]|Chart::Plotly::Trace::Box::Stream", );
has text => (
is => "rw",
isa => "Str|ArrayRef[Str]",
documentation =>
"Sets the text elements associated with each sample value. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hove...
);
has textsrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `text`.",
);
has transforms => ( is => "rw",
isa => "ArrayRef|ArrayRef[Chart::Plotly::Trace::Box::Transform]", );
has uid => (
is => "rw",
isa => "Str",
documentation =>
"Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
);
has uirevision => (
is => "rw",
isa => "Any",
documentation =>
"Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-d...
);
has unselected => ( is => "rw",
isa => "Maybe[HashRef]|Chart::Plotly::Trace::Box::Unselected", );
has upperfence => (
is => "rw",
isa => "ArrayRef|PDL",
documentation =>
"Sets the upper fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `upperfence` is not provided but a sample (in `y` or `x`) is set, we compute the low...
);
has upperfencesrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `upperfence`.",
);
has visible => (
is => "rw",
documentation =>
"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).",
);
has whiskerwidth => (
is => "rw",
isa => "Num",
documentation =>
"Sets the width of the whiskers relative to the box' width. For example, with 1, the whiskers are as wide as the box(es).",
);
has width => (
is => "rw",
isa => "Num",
documentation =>
"Sets the width of the box in data coordinate If *0* (default value) the width is automatically selected based on the positions of other box traces in the same subplot.",
);
has x => ( is => "rw",
isa => "ArrayRef|PDL",
documentation => "Sets the x sample data or coordinates. See overview for more info.",
);
has x0 => (
is => "rw",
isa => "Any",
documentation =>
"Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.",
);
has xaxis => (
is => "rw",
documentation =>
"Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.",
);
has xcalendar => ( is => "rw",
isa => enum(
[ "chinese", "coptic", "discworld", "ethiopian", "gregorian", "hebrew", "islamic", "jalali",
"julian", "mayan", "nanakshahi", "nepali", "persian", "taiwan", "thai", "ummalqura"
]
),
documentation => "Sets the calendar system to use with `x` date data.",
);
has xhoverformat => (
is => "rw",
isa => "Str",
documentation =>
"Sets the hover text formatting rulefor `x` 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...
);
has xperiod => (
is => "rw",
isa => "Any",
documentation =>
"Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *n* on the x axis. Special values in the form of *n* could be used to declare the number of months. In this case `n` must be a positive integer.",
);
has xperiod0 => (
is => "rw",
isa => "Any",
lib/Chart/Plotly/Trace/Box.pm view on Meta::CPAN
Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements
=item * customdatasrc
Sets the source reference on Chart Studio Cloud for `customdata`.
=item * dx
Sets the x coordinate step for multi-box traces set using q1/median/q3.
=item * dy
Sets the y coordinate step for multi-box traces set using q1/median/q3.
=item * fillcolor
Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
=item * hoverinfo
Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
=item * hoverinfosrc
Sets the source reference on Chart Studio Cloud for `hoverinfo`.
=item * hoverlabel
=item * hoveron
Do the hover effects highlight individual boxes or sample points or both?
=item * hovertemplate
Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When sho...
=item * hovertemplatesrc
Sets the source reference on Chart Studio Cloud for `hovertemplate`.
=item * hovertext
Same as `text`.
=item * hovertextsrc
Sets the source reference on Chart Studio Cloud for `hovertext`.
=item * ids
Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
=item * idssrc
Sets the source reference on Chart Studio Cloud for `ids`.
=item * jitter
Sets the amount of jitter in the sample points drawn. If *0*, the sample points align along the distribution axis. If *1*, the sample points are drawn in a random jitter of width equal to the width of the box(es).
=item * legendgroup
Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
=item * legendgrouptitle
=item * legendrank
Sets the legend rank for this trace. 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...
=item * line
=item * lowerfence
Sets the lower fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `lowerfence` is not provided but a sample (in `y` or `x`) is set, we compute the lower as t...
=item * lowerfencesrc
Sets the source reference on Chart Studio Cloud for `lowerfence`.
=item * marker
=item * mean
Sets the mean values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `mean` is not provided but a sample (in `y` or `x`) is set, we compute the mean for each box using...
=item * meansrc
Sets the source reference on Chart Studio Cloud for `mean`.
=item * median
Sets the median values. There should be as many items as the number of boxes desired.
=item * mediansrc
Sets the source reference on Chart Studio Cloud for `median`.
=item * pmeta
Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` tex...
=item * metasrc
Sets the source reference on Chart Studio Cloud for `meta`.
=item * name
Sets the trace name. The trace name appear as the legend item and on hover. For box traces, the name will also be used for the position coordinate, if `x` and `x0` (`y` and `y0` if horizontal) are missing and the position axis is categorical
=item * notched
Determines whether or not notches are drawn. Notches displays a confidence interval around the median. We compute the confidence interval as median +/- 1.57 * IQR / sqrt(N), where IQR is the interquartile range and N is the sample size. If two boxes'...
=item * notchspan
Sets the notch span from the boxes' `median` values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `notchspan` is not provided but a sample (in `y` or `x`) is set, we...
=item * notchspansrc
Sets the source reference on Chart Studio Cloud for `notchspan`.
=item * notchwidth
Sets the width of the notches relative to the box' width. For example, with 0, the notches are as wide as the box(es).
=item * offsetgroup
Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
=item * opacity
Sets the opacity of the trace.
=item * orientation
Sets the orientation of the box(es). If *v* (*h*), the distribution is visualized along the vertical (horizontal).
=item * pointpos
Sets the position of the sample points in relation to the box(es). If *0*, the sample points are places over the center of the box(es). Positive (negative) values correspond to positions to the right (left) for vertical boxes and above (below) for ho...
=item * q1
Sets the Quartile 1 values. There should be as many items as the number of boxes desired.
=item * q1src
Sets the source reference on Chart Studio Cloud for `q1`.
=item * q3
Sets the Quartile 3 values. There should be as many items as the number of boxes desired.
=item * q3src
Sets the source reference on Chart Studio Cloud for `q3`.
=item * quartilemethod
Sets the method used to compute the sample's Q1 and Q3 quartiles. The *linear* method uses the 25th percentile for Q1 and 75th percentile for Q3 as computed using method #10 (listed on http://jse.amstat.org/v14n3/langford.html). The *exclusive* metho...
=item * sd
Sets the standard deviation values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `sd` is not provided but a sample (in `y` or `x`) is set, we compute the standard de...
=item * sdsrc
Sets the source reference on Chart Studio Cloud for `sd`.
=item * selected
=item * selectedpoints
Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values mea...
=item * showlegend
Determines whether or not an item corresponding to this trace is shown in the legend.
=item * stream
=item * text
Sets the text elements associated with each sample value. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` ...
=item * textsrc
Sets the source reference on Chart Studio Cloud for `text`.
=item * transforms
=item * uid
Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
=item * uirevision
Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven t...
=item * unselected
=item * upperfence
Sets the upper fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `upperfence` is not provided but a sample (in `y` or `x`) is set, we compute the lower as t...
=item * upperfencesrc
Sets the source reference on Chart Studio Cloud for `upperfence`.
=item * 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).
=item * whiskerwidth
Sets the width of the whiskers relative to the box' width. For example, with 1, the whiskers are as wide as the box(es).
=item * width
Sets the width of the box in data coordinate If *0* (default value) the width is automatically selected based on the positions of other box traces in the same subplot.
=item * x
Sets the x sample data or coordinates. See overview for more info.
=item * x0
Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.
=item * xaxis
Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.
=item * xcalendar
Sets the calendar system to use with `x` date data.
=item * xhoverformat
Sets the hover text formatting rulefor `x` 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...
=item * xperiod
Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *n* on the x axis. Special values in the form of *n* could be used to declare the number of months. In this case `n` must be a positive integer.
=item * xperiod0
Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it ...
=item * xperiodalignment
Only relevant when the axis `type` is *date*. Sets the alignment of data points on the x axis.
=item * xsrc
Sets the source reference on Chart Studio Cloud for `x`.
=item * y
Sets the y sample data or coordinates. See overview for more info.
=item * y0
Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.
=item * yaxis
Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.
=item * ycalendar
Sets the calendar system to use with `y` date data.
( run in 0.790 second using v1.01-cache-2.11-cpan-39bf76dae61 )