Skip to content

Variable: polarAttributes ​

ts
const polarAttributes: ObjectNode<{
  angularaxis: ObjectNode<{
     direction: Attr<"clockwise" | "counterclockwise", {
        description: "Direction of increasing angles.";
        dflt: "counterclockwise";
        editType: "plot";
        values: readonly ["counterclockwise", "clockwise"];
     }>;
     period: Attr<number, {
        description: "Number of category positions around the circle of a `category` angular axis. Defaults to the number of categories.";
        editType: "plot";
        min: 0;
     }>;
     rotation: Attr<number, {
        description: "Where the angular axis starts, in degrees counterclockwise from 3 o’clock. Defaults to 0 (east) with `direction: counterclockwise` and 90 (north, like a compass) with `clockwise`.";
        editType: "plot";
     }>;
     thetaunit: Attr<"radians" | "degrees", {
        description: "Unit of the tick labels and hover values of a `linear` angular axis.";
        dflt: "degrees";
        editType: "plot";
        values: readonly ["radians", "degrees"];
     }>;
     type: Attr<"linear" | "-" | "category", {
        description: "Angular axis type. `'-'` detects it from the `theta` data of the first trace on the subplot. `linear`: `thetaunit` sets how labels read; `category`: `period` sets how many categories go around the circle.";
        dflt: "-";
        editType: "calc";
        values: readonly ["-", "linear", "category"];
     }>;
  }>;
  bargap: Attr<number, {
     description: "Gap between `barpolar` bars at adjacent angles, as a fraction of the smallest angle difference in the data.";
     dflt: 0.1;
     editType: "calc";
     max: 1;
     min: 0;
  }>;
  barmode: Attr<"overlay" | "stack", {
     description: "`barpolar` bars at the same angle: `stack` stacks them outwards, `overlay` draws them over one another (reduce `opacity` to see through).";
     dflt: "stack";
     editType: "calc";
     values: readonly ["stack", "overlay"];
  }>;
  bgcolor: Attr<string, {
     description: "Background color of the subplot.";
     dflt: "#fff";
     editType: "plot";
  }>;
  domain: ObjectNode<{
     column: Attr<number, {
        description: "Column of the `layout.grid` cell this trace is placed in (0 = leftmost). Only used with a grid.";
        dflt: 0;
        editType: "plot";
        min: 0;
     }>;
     row: Attr<number, {
        description: "Row of the `layout.grid` cell this trace is placed in (0 = first row in `roworder`). Only used with a grid.";
        dflt: 0;
        editType: "plot";
        min: 0;
     }>;
     x: AttrSpec<[number, number], [number, number]>;
     y: AttrSpec<[number, number], [number, number]>;
  }>;
  gridshape: Attr<"linear" | "circular", {
     description: "Radial grid lines and the angular axis line as circles (`circular`) or polygons through the category angles (`linear`: radar charts). Category angular axes only.";
     dflt: "circular";
     editType: "plot";
     values: readonly ["circular", "linear"];
  }>;
  hole: Attr<number, {
     description: "Fraction of the radius cut out of the middle.";
     dflt: 0;
     editType: "plot";
     max: 1;
     min: 0;
  }>;
  radialaxis: ObjectNode<{
     angle: Attr<number, {
        description: "Angle in degrees (counterclockwise from 3 o’clock) along which the radial axis is drawn. Defaults to the first `sector` angle.";
        editType: "plot";
     }>;
     rangemode: Attr<"normal" | "tozero" | "nonnegative", {
        description: "Linear axes only. `tozero`: the autorange extends to 0 whatever the data; `nonnegative`: it stays ≥ 0; `normal`: it follows the data extremes, like a cartesian axis.";
        dflt: "tozero";
        editType: "plot";
        values: readonly ["tozero", "nonnegative", "normal"];
     }>;
     side: Attr<"clockwise" | "counterclockwise", {
        description: "On which side of the radial axis line its ticks and labels are drawn.";
        dflt: "clockwise";
        editType: "plot";
        values: readonly ["clockwise", "counterclockwise"];
     }>;
     title: ObjectNode<{
        font: ObjectNode<{
           color: Attr<string, {
              description: "Text color.";
           }>;
           family: Attr<string, {
              description: "CSS font-family list. The renderer uses the first family it can load and falls back through the list.";
              noBlank: true;
              strict: true;
           }>;
           lineposition: Attr<
              | "none"
              | "under"
              | "over"
              | "through"
              | `under+${(...)}`
              | `over+${(...)}`
              | `through+${(...)}`, {
              description: "Text decoration: `under`, `over` and/or `through` joined with `+` (e.g. `under+over`), or `none`.";
              extras: readonly [...];
              flags: readonly [..., ..., ...];
           }>;
           shadow: Attr<string, {
              description: "CSS `text-shadow` behind the text (`2px 2px 3px black`; only the first shadow is drawn), `none`, or `auto` for a thin halo in the contrast color of the text.";
           }>;
           size: Attr<number, {
              description: "Font size in CSS pixels.";
              min: 1;
           }>;
           style: Attr<"normal" | "italic", {
              description: "Font style.";
              values: readonly [..., ...];
           }>;
           textcase: Attr<"normal" | "word caps" | "upper" | "lower", {
              description: "Letter case transform: `upper`, `lower`, `word caps` (first letter of each word), or `normal`.";
              values: readonly [..., ..., ..., ...];
           }>;
           variant: Attr<
              | "normal"
              | "small-caps"
              | "all-small-caps"
              | "all-petite-caps"
              | "petite-caps"
              | "unicase", {
              description: "Capitals variant (CSS `font-variant-caps`). The SDF text renderer approximates small and petite caps with uppercase letters at a reduced size.";
              values: readonly [..., ..., ..., ..., ..., ...];
           }>;
           weight: Attr<number | "normal" | "bold", {
              description: "Font weight: a CSS numeric weight (1–1000), `normal` or `bold`.";
              extras: readonly [..., ...];
              max: 1000;
              min: 1;
           }>;
        }>;
        text: Attr<string, {
           description: "Radial axis title.";
           dflt: "";
           editType: "plot";
        }>;
     }>;
     type: Attr<"linear" | "-" | "log" | "date" | "category", {
        description: "Radial axis type. `'-'` detects it from the `r` data of the first trace on the subplot.";
        dflt: "-";
        editType: "calc";
        values: readonly ["-", "linear", "log", "date", "category"];
     }>;
  }>;
  sector: AttrSpec<[number, number], [number, number]>;
  uirevision: AttrSpec<unknown, unknown>;
}>;

Experimental

The polar subplot container family (polar, polar2, …).

Released under the MIT License.