Skip to content

Scripting API / dashboard/dashitems/DashboardItemApi / External

External

Classes

AccountabilityDataChartBeforeDrawScriptEvent

Extends

Properties

Property Modifier Type Description Inherited from
data public AccountabilityDataChartBeforeDrawEventData Detail and data objects for the data chart that is about to be drawn DataChartBeforeDrawScriptEvent.data

Accessors

isPropagationStopped
Get Signature

get isPropagationStopped(): boolean

Returns

boolean

Inherited from

DataChartBeforeDrawScriptEvent.isPropagationStopped

Methods

stopPropagation()

stopPropagation(): void

Stop this event from continuing to the next event handler. This does not prevent any default behaviors from occurring

Returns

void

Inherited from

DataChartBeforeDrawScriptEvent.stopPropagation

ChartBeforeDrawScriptEvent

Extends

Extended by

Properties

Property Modifier Type Description Inherited from
data public DashboardItemEventData Detail, data, and Plotly objects for the chart that is about to be drawn DashboardItemScriptEvent.data

Accessors

isPropagationStopped
Get Signature

get isPropagationStopped(): boolean

Returns

boolean

Inherited from

DashboardItemScriptEvent.isPropagationStopped

Methods

stopPropagation()

stopPropagation(): void

Stop this event from continuing to the next event handler. This does not prevent any default behaviors from occurring

Returns

void

Inherited from

DashboardItemScriptEvent.stopPropagation

ControlChartBeforeDrawScriptEvent

Extends

Properties

Property Modifier Type Description Inherited from
data public ControlChartBeforeDrawEventData Detail, data, and Plotly objects for the chart that is about to be drawn ChartBeforeDrawScriptEvent.data

Accessors

isPropagationStopped
Get Signature

get isPropagationStopped(): boolean

Returns

boolean

Inherited from

ChartBeforeDrawScriptEvent.isPropagationStopped

Methods

stopPropagation()

stopPropagation(): void

Stop this event from continuing to the next event handler. This does not prevent any default behaviors from occurring

Returns

void

Inherited from

ChartBeforeDrawScriptEvent.stopPropagation

DashboardItemScriptEvent

Extends

Extended by

Properties

Property Modifier Type Inherited from
data public DashboardItemEventData ScriptEvent.data

Accessors

isPropagationStopped
Get Signature

get isPropagationStopped(): boolean

Returns

boolean

Inherited from

ScriptEvent.isPropagationStopped

Methods

stopPropagation()

stopPropagation(): void

Stop this event from continuing to the next event handler. This does not prevent any default behaviors from occurring

Returns

void

Inherited from

ScriptEvent.stopPropagation

DataChartBeforeDrawScriptEvent

Extends

Extended by

Properties

Property Modifier Type Description Inherited from
data public DashboardItemEventData Detail and data objects for the data chart that is about to be drawn ChartBeforeDrawScriptEvent.data

Accessors

isPropagationStopped
Get Signature

get isPropagationStopped(): boolean

Returns

boolean

Inherited from

ChartBeforeDrawScriptEvent.isPropagationStopped

Methods

stopPropagation()

stopPropagation(): void

Stop this event from continuing to the next event handler. This does not prevent any default behaviors from occurring

Returns

void

Inherited from

ChartBeforeDrawScriptEvent.stopPropagation

DMSDataChartBeforeDrawScriptEvent

Extends

Properties

Property Modifier Type Description Inherited from
data public DMSDataChartBeforeDrawEventData Detail and data objects for the data chart that is about to be drawn DataChartBeforeDrawScriptEvent.data

Accessors

isPropagationStopped
Get Signature

get isPropagationStopped(): boolean

Returns

boolean

Inherited from

DataChartBeforeDrawScriptEvent.isPropagationStopped

Methods

stopPropagation()

stopPropagation(): void

Stop this event from continuing to the next event handler. This does not prevent any default behaviors from occurring

Returns

void

Inherited from

DataChartBeforeDrawScriptEvent.stopPropagation

DMSTrendChartBeforeDrawScriptEvent

Extends

Properties

Property Modifier Type Description Inherited from
data public DMSTrendChartBeforeDrawEventData Detail, data, and Plotly objects for the chart that is about to be drawn ChartBeforeDrawScriptEvent.data

Accessors

isPropagationStopped
Get Signature

get isPropagationStopped(): boolean

Returns

boolean

Inherited from

ChartBeforeDrawScriptEvent.isPropagationStopped

Methods

stopPropagation()

stopPropagation(): void

Stop this event from continuing to the next event handler. This does not prevent any default behaviors from occurring

Returns

void

Inherited from

ChartBeforeDrawScriptEvent.stopPropagation

HistogramChartBeforeDrawScriptEvent

Extends

Properties

Property Modifier Type Description Inherited from
data public HistogramChartBeforeDrawEventData Detail, data, and Plotly objects for the chart that is about to be drawn ChartBeforeDrawScriptEvent.data

Accessors

isPropagationStopped
Get Signature

get isPropagationStopped(): boolean

Returns

boolean

Inherited from

ChartBeforeDrawScriptEvent.isPropagationStopped

Methods

stopPropagation()

stopPropagation(): void

Stop this event from continuing to the next event handler. This does not prevent any default behaviors from occurring

Returns

void

Inherited from

ChartBeforeDrawScriptEvent.stopPropagation

OEEChartBeforeDrawScriptEvent

Extends

Properties

Property Modifier Type Description Inherited from
data public OEEChartBeforeDrawEventData Detail, data, and Plotly objects for the chart that is about to be drawn ChartBeforeDrawScriptEvent.data

Accessors

isPropagationStopped
Get Signature

get isPropagationStopped(): boolean

Returns

boolean

Inherited from

ChartBeforeDrawScriptEvent.isPropagationStopped

Methods

stopPropagation()

stopPropagation(): void

Stop this event from continuing to the next event handler. This does not prevent any default behaviors from occurring

Returns

void

Inherited from

ChartBeforeDrawScriptEvent.stopPropagation

OEEDataChartBeforeDrawScriptEvent

Extends

Properties

Property Modifier Type Description Inherited from
data public OEEDataChartBeforeDrawEventData Detail and data objects for the data chart that is about to be drawn DataChartBeforeDrawScriptEvent.data

Accessors

isPropagationStopped
Get Signature

get isPropagationStopped(): boolean

Returns

boolean

Inherited from

DataChartBeforeDrawScriptEvent.isPropagationStopped

Methods

stopPropagation()

stopPropagation(): void

Stop this event from continuing to the next event handler. This does not prevent any default behaviors from occurring

Returns

void

Inherited from

DataChartBeforeDrawScriptEvent.stopPropagation

ParetoChartBeforeDrawScriptEvent

Extends

Properties

Property Modifier Type Description Inherited from
data public ParetoChartBeforeDrawEventData Detail, data, and Plotly objects for the chart that is about to be drawn ChartBeforeDrawScriptEvent.data

Accessors

isPropagationStopped
Get Signature

get isPropagationStopped(): boolean

Returns

boolean

Inherited from

ChartBeforeDrawScriptEvent.isPropagationStopped

Methods

stopPropagation()

stopPropagation(): void

Stop this event from continuing to the next event handler. This does not prevent any default behaviors from occurring

Returns

void

Inherited from

ChartBeforeDrawScriptEvent.stopPropagation

ScriptedChartClickScriptEvent

Extends

Properties

Property Modifier Type Inherited from
data public ScriptedChartClickEventData DashboardItemScriptEvent.data

Accessors

isPropagationStopped
Get Signature

get isPropagationStopped(): boolean

Returns

boolean

Inherited from

DashboardItemScriptEvent.isPropagationStopped

Methods

stopPropagation()

stopPropagation(): void

Stop this event from continuing to the next event handler. This does not prevent any default behaviors from occurring

Returns

void

Inherited from

DashboardItemScriptEvent.stopPropagation

ScriptEvent

Extended by

Properties

Property Type Default value
data any undefined

Accessors

isPropagationStopped
Get Signature

get isPropagationStopped(): boolean

Returns

boolean

Methods

stopPropagation()

stopPropagation(): void

Stop this event from continuing to the next event handler. This does not prevent any default behaviors from occurring

Returns

void

SPCDataChartBeforeDrawScriptEvent

Extends

Properties

Property Modifier Type Description Inherited from
data public SPCDataChartBeforeDrawEventData Detail and data objects for the data chart that is about to be drawn DataChartBeforeDrawScriptEvent.data

Accessors

isPropagationStopped
Get Signature

get isPropagationStopped(): boolean

Returns

boolean

Inherited from

DataChartBeforeDrawScriptEvent.isPropagationStopped

Methods

stopPropagation()

stopPropagation(): void

Stop this event from continuing to the next event handler. This does not prevent any default behaviors from occurring

Returns

void

Inherited from

DataChartBeforeDrawScriptEvent.stopPropagation

StatsGridBeforeDrawScriptEvent

Extends

Properties

Property Modifier Type Description Inherited from
data public StatsGridBeforeDrawEventData Stats and data for the Stats Grid which about to be drawn ChartBeforeDrawScriptEvent.data

Accessors

isPropagationStopped
Get Signature

get isPropagationStopped(): boolean

Returns

boolean

Inherited from

ChartBeforeDrawScriptEvent.isPropagationStopped

Methods

stopPropagation()

stopPropagation(): void

Stop this event from continuing to the next event handler. This does not prevent any default behaviors from occurring

Returns

void

Inherited from

ChartBeforeDrawScriptEvent.stopPropagation

TaskDataChartBeforeDrawScriptEvent

Extends

Properties

Property Modifier Type Description Inherited from
data public TaskDataChartBeforeDrawEventData Detail and data objects for the data chart that is about to be drawn DataChartBeforeDrawScriptEvent.data

Accessors

isPropagationStopped
Get Signature

get isPropagationStopped(): boolean

Returns

boolean

Inherited from

DataChartBeforeDrawScriptEvent.isPropagationStopped

Methods

stopPropagation()

stopPropagation(): void

Stop this event from continuing to the next event handler. This does not prevent any default behaviors from occurring

Returns

void

Inherited from

DataChartBeforeDrawScriptEvent.stopPropagation

Interfaces

Annotations

Extends

Properties

Property Type Description Inherited from
align "left" | "center" | "right" Sets the horizontal alignment of the text within the box. Has an effect only if text spans more 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.		 -
arrowcolor string Sets the color of the annotation arrow. -
arrowhead number Sets the end annotation arrow head style. -
arrowside "end" | "start" Sets the annotation arrow head position. -
arrowsize number Sets the size of the end annotation arrow head, relative to arrowwidth. A value of 1 (default) gives a head about 3x as wide as the line. -
arrowwidth number Sets the width (in px) of annotation arrow line. -
ax number Sets the x component of the arrow tail about the arrow head. If axref is pixel, a positive (negative) component corresponds to an arrow pointing from right to left (left to right). If axref is an axis, this is an absolute value on that axis, like x, NOT a relative value. -
axref "x" | "x2" | "x3" | "x4" | "x5" | "x6" | "x7" | "x8" | "x9" | "x10" | "x11" | "x12" | "x13" | "x14" | "x15" | "x16" | "x17" | "x30" | "x33" | "x38" | "x31" | "x34" | "x32" | "x37" | "x36" | "x35" | "x39" | "x80" | "x83" | "x88" | "x81" | "x84" | "x82" | "x87" | "x86" | "x85" | "x89" | "x18" | "x19" | "x40" | "x43" | "x48" | "x41" | "x44" | "x42" | "x47" | "x46" | "x45" | "x49" | "x20" | "x23" | "x28" | "x21" | "x24" | "x22" | "x27" | "x26" | "x25" | "x29" | "x70" | "x73" | "x78" | "x71" | "x74" | "x72" | "x77" | "x76" | "x75" | "x79" | "x60" | "x63" | "x68" | "x61" | "x64" | "x62" | "x67" | "x66" | "x65" | "x69" | "x50" | "x53" | "x58" | "x51" | "x54" | "x52" | "x57" | "x56" | "x55" | "x59" | "x90" | "x93" | "x98" | "x91" | "x94" | "x92" | "x97" | "x96" | "x95" | "x99" | "x domain" | "x2 domain" | "x3 domain" | "x4 domain" | "x5 domain" | "x6 domain" | "x7 domain" | "x8 domain" | "x9 domain" | "x10 domain" | "x11 domain" | "x12 domain" | "x13 domain" | "x14 domain" | "x15 domain" | "x16 domain" | "x17 domain" | "x30 domain" | "x33 domain" | "x38 domain" | "x31 domain" | "x34 domain" | "x32 domain" | "x37 domain" | "x36 domain" | "x35 domain" | "x39 domain" | "x80 domain" | "x83 domain" | "x88 domain" | "x81 domain" | "x84 domain" | "x82 domain" | "x87 domain" | "x86 domain" | "x85 domain" | "x89 domain" | "x18 domain" | "x19 domain" | "x40 domain" | "x43 domain" | "x48 domain" | "x41 domain" | "x44 domain" | "x42 domain" | "x47 domain" | "x46 domain" | "x45 domain" | "x49 domain" | "x20 domain" | "x23 domain" | "x28 domain" | "x21 domain" | "x24 domain" | "x22 domain" | "x27 domain" | "x26 domain" | "x25 domain" | "x29 domain" | "x70 domain" | "x73 domain" | "x78 domain" | "x71 domain" | "x74 domain" | "x72 domain" | "x77 domain" | "x76 domain" | "x75 domain" | "x79 domain" | "x60 domain" | "x63 domain" | "x68 domain" | "x61 domain" | "x64 domain" | "x62 domain" | "x67 domain" | "x66 domain" | "x65 domain" | "x69 domain" | "x50 domain" | "x53 domain" | "x58 domain" | "x51 domain" | "x54 domain" | "x52 domain" | "x57 domain" | "x56 domain" | "x55 domain" | "x59 domain" | "x90 domain" | "x93 domain" | "x98 domain" | "x91 domain" | "x94 domain" | "x92 domain" | "x97 domain" | "x96 domain" | "x95 domain" | "x99 domain" | "pixel" Indicates in what terms the tail of the annotation (ax,ay) is specified. If pixel, ax is a relative offset in pixels from x. If set to an x axis id (e.g. x or x2), ax is specified in the same terms as that axis. This is useful for trendline annotations which should continue to indicate the correct trend when zoomed. -
ay number Sets the y component of the arrow tail about the arrow head. If ayref is pixel, a positive (negative) component corresponds to an arrow pointing from bottom to top (top to bottom). If ayref is an axis, this is an absolute value on that axis, like y, NOT a relative value. -
ayref "y" | "y2" | "y3" | "y4" | "y5" | "y6" | "y7" | "y8" | "y9" | "y10" | "y11" | "y12" | "y13" | "y14" | "y15" | "y16" | "y17" | "y30" | "y33" | "y38" | "y31" | "y34" | "y32" | "y37" | "y36" | "y35" | "y39" | "y80" | "y83" | "y88" | "y81" | "y84" | "y82" | "y87" | "y86" | "y85" | "y89" | "y18" | "y19" | "y40" | "y43" | "y48" | "y41" | "y44" | "y42" | "y47" | "y46" | "y45" | "y49" | "y20" | "y23" | "y28" | "y21" | "y24" | "y22" | "y27" | "y26" | "y25" | "y29" | "y70" | "y73" | "y78" | "y71" | "y74" | "y72" | "y77" | "y76" | "y75" | "y79" | "y60" | "y63" | "y68" | "y61" | "y64" | "y62" | "y67" | "y66" | "y65" | "y69" | "y50" | "y53" | "y58" | "y51" | "y54" | "y52" | "y57" | "y56" | "y55" | "y59" | "y90" | "y93" | "y98" | "y91" | "y94" | "y92" | "y97" | "y96" | "y95" | "y99" | "y domain" | "y2 domain" | "y3 domain" | "y4 domain" | "y5 domain" | "y6 domain" | "y7 domain" | "y8 domain" | "y9 domain" | "y10 domain" | "y11 domain" | "y12 domain" | "y13 domain" | "y14 domain" | "y15 domain" | "y16 domain" | "y17 domain" | "y30 domain" | "y33 domain" | "y38 domain" | "y31 domain" | "y34 domain" | "y32 domain" | "y37 domain" | "y36 domain" | "y35 domain" | "y39 domain" | "y80 domain" | "y83 domain" | "y88 domain" | "y81 domain" | "y84 domain" | "y82 domain" | "y87 domain" | "y86 domain" | "y85 domain" | "y89 domain" | "y18 domain" | "y19 domain" | "y40 domain" | "y43 domain" | "y48 domain" | "y41 domain" | "y44 domain" | "y42 domain" | "y47 domain" | "y46 domain" | "y45 domain" | "y49 domain" | "y20 domain" | "y23 domain" | "y28 domain" | "y21 domain" | "y24 domain" | "y22 domain" | "y27 domain" | "y26 domain" | "y25 domain" | "y29 domain" | "y70 domain" | "y73 domain" | "y78 domain" | "y71 domain" | "y74 domain" | "y72 domain" | "y77 domain" | "y76 domain" | "y75 domain" | "y79 domain" | "y60 domain" | "y63 domain" | "y68 domain" | "y61 domain" | "y64 domain" | "y62 domain" | "y67 domain" | "y66 domain" | "y65 domain" | "y69 domain" | "y50 domain" | "y53 domain" | "y58 domain" | "y51 domain" | "y54 domain" | "y52 domain" | "y57 domain" | "y56 domain" | "y55 domain" | "y59 domain" | "y90 domain" | "y93 domain" | "y98 domain" | "y91 domain" | "y94 domain" | "y92 domain" | "y97 domain" | "y96 domain" | "y95 domain" | "y99 domain" | "pixel" Indicates in what terms the tail of the annotation (ax,ay) is specified. If pixel, ay is a relative offset in pixels from y. If set to a y axis id (e.g. y or y2), ay is specified in the same terms as that axis. This is useful for trendline annotations which should continue to indicate the correct trend when zoomed. -
bgcolor string Sets the background color of all hover labels on graph. Label.bgcolor
bordercolor string Sets the border color of all hover labels on graph. Label.bordercolor
borderpad number Sets the padding (in px) between the text and the enclosing border. -
borderwidth number Sets the width (in px) of the border enclosing the annotation text. -
captureevents boolean Determines whether the annotation text box captures mouse move and click events, or allows those events to pass through to data points in the plot that may be behind the annotation. By default captureevents is false unless hovertext is provided. If you use the event plotly_clickannotation without hovertext you must explicitly enable captureevents. -
clicktoshow false | "onoff" | "onout" Makes this annotation respond to clicks on the plot. If you click a data point that exactly matches the x and y values of this annotation, and it is hidden (visible: false), it will appear. In onoff mode, you must click the same point again to make it disappear, so if you click multiple points, you can show multiple annotations. In onout mode, a click anywhere else in the plot (on another data point or not) will hide this annotation. If you need to show/hide this annotation in response to different x or y values, you can set xclick and/or yclick. This is useful for example to label the side of a bar. To label markers though, standoff is preferred over xclick and yclick. -
font Partial<Font> Sets the default hover label font used by all traces on the graph. Label.font
height number Sets an explicit height for the text box. null (default) lets the text set the box height. Taller text will be clipped. -
hoverlabel Partial<HoverLabel> - -
hovertext string Sets text to appear when hovering over this annotation. If omitted or blank, no hover label will appear. -
opacity number Sets the opacity of the annotation (text + arrow). -
showarrow boolean Determines whether or not the annotation is drawn with an arrow. If true, text is placed near the arrow's tail. If false, text lines up with the x and y provided. -
standoff number Sets a distance, in pixels, to move the end arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom. Note that this shortens the arrow from the ax / ay vector, in contrast to xshift / yshift which moves everything by this amount. -
startarrowhead number Sets the start annotation arrow head style. -
startarrowsize number Sets the size of the start annotation arrow head, relative to arrowwidth. A value of 1 (default) gives a head about 3x as wide as the line. -
startstandoff number Sets a distance, in pixels, to move the start arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom. Note that this shortens the arrow from the ax / ay vector, in contrast to xshift / yshift which moves everything by this amount. -
text string Sets the text associated with this annotation. Plotly uses a subset of HTML tags to do things like newline (
), bold (), italics (), hyperlinks (). Tags , , are also supported.		 -
textangle string Sets the angle at which the text is drawn with respect to the horizontal. -
valign "top" | "middle" | "bottom" 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. -
visible boolean Determines whether or not this annotation is visible. -
width number Sets an explicit width for the text box. null (default) lets the text set the box width. Wider text will be clipped. There is no automatic wrapping; use
to start a new line.		 -
x string | number Sets the annotation's x position. If the axis type is log, then you must take the log of your desired range. If the axis type is date, it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis type is category, it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears. -
xanchor "auto" | "left" | "center" | "right" Sets the text box's horizontal position anchor This anchor binds the x position to the left, center or right of the annotation. For example, if x is set to 1, xref to paper and xanchor to right then the right-most portion of the annotation lines up with the right-most edge of the plotting area. If auto, the anchor is equivalent to center for data-referenced annotations or if there is an arrow, whereas for paper-referenced with no arrow, the anchor picked corresponds to the closest side. -
xclick any Toggle this annotation when clicking a data point whose x value is xclick rather than the annotation's x value. -
xref "x" | "paper" | "x2" | "x3" | "x4" | "x5" | "x6" | "x7" | "x8" | "x9" | "x10" | "x11" | "x12" | "x13" | "x14" | "x15" | "x16" | "x17" | "x30" | "x33" | "x38" | "x31" | "x34" | "x32" | "x37" | "x36" | "x35" | "x39" | "x80" | "x83" | "x88" | "x81" | "x84" | "x82" | "x87" | "x86" | "x85" | "x89" | "x18" | "x19" | "x40" | "x43" | "x48" | "x41" | "x44" | "x42" | "x47" | "x46" | "x45" | "x49" | "x20" | "x23" | "x28" | "x21" | "x24" | "x22" | "x27" | "x26" | "x25" | "x29" | "x70" | "x73" | "x78" | "x71" | "x74" | "x72" | "x77" | "x76" | "x75" | "x79" | "x60" | "x63" | "x68" | "x61" | "x64" | "x62" | "x67" | "x66" | "x65" | "x69" | "x50" | "x53" | "x58" | "x51" | "x54" | "x52" | "x57" | "x56" | "x55" | "x59" | "x90" | "x93" | "x98" | "x91" | "x94" | "x92" | "x97" | "x96" | "x95" | "x99" | "x domain" | "x2 domain" | "x3 domain" | "x4 domain" | "x5 domain" | "x6 domain" | "x7 domain" | "x8 domain" | "x9 domain" | "x10 domain" | "x11 domain" | "x12 domain" | "x13 domain" | "x14 domain" | "x15 domain" | "x16 domain" | "x17 domain" | "x30 domain" | "x33 domain" | "x38 domain" | "x31 domain" | "x34 domain" | "x32 domain" | "x37 domain" | "x36 domain" | "x35 domain" | "x39 domain" | "x80 domain" | "x83 domain" | "x88 domain" | "x81 domain" | "x84 domain" | "x82 domain" | "x87 domain" | "x86 domain" | "x85 domain" | "x89 domain" | "x18 domain" | "x19 domain" | "x40 domain" | "x43 domain" | "x48 domain" | "x41 domain" | "x44 domain" | "x42 domain" | "x47 domain" | "x46 domain" | "x45 domain" | "x49 domain" | "x20 domain" | "x23 domain" | "x28 domain" | "x21 domain" | "x24 domain" | "x22 domain" | "x27 domain" | "x26 domain" | "x25 domain" | "x29 domain" | "x70 domain" | "x73 domain" | "x78 domain" | "x71 domain" | "x74 domain" | "x72 domain" | "x77 domain" | "x76 domain" | "x75 domain" | "x79 domain" | "x60 domain" | "x63 domain" | "x68 domain" | "x61 domain" | "x64 domain" | "x62 domain" | "x67 domain" | "x66 domain" | "x65 domain" | "x69 domain" | "x50 domain" | "x53 domain" | "x58 domain" | "x51 domain" | "x54 domain" | "x52 domain" | "x57 domain" | "x56 domain" | "x55 domain" | "x59 domain" | "x90 domain" | "x93 domain" | "x98 domain" | "x91 domain" | "x94 domain" | "x92 domain" | "x97 domain" | "x96 domain" | "x95 domain" | "x99 domain" Sets the annotation's x coordinate axis. If set to an x axis id (e.g. x or x2), the x position refers to an x coordinate If set to paper, the x position refers to the distance from the left side of the plotting area in normalized coordinates where 0 (1) corresponds to the left (right) side. -
xshift number Shifts the position of the whole annotation and arrow to the right (positive) or left (negative) by this many pixels. -
y string | number Sets the annotation's y position. If the axis type is log, then you must take the log of your desired range. If the axis type is date, it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis type is category, it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears. -
yanchor "auto" | "top" | "middle" | "bottom" Sets the text box's vertical position anchor This anchor binds the y position to the top, middle or bottom of the annotation. For example, if y is set to 1, yref to paper and yanchor to top then the top-most portion of the annotation lines up with the top-most edge of the plotting area. If auto, the anchor is equivalent to middle for data-referenced annotations or if there is an arrow, whereas for paper-referenced with no arrow, the anchor picked corresponds to the closest side. -
yclick any Toggle this annotation when clicking a data point whose y value is yclick rather than the annotation's y value. -
yref "y" | "paper" | "y2" | "y3" | "y4" | "y5" | "y6" | "y7" | "y8" | "y9" | "y10" | "y11" | "y12" | "y13" | "y14" | "y15" | "y16" | "y17" | "y30" | "y33" | "y38" | "y31" | "y34" | "y32" | "y37" | "y36" | "y35" | "y39" | "y80" | "y83" | "y88" | "y81" | "y84" | "y82" | "y87" | "y86" | "y85" | "y89" | "y18" | "y19" | "y40" | "y43" | "y48" | "y41" | "y44" | "y42" | "y47" | "y46" | "y45" | "y49" | "y20" | "y23" | "y28" | "y21" | "y24" | "y22" | "y27" | "y26" | "y25" | "y29" | "y70" | "y73" | "y78" | "y71" | "y74" | "y72" | "y77" | "y76" | "y75" | "y79" | "y60" | "y63" | "y68" | "y61" | "y64" | "y62" | "y67" | "y66" | "y65" | "y69" | "y50" | "y53" | "y58" | "y51" | "y54" | "y52" | "y57" | "y56" | "y55" | "y59" | "y90" | "y93" | "y98" | "y91" | "y94" | "y92" | "y97" | "y96" | "y95" | "y99" | "y domain" | "y2 domain" | "y3 domain" | "y4 domain" | "y5 domain" | "y6 domain" | "y7 domain" | "y8 domain" | "y9 domain" | "y10 domain" | "y11 domain" | "y12 domain" | "y13 domain" | "y14 domain" | "y15 domain" | "y16 domain" | "y17 domain" | "y30 domain" | "y33 domain" | "y38 domain" | "y31 domain" | "y34 domain" | "y32 domain" | "y37 domain" | "y36 domain" | "y35 domain" | "y39 domain" | "y80 domain" | "y83 domain" | "y88 domain" | "y81 domain" | "y84 domain" | "y82 domain" | "y87 domain" | "y86 domain" | "y85 domain" | "y89 domain" | "y18 domain" | "y19 domain" | "y40 domain" | "y43 domain" | "y48 domain" | "y41 domain" | "y44 domain" | "y42 domain" | "y47 domain" | "y46 domain" | "y45 domain" | "y49 domain" | "y20 domain" | "y23 domain" | "y28 domain" | "y21 domain" | "y24 domain" | "y22 domain" | "y27 domain" | "y26 domain" | "y25 domain" | "y29 domain" | "y70 domain" | "y73 domain" | "y78 domain" | "y71 domain" | "y74 domain" | "y72 domain" | "y77 domain" | "y76 domain" | "y75 domain" | "y79 domain" | "y60 domain" | "y63 domain" | "y68 domain" | "y61 domain" | "y64 domain" | "y62 domain" | "y67 domain" | "y66 domain" | "y65 domain" | "y69 domain" | "y50 domain" | "y53 domain" | "y58 domain" | "y51 domain" | "y54 domain" | "y52 domain" | "y57 domain" | "y56 domain" | "y55 domain" | "y59 domain" | "y90 domain" | "y93 domain" | "y98 domain" | "y91 domain" | "y94 domain" | "y92 domain" | "y97 domain" | "y96 domain" | "y95 domain" | "y99 domain" Sets the annotation's y coordinate axis. If set to an y axis id (e.g. y or y2), the y position refers to an 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). -
yshift number Shifts the position of the whole annotation and arrow up (positive) or down (negative) by this many pixels. -

