Type Alias: BaseLayout

type BaseLayout = object;

Figure layout.

Indexable

[key: `xaxis${number}`]: unknown

Further xaxis containers (xaxis10, …): the same attributes as xaxis, not type-checked.

[key: `yaxis${number}`]: unknown

Further yaxis containers (yaxis10, …): the same attributes as yaxis, not type-checked.

Properties

autosize?

optional autosize?: boolean;

Size the figure to its container on first render (and on resize with config.responsive).

Default Value

false

---

colorway?

optional colorway?: readonly string[] | string;

Default trace colors, cycled by trace index. A registered colorway's name works too, e.g. 'Safe' (colorblind-safe, always available; Holochart only).

Default Value

["#1f77b4","#ff7f0e","#2ca02c","#d62728","#9467bd","#8c564b","#e377c2","#7f7f7f","#bcbd22","#17becf"]

---

datarevision?

optional datarevision?: unknown;

Change this to force data arrays to be re-read when they are mutated in place.

---

dragmode?

optional dragmode?:
  | "zoom"
  | "pan"
  | "select"
  | "lasso"
  | "drawclosedpath"
  | "drawopenpath"
  | "drawline"
  | "drawrect"
  | "drawcircle"
  | "orbit"
  | "turntable"
  | false;

What dragging on the plot area does: zoom, pan, box or lasso select, or draw a new shape (draw*, styled by newshape).

Default Value

"zoom"

---

font?

optional font?: LayoutFont;

Global font. Every text element inherits unset font fields from here.

---

grid?

optional grid?: LayoutGrid;

A grid of subplots (Plotly layout.grid). Cartesian axes placed in the grid get their domain, anchor, side and position defaults from their cell; domain traces (pie, …) are placed with domain.row / domain.column. Values given on an axis or a trace always win.

---

height?

optional height?: number;

Figure height in CSS pixels. Ignored when autosize fills the container.

Minimum: 10

Default Value

450

---

hovermode?

optional hovermode?: "x" | "y" | "closest" | false | "x unified" | "y unified";

How hover picks points: nearest point, all points at the same x/y, or unified labels.

Default Value

"closest"

---

margin?

optional margin?: LayoutMargin;

Space around the plot area.

---

meta?

optional meta?: unknown;

Arbitrary user data, available in text templates as %{meta}.

---

paper_bgcolor?

optional paper_bgcolor?: string;

Background color of the whole figure.

Default Value

"#fff"

---

plot_bgcolor?

optional plot_bgcolor?: string;

Background color of the plot area between the axes.

Default Value

"#fff"

---

selections?

optional selections?: readonly LayoutSelection[];

Selections as layout objects (plan E5.12): each box or lasso drag in select / lasso mode adds one (shift keeps the others), and every selection on a subplot selects the points inside it (selectedpoints follows). Set them to restore a selection; drag one to move or resize it; a double-click clears them.

---

separators?

optional separators?: string;

Decimal then thousands separator of numbers, e.g. ', ' for 1 234,5. Default: the locale's (config.locale), '.,' in English.

---

showlegend?

optional showlegend?: boolean;

Show the legend. Defaults to true when more than one trace has a legend entry.

---

template?

optional template?: unknown;

Template: a registered name ('dark'), a +-composition ('dark+presentation') or an object { layout, data }. null disables the default template.

---

title?

optional title?: BaseLayoutTitle;

Figure title.

---

transition?

optional transition?: LayoutTransition;

Default transition for animated updates (E7.3).

---

uirevision?

optional uirevision?: unknown;

While unchanged across updates, user interaction state (zoom, legend toggles, selections) is preserved.

---

uniformtext?

optional uniformtext?: LayoutUniformtext;

Uniform text sizing for bar and pie labels (E4.6).

---

width?

optional width?: number;

Figure width in CSS pixels. Ignored when autosize fills the container.

Minimum: 10

Default Value

700

---

xaxis?

optional xaxis?: LayoutXaxis;

A x axis. xaxis2, xaxis3, … declare further x axes, referenced from traces as 'x2', 'x3', ….

---

xaxis2?

optional xaxis2?: LayoutXaxis;

Subplot x2: the same attributes as xaxis.

---

xaxis3?

optional xaxis3?: LayoutXaxis;

Subplot x3: the same attributes as xaxis.

---

xaxis4?

optional xaxis4?: LayoutXaxis;

Subplot x4: the same attributes as xaxis.

---

xaxis5?

optional xaxis5?: LayoutXaxis;

Subplot x5: the same attributes as xaxis.

---

xaxis6?

optional xaxis6?: LayoutXaxis;

Subplot x6: the same attributes as xaxis.

---

xaxis7?

optional xaxis7?: LayoutXaxis;

Subplot x7: the same attributes as xaxis.

---

xaxis8?

optional xaxis8?: LayoutXaxis;

Subplot x8: the same attributes as xaxis.

---

xaxis9?

optional xaxis9?: LayoutXaxis;

Subplot x9: the same attributes as xaxis.

---

yaxis?

optional yaxis?: LayoutYaxis;

A y axis. yaxis2, yaxis3, … declare further y axes, referenced from traces as 'y2', 'y3', ….

---

yaxis2?

optional yaxis2?: LayoutYaxis;

Subplot y2: the same attributes as yaxis.

---

yaxis3?

optional yaxis3?: LayoutYaxis;

Subplot y3: the same attributes as yaxis.

---

yaxis4?

optional yaxis4?: LayoutYaxis;

Subplot y4: the same attributes as yaxis.

---

yaxis5?

optional yaxis5?: LayoutYaxis;

Subplot y5: the same attributes as yaxis.

---

yaxis6?

optional yaxis6?: LayoutYaxis;

Subplot y6: the same attributes as yaxis.

---

yaxis7?

optional yaxis7?: LayoutYaxis;

Subplot y7: the same attributes as yaxis.

---

yaxis8?

optional yaxis8?: LayoutYaxis;

Subplot y8: the same attributes as yaxis.

---

yaxis9?

optional yaxis9?: LayoutYaxis;

Subplot y9: the same attributes as yaxis.