packages/charts/chart-utilities/etc/chart-utilities.api.md
Do not edit this file. It is a report generated by API Extractor.
// @public (undocumented)
export interface Annotations extends Label {
align: 'left' | 'center' | 'right';
arrowcolor: string;
arrowhead: number;
arrowside: 'end' | 'start';
arrowsize: number;
arrowwidth: number;
ax: number;
axref: 'pixel' | XAxisName;
ay: number;
ayref: 'pixel' | YAxisName;
borderpad: number;
borderwidth: number;
captureevents: boolean;
clicktoshow: false | 'onoff' | 'onout';
height: number;
// (undocumented)
hoverlabel: Partial<HoverLabel>;
hovertext: string;
opacity: number;
showarrow: boolean;
standoff: number;
startarrowhead: number;
startarrowsize: number;
startstandoff: number;
text: string;
textangle: string | number;
valign: 'top' | 'middle' | 'bottom';
visible: boolean;
width: number;
x: number | string;
xanchor: 'auto' | 'left' | 'center' | 'right';
xclick: any;
xref: 'paper' | XAxisName;
xshift: number;
y: number | string;
yanchor: 'auto' | 'top' | 'middle' | 'bottom';
yclick: any;
yref: 'paper' | YAxisName;
yshift: number;
}
// @public (undocumented)
export interface AutoRangeOptions {
// (undocumented)
clipmax: DTickValue;
// (undocumented)
clipmin: DTickValue;
// (undocumented)
include: DTickValue;
// (undocumented)
maxallowed: DTickValue;
// (undocumented)
minallowed: DTickValue;
}
// @public (undocumented)
export interface Axis {
// (undocumented)
autorange: true | false | 'reversed' | 'min reversed' | 'max reversed' | 'min' | 'max';
// (undocumented)
autorangeoptions: Partial<AutoRangeOptions>;
// (undocumented)
autotypenumbers: 'convert types' | 'strict';
// (undocumented)
calendar: Calendar;
// (undocumented)
categoryarray: any[];
categoryorder: 'trace' | 'category ascending' | 'category descending' | 'array' | 'total ascending' | 'total descending' | 'min ascending' | 'min descending' | 'max ascending' | 'max descending' | 'sum ascending' | 'sum descending' | 'mean ascending' | 'mean descending' | 'median ascending' | 'median descending';
color: Color;
dividercolor: Color;
dividerwidth: number;
// (undocumented)
dtick: DTickValue;
exponentformat: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B';
fixedrange: boolean;
gridcolor: Color;
gridwidth: number;
hoverformat: string;
// (undocumented)
labelalias: DTickValue;
linecolor: Color;
linewidth: number;
// (undocumented)
maxallowed: DTickValue;
// (undocumented)
minallowed: DTickValue;
minexponent: number;
// (undocumented)
mirror: true | 'ticks' | false | 'all' | 'allticks';
// (undocumented)
nticks: number;
// (undocumented)
range: any[];
rangemode: 'normal' | 'tozero' | 'nonnegative';
separatethousands: boolean;
showdividers: boolean;
showexponent: 'all' | 'first' | 'last' | 'none';
showgrid: boolean;
showline: boolean;
// (undocumented)
showspikes: boolean;
// (undocumented)
showticklabels: boolean;
showtickprefix: 'all' | 'first' | 'last' | 'none';
showticksuffix: 'all' | 'first' | 'last' | 'none';
// (undocumented)
spikecolor: Color;
// (undocumented)
spikedash: string;
spikemode: 'toaxis' | 'across' | 'marker' | 'toaxis+across' | 'toaxis+across+marker' | 'across+marker' | 'toaxis+marker';
spikesnap: 'data' | 'cursor' | 'hovered data';
// (undocumented)
spikethickness: number;
// (undocumented)
tick0: number | string;
// (undocumented)
tickangle: 'auto' | number;
// (undocumented)
tickcolor: Color;
// (undocumented)
tickfont: Partial<Font>;
tickformat: string;
tickformatstops: Array<Partial<TickFormatStop>>;
// (undocumented)
ticklen: number;
tickmode: 'auto' | 'linear' | 'array';
// (undocumented)
tickprefix: string;
// (undocumented)
ticks: 'outside' | 'inside' | '';
ticksuffix: string;
// (undocumented)
ticktext: string[];
// (undocumented)
tickvals: any[];
// (undocumented)
tickwidth: number;
// (undocumented)
title: string | Partial<DataTitle>;
titlefont: Partial<Font>;
// (undocumented)
type: AxisType;
visible: boolean;
zeroline: boolean;
zerolinecolor: Color;
zerolinewidth: number;
}
// @public (undocumented)
export type AxisName = XAxisName | YAxisName;
// @public (undocumented)
export type AxisType = '-' | 'linear' | 'log' | 'date' | 'category' | 'multicategory';
// @public (undocumented)
export type Calendar = 'gregorian' | 'chinese' | 'coptic' | 'discworld' | 'ethiopian' | 'hebrew' | 'islamic' | 'julian' | 'mayan' | 'nanakshahi' | 'nepali' | 'persian' | 'jalali' | 'taiwan' | 'thai' | 'ummalqura';
// @public (undocumented)
export type Color = string | number | Array<string | number | undefined | null> | Array<Array<string | number | undefined | null>>;
// @public (undocumented)
export interface ColorAxis {
// (undocumented)
cmax?: number;
// (undocumented)
cmin?: number;
// (undocumented)
colorbar?: {
title?: string | {
text: string;
};
thickness?: number;
len?: number;
outlinewidth?: number;
};
// (undocumented)
colorscale?: Array<[number, string]>;
// (undocumented)
reversescale?: boolean;
// (undocumented)
showscale?: boolean;
}
// @public (undocumented)
export interface ColorBar {
// (undocumented)
bgcolor: Color;
// (undocumented)
bordercolor: Color;
// (undocumented)
borderwidth: Color;
// (undocumented)
dtick: DTickValue;
// (undocumented)
exponentformat: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B';
// (undocumented)
len: number;
// (undocumented)
lenmode: 'fraction' | 'pixels';
// (undocumented)
minexponent: number;
// (undocumented)
nticks: number;
// (undocumented)
outlinecolor: Color;
// (undocumented)
outlinewidth: number;
// (undocumented)
separatethousands: boolean;
// (undocumented)
showexponent: 'all' | 'first' | 'last' | 'none';
// (undocumented)
showticklabels: boolean;
// (undocumented)
showtickprefix: 'all' | 'first' | 'last' | 'none';
// (undocumented)
showticksuffix: 'all' | 'first' | 'last' | 'none';
// (undocumented)
thickness: number;
// (undocumented)
thicknessmode: 'fraction' | 'pixels';
// (undocumented)
tick0: number | string;
// (undocumented)
tickangle: 'auto' | number;
// (undocumented)
tickcolor: Color;
// (undocumented)
tickfont: Font;
// (undocumented)
tickformat: string;
// (undocumented)
tickformatstops: Array<Partial<TickFormatStop>>;
// (undocumented)
ticklen: number;
// (undocumented)
tickmode: 'auto' | 'linear' | 'array';
// (undocumented)
tickprefix: string;
// (undocumented)
ticks: 'outside' | 'inside' | '';
// (undocumented)
ticksuffix: string;
// (undocumented)
ticktext: Datum[] | Datum[][] | Datum[][][] | TypedArray;
// (undocumented)
ticktextsrc: any;
// (undocumented)
tickvals: Datum[] | Datum[][] | Datum[][][] | TypedArray;
// (undocumented)
tickvalssrc: any;
// (undocumented)
tickwidth: number;
// (undocumented)
title: string;
// (undocumented)
titlefont: Font;
// (undocumented)
titleside: 'right' | 'top' | 'bottom';
// (undocumented)
x: number;
// (undocumented)
xanchor: 'left' | 'center' | 'right';
// (undocumented)
xpad: number;
// (undocumented)
y: number;
// (undocumented)
yanchor: 'top' | 'middle' | 'bottom';
// (undocumented)
ypad: number;
}
// @public (undocumented)
export type ColorScale = string | string[] | Array<[number, string]>;
// @public (undocumented)
export interface Config {
autosizable: boolean;
fillFrame: boolean;
frameMargins: number;
globalTransforms: any[];
locale: string;
locales: {};
queueLength: number;
responsive: boolean;
typesetMath: boolean;
}
// @public (undocumented)
export type Dash = 'solid' | 'dot' | 'dash' | 'longdash' | 'dashdot' | 'longdashdot';
// @public (undocumented)
export type Data = Partial<PlotData> | Partial<PieData> | Partial<SankeyData>;
// @public (undocumented)
export interface DataTitle {
// (undocumented)
font: Partial<Font>;
// (undocumented)
position: 'top left' | 'top center' | 'top right' | 'middle center' | 'bottom left' | 'bottom center' | 'bottom right';
// (undocumented)
standoff: number;
// (undocumented)
text: string;
}
// @public (undocumented)
export type DataTransform = Partial<Transform>;
// @public (undocumented)
export type Datum = string | number | Date | null;
// @public (undocumented)
export function decodeBase64Fields(plotlySchema: PlotlySchema): PlotlySchema;
// @public (undocumented)
export interface Delta {
// (undocumented)
decreasing: {
symbol: string;
color: Color;
};
// (undocumented)
increasing: {
symbol: string;
color: Color;
};
// (undocumented)
position: 'top' | 'bottom' | 'left' | 'right';
// (undocumented)
reference: number;
// (undocumented)
relative: boolean;
// (undocumented)
valueformat: string;
}
// @public (undocumented)
export interface Domain {
// (undocumented)
column: number;
// (undocumented)
row: number;
// (undocumented)
x: number[];
// (undocumented)
y: number[];
}
// @public (undocumented)
export type DTickValue = number | string;
// @public (undocumented)
export type ErrorBar = Partial<ErrorOptions> & ({
type: 'constant' | 'percent';
value: number;
valueminus?: number | undefined;
} | {
type: 'data';
array: Datum[];
arrayminus?: Datum[] | undefined;
});
// @public (undocumented)
export interface ErrorOptions {
// (undocumented)
color: Color;
// (undocumented)
opacity: number;
// (undocumented)
symmetric: boolean;
// (undocumented)
thickness: number;
// (undocumented)
visible: boolean;
// (undocumented)
width: number;
}
// @public (undocumented)
export type FluentChart = 'annotation' | 'area' | 'composite' | 'donut' | 'fallback' | 'gauge' | 'groupedverticalbar' | 'heatmap' | 'horizontalbar' | 'line' | 'scatter' | 'scatterpolar' | 'sankey' | 'table' | 'verticalstackedbar' | 'gantt';
// @public (undocumented)
export interface Font {
// (undocumented)
color: Color;
family: string;
shadow: string;
size: number;
weight: number;
}
// @public
export const formatDateToLocaleString: (date: Date, culture?: string, useUtc?: boolean, showTZname?: boolean, options?: Intl.DateTimeFormatOptions) => string;
// @public
export const formatToLocaleString: (data: LocaleStringDataProps, culture?: string, useUtc?: boolean | string) => LocaleStringDataProps;
// @public (undocumented)
export interface Gauge {
// (undocumented)
axis: Partial<Axis>;
// (undocumented)
bar: Partial<GaugeBar>;
// (undocumented)
bgcolor: Color;
// (undocumented)
bordercolor: Color;
// (undocumented)
borderwidth: number;
// (undocumented)
shape: 'angular' | 'bullet';
// (undocumented)
steps: Array<{
range: number[];
color: Color;
}>;
// (undocumented)
threshold: Partial<Threshold>;
}
// @public (undocumented)
export interface GaugeBar {
// (undocumented)
color: Color;
// (undocumented)
line: Partial<GaugeLine>;
// (undocumented)
thickness: number;
}
// @public (undocumented)
export interface GaugeLine {
// (undocumented)
color: Color;
// (undocumented)
width: number;
}
// @public (undocumented)
export const getAxisIds: (data: Partial<PlotData>) => {
x: number;
y: number;
};
// @public (undocumented)
export const getAxisKey: (axLetter: "x" | "y", axId: number) => keyof Layout;
// @public
export function getMultiLevelDateTimeFormatOptions(startLevel?: number, endLevel?: number): Intl.DateTimeFormatOptions;
// @public (undocumented)
export const getValidSchema: (input: any) => PlotlySchema;
// @public
export function handleFloatingPointPrecisionError(num: number): number;
// @public (undocumented)
export interface HoverLabel extends Label {
align: 'left' | 'right' | 'auto';
namelength: number;
}
// @public (undocumented)
export interface Icon {
// (undocumented)
ascent?: number | undefined;
// (undocumented)
descent?: number | undefined;
// (undocumented)
height?: number | undefined;
// (undocumented)
name?: string | undefined;
// (undocumented)
path?: string | undefined;
// (undocumented)
svg?: string | undefined;
// (undocumented)
transform?: string | undefined;
// (undocumented)
width?: number | undefined;
}
// @public (undocumented)
export const isArrayOfType: (plotCoordinates: Datum[] | Datum[][] | TypedArray | undefined, typeCheck: (datum: any, ...args: any[]) => boolean, ...args: any[]) => boolean;
// @public (undocumented)
export function isArrayOrTypedArray(a: any): boolean;
// @public (undocumented)
export const isDate: (value: any) => boolean;
// @public (undocumented)
export const isDateArray: (data: Datum[] | Datum[][] | TypedArray | undefined) => boolean;
// @public (undocumented)
export const isInvalidValue: (value: any) => boolean;
// @public (undocumented)
export const isMonth: (possiblyMonthValue: any) => boolean;
// @public (undocumented)
export const isMonthArray: (data: Datum[] | Datum[][] | TypedArray | undefined) => boolean;
// @public (undocumented)
export const isNumber: (value: any) => boolean;
// @public (undocumented)
export const isNumberArray: (data: Datum[] | Datum[][] | TypedArray | undefined) => boolean;
// @public (undocumented)
export const isObjectArray: (data: Datum[] | Datum[][] | TypedArray | undefined) => boolean;
// @public (undocumented)
export const isScatterAreaChart: (data: Partial<PlotData>) => boolean;
// @public (undocumented)
export const isStringArray: (data: Datum[] | Datum[][] | TypedArray | undefined) => boolean;
// @public (undocumented)
export function isTypedArray(a: any): boolean;
// @public (undocumented)
export const isYearArray: (data: Datum[] | Datum[][] | TypedArray | undefined) => boolean;
// @public (undocumented)
export interface Label {
bgcolor: string;
bordercolor: string;
font: Partial<Font>;
}
// @public (undocumented)
export interface Layout {
// (undocumented)
'xaxis.autorange': boolean;
// (undocumented)
'xaxis.range': [Datum, Datum];
// (undocumented)
'xaxis.range[0]': Datum;
// (undocumented)
'xaxis.range[1]': Datum;
// (undocumented)
'xaxis.title': string;
// (undocumented)
'xaxis.type': AxisType;
// (undocumented)
'yaxis.autorange': boolean;
// (undocumented)
'yaxis.range': [Datum, Datum];
// (undocumented)
'yaxis.range[0]': Datum;
// (undocumented)
'yaxis.range[1]': Datum;
// (undocumented)
'yaxis.title': string;
// (undocumented)
'yaxis.type': AxisType;
// (undocumented)
angularaxis: {};
// (undocumented)
annotations: Array<Partial<Annotations>>;
// (undocumented)
autosize: boolean;
// (undocumented)
bargap: number;
// (undocumented)
bargroupgap: number;
// (undocumented)
barmode: 'stack' | 'group' | 'overlay' | 'relative';
// (undocumented)
barnorm: '' | 'fraction' | 'percent';
// (undocumented)
boxmode: 'group' | 'overlay';
// (undocumented)
calendar: Calendar;
// (undocumented)
clickmode: 'event' | 'select' | 'event+select' | 'none';
// (undocumented)
coloraxis: Partial<ColorAxis>;
// (undocumented)
colorscale: Array<[number, string]> | Partial<{
diverging: Array<[number, string]>;
sequential: Array<[number, string]>;
sequentialminus: Array<[number, string]>;
}>;
// (undocumented)
colorway: string[];
// (undocumented)
datarevision: number | string;
// (undocumented)
dragmode: 'zoom' | 'pan' | 'select' | 'lasso' | 'drawclosedpath' | 'drawopenpath' | 'drawline' | 'drawrect' | 'drawcircle' | 'orbit' | 'turntable' | false;
// (undocumented)
editrevision: number | string;
// (undocumented)
font: Partial<Font>;
// (undocumented)
geo: any;
// (undocumented)
grid: Partial<{
rows: number;
roworder: 'top to bottom' | 'bottom to top';
columns: number;
subplots: string[];
xaxes: string[];
yaxes: string[];
pattern: 'independent' | 'coupled';
xgap: number;
ygap: number;
domain: Partial<{
x: number[];
y: number[];
}>;
xside: 'bottom' | 'bottom plot' | 'top plot' | 'top';
yside: 'left' | 'left plot' | 'right plot' | 'right';
}>;
// (undocumented)
height: number;
// (undocumented)
hiddenlabels: string[];
// (undocumented)
hidesources: boolean;
// (undocumented)
hoverdistance: number;
// (undocumented)
hoverlabel: Partial<HoverLabel>;
// (undocumented)
hovermode: 'closest' | 'x' | 'y' | 'x unified' | 'y unified' | false;
// (undocumented)
legend: Partial<Legend>;
// (undocumented)
mapbox: any;
// (undocumented)
margin: Partial<Margin>;
// (undocumented)
orientation: number;
// (undocumented)
paper_bgcolor: Color;
// (undocumented)
piecolorway: string[];
// (undocumented)
plot_bgcolor: Color;
// (undocumented)
polar: Partial<PolarLayout>;
// (undocumented)
polar2: Partial<PolarLayout>;
// (undocumented)
polar3: Partial<PolarLayout>;
// (undocumented)
polar4: Partial<PolarLayout>;
// (undocumented)
polar5: Partial<PolarLayout>;
// (undocumented)
polar6: Partial<PolarLayout>;
// (undocumented)
polar7: Partial<PolarLayout>;
// (undocumented)
polar8: Partial<PolarLayout>;
// (undocumented)
polar9: Partial<PolarLayout>;
// (undocumented)
radialaxis: Partial<Axis>;
// (undocumented)
selectdirection: 'h' | 'v' | 'd' | 'any';
// (undocumented)
selectionrevision: number | string;
// (undocumented)
separators: string;
// (undocumented)
shapes: Array<Partial<Shape>>;
// (undocumented)
showlegend: boolean;
// (undocumented)
subplot: string;
// (undocumented)
template: Template;
// (undocumented)
ternary: any;
// (undocumented)
title: string | Partial<{
text: string;
font: Partial<Font>;
xref: 'container' | 'paper';
yref: 'container' | 'paper';
x: number;
y: number;
xanchor: 'auto' | 'left' | 'center' | 'right';
yanchor: 'auto' | 'top' | 'middle' | 'bottom';
pad: Partial<Padding>;
}>;
// (undocumented)
titlefont: Partial<Font>;
// (undocumented)
uid: string;
// (undocumented)
uirevision: number | string;
// (undocumented)
width: number;
// (undocumented)
xaxis: Partial<LayoutAxis>;
// (undocumented)
xaxis2: Partial<LayoutAxis>;
// (undocumented)
xaxis3: Partial<LayoutAxis>;
// (undocumented)
xaxis4: Partial<LayoutAxis>;
// (undocumented)
xaxis5: Partial<LayoutAxis>;
// (undocumented)
xaxis6: Partial<LayoutAxis>;
// (undocumented)
xaxis7: Partial<LayoutAxis>;
// (undocumented)
xaxis8: Partial<LayoutAxis>;
// (undocumented)
xaxis9: Partial<LayoutAxis>;
// (undocumented)
yaxis: Partial<LayoutAxis>;
// (undocumented)
yaxis2: Partial<LayoutAxis>;
// (undocumented)
yaxis3: Partial<LayoutAxis>;
// (undocumented)
yaxis4: Partial<LayoutAxis>;
// (undocumented)
yaxis5: Partial<LayoutAxis>;
// (undocumented)
yaxis6: Partial<LayoutAxis>;
// (undocumented)
yaxis7: Partial<LayoutAxis>;
// (undocumented)
yaxis8: Partial<LayoutAxis>;
// (undocumented)
yaxis9: Partial<LayoutAxis>;
}
// @public (undocumented)
export interface LayoutAxis extends Axis {
// (undocumented)
anchor: 'free' | AxisName;
// (undocumented)
angle: any;
// (undocumented)
automargin: boolean;
// (undocumented)
autotick: boolean;
// (undocumented)
autotickangles: number[];
// (undocumented)
constrain: 'range' | 'domain';
// (undocumented)
constraintoward: 'left' | 'center' | 'right' | 'top' | 'middle' | 'bottom';
// (undocumented)
direction: 'counterclockwise' | 'clockwise';
// (undocumented)
domain: number[];
// (undocumented)
fixedrange: boolean;
// (undocumented)
griddash: Dash;
// (undocumented)
insiderange: any[];
// (undocumented)
l2p: (v: Datum) => number;
// (undocumented)
layer: 'above traces' | 'below traces';
// (undocumented)
matches: AxisName;
// (undocumented)
minor: Partial<MinorAxisLayout>;
// (undocumented)
overlaying: 'free' | AxisName;
// (undocumented)
position: number;
// (undocumented)
rangebreaks: Array<Partial<RangeBreak>>;
// (undocumented)
rangeselector: Partial<RangeSelector>;
// (undocumented)
rangeslider: Partial<RangeSlider>;
// (undocumented)
rotation: number;
// (undocumented)
scaleanchor: AxisName;
// (undocumented)
scaleratio: number;
// (undocumented)
side: 'top' | 'bottom' | 'left' | 'right' | 'clockwise' | 'counterclockwise';
// (undocumented)
ticklabelmode: 'instant' | 'period';
// (undocumented)
ticklabeloverflow: 'allow' | 'hide past div' | 'hide past domain';
// (undocumented)
ticklabelposition: 'outside' | 'inside' | 'outside top' | 'inside top' | 'outside left' | 'inside left' | 'outside right' | 'inside right' | 'outside bottom' | 'inside bottom';
// (undocumented)
ticklabelstep: number;
// (undocumented)
tickson: 'labels' | 'boundaries';
// (undocumented)
uirevision: DTickValue;
}
// @public (undocumented)
export interface Legend extends Label {
// (undocumented)
borderwidth: number;
// (undocumented)
groupclick: 'toggleitem' | 'togglegroup';
// (undocumented)
grouptitlefont: Partial<Font>;
// (undocumented)
itemclick: 'toggle' | 'toggleothers' | false;
// (undocumented)
itemdoubleclick: 'toggle' | 'toggleothers' | false;
// (undocumented)
itemsizing: 'trace' | 'constant';
// (undocumented)
itemwidth: number;
// (undocumented)
orientation: 'v' | 'h';
// (undocumented)
title: Partial<LegendTitle>;
// (undocumented)
tracegroupgap: number;
// (undocumented)
traceorder: 'grouped' | 'normal' | 'reversed' | 'reversed+grouped';
// (undocumented)
uid: string;
// (undocumented)
uirevision: number | string;
// (undocumented)
valign: 'top' | 'middle' | 'bottom';
// (undocumented)
x: number;
// (undocumented)
xanchor: 'auto' | 'left' | 'center' | 'right';
// (undocumented)
xref: 'container' | 'paper';
// (undocumented)
y: number;
// (undocumented)
yanchor: 'auto' | 'top' | 'middle' | 'bottom';
// (undocumented)
yref: 'container' | 'paper';
}
// @public (undocumented)
export interface LegendTitle {
// (undocumented)
font: Partial<Font>;
// (undocumented)
side: 'top' | 'left' | 'top left' | 'top center' | 'top right';
// (undocumented)
text: string;
}
// @public (undocumented)
export const mapFluentChart: (input: any) => OutputChartType;
// @public (undocumented)
export interface Margin {
// (undocumented)
b: number;
// (undocumented)
l: number;
// (undocumented)
pad: number;
// (undocumented)
r: number;
// (undocumented)
t: number;
}
// @public (undocumented)
export type MarkerSymbol = string | number | Array<string | number>;
// @public (undocumented)
export interface MinorAxisLayout {
// (undocumented)
dtick: DTickValue;
// (undocumented)
gridcolor: Color;
// (undocumented)
griddash: Dash;
// (undocumented)
gridwidth: number;
// (undocumented)
nticks: number;
// (undocumented)
showgrid: boolean;
// (undocumented)
tick0: DTickValue;
// (undocumented)
tickcolor: Color;
// (undocumented)
ticklen: number;
// (undocumented)
tickmode: 'auto' | 'linear' | 'array';
// (undocumented)
ticks: 'outside' | 'inside' | '';
// (undocumented)
tickvals: any[];
// (undocumented)
tickwidth: number;
}
// @public (undocumented)
export interface OutputChartType {
// (undocumented)
errorMessage?: string;
// (undocumented)
isValid: boolean;
// (undocumented)
type?: string;
validTracesInfo?: TraceInfo[];
}
// @public (undocumented)
export interface Padding {
b: number;
// (undocumented)
editType: 'arraydraw';
l: number;
r: number;
t: number;
}
// @public
export interface Pattern {
bgcolor?: string;
fgcolor?: string;
fgopacity?: string;
fillmode?: 'replace' | 'overlay';
shape?: '' | '/' | '\\' | 'x' | '-' | '|' | '+' | '.';
size?: number;
solidity?: number;
}
// @public
export type PieColor = string | number;
// @public (undocumented)
export type PieColors = Array<PieColor | null | undefined>;
// @public (undocumented)
export interface PieData extends Pick<PlotData, 'name' | 'visible' | 'showlegend' | 'legendgroup' | 'opacity' | 'ids' | 'labels' | 'hovertext' | 'automargin' | 'textinfo' | 'direction' | 'hole' | 'rotation'> {
// (undocumented)
customdata: Datum[];
// (undocumented)
dlabel: number;
// (undocumented)
domain: Partial<PieDomain>;
// (undocumented)
hoverinfo: PieHoverInfo;
// (undocumented)
hoverlabel: Partial<PieHoverLabel>;
// (undocumented)
hovertemplate: string | string[];
// (undocumented)
insidetextfont: PieFont;
// (undocumented)
insidetextorientation: PieInsideTextOrientation;
// (undocumented)
label0: number;
// (undocumented)
marker: Partial<PieMarker>;
// (undocumented)
meta: number | string;
// (undocumented)
outsidetextfont: PieFont;
// (undocumented)
pull: number | number[];
// (undocumented)
scalegroup: string;
// (undocumented)
sort: boolean;
// (undocumented)
text: Datum | Datum[];
// (undocumented)
textfont: PieFont;
// (undocumented)
textposition: PieTextPosition | PieTextPosition[];
// (undocumented)
texttemplate: string | string[];
// (undocumented)
title: Partial<PieDataTitle>;
// (undocumented)
type: 'pie';
// (undocumented)
uirevision: number | string;
// (undocumented)
values: Array<number | string>;
}
// @public (undocumented)
export interface PieDataTitle extends Pick<DataTitle, 'text' | 'position'> {
// (undocumented)
font: Partial<PieFont>;
}
// @public (undocumented)
export interface PieDomain {
// (undocumented)
column: number;
// (undocumented)
row: number;
// (undocumented)
x: number[];
// (undocumented)
y: number[];
}
// @public (undocumented)
export interface PieFont {
// (undocumented)
color: PieColor | PieColors;
// (undocumented)
family: string | string[];
// (undocumented)
size: number | number[];
}
// @public (undocumented)
export type 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';
// @public (undocumented)
export interface PieHoverLabel {
// (undocumented)
align: HoverLabel['align'] | Array<HoverLabel['align']>;
// (undocumented)
bgcolor: PieColor | PieColors;
// (undocumented)
bordercolor: PieColor | PieColors;
// (undocumented)
font: PieFont;
// (undocumented)
namelength: number | number[];
}
// @public (undocumented)
export type PieInsideTextOrientation = 'horizontal' | 'radial' | 'tangential' | 'auto';
// @public (undocumented)
export interface PieLine {
// (undocumented)
color: PieColor | PieColors;
// (undocumented)
width: number | number[];
}
// @public (undocumented)
export interface PieMarker {
// (undocumented)
colors: PieColors;
// (undocumented)
line: Partial<PieLine>;
}
// @public (undocumented)
export type PieTextPosition = 'inside' | 'outside' | 'auto' | 'none';
// @public (undocumented)
export interface PlotCoordinate {
// (undocumented)
pointNumber: number;
// (undocumented)
x: number;
// (undocumented)
y: number;
}
// @public (undocumented)
export interface PlotData {
// (undocumented)
'line.color': Color;
// (undocumented)
'line.dash': Dash;
// (undocumented)
'line.shape': 'linear' | 'spline' | 'hv' | 'vh' | 'hvh' | 'vhv';
// (undocumented)
'line.simplify': boolean;
// (undocumented)
'line.smoothing': number;
// (undocumented)
'line.width': number;
// (undocumented)
'marker.color': Color;
// (undocumented)
'marker.colorbar': {};
// (undocumented)
'marker.colorscale': ColorScale | ColorScale[];
// (undocumented)
'marker.line': Partial<ScatterMarkerLine>;
// (undocumented)
'marker.line.color': Color;
// (undocumented)
'marker.line.colorscale': ColorScale | ColorScale[];
// (undocumented)
'marker.maxdisplayed': number;
// (undocumented)
'marker.opacity': number | number[];
// (undocumented)
'marker.pad.b': number;
// (undocumented)
'marker.pad.l': number;
// (undocumented)
'marker.pad.r': number;
// (undocumented)
'marker.pad.t': number;
// (undocumented)
'marker.showscale': boolean;
// (undocumented)
'marker.size': number | number[] | number[][];
// (undocumented)
'marker.sizemax': number;
// (undocumented)
'marker.sizemin': number;
// (undocumented)
'marker.sizemode': 'diameter' | 'area';
// (undocumented)
'marker.sizeref': number;
// (undocumented)
'marker.symbol': MarkerSymbol | MarkerSymbol[];
// (undocumented)
autobinx: boolean;
// (undocumented)
autocontour: boolean;
// (undocumented)
automargin: boolean;
// (undocumented)
base: Datum[] | Datum[][] | TypedArray;
// (undocumented)
boxmean: boolean | 'sd';
// (undocumented)
boxpoints: 'all' | 'outliers' | 'suspectedoutliers' | false;
// (undocumented)
branchvalues: 'total' | 'remainder';
// (undocumented)
cells?: {
align?: 'left' | 'center' | 'right' | ('left' | 'center' | 'right')[];
fill?: {
color?: Color | Color[];
};
font?: {
family?: string | string[];
size?: number | number[];
color?: Color | Color[];
};
values: (string | number | boolean | null)[][];
format: string | string[];
prefix: string | string[];
suffix: string | string[];
};
// (undocumented)
cliponaxis: boolean;
// (undocumented)
colorbar: Partial<ColorBar>;
// (undocumented)
colorscale: ColorScale;
// (undocumented)
connectgaps: boolean;
// (undocumented)
constraintext: 'inside' | 'outside' | 'both' | 'none';
// (undocumented)
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 | [lowerBound: number, upperBound: number];
}>;
// (undocumented)
customdata: Datum[] | Datum[][];
// (undocumented)
delta: Partial<Delta>;
// (undocumented)
direction: 'clockwise' | 'counterclockwise';
// (undocumented)
domain: Partial<{
row: number;
column: number;
x: number[];
y: number[];
}>;
// (undocumented)
error_x: ErrorBar;
// (undocumented)
error_y: ErrorBar;
// (undocumented)
fill: 'none' | 'tozeroy' | 'tozerox' | 'tonexty' | 'tonextx' | 'toself' | 'tonext';
// (undocumented)
fillcolor: string;
// (undocumented)
fillpattern: Partial<Pattern>;
// (undocumented)
gauge: Partial<Gauge>;
// (undocumented)
groupnorm: '' | 'fraction' | 'percent';
// (undocumented)
header?: {
align?: 'left' | 'center' | 'right' | ('left' | 'center' | 'right')[];
fill?: {
color?: Color | Color[];
};
font?: {
family?: string | string[];
size?: number | number[];
color?: Color | Color[];
};
values: (string | number | boolean | null)[];
};
// (undocumented)
histfunc: 'count' | 'sum' | 'avg' | 'min' | 'max';
// (undocumented)
histnorm: '' | 'percent' | 'probability' | 'density' | 'probability density';
// (undocumented)
hole: number;
// (undocumented)
hoverinfo: 'all' | 'name' | 'none' | 'skip' | 'text' | 'x' | 'x+text' | 'x+name' | 'x+y' | 'x+y+text' | 'x+y+name' | 'x+y+z' | 'x+y+z+text' | 'x+y+z+name' | 'y' | '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';
// (undocumented)
hoverlabel: Partial<HoverLabel>;
// (undocumented)
hoveron: 'points' | 'fills';
// (undocumented)
hoverongaps: boolean;
// (undocumented)
hovertemplate: string | string[];
// (undocumented)
hovertext: string | string[];
// (undocumented)
i: TypedArray;
// (undocumented)
ids: string[];
// (undocumented)
insidetextanchor: 'end' | 'middle' | 'start';
// (undocumented)
j: TypedArray;
// (undocumented)
jitter: number;
// (undocumented)
k: TypedArray;
// (undocumented)
labels: Datum[];
// (undocumented)
lat: Datum[];
// (undocumented)
legendgroup: string;
// (undocumented)
legendgrouptitle: {
text: string;
font?: Partial<Font>;
};
// (undocumented)
legendrank: number;
// (undocumented)
level: string;
// (undocumented)
line: Partial<ScatterLine>;
// (undocumented)
locationmode: 'ISO-3' | 'USA-states' | 'country names' | 'geojson-id';
// (undocumented)
locations: Datum[];
// (undocumented)
lon: Datum[];
// (undocumented)
marker: Partial<PlotMarker>;
// (undocumented)
mode: 'lines' | 'markers' | 'text' | 'lines+markers' | 'text+markers' | 'text+lines' | 'text+lines+markers' | 'none' | 'gauge' | 'number' | 'delta' | 'number+delta' | 'gauge+number' | 'gauge+number+delta' | 'gauge+delta' | 'markers+text' | 'lines+text' | 'lines+markers+text';
// (undocumented)
name: string;
// (undocumented)
ncontours: number;
// (undocumented)
number: Partial<PlotNumber>;
// (undocumented)
offset: number | number[];
// (undocumented)
opacity: number;
// (undocumented)
orientation: 'v' | 'h';
// (undocumented)
parents: string[];
// (undocumented)
pointpos: number;
// (undocumented)
r: Datum[];
// (undocumented)
reversescale: boolean;
// (undocumented)
rotation: number;
// (undocumented)
selectedpoints: Datum[];
// (undocumented)
showlegend: boolean;
// (undocumented)
showscale: boolean;
// (undocumented)
stackgaps: 'infer zero' | 'interpolate';
// (undocumented)
stackgroup: string;
// (undocumented)
stage: string;
// (undocumented)
text: string | string[];
// (undocumented)
textangle: 'auto' | number;
// (undocumented)
textfont: Partial<Font>;
// (undocumented)
textinfo: 'label' | 'label+text' | 'label+value' | 'label+percent' | 'label+text+value' | 'label+text+percent' | 'label+value+percent' | 'text' | 'text+value' | 'text+percent' | 'text+value+percent' | 'value' | 'value+percent' | 'percent' | 'none';
// (undocumented)
textposition: 'top left' | 'top center' | 'top right' | 'middle left' | 'middle center' | 'middle right' | 'bottom left' | 'bottom center' | 'bottom right' | 'inside' | 'outside' | 'auto' | 'none';
// (undocumented)
texttemplate: string | string[];
// (undocumented)
theta: Datum[];
// (undocumented)
title: Partial<DataTitle>;
// (undocumented)
transforms: DataTransform[];
// (undocumented)
transpose: boolean;
// (undocumented)
type: PlotType;
// (undocumented)
uid: string;
// (undocumented)
uirevision: string | number;
// (undocumented)
value: number;
// (undocumented)
values: Datum[];
// (undocumented)
visible: boolean | 'legendonly';
// (undocumented)
width: number | number[];
// (undocumented)
x: Datum[] | Datum[][] | TypedArray;
// (undocumented)
xaxis: string;
// (undocumented)
xbins: {
start: number | string;
end: number | string;
size: number | string;
};
// (undocumented)
xgap: number;
// (undocumented)
xhoverformat: string;
// (undocumented)
xy: Float32Array;
// (undocumented)
y: Datum[] | Datum[][] | TypedArray;
// (undocumented)
yaxis: string;
// (undocumented)
ybins: {
start: number | string;
end: number | string;
size: number | string;
};
// (undocumented)
ygap: number;
// (undocumented)
yhoverformat: string;
// (undocumented)
z: Datum[] | Datum[][] | Datum[][][] | TypedArray;
// (undocumented)
zhoverformat: string;
// (undocumented)
zmax: number;
// (undocumented)
zmin: number;
// (undocumented)
zsmooth: 'fast' | 'best' | false;
}
// @public (undocumented)
export interface PlotDatum {
// (undocumented)
curveNumber: number;
// (undocumented)
customdata: Datum;
// (undocumented)
data: PlotData;
// (undocumented)
pointIndex: number;
// (undocumented)
pointNumber: number;
// (undocumented)
text: string;
// (undocumented)
x: Datum;
// (undocumented)
xaxis: LayoutAxis;
// (undocumented)
y: Datum;
// (undocumented)
yaxis: LayoutAxis;
}
// @public (undocumented)
export interface PlotlySchema {
// (undocumented)
config?: Partial<Config>;
// (undocumented)
data: Data[];
// (undocumented)
layout?: Partial<Layout>;
}
// @public
export interface PlotMarker {
// (undocumented)
autocolorscale?: boolean | undefined;
// (undocumented)
cauto?: boolean | undefined;
// (undocumented)
cmax?: number | undefined;
// (undocumented)
cmin?: number | undefined;
// (undocumented)
color?: Color | Color[] | undefined;
// (undocumented)
colorbar?: Partial<ColorBar> | undefined;
// (undocumented)
colors?: Color[] | undefined;
// (undocumented)
colorscale?: ColorScale | undefined;
// (undocumented)
gradient?: {
type: 'radial' | 'horizontal' | 'vertical' | 'none';
color: Color;
typesrc: any;
colorsrc: any;
} | undefined;
// (undocumented)
line: Partial<ScatterMarkerLine>;
// (undocumented)
maxdisplayed?: number | undefined;
// (undocumented)
opacity: number | number[];
// (undocumented)
pad?: Partial<Padding> | undefined;
// (undocumented)
pattern?: Partial<Pattern>;
// (undocumented)
reversescale?: boolean | undefined;
// (undocumented)
showscale?: boolean | undefined;
// (undocumented)
size: number | number[];
// (undocumented)
sizemax?: number | undefined;
// (undocumented)
sizemin?: number | undefined;
// (undocumented)
sizemode?: 'diameter' | 'area' | undefined;
// (undocumented)
sizeref?: number | undefined;
// (undocumented)
symbol: MarkerSymbol;
// (undocumented)
width?: number | undefined;
}
// @public (undocumented)
export interface PlotNumber {
// (undocumented)
font: Partial<Font>;
// (undocumented)
prefix: string;
// (undocumented)
suffix: string;
// (undocumented)
valueformat: string;
}
// @public (undocumented)
export interface PlotScatterDataPoint {
// (undocumented)
curveNumber: number;
// (undocumented)
data: PlotData;
// (undocumented)
pointIndex: number;
// (undocumented)
pointNumber: number;
// (undocumented)
x: number;
// (undocumented)
xaxis: LayoutAxis;
// (undocumented)
y: number;
// (undocumented)
yaxis: LayoutAxis;
}
// @public (undocumented)
export interface PlotScene {
// (undocumented)
center: Point;
// (undocumented)
eye: Point;
// (undocumented)
up: Point;
}
// @public (undocumented)
export type PlotSelectedData = Partial<PlotDatum>;
// @public (undocumented)
export type PlotType = 'bar' | 'barpolar' | 'box' | 'candlestick' | 'carpet' | 'choropleth' | 'choroplethmapbox' | 'cone' | 'contour' | 'contourcarpet' | 'densitymapbox' | 'funnel' | 'funnelarea' | 'heatmap' | 'heatmapgl' | 'histogram' | 'histogram2d' | 'histogram2dcontour' | 'image' | 'indicator' | 'isosurface' | 'mesh3d' | 'ohlc' | 'parcats' | 'parcoords' | 'pie' | 'pointcloud' | 'sankey' | 'scatter' | 'scatter3d' | 'scattercarpet' | 'scattergeo' | 'scattergl' | 'scattermapbox' | 'scatterpolar' | 'scatterpolargl' | 'scatterternary' | 'splom' | 'streamtube' | 'sunburst' | 'surface' | 'table' | 'treemap' | 'violin' | 'volume' | 'waterfall' | 'gauge';
// @public (undocumented)
export interface Point {
// (undocumented)
x: number;
// (undocumented)
y: number;
// (undocumented)
z: number;
}
// @public (undocumented)
export interface PolarLayout {
// (undocumented)
angularaxis: Partial<LayoutAxis>;
// (undocumented)
bgcolor: Color;
// (undocumented)
domain: Partial<Domain>;
// (undocumented)
gridshape: 'circular' | 'linear';
// (undocumented)
hole: number;
// (undocumented)
radialaxis: Partial<LayoutAxis>;
// (undocumented)
sector: number[];
// (undocumented)
uid: string;
// (undocumented)
uirevision: string | number;
}
// @public (undocumented)
export interface RangeBreak {
// (undocumented)
bounds: any[];
// (undocumented)
dvalue: number;
// (undocumented)
enabled: boolean;
// (undocumented)
name: string;
// (undocumented)
pattern: 'day of week' | 'hour' | '';
// (undocumented)
templateitemname: string;
// (undocumented)
values: any[];
}
// @public (undocumented)
export interface RangeSelector extends Label {
// (undocumented)
activecolor: string;
// (undocumented)
borderwidth: number;
// (undocumented)
buttons: Array<Partial<RangeSelectorButton>>;
// (undocumented)
visible: boolean;
// (undocumented)
x: number;
// (undocumented)
xanchor: 'auto' | 'left' | 'center' | 'right';
// (undocumented)
y: number;
// (undocumented)
yanchor: 'auto' | 'top' | 'middle' | 'bottom';
}
// @public (undocumented)
export interface RangeSelectorButton {
// (undocumented)
count: number;
// (undocumented)
label: string;
// (undocumented)
step: 'second' | 'minute' | 'hour' | 'day' | 'month' | 'year' | 'all';
// (undocumented)
stepmode: 'backward' | 'todate';
}
// @public (undocumented)
export interface RangeSlider {
// (undocumented)
bgcolor: string;
// (undocumented)
bordercolor: string;
// (undocumented)
borderwidth: number;
// (undocumented)
range: [Datum, Datum];
// (undocumented)
thickness: number;
// (undocumented)
visible: boolean;
}
// @public (undocumented)
export const sanitizeJson: (jsonObject: any, depth?: number) => any;
// @public (undocumented)
export type SankeyColor = string | number;
// @public (undocumented)
export type SankeyColors = Array<SankeyColor | null | undefined>;
// @public (undocumented)
export interface SankeyColorscale {
// (undocumented)
cmax: number;
// (undocumented)
cmin: number;
// (undocumented)
colorscale: Array<[number, string]>;
// (undocumented)
label: string;
// (undocumented)
name: string;
// (undocumented)
templateitemname: string;
}
// @public (undocumented)
export interface SankeyData {
// (undocumented)
arrangement: 'snap' | 'perpendicular' | 'freeform' | 'fixed';
// (undocumented)
customdata: Datum[];
// (undocumented)
domain: Partial<SankeyDomain>;
// (undocumented)
hoverinfo: string;
// (undocumented)
hoverlabel: Partial<SankeyHoverLabel>;
// (undocumented)
ids: string[];
// (undocumented)
legend: string;
// (undocumented)
legendgrouptitle: Partial<SankeyDataTitle>;
// (undocumented)
legendrank: number;
// (undocumented)
legendwidth: number;
// (undocumented)
link: Partial<SankeyLink>;
// (undocumented)
meta: number | string;
// (undocumented)
name: string;
// (undocumented)
node: Partial<SankeyNode>;
// (undocumented)
orientation: SankeyOrientation;
// (undocumented)
selectpoints: string | number;
// (undocumented)
textfont: Partial<SankeyFont>;
// (undocumented)
type: 'sankey';
// (undocumented)
uirevision: string | number;
// (undocumented)
valueformat: string;
// (undocumented)
valuesuffix: string;
// (undocumented)
visible: boolean | 'legendonly';
}
// @public (undocumented)
export interface SankeyDataTitle {
// (undocumented)
font: Partial<SankeyFont>;
// (undocumented)
title: string;
}
// @public (undocumented)
export interface SankeyDomain {
// (undocumented)
column: number;
// (undocumented)
row: number;
// (undocumented)
x: number[];
// (undocumented)
y: number[];
}
// @public (undocumented)
export interface SankeyFont {
// (undocumented)
color: SankeyColor | SankeyColors;
// (undocumented)
family: string | string[];
// (undocumented)
size: number | number[];
}
// @public (undocumented)
export interface SankeyHoverLabel {
// (undocumented)
align: HoverLabel['align'] | Array<HoverLabel['align']>;
// (undocumented)
bgcolor: SankeyColor | SankeyColors;
// (undocumented)
bordercolor: SankeyColor | SankeyColors;
// (undocumented)
font: SankeyFont;
// (undocumented)
namelength: number | number[];
}
// @public (undocumented)
export interface SankeyLink {
// (undocumented)
arrowlen: number;
// (undocumented)
color: SankeyColor | SankeyColor[];
// (undocumented)
colorscale: Partial<SankeyColorscale>;
// (undocumented)
customdata: Datum[];
// (undocumented)
hovercolor: SankeyColor | SankeyColor[];
// (undocumented)
hoverinfo: 'all' | 'none' | 'skip';
// (undocumented)
hoverlabel: Partial<SankeyHoverLabel>;
// (undocumented)
hovertemplate: string | string[];
// (undocumented)
label: Datum[];
// (undocumented)
line: Partial<{
color: SankeyColor;
width: number;
}>;
// (undocumented)
source: number[];
// (undocumented)
target: number[];
// (undocumented)
value: number[];
}
// @public (undocumented)
export interface SankeyNode {
// (undocumented)
color: SankeyColor[];
// (undocumented)
customdata: Datum[];
// (undocumented)
groups: SankeyNode[];
// (undocumented)
hoverinfo: 'all' | 'none' | 'skip';
// (undocumented)
hoverlabel: Partial<SankeyHoverLabel>;
// (undocumented)
hovertemplate: string | string[];
// (undocumented)
label: Datum[];
// (undocumented)
line: Partial<{
color: SankeyColor;
width: number;
}>;
// (undocumented)
pad: number;
// (undocumented)
thickness: number;
// (undocumented)
x: number[];
// (undocumented)
y: number[];
}
// @public (undocumented)
export type SankeyOrientation = 'v' | 'h';
// @public (undocumented)
export type ScatterData = PlotData;
// @public (undocumented)
export interface ScatterLine {
// (undocumented)
color: Color;
// (undocumented)
dash: Dash;
// (undocumented)
shape: 'linear' | 'spline' | 'hv' | 'vh' | 'hvh' | 'vhv';
// (undocumented)
simplify: boolean;
// (undocumented)
smoothing: number;
// (undocumented)
width: number;
}
// @public (undocumented)
export type ScatterMarker = PlotMarker;
// @public (undocumented)
export interface ScatterMarkerLine {
// (undocumented)
autocolorscale?: boolean | undefined;
// (undocumented)
cauto?: boolean | undefined;
// (undocumented)
cmax?: number | undefined;
// (undocumented)
cmid?: number | undefined;
// (undocumented)
cmin?: number | undefined;
// (undocumented)
color: Color;
// (undocumented)
coloraxis?: string | undefined;
// (undocumented)
colorscale?: ColorScale | undefined;
// (undocumented)
reversescale?: boolean | undefined;
// (undocumented)
width: number | number[];
}
// @public (undocumented)
export interface SceneAxis extends Axis {
// (undocumented)
backgroundcolor: Color;
// (undocumented)
showaxeslabels: boolean;
// (undocumented)
showbackground: boolean;
// (undocumented)
spikesides: boolean;
}
// @public (undocumented)
export interface SelectionRange {
// (undocumented)
x: number[];
// (undocumented)
y: number[];
}
// @public (undocumented)
export interface Shape {
// (undocumented)
fillcolor: string;
// (undocumented)
label: Partial<ShapeLabel>;
// (undocumented)
layer: 'below' | 'above';
// (undocumented)
legendgroup: string;
// (undocumented)
legendgrouptitle: {
text: string;
font?: Partial<Font>;
};
// (undocumented)
legendrank: number;
// (undocumented)
line: Partial<ShapeLine>;
// (undocumented)
name: string;
// (undocumented)
opacity: number;
// (undocumented)
path: string;
// (undocumented)
showlegend: boolean;
// (undocumented)
templateitemname: string;
// (undocumented)
type: 'rect' | 'circle' | 'line' | 'path';
// (undocumented)
visible: boolean | 'legendonly';
// (undocumented)
x0: Datum;
// (undocumented)
x1: Datum;
// (undocumented)
xanchor: number | string;
// (undocumented)
xref: 'paper' | XAxisName;
// (undocumented)
xsizemode: 'scaled' | 'pixel';
// (undocumented)
y0: Datum;
// (undocumented)
y1: Datum;
// (undocumented)
yanchor: number | string;
// (undocumented)
yref: 'paper' | YAxisName;
// (undocumented)
ysizemode: 'scaled' | 'pixel';
}
// @public (undocumented)
export interface ShapeLabel {
// (undocumented)
font: Partial<Font>;
// (undocumented)
padding: number;
// (undocumented)
text: string;
// (undocumented)
textangle: 'auto' | number;
// (undocumented)
textposition: 'top left' | 'top center' | 'top right' | 'middle left' | 'middle center' | 'middle right' | 'bottom left' | 'bottom center' | 'bottom right' | 'start' | 'middle' | 'end';
// (undocumented)
texttemplate: string;
// (undocumented)
xanchor: 'auto' | 'left' | 'center' | 'right';
// (undocumented)
yanchor: 'top' | 'middle' | 'bottom';
}
// @public (undocumented)
export interface ShapeLine {
// (undocumented)
color: string;
// (undocumented)
dash: Dash;
// (undocumented)
width: number;
}
// @public (undocumented)
export interface TableData {
// (undocumented)
cells?: {
align?: 'left' | 'center' | 'right' | ('left' | 'center' | 'right')[];
fill?: {
color?: Color | Color[];
};
font?: {
family?: string | string[];
size?: number | number[];
color?: Color | Color[];
};
values: (string | number | boolean | null)[][];
format?: string | string[];
prefix?: string | string[];
suffix?: string | string[];
};
// (undocumented)
header?: {
align?: 'left' | 'center' | 'right' | ('left' | 'center' | 'right')[];
fill?: {
color?: Color | Color[];
};
font?: {
family?: string | string[];
size?: number | number[];
color?: Color | Color[];
};
values: (string | number | boolean | null)[];
};
// (undocumented)
type: 'table';
}
// @public (undocumented)
export interface Template {
// (undocumented)
data?: {
[type in PlotType]?: Array<Partial<PlotData>>;
} | undefined;
// (undocumented)
layout?: Partial<Layout> | undefined;
}
// @public (undocumented)
export interface Threshold {
// (undocumented)
line: Partial<GaugeLine>;
// (undocumented)
thickness: number;
// (undocumented)
value: number;
}
// @public (undocumented)
export interface TickFormatStop {
dtickrange: [DTickValue | null, DTickValue | null];
enabled: boolean;
name: string;
templateitemname: string;
value: string;
}
// @public (undocumented)
export type TraceInfo = {
index: number;
type: FluentChart;
};
// @public (undocumented)
export interface Transform {
// (undocumented)
aggregations: TransformAggregation[];
// (undocumented)
enabled: boolean;
// (undocumented)
groups: string | number[] | string[];
// (undocumented)
nameformat: string;
// (undocumented)
operation: string;
// (undocumented)
order: 'ascending' | 'descending';
// (undocumented)
preservegaps: boolean;
// (undocumented)
styles: TransformStyle[];
// (undocumented)
target: number | string | number[] | string[];
// (undocumented)
type: 'aggregate' | 'filter' | 'groupby' | 'sort';
// (undocumented)
value: any;
}
// @public (undocumented)
export interface TransformAggregation {
// (undocumented)
enabled?: boolean | undefined;
// (undocumented)
func?: 'count' | 'sum' | 'avg' | 'median' | 'mode' | 'rms' | 'stddev' | 'min' | 'max' | 'first' | 'last' | undefined;
// (undocumented)
funcmode?: 'sample' | 'population' | undefined;
// (undocumented)
target: string;
}
// @public
export interface TransformStyle {
// (undocumented)
target: number | string | number[] | string[];
// (undocumented)
value: Partial<PlotData>;
}
// @public (undocumented)
export type TypedArray = Int8Array | Uint8Array | Int16Array | Uint16Array | Int32Array | Uint32Array | Uint8ClampedArray | Float32Array | Float64Array;
// @public (undocumented)
export const validate2Dseries: (series: Partial<PlotData>) => boolean;
// @public (undocumented)
export type XAxisName = `x${xYAxisNames}`;
// @public (undocumented)
export type YAxisName = `y${xYAxisNames}`;
// (No @packageDocumentation comment for this package)