AutoRangeOptions

Properties

Property Type
clipmax DTickValue
clipmin DTickValue
include DTickValue
maxallowed DTickValue
minallowed DTickValue

Axis

Extended by

Properties

Property Type Description
autorange boolean | "min" | "max" | "reversed" | "min reversed" | "max reversed" -
autorangeoptions Partial<AutoRangeOptions> -
autotypenumbers "convert types" | "strict" -
calendar Calendar -
categoryarray any[] -
categoryorder "trace" | "array" | "category ascending" | "category descending" | "total ascending" | "total descending" | "min ascending" | "min descending" | "max ascending" | "max descending" | "sum ascending" | "sum descending" | "mean ascending" | "mean descending" | "median ascending" | "median descending" 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.
color Color Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.
dividercolor Color Sets the color of the dividers Only has an effect on multicategory axes.
dividerwidth number Sets the width (in px) of the dividers Only has an effect on multicategory axes.
dtick DTickValue -
exponentformat "none" | "e" | "E" | "power" | "SI" | "B" 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.
fixedrange boolean Determines whether or not this axis is zoom-able. If true, then zoom is disabled.
gridcolor Color Sets the color of the grid lines.
gridwidth number Sets the width (in px) of the grid lines.
hoverformat string Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: %{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 "091523.46"
labelalias DTickValue -
linecolor Color Sets the axis line color
linewidth number Sets the width (in px) of the axis line.
maxallowed DTickValue -
minallowed DTickValue -
minexponent number Hide SI prefix for 10^n if
mirror boolean | "all" | "ticks" | "allticks" -
nticks number -
range any[] -
rangemode "normal" | "tozero" | "nonnegative" '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.
separatethousands boolean 'If true, even 4-digit integers are separated
showdividers boolean Determines whether or not a dividers are drawn between the category levels of this axis. Only has an effect on multicategory axes.
showexponent "all" | "none" | "first" | "last" 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.
showgrid boolean Determines whether or not grid lines are drawn. If true, the grid lines are drawn at every tick mark.
showline boolean Determines whether or not a line bounding this axis is drawn.
showspikes boolean -
showticklabels boolean -
showtickprefix "all" | "none" | "first" | "last" 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 "all" | "none" | "first" | "last" Same as showtickprefix but for tick suffixes.
spikecolor Color -
spikedash string -
spikemode "marker" | "toaxis" | "across" | "toaxis+across" | "toaxis+across+marker" | "across+marker" | "toaxis+marker" Determines the drawing mode for the spike line. If toaxis, the line is drawn from the data point to the axis the series is plotted on. If across, the line is drawn across the entire plot area, and supercedes toaxis. If marker, then a marker dot is drawn on the axis the series is plotted on
spikesnap "data" | "cursor" | "hovered data" Determines whether spikelines are stuck to the cursor or to the closest datapoints.
spikethickness number -
tick0 string | number -
tickangle number | "auto" -
tickcolor Color -
tickfont Partial<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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: %{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 Partial<TickFormatStop>[] Array of Partial<TickFormatStop> objects.
ticklen number -
tickmode "auto" | "linear" | "array" | "sync" Ticks
tickprefix string -
ticks "" | "inside" | "outside" -
ticksuffix string Sets a tick label suffix.
ticktext string[] -
tickvals any[] -
tickwidth number -
title Partial<DataTitle> -
type AxisType -
visible boolean A single toggle to hide the axis while preserving interaction like dragging. Default is true when a cheater plot is present on the axis, otherwise false
zeroline boolean 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.
zerolinewidth number Sets the width (in px) of the zero line.

BoxPlotData

Extends

Properties

Property Type Overrides Inherited from
alignmentgroup string - -
autobinx boolean - PlotData.autobinx
autocontour boolean - PlotData.autocontour
automargin boolean - PlotData.automargin
boxmean boolean | "sd" - PlotData.boxmean
boxpoints false | "all" | "outliers" | "suspectedoutliers" PlotData.boxpoints -
branchvalues "total" | "remainder" - PlotData.branchvalues
cliponaxis boolean - PlotData.cliponaxis
colorbar Partial<ColorBar> - PlotData.colorbar
colorscale ColorScale - PlotData.colorscale
connectgaps boolean - PlotData.connectgaps
constraintext "none" | "inside" | "outside" | "both" - PlotData.constraintext
contours Partial<{ coloring: "fill" | "heatmap" | "lines" | "none"; end: number; labelfont: Partial<Font>; labelformat: string; operation: "=" | "<" | ">=" | ">" | "<=" | "[]" | "()" | "[)" | "(]" | "][" | ")(" | "](" | ")["; showlabels: boolean; showlines: boolean; size: number; start: number; type: "levels" | "constraint"; value: number | [number, number]; }> - PlotData.contours
customdata Datum[] | Datum[][] - PlotData.customdata
delta Partial<Delta> - PlotData.delta
direction "clockwise" | "counterclockwise" - PlotData.direction
domain Partial<{ column: number; row: number; x: number[]; y: number[]; }> - PlotData.domain
error_x ErrorBar - PlotData.error_x
error_y ErrorBar - PlotData.error_y
fill "none" | "tozeroy" | "tozerox" | "tonexty" | "tonextx" | "toself" | "tonext" - PlotData.fill
fillcolor string - PlotData.fillcolor
fillpattern Partial<Pattern> - PlotData.fillpattern
gauge Partial<Gauge> - PlotData.gauge
groupnorm "" | "fraction" | "percent" - PlotData.groupnorm
histfunc "count" | "sum" | "avg" | "min" | "max" - PlotData.histfunc
histnorm "" | "probability" | "percent" | "density" | "probability density" - PlotData.histnorm
hole number - PlotData.hole
hoverinfo "all" | "text" | "none" | "x" | "name" | "y" | "skip" | "x+text" | "x+name" | "x+y" | "x+y+text" | "x+y+name" | "x+y+z" | "x+y+z+text" | "x+y+z+name" | "y+name" | "y+x" | "y+text" | "y+x+text" | "y+x+name" | "y+z" | "y+z+text" | "y+z+name" | "y+x+z" | "y+x+z+text" | "y+x+z+name" | "z" | "z+x" | "z+x+text" | "z+x+name" | "z+y+x" | "z+y+x+text" | "z+y+x+name" | "z+x+y" | "z+x+y+text" | "z+x+y+name" - PlotData.hoverinfo
hoverlabel Partial<HoverLabel> - PlotData.hoverlabel
hoveron "points" | "fills" - PlotData.hoveron
hoverongaps boolean - PlotData.hoverongaps
hovertemplate string | string[] - PlotData.hovertemplate
hovertext string | string[] - PlotData.hovertext
i TypedArray - PlotData.i
ids string[] - PlotData.ids
insidetextanchor "middle" | "end" | "start" - PlotData.insidetextanchor
j TypedArray - PlotData.j
jitter number PlotData.jitter -
k TypedArray - PlotData.k
labels Datum[] - PlotData.labels
lat Datum[] - PlotData.lat
legendgroup string - PlotData.legendgroup
legendgrouptitle object - PlotData.legendgrouptitle
legendgrouptitle.font? Partial<Font> - -
legendgrouptitle.text string - -
legendrank number - PlotData.legendrank
level string - PlotData.level
line Partial<ScatterLine> - PlotData.line
line.color Color - PlotData.line.color
line.dash Dash - PlotData.line.dash
line.shape "linear" | "spline" | "hv" | "vh" | "hvh" | "vhv" - PlotData.line.shape
line.simplify boolean - PlotData.line.simplify
line.smoothing number - PlotData.line.smoothing
line.width number - PlotData.line.width
locationmode "ISO-3" | "USA-states" | "country names" | "geojson-id" - PlotData.locationmode
locations Datum[] - PlotData.locations
lon Datum[] - PlotData.lon
marker Partial<BoxPlotMarker> PlotData.marker -
marker.color Color - PlotData.marker.color
marker.colorbar object - PlotData.marker.colorbar
marker.colorscale ColorScale | ColorScale[] - PlotData.marker.colorscale
marker.line Partial<ScatterMarkerLine> - PlotData.marker.line
marker.line.color Color - PlotData.marker.line.color
marker.line.colorscale ColorScale | ColorScale[] - PlotData.marker.line.colorscale
marker.maxdisplayed number - PlotData.marker.maxdisplayed
marker.opacity number | number[] - PlotData.marker.opacity
marker.pad.b number - PlotData.marker.pad.b
marker.pad.l number - PlotData.marker.pad.l
marker.pad.r number - PlotData.marker.pad.r
marker.pad.t number - PlotData.marker.pad.t
marker.showscale boolean - PlotData.marker.showscale
marker.size number | number[] | number[][] - PlotData.marker.size
marker.sizemax number - PlotData.marker.sizemax
marker.sizemin number - PlotData.marker.sizemin
marker.sizemode "area" | "diameter" - PlotData.marker.sizemode
marker.sizeref number - PlotData.marker.sizeref
marker.symbol MarkerSymbol | MarkerSymbol[] - PlotData.marker.symbol
maxdepth number - PlotData.maxdepth
mode "number" | "text" | "none" | "lines" | "markers" | "lines+markers" | "text+markers" | "text+lines" | "text+lines+markers" | "gauge" | "delta" | "number+delta" | "gauge+number" | "gauge+number+delta" | "gauge+delta" - PlotData.mode
name string - PlotData.name
ncontours number - PlotData.ncontours
number Partial<PlotNumber> - PlotData.number
offset number | number[] - PlotData.offset
offsetgroup string - -
opacity number - PlotData.opacity
orientation "v" | "h" - PlotData.orientation
parents string[] - PlotData.parents
pointpos number PlotData.pointpos -
quartilemethod "linear" | "exclusive" | "inclusive" - -
r Datum[] - PlotData.r
reversescale boolean - PlotData.reversescale
rotation number - PlotData.rotation
selected ScatterSelectedMarker - -
selectedpoints Datum[] - PlotData.selectedpoints
showlegend boolean - PlotData.showlegend
showscale boolean - PlotData.showscale
stackgaps "infer zero" | "interpolate" - PlotData.stackgaps
stackgroup string - PlotData.stackgroup
text string | string[] - PlotData.text
textangle number | "auto" - PlotData.textangle
textfont Partial<Font> - PlotData.textfont
textinfo "text" | "none" | "label" | "value" | "percent" | "label+text" | "label+value" | "label+percent" | "label+text+value" | "label+text+percent" | "label+value+percent" | "text+value" | "text+percent" | "text+value+percent" | "value+percent" - PlotData.textinfo
textposition "none" | "auto" | "top left" | "top center" | "top right" | "middle left" | "middle center" | "middle right" | "bottom left" | "bottom center" | "bottom right" | "inside" | "outside" - PlotData.textposition
texttemplate string | string[] - PlotData.texttemplate
theta Datum[] - PlotData.theta
title Partial<DataTitle> - PlotData.title
transpose boolean - PlotData.transpose
type "box" PlotData.type -
uid string - PlotData.uid
uirevision string | number - PlotData.uirevision
unselected ScatterSelectedMarker - -
value number - PlotData.value
values Datum[] - PlotData.values
visible boolean | "legendonly" - PlotData.visible
width number PlotData.width -
x Datum[] | Datum[][] | TypedArray - PlotData.x
x0 any - -
xaxis string - PlotData.xaxis
xbins object - PlotData.xbins
xbins.end string | number - -
xbins.size string | number - -
xbins.start string | number - -
xgap number - PlotData.xgap
xhoverformat string - PlotData.xhoverformat
xy Float32Array - PlotData.xy
y Datum[] | Datum[][] | TypedArray - PlotData.y
y0 any - -
yaxis string - PlotData.yaxis
ygap number - PlotData.ygap
yhoverformat string - PlotData.yhoverformat
z Datum[] | Datum[][] | TypedArray | Datum[][][] - PlotData.z
zhoverformat string - PlotData.zhoverformat
zmax number - PlotData.zmax
zmin number - PlotData.zmin
zsmooth false | "fast" | "best" - PlotData.zsmooth

BoxPlotMarker

Properties

Property Type
color Color
line Partial<{ color: Color; outliercolor: Color; outlierwidth: number; width: number; }>
opacity number
outliercolor Color
size number
symbol MarkerSymbol

Camera

Properties

Property Type
center Partial<Point>
eye Partial<Point>
up Partial<Point>

CandlestickData

Properties

Property Type Description
close number[] -
decreasing object -
decreasing.line? object -
decreasing.line.color? string -
decreasing.line.width? number -
high number[] -
hoverinfo HoverInfo Default "all"
hoverlabel object -
hoverlabel.align? "auto" | "left" | "right" -
hoverlabel.bgcolor? string | string[] -
hoverlabel.bordercolor? string | string[] -
hoverlabel.font? object -
hoverlabel.font.color? string | string[] -
hoverlabel.font.family? string | string[] -
hoverlabel.font.size? number -
hoverlabel.namelength? number | number[] -
hoverlabel.split? boolean -
hovertext string | string[] Default ""
ids string[] -
increasing object -
increasing.line? object -
increasing.line.color? string -
increasing.line.width? number -
line object Default width=2
line.width? number -
low number[] -
meta any -
name string -
opacity number number between 0 and 1 Default 1
open number[] -
showlegend boolean Default true
text string | string[] Default ""
type "candlestick" -
visible boolean | "legendonly" Default true
whiskerwidth number Number between 0 and 1. Selects the width of the whiskers relative to the box´s width. For example, with 1, the whiskers are as wide as the box(es). Default 0
x string[] -
xaxis string Default "x"
xperiod any Default 0
xperiod0 any -
xperiodalignment "middle" | "end" | "start" Default "middle"

ColorBar

Properties

Property Type Description
bgcolor Color Sets the color of padded area. Default "rgba(0,0,0,0)"
bordercolor Color Sets the color of the border enclosing this color bar.
borderwidth number Sets the width (in px) of the border enclosing this color bar. Default 0
dtick DTickValue Sets the step between ticks.
exponentformat "none" | "e" | "E" | "power" | "SI" | "B" Sets the format for exponents.
labelalias DTickValue Allows specifying an alias for tick labels.
len number 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. Default 1
lenmode "fraction" | "pixels" 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. Default "fraction"
minexponent number Sets the minimum exponent for which to use exponent notation.
nticks number Sets the number of ticks.
orientation "v" | "h" Sets the orientation of the colorbar. Default "v"
outlinecolor Color Sets the color of the outline around the color bar.
outlinewidth number Sets the width (in px) of the outline around the color bar. Default 1
separatethousands boolean Determines whether thousands are separated.
showexponent "all" | "none" | "first" | "last" Determines which tick labels show the exponent.
showticklabels boolean Determines whether tick labels are shown.
showtickprefix "all" | "none" | "first" | "last" Determines which tick labels show the prefix.
showticksuffix "all" | "none" | "first" | "last" Determines which tick labels show the suffix.
thickness number Sets the thickness of the color bar. This measure excludes the size of the padding, ticks, and labels. Default 30
thicknessmode "fraction" | "pixels" 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. Default "pixels"
tick0 string | number Sets the starting tick.
tickangle number | "auto" Sets the angle of the tick labels.
tickcolor Color Sets the color of the ticks.
tickfont Partial<Font> Sets the color bar"s tick label font.
tickformat string Sets the format for tick labels.
tickformatstops Partial<TickFormatStop>[] Sets the format stops for tick labels.
ticklabeloverflow "allow" | "hide past div" | "hide past domain" 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 "inside" | "outside" | "outside top" | "inside top" | "outside left" | "inside left" | "outside right" | "inside right" | "outside bottom" | "inside bottom" Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v. Default "outside"
ticklabelstep number Sets the step between tick labels.
ticklen number Sets the length of the ticks.
tickmode "auto" | "linear" | "array" Determines the tick mode for the color bar.
tickprefix string Sets the prefix for tick labels.
ticks "" | "inside" | "outside" Determines whether ticks are drawn. Default ""
ticksuffix string Sets the suffix for tick labels.
ticktext Datum[] | Datum[][] | TypedArray | Datum[][][] Sets the text displayed at the ticks.
tickvals Datum[] | Datum[][] | TypedArray | Datum[][][] Sets the values at which ticks should appear.
tickwidth number Sets the width of the ticks.
title Partial<ColorBarTitle> Configuration for the color bar title.
x number Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.
xanchor "left" | "center" | "right" Sets this color bar"s horizontal position anchor. This anchor binds the x position to the left, center, or right of the color bar. Defaults to left when orientation is v and center when orientation is h.
xpad number Sets the amount of padding (in px) along the x direction. Default 10
xref "container" | "paper" Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only. Default "paper"
y number Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.
yanchor "top" | "middle" | "bottom" Sets this color bar"s vertical position anchor. This anchor binds the y position to the top, middle, or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.
ypad number Sets the amount of padding (in px) along the y direction. Default 10
yref "container" | "paper" Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only. Default "paper"

ColorBarTitle

Properties

Property Type Description
font Partial<Font> Sets this color bar"s title font.
side "right" | "top" | "bottom" Determines the location of color bar"s title with respect to the color bar. Defaults to top when orientation is v and defaults to right when orientation is h.
text string Sets the title of the color bar.

CurrentValue

Properties

Property Type Description
font Partial<Font> Sets the font of the current value label text.
offset number The amount of space, in pixels, between the current value label and the slider.
prefix string When currentvalue.visible is true, this sets the prefix of the label.
suffix string When currentvalue.visible is true, this sets the suffix of the label.
visible boolean Shows the currently-selected value above the slider.
xanchor "left" | "center" | "right" The alignment of the value readout relative to the length of the slider.

DataTitle

Properties

Property Type
font Partial<Font>
position "top left" | "top center" | "top right" | "middle center" | "bottom left" | "bottom center" | "bottom right"
standoff number
text string

Delta

Properties

Property Type
decreasing object
decreasing.color Color
decreasing.symbol string
increasing object
increasing.color Color
increasing.symbol string
position "left" | "right" | "top" | "bottom"
reference number
relative boolean
valueformat string

Domain

Properties

Property Type
column number
row number
x number[]
y number[]

ErrorOptions

Properties

Property Type
color Color
symmetric boolean
thickness number
visible boolean
width number

Font

Properties

Property Type Description
color Color -
family string HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include Arial, Balto, Courier New, Droid Sans, Droid Serif, Droid Sans Mono, Gravitas One, Old Standard TT, Open Sans, Overpass, PT Sans Narrow, Raleway, Times New Roman. Default "Arial, sans-serif"
lineposition "none" | "under" | "over" | "through" | "under+over" | "over+under" | "over+through" | "through+over" | "through+under" | "under+through" | "under+over+through" | "under+through+over" | "over+under+through" | "over+through+under" | "through+under+over" | "through+over+under" Sets the kind of decoration line(s) with text, such as an "under", "over" or "through" as well as combinations e.g. "under+over". Default "none"
shadow string Sets the shape and color of the shadow behind text. "auto" places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options. Default "none"
size number number greater than or equal to 1 Default 13
style "normal" | "italic" Sets whether a font should be styled with a normal or italic face from its family. Default "normal"
textcase "normal" | "upper" | "lower" | "word caps" Sets capitalization of text. Can be used to make text appear in all-uppercase, all-lowercase, or with each word capitalized. Default "normal"
variant "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase" Sets the variant of the font. Default "normal"
weight number | "normal" | "bold" Sets the weight (or boldness) of the font. number between or equal to 1 and 1000 Default "normal"

Gauge

Properties

Property Type
axis Partial<Axis>
bar Partial<GaugeBar>
bgcolor Color
bordercolor Color
borderwidth number
shape "angular" | "bullet"
steps object[]
threshold Partial<Threshold>

GaugeBar

Properties

Property Type
color Color
line Partial<GaugeLine>
thickness number

GaugeLine

Properties

Property Type
color Color
width number

HoverLabel

Extends

Properties

Property Type Description Inherited from
align "auto" | "left" | "right" Sets the horizontal alignment of the text content within hover label box. Default "auto" -
bgcolor string Sets the background color of all hover labels on graph. Label.bgcolor
bordercolor string Sets the border color of all hover labels on graph. Label.bordercolor
font Partial<Font> Sets the default hover label font used by all traces on the graph. Label.font
namelength number Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. Default 15 -

Image

Properties

Property Type
layer "below" | "above"
opacity number
sizex number
sizey number
sizing "fill" | "contain" | "stretch"
source string
visible boolean
x string | number
xanchor "left" | "center" | "right"
xref "x" | "paper" | "x2" | "x3" | "x4" | "x5" | "x6" | "x7" | "x8" | "x9" | "x10" | "x11" | "x12" | "x13" | "x14" | "x15" | "x16" | "x17" | "x30" | "x33" | "x38" | "x31" | "x34" | "x32" | "x37" | "x36" | "x35" | "x39" | "x80" | "x83" | "x88" | "x81" | "x84" | "x82" | "x87" | "x86" | "x85" | "x89" | "x18" | "x19" | "x40" | "x43" | "x48" | "x41" | "x44" | "x42" | "x47" | "x46" | "x45" | "x49" | "x20" | "x23" | "x28" | "x21" | "x24" | "x22" | "x27" | "x26" | "x25" | "x29" | "x70" | "x73" | "x78" | "x71" | "x74" | "x72" | "x77" | "x76" | "x75" | "x79" | "x60" | "x63" | "x68" | "x61" | "x64" | "x62" | "x67" | "x66" | "x65" | "x69" | "x50" | "x53" | "x58" | "x51" | "x54" | "x52" | "x57" | "x56" | "x55" | "x59" | "x90" | "x93" | "x98" | "x91" | "x94" | "x92" | "x97" | "x96" | "x95" | "x99" | "x domain" | "x2 domain" | "x3 domain" | "x4 domain" | "x5 domain" | "x6 domain" | "x7 domain" | "x8 domain" | "x9 domain" | "x10 domain" | "x11 domain" | "x12 domain" | "x13 domain" | "x14 domain" | "x15 domain" | "x16 domain" | "x17 domain" | "x30 domain" | "x33 domain" | "x38 domain" | "x31 domain" | "x34 domain" | "x32 domain" | "x37 domain" | "x36 domain" | "x35 domain" | "x39 domain" | "x80 domain" | "x83 domain" | "x88 domain" | "x81 domain" | "x84 domain" | "x82 domain" | "x87 domain" | "x86 domain" | "x85 domain" | "x89 domain" | "x18 domain" | "x19 domain" | "x40 domain" | "x43 domain" | "x48 domain" | "x41 domain" | "x44 domain" | "x42 domain" | "x47 domain" | "x46 domain" | "x45 domain" | "x49 domain" | "x20 domain" | "x23 domain" | "x28 domain" | "x21 domain" | "x24 domain" | "x22 domain" | "x27 domain" | "x26 domain" | "x25 domain" | "x29 domain" | "x70 domain" | "x73 domain" | "x78 domain" | "x71 domain" | "x74 domain" | "x72 domain" | "x77 domain" | "x76 domain" | "x75 domain" | "x79 domain" | "x60 domain" | "x63 domain" | "x68 domain" | "x61 domain" | "x64 domain" | "x62 domain" | "x67 domain" | "x66 domain" | "x65 domain" | "x69 domain" | "x50 domain" | "x53 domain" | "x58 domain" | "x51 domain" | "x54 domain" | "x52 domain" | "x57 domain" | "x56 domain" | "x55 domain" | "x59 domain" | "x90 domain" | "x93 domain" | "x98 domain" | "x91 domain" | "x94 domain" | "x92 domain" | "x97 domain" | "x96 domain" | "x95 domain" | "x99 domain"
y string | number
yanchor "top" | "middle" | "bottom"
yref "y" | "paper" | "y2" | "y3" | "y4" | "y5" | "y6" | "y7" | "y8" | "y9" | "y10" | "y11" | "y12" | "y13" | "y14" | "y15" | "y16" | "y17" | "y30" | "y33" | "y38" | "y31" | "y34" | "y32" | "y37" | "y36" | "y35" | "y39" | "y80" | "y83" | "y88" | "y81" | "y84" | "y82" | "y87" | "y86" | "y85" | "y89" | "y18" | "y19" | "y40" | "y43" | "y48" | "y41" | "y44" | "y42" | "y47" | "y46" | "y45" | "y49" | "y20" | "y23" | "y28" | "y21" | "y24" | "y22" | "y27" | "y26" | "y25" | "y29" | "y70" | "y73" | "y78" | "y71" | "y74" | "y72" | "y77" | "y76" | "y75" | "y79" | "y60" | "y63" | "y68" | "y61" | "y64" | "y62" | "y67" | "y66" | "y65" | "y69" | "y50" | "y53" | "y58" | "y51" | "y54" | "y52" | "y57" | "y56" | "y55" | "y59" | "y90" | "y93" | "y98" | "y91" | "y94" | "y92" | "y97" | "y96" | "y95" | "y99" | "y domain" | "y2 domain" | "y3 domain" | "y4 domain" | "y5 domain" | "y6 domain" | "y7 domain" | "y8 domain" | "y9 domain" | "y10 domain" | "y11 domain" | "y12 domain" | "y13 domain" | "y14 domain" | "y15 domain" | "y16 domain" | "y17 domain" | "y30 domain" | "y33 domain" | "y38 domain" | "y31 domain" | "y34 domain" | "y32 domain" | "y37 domain" | "y36 domain" | "y35 domain" | "y39 domain" | "y80 domain" | "y83 domain" | "y88 domain" | "y81 domain" | "y84 domain" | "y82 domain" | "y87 domain" | "y86 domain" | "y85 domain" | "y89 domain" | "y18 domain" | "y19 domain" | "y40 domain" | "y43 domain" | "y48 domain" | "y41 domain" | "y44 domain" | "y42 domain" | "y47 domain" | "y46 domain" | "y45 domain" | "y49 domain" | "y20 domain" | "y23 domain" | "y28 domain" | "y21 domain" | "y24 domain" | "y22 domain" | "y27 domain" | "y26 domain" | "y25 domain" | "y29 domain" | "y70 domain" | "y73 domain" | "y78 domain" | "y71 domain" | "y74 domain" | "y72 domain" | "y77 domain" | "y76 domain" | "y75 domain" | "y79 domain" | "y60 domain" | "y63 domain" | "y68 domain" | "y61 domain" | "y64 domain" | "y62 domain" | "y67 domain" | "y66 domain" | "y65 domain" | "y69 domain" | "y50 domain" | "y53 domain" | "y58 domain" | "y51 domain" | "y54 domain" | "y52 domain" | "y57 domain" | "y56 domain" | "y55 domain" | "y59 domain" | "y90 domain" | "y93 domain" | "y98 domain" | "y91 domain" | "y94 domain" | "y92 domain" | "y97 domain" | "y96 domain" | "y95 domain" | "y99 domain"

Label

Extended by

Properties

Property Type Description
bgcolor string Sets the background color of all hover labels on graph.
bordercolor string Sets the border color of all hover labels on graph.
font Partial<Font> Sets the default hover label font used by all traces on the graph.

Layout

Properties

Property Type Description
angularaxis object -
annotations Partial<Annotations>[] -
autosize boolean -
bargap number -
bargroupgap number -
barmode "overlay" | "relative" | "group" | "stack" -
barnorm "" | "fraction" | "percent" -
boxmode "overlay" | "group" -
calendar Calendar -
clickmode "none" | "select" | "event" | "event+select" -
colorway string[] -
datarevision string | number -
dragmode false | "select" | "zoom" | "pan" | "lasso" | "drawclosedpath" | "drawopenpath" | "drawline" | "drawrect" | "drawcircle" | "orbit" | "turntable" -
editrevision string | number -
font Partial<Font> -
geo object -
grid Partial<{ columns: number; domain: Partial<{ x: number[]; y: number[]; }>; pattern: "independent" | "coupled"; roworder: "top to bottom" | "bottom to top"; rows: number; subplots: string[]; xaxes: string[]; xgap: number; xside: "bottom" | "bottom plot" | "top plot" | "top"; yaxes: string[]; ygap: number; yside: "left" | "left plot" | "right plot" | "right"; }> -
height number -
hiddenlabels string[] -
hidesources boolean -
hoverdistance number -
hoverlabel Partial<HoverLabel> -
hovermode false | "x" | "y" | "closest" | "x unified" | "y unified" -
hoversubplots "overlaying" | "single" | "axis" Determines expansion of hover effects to other subplots. If "single" just the axis pair of the primary point is included without overlaying subplots. If "overlaying" all subplots using the main axis and occupying the same space are included. If "axis", also include stacked subplots using the same axis when hovermode is set to "x", "x unified", "y" or "y unified". Default "overlaying"
images Partial<Image>[] -
legend Partial<Legend> -
map Partial<Mapbox> -
mapbox Partial<Mapbox> -
margin Partial<Margin> -
modebar Partial<ModeBar> -
orientation number -
paper_bgcolor Color -
plot_bgcolor Color -
polar Partial<PolarLayout> -
polar2 Partial<PolarLayout> -
polar3 Partial<PolarLayout> -
polar4 Partial<PolarLayout> -
polar5 Partial<PolarLayout> -
polar6 Partial<PolarLayout> -
polar7 Partial<PolarLayout> -
polar8 Partial<PolarLayout> -
polar9 Partial<PolarLayout> -
radialaxis Partial<Axis> -
scene Partial<Scene> -
scene2 Partial<Scene> -
scene3 Partial<Scene> -
scene4 Partial<Scene> -
scene5 Partial<Scene> -
scene6 Partial<Scene> -
scene7 Partial<Scene> -
scene8 Partial<Scene> -
scene9 Partial<Scene> -
selectdirection "any" | "v" | "h" | "d" -
selectionrevision string | number -
separators string -
shapes Partial<Shape>[] -
showlegend boolean -
sliders Partial<Slider>[] -
subplot string -
template Template -
ternary object -
title Partial<{ font: Partial<Font>; pad: Partial<Padding>; subtitle: string | Partial<{ font: Partial<Font>; text: string; }>; text: string; x: number; xanchor: "auto" | "left" | "center" | "right"; xref: "container" | "paper"; y: number; yanchor: "auto" | "top" | "middle" | "bottom"; yref: "container" | "paper"; }> -
transition Transition -
uid string -
uirevision string | number -
updatemenus Partial<UpdateMenu>[] -
width number -
xaxis Partial<LayoutAxis> -
xaxis.autorange boolean -
xaxis.range [Datum, Datum] -
xaxis.range[0] Datum -
xaxis.range[1] Datum -
xaxis.title Partial<DataTitle> -
xaxis.type AxisType -
xaxis2 Partial<LayoutAxis> -
xaxis3 Partial<LayoutAxis> -
xaxis4 Partial<LayoutAxis> -
xaxis5 Partial<LayoutAxis> -
xaxis6 Partial<LayoutAxis> -
xaxis7 Partial<LayoutAxis> -
xaxis8 Partial<LayoutAxis> -
xaxis9 Partial<LayoutAxis> -
yaxis Partial<LayoutAxis> -
yaxis.autorange boolean -
yaxis.range [Datum, Datum] -
yaxis.range[0] Datum -
yaxis.range[1] Datum -
yaxis.title Partial<DataTitle> -
yaxis.type AxisType -
yaxis2 Partial<LayoutAxis> -
yaxis3 Partial<LayoutAxis> -
yaxis4 Partial<LayoutAxis> -
yaxis5 Partial<LayoutAxis> -
yaxis6 Partial<LayoutAxis> -
yaxis7 Partial<LayoutAxis> -
yaxis8 Partial<LayoutAxis> -
yaxis9 Partial<LayoutAxis> -

LayoutAxis

Extends

Properties

Property Type Description Overrides Inherited from
anchor AxisName | "free" - - -
angle any - - -
automargin boolean - - -
autorange boolean | "min" | "max" | "reversed" | "min reversed" | "max reversed" - - Axis.autorange
autorangeoptions Partial<AutoRangeOptions> - - Axis.autorangeoptions
autotickangles number[] - - -
autotypenumbers "convert types" | "strict" - - Axis.autotypenumbers
calendar Calendar - - Axis.calendar
categoryarray any[] - - Axis.categoryarray
categoryorder "trace" | "array" | "category ascending" | "category descending" | "total ascending" | "total descending" | "min ascending" | "min descending" | "max ascending" | "max descending" | "sum ascending" | "sum descending" | "mean ascending" | "mean descending" | "median ascending" | "median descending" 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. - Axis.categoryorder
color Color Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this. - Axis.color
constrain "range" | "domain" - - -
constraintoward "left" | "center" | "right" | "top" | "middle" | "bottom" - - -
direction "clockwise" | "counterclockwise" - - -
dividercolor Color Sets the color of the dividers Only has an effect on multicategory axes. - Axis.dividercolor
dividerwidth number Sets the width (in px) of the dividers Only has an effect on multicategory axes. - Axis.dividerwidth
domain number[] - - -
dtick DTickValue - - Axis.dtick
exponentformat "none" | "e" | "E" | "power" | "SI" | "B" 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. - Axis.exponentformat
fixedrange boolean Determines whether or not this axis is zoom-able. If true, then zoom is disabled. Axis.fixedrange -
gridcolor Color Sets the color of the grid lines. - Axis.gridcolor
griddash Dash - - -
gridwidth number Sets the width (in px) of the grid lines. - Axis.gridwidth
hoverformat string Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: %{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 "091523.46" - Axis.hoverformat
insiderange any[] - - -
l2p (v) => number - - -
labelalias DTickValue - - Axis.labelalias
layer "above traces" | "below traces" - - -
linecolor Color Sets the axis line color - Axis.linecolor
linewidth number Sets the width (in px) of the axis line. - Axis.linewidth
matches AxisName - - -
maxallowed DTickValue - - Axis.maxallowed
minallowed DTickValue - - Axis.minallowed
minexponent number Hide SI prefix for 10^n if n is below this number. This only has an effect when tickformat is "SI" or "B".
minor Partial<MinorAxisLayout> - - -
mirror boolean | "all" | "ticks" | "allticks" - - Axis.mirror
nticks number - - Axis.nticks
overlaying AxisName | "free" - - -
position number - - -
range any[] - - Axis.range
rangebreaks Partial<RangeBreak>[] - - -
rangemode "normal" | "tozero" | "nonnegative" '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. | - | [Axis](#axis).[rangemode`](#rangemode)
rangeselector Partial<RangeSelector> - - -
rangeslider Partial<RangeSlider> - - -
rotation number - - -
scaleanchor AxisName - - -
scaleratio number - - -
separatethousands boolean 'If true, even 4-digit integers are separated - Axis.separatethousands
showdividers boolean Determines whether or not a dividers are drawn between the category levels of this axis. Only has an effect on multicategory axes. - Axis.showdividers
showexponent "all" | "none" | "first" | "last" 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. - Axis.showexponent
showgrid boolean Determines whether or not grid lines are drawn. If true, the grid lines are drawn at every tick mark. - Axis.showgrid
showline boolean Determines whether or not a line bounding this axis is drawn. - Axis.showline
showspikes boolean - - Axis.showspikes
showticklabels boolean - - Axis.showticklabels
showtickprefix "all" | "none" | "first" | "last" 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. - Axis.showtickprefix
showticksuffix "all" | "none" | "first" | "last" Same as showtickprefix but for tick suffixes. - Axis.showticksuffix
side "left" | "right" | "top" | "bottom" | "clockwise" | "counterclockwise" - - -
spikecolor Color - - Axis.spikecolor
spikedash string - - Axis.spikedash
spikemode "marker" | "toaxis" | "across" | "toaxis+across" | "toaxis+across+marker" | "across+marker" | "toaxis+marker" Determines the drawing mode for the spike line. If toaxis, the line is drawn from the data point to the axis the series is plotted on. If across, the line is drawn across the entire plot area, and supercedes toaxis. If marker, then a marker dot is drawn on the axis the series is plotted on - Axis.spikemode
spikesnap "data" | "cursor" | "hovered data" Determines whether spikelines are stuck to the cursor or to the closest datapoints. - Axis.spikesnap
spikethickness number - - Axis.spikethickness
tick0 string | number - - Axis.tick0
tickangle number | "auto" - - Axis.tickangle
tickcolor Color - - Axis.tickcolor
tickfont Partial<Font> - - Axis.tickfont
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: %{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" - Axis.tickformat
tickformatstops Partial<TickFormatStop>[] Array of Partial<TickFormatStop> objects. - Axis.tickformatstops
ticklabelmode "instant" | "period" - - -
ticklabeloverflow "allow" | "hide past div" | "hide past domain" - - -
ticklabelposition "inside" | "outside" | "outside top" | "inside top" | "outside left" | "inside left" | "outside right" | "inside right" | "outside bottom" | "inside bottom" - - -
ticklabelstep number - - -
ticklen number - - Axis.ticklen
tickmode "auto" | "linear" | "array" | "sync" Ticks - Axis.tickmode
tickprefix string - - Axis.tickprefix
ticks "" | "inside" | "outside" - - Axis.ticks
tickson "labels" | "boundaries" - - -
ticksuffix string Sets a tick label suffix. - Axis.ticksuffix
ticktext string[] - - Axis.ticktext
tickvals any[] - - Axis.tickvals
tickwidth number - - Axis.tickwidth
title Partial<DataTitle> - - Axis.title
type AxisType - - Axis.type
uirevision DTickValue - - -
visible boolean A single toggle to hide the axis while preserving interaction like dragging. Default is true when a cheater plot is present on the axis, otherwise false - Axis.visible
zeroline boolean 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. - Axis.zeroline
zerolinecolor Color Sets the line color of the zero line. - Axis.zerolinecolor
zerolinewidth number Sets the width (in px) of the zero line. - Axis.zerolinewidth

Legend

Extends

Properties

Property Type Description Inherited from
bgcolor string Sets the background color of all hover labels on graph. Label.bgcolor
bordercolor string Sets the border color of all hover labels on graph. Label.bordercolor
borderwidth number - -
font Partial<Font> Sets the default hover label font used by all traces on the graph. Label.font
groupclick "toggleitem" | "togglegroup" - -
grouptitlefont Partial<Font> - -
itemclick false | "toggle" | "toggleothers" - -
itemdoubleclick false | "toggle" | "toggleothers" - -
itemsizing "trace" | "constant" - -
itemwidth number - -
orientation "v" | "h" - -
title Partial<LegendTitle> - -
tracegroupgap number - -
traceorder "normal" | "reversed" | "grouped" | "reversed+grouped" - -
uid string - -
uirevision string | number - -
valign "top" | "middle" | "bottom" - -
x number - -
xanchor "auto" | "left" | "center" | "right" - -
xref "container" | "paper" - -
y number - -
yanchor "auto" | "top" | "middle" | "bottom" - -
yref "container" | "paper" - -

LegendTitle

Properties

Property Type
font Partial<Font>
side "left" | "top" | "top left" | "top center" | "top right"
text string

Mapbox

Properties

Property Type Description
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.
bearing number Sets the bearing angle of the map in degrees counter-clockwise from North (mapbox.bearing).
bounds MapboxBounds -
center Partial<MapboxCenter> -
domain Partial<Domain> -
layers Partial<MapboxLayers>[] -
pitch number Sets the pitch angle of the map (in degrees, where 0 means perpendicular to the surface of the map) (mapbox.pitch).
style string | number 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--
uid string -
uirevision string | number Controls persistence of user-driven changes in the view: center, zoom, bearing, pitch. Defaults to layout.uirevision.
zoom number Sets the zoom level of the map (mapbox.zoom).

MapboxBounds

Properties

Property Type Description
east number Sets the maximum longitude of the map (in degrees East) if west, south and north are declared.
north number Sets the maximum latitude of the map (in degrees North) if east, west and south are declared.
south number Sets the minimum latitude of the map (in degrees North) if east, west and north are declared.
west number Sets the minimum longitude of the map (in degrees East) if east, south and north are declared.

MapboxCenter

Properties

Property Type Description
lat number Sets the longitude of the center of the map (in degrees East).
lon number Sets the latitude of the center of the map (in degrees North).

MapboxLayers

Properties

Property Type Description
below string Determines if the layer will be inserted before the layer with the specified ID. If omitted or set to '', the layer will be inserted above every existing layer.
circle object -
circle.radius number Sets the circle radius (mapbox.layer.paint.circle-radius). Has an effect only when type is set to circle.
color Color Sets the primary layer color. If type is circle, color corresponds to the circle color (mapbox.layer.paint.circle-color). If type is line, color corresponds to the line color (mapbox.layer.paint.line-color). If type is fill, color corresponds to the fill color (mapbox.layer.paint.fill-color). If type is symbol, color corresponds to the icon color (mapbox.layer.paint.icon-color).
coordinates string | number Sets the coordinates array contains [longitude, latitude] pairs for the image corners listed in clockwise order: top left, top right, bottom right, bottom left. Only has an effect for image sourcetype.
fill object -
fill.outlinecolor Color Sets the fill outline color (mapbox.layer.paint.fill-outline-color). Has an effect only when type is set to fill.
line Partial<ShapeLine> -
maxzoom number Sets the maximum zoom level (mapbox.layer.maxzoom). At zoom levels equal to or greater than the maxzoom, the layer will be hidden.
minzoom number Sets the minimum zoom level (mapbox.layer.minzoom). At zoom levels less than the minzoom, the layer will be hidden.
name string When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with templateitemname matching this name alongside your modifications (including visible: false or enabled: false to hide it). Has no effect outside of a template.
opacity number Sets the opacity of the layer. If type is circle, opacity corresponds to the circle opacity (mapbox.layer.paint.circle-opacity). If type is line, opacity corresponds to the line opacity (mapbox.layer.paint.line-opacity). If type is fill, opacity corresponds to the fill opacity (mapbox.layer.paint.fill-opacity). If type is symbol, opacity corresponds to the icon/text opacity (mapbox.layer.paint.text-opacity).
source any Sets the source data for this layer (mapbox.layer.source). When sourcetype is set to geojson, source can be a URL to a GeoJSON or a GeoJSON object. When sourcetype is set to vector or raster, source can be a URL or an array of tile URLs. When sourcetype is set to image, source can be a URL to an image.
sourceattribution string Sets the attribution for this source.
sourcelayer string Specifies the layer to use from a vector tile source (mapbox.layer.source-layer). Required for vector source type that supports multiple layers.
sourcetype "image" | "geojson" | "vecotr" | "raster" Sets the source type for this layer, that is the type of the layer data.
symbol Partial<MapboxSymbol> -
templateitemname string Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with templateitemname matching its name, alongside your modifications (including visible: false or enabled: false to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with visible: true.
type "symbol" | "fill" | "line" | "circle" | "raster" Sets the layer type, that is the how the layer data set in source will be rendered With sourcetype set to geojson, the following values are allowed: circle, line, fill and symbol. But note that line and fill are not compatible with Point GeoJSON geometries. With sourcetype set to vector, the following values are allowed: circle, line, fill and symbol. With sourcetype set to raster or *image*, only the raster value is allowed.
visible boolean Determines whether this layer is displayed.

MapboxSymbol

Properties

Property Type Description
icon string Sets the symbol icon image (mapbox.layer.layout.icon-image). Full list: https://www.mapbox.com/maki-icons/
iconsize number Sets the symbol icon size (mapbox.layer.layout.icon-size). Has an effect only when type is set to symbol.
placement "line" | "point" | "line-center" Sets the symbol and/or text placement (mapbox.layer.layout.symbol-placement). If placement is point, the label is placed where the geometry is located. If placement is line, the label is placed along the line of the geometry. If placement is line-center, the label is placed on the center of the geometry.
text string Sets the symbol text (mapbox.layer.layout.text-field).
textfont Partial<Font> -
textposition "top left" | "top center" | "top right" | "middle center" | "bottom left" | "bottom center" | "bottom right" Sets the positions of the text elements with respects to the (x,y) coordinates.

Margin

Properties

Property Type
b number
l number
pad number
r number
t number

MinorAxisLayout

Properties

Property Type
dtick DTickValue
gridcolor Color
griddash Dash
gridwidth number
nticks number
showgrid boolean
tick0 DTickValue
tickcolor Color
ticklen number
tickmode "auto" | "linear" | "array"
ticks "" | "inside" | "outside"
tickvals any[]
tickwidth number

ModeBar

Properties

Property Type
activecolor Color
add ModeBarDefaultButtons | ModeBarDefaultButtons[]
bgcolor Color
color Color
orientation "v" | "h"
remove ModeBarDefaultButtons | ModeBarDefaultButtons[]
uid string
uirevision string | number

OhlcData

Properties

Property Type
close number[]
customdata any[]
decreasing object
decreasing.line? object
decreasing.line.color? string
decreasing.line.dash? Dash
decreasing.line.width? number
high number[]
hoverinfo HoverInfo
hoverlabel object
hoverlabel.align? "auto" | "left" | "right"
hoverlabel.bgcolor? string | string[]
hoverlabel.bordercolor? string | string[]
hoverlabel.font? object
hoverlabel.font.color? string | string[]
hoverlabel.font.family? string | string[]
hoverlabel.font.size? number
hoverlabel.namelength? number | number[]
hoverlabel.split? boolean
hovertext string | string[]
ids string[]
increasing object
increasing.line? object
increasing.line.color? string
increasing.line.dash? Dash
increasing.line.width? number
legendgroup string
line object
line.dash Dash
line.width number
low number[]
meta any
name string
opacity number
open number[]
selectedpoints any
showlegend boolean
text string | string[]
tickwidth number
type "ohlc"
uirevision any
visible boolean | "legendonly"
x string[]
xaxis string
xcalendar XCalendar
xperiod any
xperiod0 any
xperiodalignment "middle" | "end" | "start"
yaxis string

Padding

Properties

Property Type Description
b number The amount of padding (in px) along the bottom of the component.
editType "arraydraw" -
l number The amount of padding (in px) on the left side of the component.
r number The amount of padding (in px) on the right side of the component.
t number The amount of padding (in px) along the top of the component.

Pattern

'Sets the pattern within the marker.

Properties

Property Type Description
bgcolor? string When there is no colorscale sets the color of background pattern fill. Defaults to a marker.color background when fillmode is overlay. Otherwise, defaults to a transparent background.
fgcolor? string When there is no colorscale sets the color of foreground pattern fill. Defaults to a marker.color background when fillmode is replace. Otherwise, defaults to dark grey or white to increase contrast with the bgcolor.
fgopacity? string Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when fillmode is overlay. Otherwise, defaults to 1.
fillmode? "overlay" | "replace" Determines whether marker.color should be used as a default to bgcolor or a fgcolor.
shape? "" | "x" | "." | "-" | "/" | "\" | "|" | "+" Sets the shape of the pattern fill. By default, no pattern is used for filling the area.
size? number Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.
solidity? number Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.

PieData

From T, pick a set of properties whose keys are in the union K

Extends

  • Pick<PlotData, "name" | "visible" | "showlegend" | "legendgroup" | "opacity" | "ids" | "labels" | "hovertext" | "automargin" | "textinfo" | "direction" | "hole" | "rotation">

Properties

Property Type Inherited from
automargin boolean PlotData.automargin
customdata Datum[] -
direction "clockwise" | "counterclockwise" PlotData.direction
dlabel number -
domain Partial<PieDomain> -
hole number PlotData.hole
hoverinfo PieHoverInfo -
hoverlabel Partial<PieHoverLabel> -
hovertemplate string | string[] -
hovertext string | string[] PlotData.hovertext
ids string[] PlotData.ids
insidetextfont PieFont -
insidetextorientation PieInsideTextOrientation -
label0 number -
labels Datum[] PlotData.labels
legendgroup string PlotData.legendgroup
marker Partial<PieMarker> -
meta string | number -
name string PlotData.name
opacity number PlotData.opacity
outsidetextfont PieFont -
pull number | number[] -
rotation number PlotData.rotation
scalegroup string -
showlegend boolean PlotData.showlegend
sort boolean -
text Datum | Datum[] -
textfont PieFont -
textinfo "text" | "none" | "label" | "value" | "percent" | "label+text" | "label+value" | "label+percent" | "label+text+value" | "label+text+percent" | "label+value+percent" | "text+value" | "text+percent" | "text+value+percent" | "value+percent" PlotData.textinfo
textposition PieTextPosition | PieTextPosition[] -
texttemplate string | string[] -
title Partial<PieDataTitle> -
type "pie" -
uirevision string | number -
values (string | number)[] -
visible boolean | "legendonly" PlotData.visible

PieDataTitle

From T, pick a set of properties whose keys are in the union K

Extends

Properties

Property Type Inherited from
font Partial<PieFont> -
position "top left" | "top center" | "top right" | "middle center" | "bottom left" | "bottom center" | "bottom right" DataTitle.position
text string DataTitle.text

PieDomain

Properties

Property Type
column number
row number
x number[]
y number[]

PieFont

Properties

Property Type
color PieColors | PieColor
family string | string[]
size number | number[]

PieHoverLabel

Properties

Property Type
align "auto" | "left" | "right" | ("auto" | "left" | "right")[]
bgcolor PieColors | PieColor
bordercolor PieColors | PieColor
font PieFont
namelength number | number[]

PieLine

Properties

Property Type
color PieColors | PieColor
width number | number[]

PieMarker

Properties

Property Type
colors PieColors
line Partial<PieLine>

PlotData

Extended by

Properties

Property Type
autobinx boolean
autocontour boolean
automargin boolean
boxmean boolean | "sd"
boxpoints false | "all" | "outliers" | "suspectedoutliers"
branchvalues "total" | "remainder"
cliponaxis boolean
colorbar Partial<ColorBar>
colorscale ColorScale
connectgaps boolean
constraintext "none" | "inside" | "outside" | "both"
contours Partial<{ coloring: "fill" | "heatmap" | "lines" | "none"; end: number; labelfont: Partial<Font>; labelformat: string; operation: "=" | "<" | ">=" | ">" | "<=" | "[]" | "()" | "[)" | "(]" | "][" | ")(" | "](" | ")["; showlabels: boolean; showlines: boolean; size: number; start: number; type: "levels" | "constraint"; value: number | [number, number]; }>
customdata Datum[] | Datum[][]
delta Partial<Delta>
direction "clockwise" | "counterclockwise"
domain Partial<{ column: number; row: number; x: number[]; y: number[]; }>
error_x ErrorBar
error_y ErrorBar
fill "none" | "tozeroy" | "tozerox" | "tonexty" | "tonextx" | "toself" | "tonext"
fillcolor string
fillpattern Partial<Pattern>
gauge Partial<Gauge>
groupnorm "" | "fraction" | "percent"
histfunc "count" | "sum" | "avg" | "min" | "max"
histnorm "" | "probability" | "percent" | "density" | "probability density"
hole number
hoverinfo "all" | "text" | "none" | "x" | "name" | "y" | "skip" | "x+text" | "x+name" | "x+y" | "x+y+text" | "x+y+name" | "x+y+z" | "x+y+z+text" | "x+y+z+name" | "y+name" | "y+x" | "y+text" | "y+x+text" | "y+x+name" | "y+z" | "y+z+text" | "y+z+name" | "y+x+z" | "y+x+z+text" | "y+x+z+name" | "z" | "z+x" | "z+x+text" | "z+x+name" | "z+y+x" | "z+y+x+text" | "z+y+x+name" | "z+x+y" | "z+x+y+text" | "z+x+y+name"
hoverlabel Partial<HoverLabel>
hoveron "points" | "fills"
hoverongaps boolean
hovertemplate string | string[]
hovertext string | string[]
i TypedArray
ids string[]
insidetextanchor "middle" | "end" | "start"
j TypedArray
jitter number
k TypedArray
labels Datum[]
lat Datum[]
legendgroup string
legendgrouptitle object
legendgrouptitle.font? Partial<Font>
legendgrouptitle.text string
legendrank number
level string
line Partial<ScatterLine>
line.color Color
line.dash Dash
line.shape "linear" | "spline" | "hv" | "vh" | "hvh" | "vhv"
line.simplify boolean
line.smoothing number
line.width number
locationmode "ISO-3" | "USA-states" | "country names" | "geojson-id"
locations Datum[]
lon Datum[]
marker Partial<PlotMarker> | Partial<BoxPlotMarker>
marker.color Color
marker.colorbar object
marker.colorscale ColorScale | ColorScale[]
marker.line Partial<ScatterMarkerLine>
marker.line.color Color
marker.line.colorscale ColorScale | ColorScale[]
marker.maxdisplayed number
marker.opacity number | number[]
marker.pad.b number
marker.pad.l number
marker.pad.r number
marker.pad.t number
marker.showscale boolean
marker.size number | number[] | number[][]
marker.sizemax number
marker.sizemin number
marker.sizemode "area" | "diameter"
marker.sizeref number
marker.symbol MarkerSymbol | MarkerSymbol[]
maxdepth number
mode "number" | "text" | "none" | "lines" | "markers" | "lines+markers" | "text+markers" | "text+lines" | "text+lines+markers" | "gauge" | "delta" | "number+delta" | "gauge+number" | "gauge+number+delta" | "gauge+delta"
name string
ncontours number
number Partial<PlotNumber>
offset number | number[]
opacity number
orientation "v" | "h"
parents string[]
pointpos number
r Datum[]
reversescale boolean
rotation number
selectedpoints Datum[]
showlegend boolean
showscale boolean
stackgaps "infer zero" | "interpolate"
stackgroup string
text string | string[]
textangle number | "auto"
textfont Partial<Font>
textinfo "text" | "none" | "label" | "value" | "percent" | "label+text" | "label+value" | "label+percent" | "label+text+value" | "label+text+percent" | "label+value+percent" | "text+value" | "text+percent" | "text+value+percent" | "value+percent"
textposition "none" | "auto" | "top left" | "top center" | "top right" | "middle left" | "middle center" | "middle right" | "bottom left" | "bottom center" | "bottom right" | "inside" | "outside"
texttemplate string | string[]
theta Datum[]
title Partial<DataTitle>
transpose boolean
type PlotType
uid string
uirevision string | number
value number
values Datum[]
visible boolean | "legendonly"
width number | number[]
x Datum[] | Datum[][] | TypedArray
xaxis string
xbins object
xbins.end string | number
xbins.size string | number
xbins.start string | number
xgap number
xhoverformat string
xy Float32Array
y Datum[] | Datum[][] | TypedArray
yaxis string
ygap number
yhoverformat string
z Datum[] | Datum[][] | TypedArray | Datum[][][]
zhoverformat string
zmax number
zmin number
zsmooth false | "fast" | "best"

PlotDatum

Properties

Property Type
curveNumber number
customdata Datum
data PlotData
pointIndex number
pointNumber number
text string
x Datum
xaxis LayoutAxis
y Datum
yaxis LayoutAxis

PlotMarker

Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip". examples: "x", "y", "x+y", "x+y+z", "all" default: "all"

Properties

Property Type
autocolorscale? boolean
cauto? boolean
cmax? number
cmin? number
color? Color | Color[]
colorbar? Partial<ColorBar>
colors? Color[]
colorscale? ColorScale
gradient? object
gradient.color Color
gradient.colorsrc any
gradient.type "none" | "horizontal" | "radial" | "vertical"
gradient.typesrc any
line Partial<ScatterMarkerLine>
maxdisplayed? number
opacity number | number[]
pad? Partial<Padding>
pattern? Partial<Pattern>
reversescale? boolean
showscale? boolean
size number | number[]
sizemax? number
sizemin? number
sizemode? "area" | "diameter"
sizeref? number
symbol MarkerSymbol
width? number

PlotNumber

Properties

Property Type
font Partial<Font>
prefix string
suffix string
valueformat string

Point

Properties

Property Type
x number
y number
z number

PolarLayout

Properties

Property Type
angularaxis Partial<LayoutAxis>
bgcolor Color
domain Partial<Domain>
gridshape "linear" | "circular"
hole number
radialaxis Partial<LayoutAxis>
sector number[]
uid string
uirevision string | number

RangeBreak

Properties

Property Type
bounds any[]
dvalue number
enabled boolean
name string
pattern "" | "hour" | "day of week"
templateitemname string
values any[]

RangeSelector

Extends

Properties

Property Type Description Inherited from
activecolor string - -
bgcolor string Sets the background color of all hover labels on graph. Label.bgcolor
bordercolor string Sets the border color of all hover labels on graph. Label.bordercolor
borderwidth number - -
buttons Partial<RangeSelectorButton>[] - -
font Partial<Font> Sets the default hover label font used by all traces on the graph. Label.font
visible boolean - -
x number - -
xanchor "auto" | "left" | "center" | "right" - -
y number - -
yanchor "auto" | "top" | "middle" | "bottom" - -

RangeSelectorButton

Properties

Property Type
count number
label string
step "year" | "month" | "day" | "hour" | "all" | "second" | "minute"
stepmode "backward" | "todate"

RangeSlider

Properties

Property Type
bgcolor string
bordercolor string
borderwidth number
range [Datum, Datum]
thickness number
visible boolean

SankeyColorscale

Properties

Property Type
cmax number
cmin number
colorscale [number, string][]
label string
name string
templateitemname string

SankeyData

Properties

Property Type
arrangement "fixed" | "snap" | "perpendicular" | "freeform"
customdata Datum[]
domain Partial<SankeyDomain>
hoverinfo string
hoverlabel Partial<SankeyHoverLabel>
ids string[]
legend string
legendgrouptitle Partial<SankeyDataTitle>
legendrank number
legendwidth number
link Partial<SankeyLink>
meta string | number
name string
node Partial<SankeyNode>
orientation SankeyOrientation
selectpoints string | number
textfont Partial<SankeyFont>
type "sankey"
uirevision string | number
valueformat string
valuesuffix string
visible boolean | "legendonly"

SankeyDataTitle

Properties

Property Type
font Partial<SankeyFont>
title string

SankeyDomain

Properties

Property Type
column number
row number
x number[]
y number[]

SankeyFont

Properties

Property Type
color SankeyColor | SankeyColors
family string | string[]
size number | number[]

SankeyHoverLabel

Properties

Property Type
align "auto" | "left" | "right" | ("auto" | "left" | "right")[]
bgcolor SankeyColor | SankeyColors
bordercolor SankeyColor | SankeyColors
font SankeyFont
namelength number | number[]

Properties

Property Type
arrowlen number
color SankeyColor | SankeyColor[]
colorscale Partial<SankeyColorscale>
customdata Datum[]
hovercolor SankeyColor | SankeyColor[]
hoverinfo "all" | "none" | "skip"
hoverlabel Partial<SankeyHoverLabel>
hovertemplate string | string[]
label Datum[]
line Partial<{ color: SankeyColor; width: number; }>
source number[]
target number[]
value number[]

SankeyNode

Properties

Property Type
color SankeyColor[]
customdata Datum[]
groups SankeyNode[]
hoverinfo "all" | "none" | "skip"
hoverlabel Partial<SankeyHoverLabel>
hovertemplate string | string[]
label Datum[]
line Partial<{ color: SankeyColor; width: number; }>
pad number
thickness number
x number[]
y number[]

ScatterLine

Properties

Property Type
color Color
dash Dash
shape "linear" | "spline" | "hv" | "vh" | "hvh" | "vhv"
simplify boolean
smoothing number
width number

ScatterMarkerLine

Properties

Property Type
autocolorscale? boolean
cauto? boolean
cmax? number
cmid? number
cmin? number
color Color
coloraxis? string
colorscale? ColorScale
reversescale? boolean
width number | number[]

ScatterSelectedMarker

Properties

Property Type
marker Partial<{ color: Color; opacity: number; }>
textfont object
textfont.color Color

Scene

Properties

Property Type
annotations Partial<Annotations> | Partial<Annotations>[]
aspectmode "data" | "auto" | "manual" | "cube"
aspectratio Partial<Point>
bgcolor string
camera Partial<Camera>
captureevents boolean
domain Partial<Domain>
dragmode false | "zoom" | "pan" | "orbit" | "turntable"
hovermode false | "closest"
xaxis Partial<SceneAxis>
yaxis Partial<SceneAxis>
zaxis Partial<SceneAxis>

SceneAxis

Extends

Properties

Property Type Description Inherited from
autorange boolean | "min" | "max" | "reversed" | "min reversed" | "max reversed" - Axis.autorange
autorangeoptions Partial<AutoRangeOptions> - Axis.autorangeoptions
autotypenumbers "convert types" | "strict" - Axis.autotypenumbers
backgroundcolor Color - -
calendar Calendar - Axis.calendar
categoryarray any[] - Axis.categoryarray
categoryorder "trace" | "array" | "category ascending" | "category descending" | "total ascending" | "total descending" | "min ascending" | "min descending" | "max ascending" | "max descending" | "sum ascending" | "sum descending" | "mean ascending" | "mean descending" | "median ascending" | "median descending" 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. Axis.categoryorder
color Color Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this. Axis.color
dividercolor Color Sets the color of the dividers Only has an effect on multicategory axes. Axis.dividercolor
dividerwidth number Sets the width (in px) of the dividers Only has an effect on multicategory axes. Axis.dividerwidth
dtick DTickValue - Axis.dtick
exponentformat "none" | "e" | "E" | "power" | "SI" | "B" 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. Axis.exponentformat
fixedrange boolean Determines whether or not this axis is zoom-able. If true, then zoom is disabled. Axis.fixedrange
gridcolor Color Sets the color of the grid lines. Axis.gridcolor
gridwidth number Sets the width (in px) of the grid lines. Axis.gridwidth
hoverformat string Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: %{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 "091523.46" Axis.hoverformat
labelalias DTickValue - Axis.labelalias
linecolor Color Sets the axis line color Axis.linecolor
linewidth number Sets the width (in px) of the axis line. Axis.linewidth
maxallowed DTickValue - Axis.maxallowed
minallowed DTickValue - Axis.minallowed
minexponent number Hide SI prefix for 10^n if n
mirror boolean | "all" | "ticks" | "allticks" - Axis.mirror
nticks number - Axis.nticks
range any[] - Axis.range
rangemode "normal" | "tozero" | "nonnegative" '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. | [Axis](#axis).[rangemode`](#rangemode)
separatethousands boolean 'If true, even 4-digit integers are separated Axis.separatethousands
showaxeslabels boolean - -
showbackground boolean - -
showdividers boolean Determines whether or not a dividers are drawn between the category levels of this axis. Only has an effect on multicategory axes. Axis.showdividers
showexponent "all" | "none" | "first" | "last" 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. Axis.showexponent
showgrid boolean Determines whether or not grid lines are drawn. If true, the grid lines are drawn at every tick mark. Axis.showgrid
showline boolean Determines whether or not a line bounding this axis is drawn. Axis.showline
showspikes boolean - Axis.showspikes
showticklabels boolean - Axis.showticklabels
showtickprefix "all" | "none" | "first" | "last" 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. Axis.showtickprefix
showticksuffix "all" | "none" | "first" | "last" Same as showtickprefix but for tick suffixes. Axis.showticksuffix
spikecolor Color - Axis.spikecolor
spikedash string - Axis.spikedash
spikemode "marker" | "toaxis" | "across" | "toaxis+across" | "toaxis+across+marker" | "across+marker" | "toaxis+marker" Determines the drawing mode for the spike line. If toaxis, the line is drawn from the data point to the axis the series is plotted on. If across, the line is drawn across the entire plot area, and supercedes toaxis. If marker, then a marker dot is drawn on the axis the series is plotted on Axis.spikemode
spikesides boolean - -
spikesnap "data" | "cursor" | "hovered data" Determines whether spikelines are stuck to the cursor or to the closest datapoints. Axis.spikesnap
spikethickness number - Axis.spikethickness
tick0 string | number - Axis.tick0
tickangle number | "auto" - Axis.tickangle
tickcolor Color - Axis.tickcolor
tickfont Partial<Font> - Axis.tickfont
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-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3's date formatter: %{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" Axis.tickformat
tickformatstops Partial<TickFormatStop>[] Array of Partial<TickFormatStop> objects. Axis.tickformatstops
ticklen number - Axis.ticklen
tickmode "auto" | "linear" | "array" | "sync" Ticks Axis.tickmode
tickprefix string - Axis.tickprefix
ticks "" | "inside" | "outside" - Axis.ticks
ticksuffix string Sets a tick label suffix. Axis.ticksuffix
ticktext string[] - Axis.ticktext
tickvals any[] - Axis.tickvals
tickwidth number - Axis.tickwidth
title Partial<DataTitle> - Axis.title
type AxisType - Axis.type
visible boolean A single toggle to hide the axis while preserving interaction like dragging. Default is true when a cheater plot is present on the axis, otherwise false Axis.visible
zeroline boolean 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. Axis.zeroline
zerolinecolor Color Sets the line color of the zero line. Axis.zerolinecolor
zerolinewidth number Sets the width (in px) of the zero line. Axis.zerolinewidth

Shape

Properties

Property Type
fillcolor string
label Partial<ShapeLabel>
layer "below" | "above"
legendgroup string
legendgrouptitle object
legendgrouptitle.font? Partial<Font>
legendgrouptitle.text string
legendrank number
line Partial<ShapeLine>
name string
opacity number
path string
showlegend boolean
templateitemname string
type "line" | "rect" | "circle" | "path"
visible boolean | "legendonly"
x0 Datum
x1 Datum
xanchor string | number
xref "x" | "paper" | "x2" | "x3" | "x4" | "x5" | "x6" | "x7" | "x8" | "x9" | "x10" | "x11" | "x12" | "x13" | "x14" | "x15" | "x16" | "x17" | "x30" | "x33" | "x38" | "x31" | "x34" | "x32" | "x37" | "x36" | "x35" | "x39" | "x80" | "x83" | "x88" | "x81" | "x84" | "x82" | "x87" | "x86" | "x85" | "x89" | "x18" | "x19" | "x40" | "x43" | "x48" | "x41" | "x44" | "x42" | "x47" | "x46" | "x45" | "x49" | "x20" | "x23" | "x28" | "x21" | "x24" | "x22" | "x27" | "x26" | "x25" | "x29" | "x70" | "x73" | "x78" | "x71" | "x74" | "x72" | "x77" | "x76" | "x75" | "x79" | "x60" | "x63" | "x68" | "x61" | "x64" | "x62" | "x67" | "x66" | "x65" | "x69" | "x50" | "x53" | "x58" | "x51" | "x54" | "x52" | "x57" | "x56" | "x55" | "x59" | "x90" | "x93" | "x98" | "x91" | "x94" | "x92" | "x97" | "x96" | "x95" | "x99" | "x domain" | "x2 domain" | "x3 domain" | "x4 domain" | "x5 domain" | "x6 domain" | "x7 domain" | "x8 domain" | "x9 domain" | "x10 domain" | "x11 domain" | "x12 domain" | "x13 domain" | "x14 domain" | "x15 domain" | "x16 domain" | "x17 domain" | "x30 domain" | "x33 domain" | "x38 domain" | "x31 domain" | "x34 domain" | "x32 domain" | "x37 domain" | "x36 domain" | "x35 domain" | "x39 domain" | "x80 domain" | "x83 domain" | "x88 domain" | "x81 domain" | "x84 domain" | "x82 domain" | "x87 domain" | "x86 domain" | "x85 domain" | "x89 domain" | "x18 domain" | "x19 domain" | "x40 domain" | "x43 domain" | "x48 domain" | "x41 domain" | "x44 domain" | "x42 domain" | "x47 domain" | "x46 domain" | "x45 domain" | "x49 domain" | "x20 domain" | "x23 domain" | "x28 domain" | "x21 domain" | "x24 domain" | "x22 domain" | "x27 domain" | "x26 domain" | "x25 domain" | "x29 domain" | "x70 domain" | "x73 domain" | "x78 domain" | "x71 domain" | "x74 domain" | "x72 domain" | "x77 domain" | "x76 domain" | "x75 domain" | "x79 domain" | "x60 domain" | "x63 domain" | "x68 domain" | "x61 domain" | "x64 domain" | "x62 domain" | "x67 domain" | "x66 domain" | "x65 domain" | "x69 domain" | "x50 domain" | "x53 domain" | "x58 domain" | "x51 domain" | "x54 domain" | "x52 domain" | "x57 domain" | "x56 domain" | "x55 domain" | "x59 domain" | "x90 domain" | "x93 domain" | "x98 domain" | "x91 domain" | "x94 domain" | "x92 domain" | "x97 domain" | "x96 domain" | "x95 domain" | "x99 domain"
xsizemode "pixel" | "scaled"
y0 Datum
y1 Datum
yanchor string | number
yref "y" | "paper" | "y2" | "y3" | "y4" | "y5" | "y6" | "y7" | "y8" | "y9" | "y10" | "y11" | "y12" | "y13" | "y14" | "y15" | "y16" | "y17" | "y30" | "y33" | "y38" | "y31" | "y34" | "y32" | "y37" | "y36" | "y35" | "y39" | "y80" | "y83" | "y88" | "y81" | "y84" | "y82" | "y87" | "y86" | "y85" | "y89" | "y18" | "y19" | "y40" | "y43" | "y48" | "y41" | "y44" | "y42" | "y47" | "y46" | "y45" | "y49" | "y20" | "y23" | "y28" | "y21" | "y24" | "y22" | "y27" | "y26" | "y25" | "y29" | "y70" | "y73" | "y78" | "y71" | "y74" | "y72" | "y77" | "y76" | "y75" | "y79" | "y60" | "y63" | "y68" | "y61" | "y64" | "y62" | "y67" | "y66" | "y65" | "y69" | "y50" | "y53" | "y58" | "y51" | "y54" | "y52" | "y57" | "y56" | "y55" | "y59" | "y90" | "y93" | "y98" | "y91" | "y94" | "y92" | "y97" | "y96" | "y95" | "y99" | "y domain" | "y2 domain" | "y3 domain" | "y4 domain" | "y5 domain" | "y6 domain" | "y7 domain" | "y8 domain" | "y9 domain" | "y10 domain" | "y11 domain" | "y12 domain" | "y13 domain" | "y14 domain" | "y15 domain" | "y16 domain" | "y17 domain" | "y30 domain" | "y33 domain" | "y38 domain" | "y31 domain" | "y34 domain" | "y32 domain" | "y37 domain" | "y36 domain" | "y35 domain" | "y39 domain" | "y80 domain" | "y83 domain" | "y88 domain" | "y81 domain" | "y84 domain" | "y82 domain" | "y87 domain" | "y86 domain" | "y85 domain" | "y89 domain" | "y18 domain" | "y19 domain" | "y40 domain" | "y43 domain" | "y48 domain" | "y41 domain" | "y44 domain" | "y42 domain" | "y47 domain" | "y46 domain" | "y45 domain" | "y49 domain" | "y20 domain" | "y23 domain" | "y28 domain" | "y21 domain" | "y24 domain" | "y22 domain" | "y27 domain" | "y26 domain" | "y25 domain" | "y29 domain" | "y70 domain" | "y73 domain" | "y78 domain" | "y71 domain" | "y74 domain" | "y72 domain" | "y77 domain" | "y76 domain" | "y75 domain" | "y79 domain" | "y60 domain" | "y63 domain" | "y68 domain" | "y61 domain" | "y64 domain" | "y62 domain" | "y67 domain" | "y66 domain" | "y65 domain" | "y69 domain" | "y50 domain" | "y53 domain" | "y58 domain" | "y51 domain" | "y54 domain" | "y52 domain" | "y57 domain" | "y56 domain" | "y55 domain" | "y59 domain" | "y90 domain" | "y93 domain" | "y98 domain" | "y91 domain" | "y94 domain" | "y92 domain" | "y97 domain" | "y96 domain" | "y95 domain" | "y99 domain"
ysizemode "pixel" | "scaled"

ShapeLabel

Properties

Property Type
font Partial<Font>
padding number
text string
textangle number | "auto"
textposition "middle" | "top left" | "top center" | "top right" | "middle left" | "middle center" | "middle right" | "bottom left" | "bottom center" | "bottom right" | "end" | "start"
texttemplate string
xanchor "auto" | "left" | "center" | "right"
yanchor "top" | "middle" | "bottom"

ShapeLine

Properties

Property Type
color string
dash Dash
width number

Slider

Properties

Property Type Description
active number Determines which button (by index starting from 0) is considered active.
activebgcolor Color Sets the background color of the slider grip while dragging.
bgcolor Color Sets the background color of the slider.
bordercolor Color Sets the color of the border enclosing the slider.
borderwidth number Sets the width (in px) of the border enclosing the slider.
currentvalue Partial<CurrentValue> -
font Partial<Font> Sets the font of the slider step labels.
len number Sets the length of the slider This measure excludes the padding of both ends. That is, the slider's length is this length minus the padding on both ends.
lenmode "fraction" | "pixels" Determines whether this slider length is set in units of plot fraction or in *pixels. Use len to set the value.
minorticklen number Sets the length in pixels of minor step tick marks
pad Partial<Padding> Set the padding of the slider component along each side.
steps Partial<SliderStep>[] -
tickcolor Color Sets the color of the border enclosing the slider.
ticklen number Sets the length in pixels of step tick marks
tickwidth number Sets the tick width (in px).
transition Transition -
visible boolean Determines whether or not the slider is visible.
x number Sets the x position (in normalized coordinates) of the slider.
xanchor "auto" | "left" | "center" | "right" Sets the slider's horizontal position anchor. This anchor binds the x position to the left, center or right of the range selector.
y number Sets the y position (in normalized coordinates) of the slider.
yanchor "auto" | "top" | "middle" | "bottom" Sets the slider's vertical position anchor This anchor binds the y position to the top, middle or bottom of the range selector.

SliderStep

Properties

Property Type Description
args any[] Sets the arguments values to be passed to the Plotly method set in method on slide.
execute boolean When true, the API method is executed. When false, all other behaviors are the same and command execution is skipped. This may be useful when hooking into, for example, the plotly_sliderchange method and executing the API command manually without losing the benefit of the slider automatically binding to the state of the plot through the specification of method and args.
label string Sets the text label to appear on the slider
method "update" | "skip" | "restyle" | "relayout" | "animate" Sets the Plotly method to be called when the slider value is changed. If the skip method is used, the API slider will function as normal but will perform no API calls and will not bind automatically to state updates. This may be used to create a component interface and attach to slider events manually via JavaScript.
value string Sets the value of the slider step, used to refer to the step programatically. Defaults to the slider label if not provided.
visible boolean Determines whether or not this step is included in the slider.

Template

Properties

Property Type
data? object
data.bar? Partial<PlotData>[]
data.barpolar? Partial<PlotData>[]
data.box? Partial<PlotData>[]
data.candlestick? Partial<PlotData>[]
data.carpet? Partial<PlotData>[]
data.choropleth? Partial<PlotData>[]
data.choroplethmap? Partial<PlotData>[]
data.choroplethmapbox? Partial<PlotData>[]
data.cone? Partial<PlotData>[]
data.contour? Partial<PlotData>[]
data.contourcarpet? Partial<PlotData>[]
data.densitymap? Partial<PlotData>[]
data.densitymapbox? Partial<PlotData>[]
data.funnel? Partial<PlotData>[]
data.funnelarea? Partial<PlotData>[]
data.heatmap? Partial<PlotData>[]
data.histogram? Partial<PlotData>[]
data.histogram2d? Partial<PlotData>[]
data.histogram2dcontour? Partial<PlotData>[]
data.image? Partial<PlotData>[]
data.indicator? Partial<PlotData>[]
data.isosurface? Partial<PlotData>[]
data.mesh3d? Partial<PlotData>[]
data.ohlc? Partial<PlotData>[]
data.parcats? Partial<PlotData>[]
data.parcoords? Partial<PlotData>[]
data.pie? Partial<PlotData>[]
data.sankey? Partial<PlotData>[]
data.scatter? Partial<PlotData>[]
data.scatter3d? Partial<PlotData>[]
data.scattercarpet? Partial<PlotData>[]
data.scattergeo? Partial<PlotData>[]
data.scattergl? Partial<PlotData>[]
data.scattermap? Partial<PlotData>[]
data.scattermapbox? Partial<PlotData>[]
data.scatterpolar? Partial<PlotData>[]
data.scatterpolargl? Partial<PlotData>[]
data.scatterternary? Partial<PlotData>[]
data.splom? Partial<PlotData>[]
data.streamtube? Partial<PlotData>[]
data.sunburst? Partial<PlotData>[]
data.surface? Partial<PlotData>[]
data.table? Partial<PlotData>[]
data.treemap? Partial<PlotData>[]
data.violin? Partial<PlotData>[]
data.volume? Partial<PlotData>[]
data.waterfall? Partial<PlotData>[]
layout? Partial<Layout>

Threshold

Properties

Property Type
line Partial<GaugeLine>
thickness number
value number

TickFormatStop

Properties

Property Type Description
dtickrange [DTickValue | null, DTickValue | null] Range [min, max], where min, max - dtick values which describe some zoom level, it is possible to omit min or max value by passing null
enabled boolean Determines whether or not this stop is used. If false, this stop is ignored even within its dtickrange.
name string When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with templateitemname matching this name alongside your modifications (including visible: false or enabled: false to hide it). Has no effect outside of a template.
templateitemname string Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with templateitemname matching its name, alongside your modifications (including visible: false or enabled: false to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with visible: true.
value string dtickformat for described zoom level, the same as tickformat

Transition

Properties

Property Type Description
duration number Sets the duration of the slider transition
easing "linear" | "circle" | "quad" | "cubic" | "sin" | "exp" | "elastic" | "back" | "bounce" | "linear-in" | "quad-in" | "cubic-in" | "sin-in" | "exp-in" | "circle-in" | "elastic-in" | "back-in" | "bounce-in" | "linear-out" | "quad-out" | "cubic-out" | "sin-out" | "exp-out" | "circle-out" | "elastic-out" | "back-out" | "bounce-out" | "linear-in-out" | "quad-in-out" | "cubic-in-out" | "sin-in-out" | "exp-in-out" | "circle-in-out" | "elastic-in-out" | "back-in-out" | "bounce-in-out" Sets the easing function of the slider transition
ordering? "layout first" | "traces first" Determines whether the figure's layout or traces smoothly transitions during updates that make both traces and layout change. Default is "layout first".

UpdateMenu

Properties

Property Type Description
active? number Determines which button (by index starting from 0) is considered active.
bgcolor? Color Sets the background color of the update menu buttons.
bordercolor? Color Sets the color of the border enclosing the update menu.
borderwidth number Sets the width (in px) of the border enclosing the update menu.
buttons Partial<UpdateMenuButton>[] array of object where each object has one or more of the keys listed below.
direction "left" | "right" | "up" | "down" Determines the direction in which the buttons are laid out, whether in a dropdown menu or a row/column of buttons. For left and up, the buttons will still appear in left-to-right or top-to-bottom order respectively.
font Partial<Font> Sets the font of the update menu button text.
name string When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with templateitemname matching this name alongside your modifications (including visible: false or enabled: false to hide it). Has no effect outside of a template.
pad Partial<Padding> Sets the padding around the buttons or dropdown menu.
showactive boolean Highlights active dropdown item or active button if true.
templateitemname string Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with templateitemname matching its name, alongside your modifications (including visible: false or enabled: false to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with visible: true.
type "buttons" | "dropdown" Determines whether the buttons are accessible via a dropdown menu or whether the buttons are stacked horizontally or vertically
visible boolean Determines whether or not the update menu is visible.
x number Sets the x position (in normalized coordinates) of the update menu.
xanchor "auto" | "left" | "center" | "right" Sets the update menu's horizontal position anchor. This anchor binds the x position to the "left", "center" or "right" of the range selector.
y number Sets the y position (in normalized coordinates) of the update menu.
yanchor "auto" | "top" | "middle" | "bottom" Sets the update menu's vertical position anchor This anchor binds the y position to the "top", "middle" or "bottom" of the range selector.

UpdateMenuButton

Properties

Property Type Description
args any[] Sets the arguments values to be passed to the Plotly method set in method on click.
args2 any[] Sets a 2nd set of args, these arguments values are passed to the Plotly method set in method` when clicking this button while in the active state. Use this to create toggle buttons.
execute boolean When true, the API method is executed. When false, all other behaviors are the same and command execution is skipped. This may be useful when hooking into, for example, the plotly_buttonclicked method and executing the API command manually without losing the benefit of the updatemenu automatically binding to the state of the plot through the specification of method and args.
label string Sets the text label to appear on the button.
method "update" | "skip" | "restyle" | "relayout" | "animate" Sets the Plotly method to be called on click. If the skip method is used, the API updatemenu will function as normal but will perform no API calls and will not bind automatically to state updates. This may be used to create a component interface and attach to updatemenu events manually via JavaScript.
name string When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with templateitemname matching this name alongside your modifications (including visible: false or enabled: false to hide it). Has no effect outside of a template.
templateitemname string Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with templateitemname matching its name, alongside your modifications (including visible: false or enabled: false to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with visible: true.
visible boolean Determines whether or not this button is visible.

ViolinData

Properties

Property Type
alignmentgroup string
bandwidth number
box Partial<{ fillcolor: Color; line: Partial<{ color: Color; width: number; }>; visible: boolean; width: number; }>
fillcolor Color
hoveron string
hovertemplate string | string[]
hovertext string | string[]
jitter number
line Partial<{ color: Color; width: number; }>
marker Partial<BoxPlotMarker>
meanline Partial<{ color: Color; visible: boolean; width: number; }>
name string
offsetgroup string
opacity number
orientation "v" | "h"
pointpos number
points false | "all" | "outliers" | "suspectedoutliers"
scalegroup string
scalemode "width" | "count"
selected ScatterSelectedMarker
side "both" | "positive" | "negative"
span any[]
spanmode "soft" | "hard" | "manual"
text string | string[]
type "violin"
unselected ScatterSelectedMarker
width number
x Datum[] | Datum[][] | TypedArray
x0 any
y Datum[] | Datum[][] | TypedArray
y0 any

Type Aliases

AccountabilityDataChartBeforeDrawEventData

AccountabilityDataChartBeforeDrawEventData = DashboardItemEventData & CanIncludeStatsBeforeDrawEventData<"accountability"> & object

Type Declaration

Name Type Description
columns AccountabilityDataChartColumnWorker[] The current columns drawn in the table. Will only contain an id field if type is set to traceability, in which case the id field is the Traceability ID.
data AccountabilityDataDetail[] The current data used in the table.

AccountabilityDataChartColumn

AccountabilityDataChartColumn = DataChartColumn<AccountabilityDataChartColumnType>

AccountabilityDataChartColumnType

AccountabilityDataChartColumnType = BaseSharedDataChartColumnType | "status" | "scheduledDate" | "startedDate" | "completedDate" | "late" | "shownToUser"

AccountabilityDataChartColumnWorker

AccountabilityDataChartColumnWorker = DataChartColumnWorker<AccountabilityDataChartColumn>

AccountabilityDataChartWorkerGet

AccountabilityDataChartWorkerGet = NonSPCChartWorkerGet & object

Type Declaration

Name Type Description
columns AccountabilityDataChartColumnWorker[] The current columns drawn in the table. Will only contain an id field if type is set to traceability, in which case the id field is the Traceability ID.
data? AccountabilityDataDetail[] The current data used in the table. Will be set to undefined if the table has never been drawn, or if there was an error with the retrieval.

AccountabilityDataChartWorkerUpdate

AccountabilityDataChartWorkerUpdate = NonSPCChartWorkerUpdate & ChartCanIncludeAccountabilityStatsWorkerUpdate & object

Type Declaration

Name Type Description
columns? AccountabilityDataChartColumnWorker[] | null Updates the current columns drawn in the table. May only contain an id field if type is set to traceability, in which case the id field is the Traceability ID. When unset, it will revert to the default columns.

AccountabilityStatsDetail

AccountabilityStatsDetail = BaseDetail & object

Type Declaration

Name Type Description
stats AccountabilityStatValues Doc Calculated statistics

AccountabilityStatsGridValue

AccountabilityStatsGridValue = object

Properties

Property Type Description
data? AccountabilityDataDetail The data detail for this Stats Grid grouping. Only included if includeData is set to true on the Stats Grid.
dataType "accountability" The data type of this Stats Grid grouping.
stats Partial<Record<AccountabilityStatType, { color?: string; value?: string | number | Date | boolean; }>> The stat values for this stat grid grouping. May include a background color. Unlike custom values, the values provided must match the expected type (e.g. Mean must be a number).

AxisName

AxisName = XAxisName | YAxisName

AxisType

AxisType = "-" | "linear" | "log" | "date" | "category" | "multicategory"

BaseDrillDownInsight

BaseDrillDownInsight = object

Properties

Property Type Description
groupBy TraceabilityWithId | DrillDownInsightGroupByForInterchange Doc Field used to group this insight. Either a traceability internal ID or the string representation of a field, e.g. 'location'
type QuantitativeType Doc Whether this insight grouping is for a discrete field or a continuous traceability

BaseSharedDataChartColumnType

BaseSharedDataChartColumnType = "row" | "id" | "process" | "part" | "traceability" | "note" | "location" | "inspection" | "user"

ButtonDashboardItemWorkerGet

ButtonDashboardItemWorkerGet = object & DashboardItemWorkerGet

Type Declaration

Name Type Description
backgroundColor? string The background color of the button when it is not hovered. If not set, it will use the default button color of the application.
hoverColor? string The background color of the button when it is hovered. If not set, it will use the default button hover color of the application.
textColor? string The text color of the button. If not set, it will use the default button text color of the application.

ButtonDashboardItemWorkerUpdate

ButtonDashboardItemWorkerUpdate = object & DashboardItemWorkerUpdate

Type Declaration

Name Type Description
backgroundColor? string | null Change the background color of the button when it is not hovered. Set to null to revert to the default. This may be set to any valid HTML color.
hoverColor? string | null Change the background color of the button when it is hovered. Set to null to revert to the default. This may be set to any valid HTML color.
textColor? string | null Change the text color of the button. Set to null to revert to the default. This may be set to any valid HTML color.

Calendar

Calendar = "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura"

CanIncludeStatsBeforeDrawEventData

CanIncludeStatsBeforeDrawEventData<T> = object

Type Parameters

Type Parameter
T extends keyof StatsGridRetrievalData

Properties

Property Type Description
stats? StatsGridRetrievalData[T] An array of statistic details. Each item in this array corresponds to one graph on the chart.   Which statistics are calculated is determined by calling this chart's .updateProperties({ includeStats: [...] })   The Split By property of this chart determines how data is split into groups when calculating statistics. Each unique combination of values for all selected Split By fields will generate one item in this array.

ChartBeforeDrawEventData

ChartBeforeDrawEventData = DashboardItemEventData & object

Type Declaration

Name Type Description
plotlyData GraphData[] Plotly GraphData[] about to be drawn in the chart   Any changes to this object will be reflected in the chart when it draws

ChartCanIncludeAccountabilityStatsWorkerUpdate

ChartCanIncludeAccountabilityStatsWorkerUpdate = object

Properties

Property Type Description
includeStats? AccountabilityStatType[] | null Change which statistics will be retrieved and included in the arguments to this chart's beforeDraw()

ChartCanIncludeDataWorkerUpdate

ChartCanIncludeDataWorkerUpdate = object

Properties

Property Type Description
includeData? boolean Change whether or not data will be retrieved and included in the arguments to this chart's beforeDraw()

ChartCanIncludeDMSStatsWorkerUpdate

ChartCanIncludeDMSStatsWorkerUpdate = object

Properties

Property Type Description
includeStats? DMSStatType[] | null Change which statistics will be retrieved and included in the arguments to this chart's beforeDraw()

ChartCanIncludeOEEStatsWorkerUpdate

ChartCanIncludeOEEStatsWorkerUpdate = object

Properties

Property Type Description
includeStats? OEEStatType[] | null Change which statistics will be retrieved and included in the arguments to this chart's beforeDraw()

ChartCanIncludeSPCStatsWorkerUpdate

ChartCanIncludeSPCStatsWorkerUpdate = object

Properties

Property Type Description
includeStats? SPCStatType[] | null Change which statistics will be retrieved and included in the arguments to this chart's beforeDraw()

ChartCanIncludeTaskStatsWorkerUpdate

ChartCanIncludeTaskStatsWorkerUpdate = object

Properties

Property Type Description
includeStats? TaskStatType[] | null Change which statistics will be retrieved and included in the arguments to this chart's beforeDraw()

ChartWorkerGet

ChartWorkerGet = DashboardItemWorkerGet & object

ChartWorkerUpdate

ChartWorkerUpdate = DashboardItemWorkerUpdate & object

Color

Color = string | number | (string | number | undefined | null)[] | (string | number | undefined | null)[][]

ColorScale

ColorScale = string | string[] | [number, string][]

ContinuousFirstLevelDrillDownInsight

ContinuousFirstLevelDrillDownInsight = BaseDrillDownInsight & object

Type Declaration

Name Type Description
costRSquared? number Doc R² measure of how much variation can be explained by this independent variable using a linear regression. If set, then the cost was significantly impacted by this field.
costSlope? number Doc Slope of the best-fit line for cost regression. If set, then the cost was significantly impacted by this field.
costYIntercept? number Doc Y-Intercept of the best-fit line for cost regression. If set, then the cost was significantly impacted by this field.
defectRSquared? number Doc R² measure of how much variation can be explained by this independent variable using a linear regression. If set, then the defect count was significantly impacted by this field.
defectSlope? number Doc Slope of the best-fit line for defect count regression. If set, then the defect count was significantly impacted by this field.
defectYIntercept? number Doc Y-Intercept of the best-fit line for defect count regression. If set, then the defect count was significantly impacted by this field.
type "continuous" -

ControlChartBeforeDrawEventData

ControlChartBeforeDrawEventData = SPCChartBeforeDrawEventData & object

Type Declaration

Name Type Description
detail ControlDetail[] An array of control chart details. Each item in this array corresponds to one graph on the chart.   Each item in this array contains a .groups property, which has information about each group in that graph. Each group contains its limits and data points.   The Split By property of this chart determines how data is split into groups. Each unique combination of values for all selected Split By fields will generate one item in this array.

ControlChartGroupBy

ControlChartGroupBy = ControlGroupByForInterchangeType | number

ControlChartWorkerGet

ControlChartWorkerGet = SPCChartWorkerGet & object

Type Declaration

Name Type Description
detail? ControlDetail[] The current data used to draw the chart. Will be set to undefined if the chart has never been drawn, or if there was an error with the retrieval.
groupBy? ControlChartGroupBy Controls how the data on each graph should be grouped. Numbers are treated as Traceability IDs.
showControlLimits ControlLimitType Which type of control limit should be shown. When set to 'fixed', the control limits set on the Characteristic will be shown. When set to 'dynamic', the control limits will be calculated based on the previous data. When set to 'none', no control limits will be drawn.
showIndividualLimits boolean Whether or not individual limits are drawn.
showRangeChart boolean Whether to draw a range chart.
showSpecs boolean Whether or not specs are drawn.
showZoneColors ZoneColorType Which type of zone colors should be shown. When set to 'control', the zones will be based on the control limits. When set to 'spec', the zones will based on the characteristic's specs. When set to 'none', no zones will be drawn.

ControlChartWorkerUpdate

ControlChartWorkerUpdate = SPCChartWorkerUpdate & ChartCanIncludeSPCStatsWorkerUpdate & ChartCanIncludeDataWorkerUpdate & object

Type Declaration

Name Type Description
groupBy? ControlChartGroupBy | null Updates how the data on each graph should be grouped. Numbers are treated as Traceability IDs. If a number is provided which does not correspond to an existing Traceability ID, an error will be thrown.
showControlLimits? ControlLimitType Change how control limit are shown. When set to 'fixed', the control limits set on the Characteristic will be shown. When set to 'dynamic', the control limits will be calculated based on the previous data. When set to 'none', no control limits will be drawn.
showIndividualLimits? boolean Change whether or not individual limits are drawn.
showRangeChart? boolean Change whether the range chart will be drawn.
showSpecs? boolean Change whether or not specs are drawn.
showZoneColors? ZoneColorType Change how zone colors should be shown. When set to 'control', the zones will be based on the control limits. When set to 'spec', the zones will based on the characteristic's specs. When set to 'none', no zones will be drawn.

ControlDataPoint

ControlDataPoint = object

Properties

Property Type Description
dateTime Date Doc Date and time of the data point
id? number Doc Internal ID of the data point
isTempPoint? boolean Doc Whether this data point is a temporary point added to a chart in an inspection. For internal use only.
mean? number Doc Average of the values of this data point (i.e. x-bar)
note? string Doc Note associated with this data point
range? number Doc Range of the values of this data point
rtfs? SPCRTFReportForInterchange Doc Information about the real-time failures associated with this data point
stdDev? number Doc Standard deviation of the values of this data point

ControlDetail

ControlDetail = BaseSPCDetail & object

Type Declaration

Name Type Description
groups ControlDetailGroup[] Doc The groups of the graph, determined by this chart's Group By
rangeType RangeType Doc Range type of the graph

ControlDetailGroup

ControlDetailGroup = object

Properties

Property Type Description
data ControlDataPoint[] Doc Array of data points
key? number | number | string | boolean | Date Doc Value used for this group
lclR? number Doc R Lower control limit of this group
lclX? number Doc X Lower control limit of this group
mean? number Doc Average of this group's subgroups (i.e. x-double-bar)
rBar? number Doc Average of this group's ranges
uclR? number Doc R Upper control limit of this group
uclX? number Doc X Upper control limit of this group

ControlGroupByForInterchangeType

ControlGroupByForInterchangeType = "anchorPoint" | "location" | "testLabel" | "user" | "inspection"

ControlLimitType

ControlLimitType = "fixed" | "dynamic" | "none"

CurvePoint

CurvePoint = object

Properties

Property Type Description
x number Doc Point's x value
y number Doc Point's y value

Dash

Dash = "solid" | "dot" | "dash" | "longdash" | "dashdot" | "longdashdot"

Dash

Dash = "solid" | "dot" | "dash" | "longdash" | "dashdot" | "longdashdot"

DashboardItemEventData

DashboardItemEventData = object

Properties

Property Type Description
itemType DashboardItemType The type of the item
scriptId string The scriptId of the item

DashboardItemWorkerGet

DashboardItemWorkerGet = object

Properties

Property Type Description
label string The text that accompanies the dashboard item.

DashboardItemWorkerUpdate

DashboardItemWorkerUpdate = object

Properties

Property Type Description
label? string Change the text that accompanies the dashboard item.

Data

Data = Partial<PlotData> | Partial<BoxPlotData> | Partial<ViolinData> | Partial<OhlcData> | Partial<CandlestickData> | Partial<PieData> | Partial<SankeyData>

DataChartColumn

DataChartColumn<T> = object

Type Parameters

Type Parameter Default type
T extends DataChartColumnType DataChartColumnType

Properties

Property Type
id? number
type T

DataChartColumnType

DataChartColumnType = SPCDataChartColumnType | DMSDataChartColumnType | OEEDataChartColumnType | TaskDataChartColumnType | AccountabilityDataChartColumnType

DataChartColumnWorker

DataChartColumnWorker<T> = T & object

Type Declaration

Name Type
type Exclude<T["type"], "id">

Type Parameters

Type Parameter Default type
T extends DataChartColumn DataChartColumn

Datum

Datum = string | number | Date | null

DiscreteFirstLevelDrillDownInsight

DiscreteFirstLevelDrillDownInsight = BaseDrillDownInsight & object

Type Declaration

Name Type Description
costPerUnit? number Doc If set, then the cost was significantly different from the mean. This is the value of the bar with the largest difference from the mean.
costPerUnitGroupByValue? number | number | string | boolean | Date Doc Internal ID of the part, process, etc.; or the string traceability value
meanCostPerUnit? number Doc The average cost per sample for the entire data set
meanPercentDefects? number Doc The average percentage of defects for the entire data set
percentDefects? number Doc If set, then the percent defects was significantly different from the mean. This is the value of the bar with the largest difference from the mean.
percentDefectsGroupByValue? number | number | string | boolean | Date Doc Internal ID of the part, process, etc.; or the string traceability value
type "discrete" -

DMSChartBeforeDrawEventData

DMSChartBeforeDrawEventData = ChartBeforeDrawEventData & CanIncludeStatsBeforeDrawEventData<"dms"> & object

Type Declaration

Name Type Description
data? DMSDataDetail[] An array of data details. Each item in this array corresponds to one graph on the chart.   This array will only be populated by calling this chart's .updateProperties({ includeData: true })   The Split By property of this chart determines how data is split into groups. Each unique combination of values for all selected Split By fields will generate one item in this array.

DMSDataChartBeforeDrawEventData

DMSDataChartBeforeDrawEventData = DashboardItemEventData & CanIncludeStatsBeforeDrawEventData<"dms"> & object

Type Declaration

Name Type Description
columns DMSDataChartColumnWorker[] The current columns drawn in the table. Will only contain an id field if type is set to traceability, in which case the id field is the Traceability ID.
data DMSDataDetail[] The current data used in the table.

DMSDataChartColumn

DMSDataChartColumn = DataChartColumn<DMSDataChartColumnType>

DMSDataChartColumnType

DMSDataChartColumnType = SharedDataChartColumnTypeWithRTFs | "sampleSize" | "ncu" | "sumGood" | "sumDefects" | "percentDefects" | "defects" | "testLabel" | "date"

DMSDataChartColumnWorker

DMSDataChartColumnWorker = DataChartColumnWorker<DMSDataChartColumn>

DMSDataChartWorkerGet

DMSDataChartWorkerGet = NonSPCChartWorkerGet & object

Type Declaration

Name Type Description
columns DMSDataChartColumnWorker[] The current columns drawn in the table. Will only contain an id field if type is set to traceability, in which case the id field is the Traceability ID.
data? DMSDataDetail[] The current data used in the table. Will be set to undefined if the table has never been drawn, or if there was an error with the retrieval.

DMSDataChartWorkerUpdate

DMSDataChartWorkerUpdate = NonSPCChartWorkerUpdate & ChartCanIncludeDMSStatsWorkerUpdate & object

Type Declaration

Name Type Description
columns? DMSDataChartColumnWorker[] | null Updates the current columns drawn in the table. May only contain an id field if type is set to traceability, in which case the id field is the Traceability ID. When unset, it will revert to the default columns.

DMSStatsDetail

DMSStatsDetail = BaseDetail & object

Type Declaration

Name Type Description
stats DMSStatValues Doc Calculated statistics

DMSStatsGridValue

DMSStatsGridValue = object

Properties

Property Type Description
data? DMSDataDetail The data detail for this Stats Grid grouping. Only included if includeData is set to true on the Stats Grid.
dataType "dms" The data type of this Stats Grid grouping.
stats Partial<Record<DMSStatType, { color?: string; value?: string | number | Date | boolean; }>> The stat values for this stat grid grouping. May include a background color. Unlike custom values, the values provided must match the expected type (e.g. Mean must be a number).

DMSTrendChartBeforeDrawEventData

DMSTrendChartBeforeDrawEventData = DMSChartBeforeDrawEventData & object

Type Declaration

Name Type Description
detail DMSTrendDetail[] An array of trend chart details. Each item in this array corresponds to one graph on the chart.   Each item in this array contains a .groups property, which has information about each data point in that graph.   The Split By property of this chart determines how data is split into groups. Each unique combination of values for all selected Split By fields will generate one item in this array.

DMSTrendChartWorkerGet

DMSTrendChartWorkerGet = NonSPCChartWorkerGet & object

Type Declaration

Name Type Description
detail? DMSTrendDetail[] The current data used to draw the chart. Will be set to undefined if the chart has never been drawn, or if there was an error with the retrieval.
groupBy? TrendGroupBy How the data set is grouped on the chart, drawing a separate line for each group. Numbers are treated as Traceability IDs. For example, grouping by 'process' will draw a separate line for each process in the data set.
groupByTime TimeGroupByType The time period to aggregate the graph over.
trendMethod DMSTrendMethodType The type of trend which will be graphed on the Y-Axis. For example, a trend method of DPM will produce a graph of DPM over time.

DMSTrendChartWorkerUpdate

DMSTrendChartWorkerUpdate = NonSPCChartWorkerUpdate & ChartCanIncludeDMSStatsWorkerUpdate & ChartCanIncludeDataWorkerUpdate & object

Type Declaration

Name Type Description
groupBy? TrendGroupBy | null Updates how the data set is grouped on the chart, drawing a separate line for each group. Use null to unset. Numbers are treated as Traceability IDs. For example, grouping by 'process' will draw a separate line for each process in the data set.
groupByTime? TimeGroupByType Updates the time period to aggregate the graph over.
trendMethod? DMSTrendMethodType Updates the type of trend which will be graphed on the Y-Axis. For example, a trend method of DPM will produce a graph of DPM over time.

DMSTrendDetail

DMSTrendDetail = BaseDetail & object

Type Declaration

Name Type Description
groups DMSTrendDetailGroup[] Doc Information about each data point in the graph

DMSTrendDetailGroup

DMSTrendDetailGroup = object

Properties

Property Type Description
dpm number Doc Defects per million units of this data point
key Date | number Doc Group By Time date/time, day of week, or hour of day for this data point
ppm number Doc Non-conforming units per million of this data point
secondaryKey? number | number | string | boolean | Date Doc If set, the value of the Group By for this data point
sumDefectCost number Doc Total defect cost of this data point
sumDefects number Doc Total defect count of this data point
sumNCU number Doc Total non-conforming units of this data point
sumSampleSize number Doc Total sample size of this data point
yield number Doc Yield (i.e. the percentage of conforming units) of this data point

DMSTrendMethodType

DMSTrendMethodType = "dpm" | "ppm" | "yield"

DrillDownInsightGroupByForInterchange

DrillDownInsightGroupByForInterchange = object

Properties

Property Type Description
type DrillDownInsightGroupByForInterchangeType Doc Field used to group this insight

DrillDownInsightGroupByForInterchangeType

DrillDownInsightGroupByForInterchangeType = "location" | "testLabel" | "part" | "process" | "user" | "inspection"

DTickValue

DTickValue = number | string

ErrorBar

ErrorBar = Partial<ErrorOptions> & { type: "constant" | "percent"; value: number; valueminus?: number; } | { array: Datum[]; arrayminus?: Datum[]; type: "data"; }

Exclude

Exclude<T, U> = T extends U ? never : T

Exclude from T those types that are assignable to U

Type Parameters

Type Parameter
T
U

GraphData

GraphData = object

Properties

Property Type Description
data Data[] A list of Plotly Data Traces (https://plotly.com/javascript/reference/).
layout Partial<Layout> A Plotly Layout (https://plotly.com/javascript/reference/layout/) object.

HistogramChartBeforeDrawEventData

HistogramChartBeforeDrawEventData = SPCChartBeforeDrawEventData & object

Type Declaration

Name Type Description
detail HistogramDetail[] An array of histogram details. Each item in this array corresponds to one graph on the chart.   Each item in this array describes the bars, counts, and curve used to draw the histogram.   The Split By property of this chart determines how data is split into groups. Each unique combination of values for all selected Split By fields will generate one item in this array.

HistogramChartWorkerGet

HistogramChartWorkerGet = SPCChartWorkerGet & object

Type Declaration

Name Type Description
detail? HistogramDetail[] The current data used to draw the chart. Will be set to undefined if the chart has never been drawn, or if there was an error with the retrieval.
showSpecs boolean Whether spec lines are drawn on the chart.

HistogramChartWorkerUpdate

HistogramChartWorkerUpdate = SPCChartWorkerUpdate & ChartCanIncludeSPCStatsWorkerUpdate & ChartCanIncludeDataWorkerUpdate & object

Type Declaration

Name Type Description
showSpecs? boolean Updates whether spec lines are drawn on the chart.

HistogramDetail

HistogramDetail = BaseSPCDetail & object

Type Declaration

Name Type Description
barCounts number[] Doc Array of counts for each bar in the graph, starting from .start and ending with .end
barWidth number Doc The width of each bar in the graph
curve? CurvePoint[] Doc Points describing the curve fitted to the histogram. See .distribution for the distribution of this curve
distribution SPCDistributionType Doc Calculated distribution of the data
end number Doc Greatest X value of the graph
start number Doc Lowest X value of the graph

HoverInfo

HoverInfo = "x" | "y" | "z" | "text" | "name" | "x+y" | "x+z" | "x+text" | "x+name" | "y+z" | "y+text" | "y+name" | "z+text" | "z+name" | "x+y+z" | "x+y+text" | "x+y+name" | "y+z+text" | "y+z+name" | "z+text+name" | "all" | "none" | "skip"

LabelDashboardItemWorkerGet

LabelDashboardItemWorkerGet = Omit<DashboardItemWorkerGet, "label"> & object

Type Declaration

Name Type Description
content string The content of the label.

LabelDashboardItemWorkerUpdate

LabelDashboardItemWorkerUpdate = Omit<DashboardItemWorkerUpdate, "label"> & object

Type Declaration

Name Type Description
content? string Change the content of the label.

MarkerSymbol

MarkerSymbol = string | number | (string | number)[]

ModeBarDefaultButtons

ModeBarDefaultButtons = "lasso2d" | "select2d" | "sendDataToCloud" | "zoom2d" | "pan2d" | "zoomIn2d" | "zoomOut2d" | "autoScale2d" | "resetScale2d" | "hoverClosestCartesian" | "hoverCompareCartesian" | "zoom3d" | "pan3d" | "orbitRotation" | "tableRotation" | "handleDrag3d" | "resetCameraDefault3d" | "resetCameraLastSave3d" | "hoverClosest3d" | "zoomInGeo" | "zoomOutGeo" | "resetGeo" | "hoverClosestGeo" | "hoverClosestGl2d" | "hoverClosestPie" | "toggleHover" | "toImage" | "resetViews" | "toggleSpikelines" | "zoomInMap" | "zoomInMapbox" | "zoomOutMap" | "zoomOutMapbox" | "resetViewMap" | "resetViewMapbox" | "togglespikelines" | "togglehover" | "hovercompare" | "hoverclosest" | "v1hovermode"

NonSPCChartWorkerGet

NonSPCChartWorkerGet = ChartWorkerGet & object

Type Declaration

Name Type Description
splitBy NonSPCSplitBy[] Controls how the chart will be split into separately rendered graphs. For example, when set to ['process', 'part'], a separate graph will be drawn for each Process / Part combination.

NonSPCChartWorkerUpdate

NonSPCChartWorkerUpdate = ChartWorkerUpdate & object

Type Declaration

Name Type Description
splitBy? NonSPCSplitBy[] Controls how the chart will be split into separately rendered graphs. For example, when set to ['process', 'part'], a separate graph will be drawn for each Process / Part combination.

NonSPCSplitBy

NonSPCSplitBy = "part" | "process"

OEEChartBeforeDrawEventData

OEEChartBeforeDrawEventData = ChartBeforeDrawEventData & CanIncludeStatsBeforeDrawEventData<"oee"> & object

Type Declaration

Name Type Description
data? OEEDataDetail[] An array of data details. Each item in this array corresponds to one graph on the chart.   This array will only be populated by calling this chart's .updateProperties({ includeData: true })   The Split By property of this chart determines how data is split into groups. Each unique combination of values for all selected Split By fields will generate one item in this array.
detail OEEDetail[] An array of OEE chart details. Each item in this array corresponds to one graph on the chart.   Each item in this array contains a .groups property, which has information about each data point in that graph (or bar, if the chart is not grouped by time).   The Split By property of this chart determines how data is split into groups. Each unique combination of values for all selected Split By fields will generate one item in this array.

OEEChartWorkerGet

OEEChartWorkerGet = NonSPCChartWorkerGet & object

Type Declaration

Name Type Description
detail? OEEDetail[] The current data used to draw the chart. Will be set to undefined if the chart has never been drawn, or if there was an error with the retrieval.
factors OEEFactorType[] Which OEE factors to show. A separate graph will be drawn for each factor.
groupBy? TrendGroupBy How the data should be grouped within each graph. If groupByTime is set, a separate line will be drawn for each group. If groupByTime is not set, a separate bar will be drawn for each group. Numbers are treated as Traceability IDs. If a number is provided which does not correspond to an existing Traceability ID, an error will be thrown.
groupByTime? TimeGroupByType The time period to aggregate the graph over. If set, the data will be plotted as a time series with a line chart. If not set, the data will be plotted on a bar chart.

OEEChartWorkerUpdate

OEEChartWorkerUpdate = NonSPCChartWorkerUpdate & ChartCanIncludeOEEStatsWorkerUpdate & ChartCanIncludeDataWorkerUpdate & object

Type Declaration

Name Type Description
factors? OEEFactorType[] Updates which OEE factors to show. A separate graph will be drawn for each factor.
groupBy? TrendGroupBy | null Updates how the data should be grouped within each graph. If groupByTime is set, a separate line will be drawn for each group. If groupByTime is not set, a separate bar will be drawn for each group. Numbers are treated as Traceability IDs. If a number is provided which does not correspond to an existing Traceability ID, an error will be thrown.
groupByTime? TimeGroupByType | null Updates time period to aggregate the graph over. If set, the data will be plotted as a time series with a line chart. If not set, the data will be plotted on a bar chart.

OEEDataChartBeforeDrawEventData

OEEDataChartBeforeDrawEventData = DashboardItemEventData & CanIncludeStatsBeforeDrawEventData<"oee"> & object

Type Declaration

Name Type Description
columns OEEDataChartColumnWorker[] The current columns drawn in the table. Will only contain an id field if type is set to traceability, in which case the id field is the Traceability ID.
data OEEDataDetail[] The current data used in the table.

OEEDataChartColumn

OEEDataChartColumn = DataChartColumn<OEEDataChartColumnType>

OEEDataChartColumnType

OEEDataChartColumnType = SharedDataChartColumnTypeWithRTFs | "availableTime" | "scheduledTime" | "goodParts" | "totalParts" | "cycleTime" | "availability" | "performance" | "quality" | "oee" | "testLabel" | "date"

OEEDataChartColumnWorker

OEEDataChartColumnWorker = DataChartColumnWorker<OEEDataChartColumn>

OEEDataChartWorkerGet

OEEDataChartWorkerGet = NonSPCChartWorkerGet & object

Type Declaration

Name Type Description
columns OEEDataChartColumnWorker[] The current columns drawn in the table. Will only contain an id field if type is set to traceability, in which case the id field is the Traceability ID.
data? OEEDataDetail[] The current data used in the table. Will be set to undefined if the table has never been drawn, or if there was an error with the retrieval.

OEEDataChartWorkerUpdate

OEEDataChartWorkerUpdate = NonSPCChartWorkerUpdate & ChartCanIncludeOEEStatsWorkerUpdate & object

Type Declaration

Name Type Description
columns? OEEDataChartColumnWorker[] | null Updates the current columns drawn in the table. May only contain an id field if type is set to traceability, in which case the id field is the Traceability ID. When unset, it will revert to the default columns.

OEEDetail

OEEDetail = BaseDetail & object

Type Declaration

Name Type Description
groups OEEDetailGroup[] Doc Information about each data point in the graph

OEEDetailGroup

OEEDetailGroup = object

Properties

Property Type Description
availability? number Doc Calculated availability of the records in this point.
key number | number | string | boolean | Date Doc If Group By Time is set, the time's display name for this data point. Otherwise if Group By is set, the grouping's display name or internal ID of the entity for this data point. Otherwise empty.
oee? number Doc Calculated OEE of the records in this point.
performance? number Doc Calculated performance of the records in this point.
quality? number Doc Calculated quality of the records in this point.
secondaryKey? number | number | string | boolean | Date Doc If Group By Time and Group By is set, the grouping's display name or internal ID of the entity for this data point. Otherwise empty.
sumAvailableTime? number Doc Sum of available time of the records in this point.
sumDowntime? number Doc Sum of downtime of the records in this point.
sumGoodParts? number Doc Sum of good parts of the records in this point.
sumScheduledTime? number Doc Sum of scheduled time of the records in this point.
sumTotalParts? number Doc Sum of total parts of the records in this point.

OEEFactorType

OEEFactorType = "availability" | "quality" | "performance" | "oee"

OEEStatsDetail

OEEStatsDetail = BaseDetail & object

Type Declaration

Name Type Description
stats OEEStatValues Doc Calculated statistics

OEEStatsGridValue

OEEStatsGridValue = object

Properties

Property Type Description
data? OEEDataDetail The data detail for this Stats Grid grouping. Only included if includeData is set to true on the Stats Grid.
dataType "oee" The data type of this Stats Grid grouping.
stats Partial<Record<OEEStatType, { color?: string; value?: string | number | Date | boolean; }>> The stat values for this stat grid grouping. May include a background color. Unlike custom values, the values provided must match the expected type (e.g. Mean must be a number).

Omit

Omit<T, K> = Pick<T, Exclude<keyof T, K>>

Construct a type with the properties of T except for those in type K.

Type Parameters

Type Parameter
T
K extends keyof any

ParetoBarMethodType

ParetoBarMethodType = "defectPctOfDefects" | "defectPctOfSampleSize" | "costPctOfDefects" | "costPctOfTotalCost" | "sigma" | "ppm" | "dpm" | "costPerUnit"

ParetoChartBeforeDrawEventData

ParetoChartBeforeDrawEventData = DMSChartBeforeDrawEventData & object

Type Declaration

Name Type Description
detail ParetoDetail[] An array of Pareto chart details. Each item in this array corresponds to one graph on the chart.   Each item in this array describes the bars and counts used to draw the Pareto chart.   The Split By property of this chart determines how data is split into groups. Each unique combination of values for all selected Split By fields will generate one item in this array.

ParetoChartWorkerGet

ParetoChartWorkerGet = NonSPCChartWorkerGet & object

Type Declaration

Name Type Description
barMethod ParetoBarMethodType The method used to draw bars on the graph.
detail? ParetoDetail[] The current data used to draw the chart. Will be set to undefined if the chart has never been drawn, or if there was an error with the retrieval.
groupBy ParetoGroupBy How the data should be grouped into bars on the graph. For example, if 'process' is set, each graph will contain one bar for each Process in the data set.

ParetoChartWorkerUpdate

ParetoChartWorkerUpdate = NonSPCChartWorkerUpdate & ChartCanIncludeDMSStatsWorkerUpdate & ChartCanIncludeDataWorkerUpdate & object

Type Declaration

Name Type Description
barMethod? ParetoBarMethodType Update the method used to draw bars on the graph.
groupBy? ParetoGroupBy Update how the data should be grouped into bars on the graph. For example, if 'process' is set, each graph will contain one bar for each Process in the data set.

ParetoDetail

ParetoDetail = BaseDetail & object

Type Declaration

Name Type Description
drillDownInsights? (DiscreteFirstLevelDrillDownInsight | ContinuousFirstLevelDrillDownInsight)[] Doc First-level drill-down insights
groups ParetoDetailGroup[] Doc An array of information about each bar of the Pareto graph

ParetoDetailGroup

ParetoDetailGroup = object

Properties

Property Type Description
costPerUnit number Doc Bar's average cost per unit
dpm? number Doc Bar's defects per million units
key number | number | string | boolean | Date Doc Bar's display name, or internal ID of the entity for that bar
percentNCUOfSampleSize number Doc Bar's percent of non-conforming units to the total non-conforming units. Used to draw the summary line on a Pareto graph.
percentOfAllDefects? number Doc Bar's percent of defects to the total sum of defects. Used to draw the summary line on a Pareto graph.
percentOfDefectCost? number Doc Bar's percent of defect cost to the total defect cost. Used to draw the summary line on a Pareto graph.
percentOfSampleSize number Doc Bar's percent of defects to the total sample size. Used to draw the summary line on a Pareto graph.
percentOfTotalCost? number Doc Bar's percent of defect cost to the total cost of the data set (i.e. if 100% of the sample size were defects). Used to draw the summary line on a Pareto graph.
ppm? number Doc Bar's non-conforming units per million
sigma? number Doc Bar's sigma value
sumDefectCost number Doc Bar's total defect cost
sumDefects number Doc Bar's total defects
sumNCU number Doc Bar's total non-conforming units

ParetoGroupBy

ParetoGroupBy = ParetoGroupByForInterchangeType | number

ParetoGroupByForInterchangeType

ParetoGroupByForInterchangeType = "part" | "process" | "location" | "testLabel" | "defect" | "user" | "inspection"

Partial

Partial<T> = { [P in keyof T]?: T[P] }

Make all properties in T optional

Type Parameters

Type Parameter
T

Pick

Pick<T, K> = { [P in K]: T[P] }

From T, pick a set of properties whose keys are in the union K

Type Parameters

Type Parameter
T
K extends keyof T

PieColor

PieColor = string | number

PieColors

PieColors = (PieColor | null | undefined)[]

PieHoverInfo

PieHoverInfo = "all" | "none" | "skip" | "label" | "text" | "value" | "percent" | "name" | "label+text" | "label+value" | "label+percent" | "label+name" | "text+value" | "text+percent" | "text+name" | "value+percent" | "value+name" | "percent+name" | "label+text+value" | "label+text+percent" | "label+text+name" | "label+value+percent" | "label+value+name" | "label+percent+name" | "text+value+percent" | "text+value+name" | "text+percent+name" | "value+percent+name" | "label+text+value+percent" | "label+text+value+name" | "label+text+percent+name" | "label+value+percent+name" | "text+value+percent+name"

PieInsideTextOrientation

PieInsideTextOrientation = "horizontal" | "radial" | "tangential" | "auto"

PieTextPosition

PieTextPosition = "inside" | "outside" | "auto" | "none"

PlotType

PlotType = "bar" | "barpolar" | "box" | "candlestick" | "carpet" | "choropleth" | "choroplethmap" | "choroplethmapbox" | "cone" | "contour" | "contourcarpet" | "densitymap" | "densitymapbox" | "funnel" | "funnelarea" | "heatmap" | "histogram" | "histogram2d" | "histogram2dcontour" | "image" | "indicator" | "isosurface" | "mesh3d" | "ohlc" | "parcats" | "parcoords" | "pie" | "sankey" | "scatter" | "scatter3d" | "scattercarpet" | "scattergeo" | "scattergl" | "scattermap" | "scattermapbox" | "scatterpolar" | "scatterpolargl" | "scatterternary" | "splom" | "streamtube" | "sunburst" | "surface" | "table" | "treemap" | "violin" | "volume" | "waterfall"

Record

Record<K, T> = { [P in K]: T }

Construct a type with a set of properties K of type T

Type Parameters

Type Parameter
K extends keyof any
T

SankeyColor

SankeyColor = string | number

SankeyColors

SankeyColors = (SankeyColor | null | undefined)[]

SankeyOrientation

SankeyOrientation = "v" | "h"

ScriptedChartClickEventData

ScriptedChartClickEventData = object & DashboardItemEventData

Type Declaration

Name Type Description
event Omit<PlotDatum, "xaxis" | "yaxis">[] The click event from plotly
graphIndex number The index of the graph that was clicked

SharedDataChartColumnTypeWithRTFs

SharedDataChartColumnTypeWithRTFs = BaseSharedDataChartColumnType | "rtfs"

SPCChartBeforeDrawEventData

SPCChartBeforeDrawEventData = ChartBeforeDrawEventData & CanIncludeStatsBeforeDrawEventData<"spc"> & object

Type Declaration

Name Type Description
data? SPCDataDetail[] An array of data details. Each item in this array corresponds to one graph on the chart.   This array will only be populated by calling this chart's .updateProperties({ includeData: true })   The Split By property of this chart determines how data is split into groups. Each unique combination of values for all selected Split By fields will generate one item in this array.

SPCChartWorkerGet

SPCChartWorkerGet = ChartWorkerGet & object

Type Declaration

Name Type Description
splitBy SplitBy[] Controls how the chart will be split into separately rendered graphs. Numbers are treated as Traceability IDs. For example, when set to ['process', 3], given that the Traceability with ID 3 is "Shift", a separate graph will be drawn for each Process / Shift combination.

SPCChartWorkerUpdate

SPCChartWorkerUpdate = ChartWorkerUpdate & object

Type Declaration

Name Type Description
splitBy? SplitBy[] Update how the chart will be split into separately rendered graphs. Numbers are treated as Traceability IDs. For example, when set to ['process', 3], given that the Traceability with ID 3 is "Shift", a separate graph will be drawn for each Process / Shift combination.

SPCDataChartBeforeDrawEventData

SPCDataChartBeforeDrawEventData = DashboardItemEventData & CanIncludeStatsBeforeDrawEventData<"spc"> & object

Type Declaration

Name Type Description
columns SPCDataChartColumnWorker[] The current columns drawn in the table. Will only contain an id field if type is set to traceability, in which case the id field is the Traceability ID.
data SPCDataDetail[] The current data used in the table.

SPCDataChartColumn

SPCDataChartColumn = DataChartColumn<SPCDataChartColumnType>

SPCDataChartColumnType

SPCDataChartColumnType = SharedDataChartColumnTypeWithRTFs | "data" | "mean" | "range" | "characteristic" | "testLabel" | "date"

SPCDataChartColumnWorker

SPCDataChartColumnWorker = DataChartColumnWorker<SPCDataChartColumn>

SPCDataChartWorkerGet

SPCDataChartWorkerGet = SPCChartWorkerGet & object

Type Declaration

Name Type Description
columns? SPCDataChartColumnWorker[] The current columns drawn in the table. Will only contain an id field if type is set to traceability, in which case the id field is the Traceability ID.
data? SPCDataDetail[] The current data used in the table. Will be set to undefined if the table has never been drawn, or if there was an error with the retrieval.

SPCDataChartWorkerUpdate

SPCDataChartWorkerUpdate = SPCChartWorkerUpdate & ChartCanIncludeSPCStatsWorkerUpdate & object

Type Declaration

Name Type Description
columns? SPCDataChartColumnWorker[] | null Updates the current columns drawn in the table. May only contain an id field if type is set to traceability, in which case the id field is the Traceability ID. When unset, it will revert to the default columns.

SPCStatsDetail

SPCStatsDetail = BaseSPCDetail & object

Type Declaration

Name Type Description
stats SPCStatValues Doc Calculated statistics

SPCStatsGridValue

SPCStatsGridValue = object

Stats Grid Before Draw Types

Properties

Property Type Description
characteristic SingleSPCCharacteristicRevision The SPC Characteristic applied to this Stats Grid grouping. May be an auto-generated short run SPC Characteristic.
data? SPCDataDetail The data detail for this Stats Grid grouping. Only included if includeData is set to true on the Stats Grid.
dataType "spc" The data type of this Stats Grid grouping.
stats Partial<Record<SPCStatType, { color?: string; value?: string | number | Date | boolean; }>> The stat values for this stat grid grouping. May include a background color. Unlike custom values, the values provided must match the expected type (e.g. Mean must be a number).

SplitBy

SplitBy = SplitByForInterchangeType | number

splitByKeyType

splitByKeyType = object

Properties

Property Type Description
splitByKey string INTERNAL USE ONLY. Pipe-concatenated string of the unique combination of Split By values. Used internally to determine whether two details are equal.

SplitByValue

SplitByValue = SplitByNonTraceabilityValue | SplitByTraceabilityValue

StatsGridBeforeDrawEventData

StatsGridBeforeDrawEventData = DashboardItemEventData & object

Type Declaration

Name Type Description
customColumns string[] Any custom columns for this Stats Grid.
groupColumns SplitBy[] The columns used to group this Stats Grid.
rows object[] The rows to be drawn for this Stats Grid. values and customValues may be modified in order to update how the Stats Grid is drawn.
valueColumns WorkerStatsGridValueColumn[] The value columns (each corresponding to a particular stat in a retrieval) used to draw this Stats Grid.

StatsGridChartWorkerGet

StatsGridChartWorkerGet = ChartWorkerGet & object

Type Declaration

Name Type Description
customColumns WorkerStatsGridCustomColumn[] Columns used to display custom values in this Stats Grid
data Record<string, StatsGridRetrievalData> Key is the Retrieval's script ID, Value is a record of data type -> stats response
groupColumns SplitBy[] Columns used to group statistics in this Stats Grid
valueColumns WorkerStatsGridValueColumn[] Columns used to display statistics in this Stats Grid

StatsGridChartWorkerUpdate

StatsGridChartWorkerUpdate = ChartWorkerUpdate & object

Type Declaration

Name Type Description
customColumns? WorkerStatsGridCustomColumn[] Change the columns used to display custom values in this table
groupColumns? SplitBy[] Change the columns used to group statistics in this Stats Grid
includeData? boolean Change whether or not data will be included when calling onBeforeDraw
valueColumns? WorkerStatsGridValueColumn[] Change the columns used to display statistics in this Stats Grid

StatsGridColumnColorFilter

StatsGridColumnColorFilter = object

Properties

Property Type Description
color string The background color to apply to a cell. The foreground color is calculated automatically to maximize legibility for given background.
expression FilterExpression If the expression condition matches the value of a stats grid cell, the cell will be colored appropriately.

StatsGridCustomColumn

StatsGridCustomColumn = object

Properties

Property Type Description
heading string The column heading that will be displayed to the user.
id string The ID of the column, used to reference this column when writing scripts.
type "custom" -

StatsGridRetrievalData

StatsGridRetrievalData = object

Properties

Property Type
accountability? splitByKeyType & AccountabilityStatsDetail[]
dms? splitByKeyType & DMSStatsDetail[]
oee? splitByKeyType & OEEStatsDetail[]
spc? splitByKeyType & SPCStatsDetail[]
task? splitByKeyType & TaskStatsDetail[]

StatsGridValueColumn

StatsGridValueColumn = object & { dataType: "spc"; stat: SPCStatType; } | { dataType: "dms"; stat: DMSStatType; } | { dataType: "oee"; stat: OEEStatType; } | { dataType: "task"; stat: TaskStatType; } | { dataType: "accountability"; stat: AccountabilityStatType; }

Type Declaration

Name Type Description
colorFilters? StatsGridColumnColorFilter[] Filters used to modify the background color of cells. If multiple filters match for a given cell, the cell will be colored based on the first matching filter.
hidden boolean Whether or not this column will be shown to the user. Useful for columns which are used in calculations, but do not need to be visible to the user.
retrieval string The retrieval used to generate stats for this column.
type "value" -

StatsGridValues

StatsGridValues = object & SPCStatsGridValue | DMSStatsGridValue | OEEStatsGridValue | TaskStatsGridValue | AccountabilityStatsGridValue

Type Declaration

Name Type
retrievalId string

TaskDataChartBeforeDrawEventData

TaskDataChartBeforeDrawEventData = DashboardItemEventData & object

Type Declaration

Name Type Description
columns TaskDataChartColumnWorker[] The current columns drawn in the table. Will only contain an id field if type is set to traceability, in which case the id field is the Traceability ID.
data TaskDataDetail[] The current data used in the table.

TaskDataChartColumn

TaskDataChartColumn = DataChartColumn<TaskDataChartColumnType>

TaskDataChartColumnType

TaskDataChartColumnType = BaseSharedDataChartColumnType | "description" | "signOffUser" | "testLabel" | "date"

TaskDataChartColumnWorker

TaskDataChartColumnWorker = DataChartColumnWorker<TaskDataChartColumn>

TaskDataChartWorkerGet

TaskDataChartWorkerGet = NonSPCChartWorkerGet & object

Type Declaration

Name Type Description
columns TaskDataChartColumnWorker[] The current columns drawn in the table. Will only contain an id field if type is set to traceability, in which case the id field is the Traceability ID.
data? TaskDataDetail[] The current data used in the table. Will be set to undefined if the table has never been drawn, or if there was an error with the retrieval.

TaskDataChartWorkerUpdate

TaskDataChartWorkerUpdate = NonSPCChartWorkerUpdate & ChartCanIncludeTaskStatsWorkerUpdate & object

Type Declaration

Name Type Description
columns? TaskDataChartColumnWorker[] | null Updates the current columns drawn in the table. May only contain an id field if type is set to traceability, in which case the id field is the Traceability ID. When unset, it will revert to the default columns.

TaskStatsDetail

TaskStatsDetail = BaseDetail & object

Type Declaration

Name Type Description
stats TaskStatValues Doc Calculated statistics

TaskStatsGridValue

TaskStatsGridValue = object

Properties

Property Type Description
data? TaskDataDetail The data detail for this Stats Grid grouping. Only included if includeData is set to true on the Stats Grid.
dataType "task" The data type of this Stats Grid grouping.
stats Partial<Record<TaskStatType, { color?: string; value?: string | number | Date | boolean; }>> The stat values for this stat grid grouping. May include a background color. Unlike custom values, the values provided must match the expected type (e.g. Mean must be a number).

TimeGroupByType

TimeGroupByType = "hour" | "hourOfDay" | "day" | "dayOfWeek" | "week" | "month" | "year" | "quarter"

TrendGroupBy

TrendGroupBy = TrendGroupByForInterchangeType | number

TrendGroupByForInterchangeType

TrendGroupByForInterchangeType = "part" | "process" | "location" | "testLabel" | "user" | "inspection"

TypedArray

TypedArray = Int8Array | Uint8Array | Int16Array | Uint16Array | Int32Array | Uint32Array | Uint8ClampedArray | Float32Array | Float64Array

WorkerStatsGridCustomColumn

WorkerStatsGridCustomColumn = Omit<StatsGridCustomColumn, "type">

WorkerStatsGridValueColumn

WorkerStatsGridValueColumn = Omit<StatsGridValueColumn, "type">

XAxisName

XAxisName = `x${xYAxisNames}`

XCalendar

XCalendar = "gregorian" | "chinese" | "coptic" | "discworld" | "ethiopian" | "hebrew" | "islamic" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "jalali" | "taiwan" | "thai" | "ummalqura"

xYAxisNames

xYAxisNames = `\(\{"" \| \`\){2 | 3 | 4 | 5 | 6 | 7 | 8 | 9}` | `\(\{1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9\}\){0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9}`}${"" | " domain"}`

YAxisName

YAxisName = `y${xYAxisNames}`

ZoneColorType

ZoneColorType = "spec" | "control" | "none"