Skip to content

pie attributes ​

Pie and donut charts: slices proportional to their values, placed by domain, drawn as one instanced GPU arc set with batched SDF labels and leader lines.

  • Categories: domain, pie-like, pie, showLegend
  • Plotly equivalent: pie
  • Guide: pie chart page
  • Used in examples: accessibility/patterns, demos/index-funds/concentration, demos/openrouter/authors-donut, demos/science-basics/composition-pies, legends/grouped-dashboard, pie/basic, pie/depth-donut, pie/depth-exploded, pie/depth-height, pie/depth-tilt, pie/depth, pie/donut, pie/grid-scalegroup, pie/interaction, pie/many-slices, pie/patterns, pie/pulled, pie/text-orientation, pie/uniformtext, reports/regional-revenue

Generated from the attribute schema (126 entries). Machine-readable: plot-schema.json.

Attribute tree

type string ​

Trace type, e.g. 'scatter'. Defaults to 'scatter'.

  • Type: string (non-empty)
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

visible enumerated ​

Whether the trace is drawn. legendonly hides it but keeps its (toggleable) legend entry.

  • Type: enumerated
  • Values: true | false | "legendonly"
  • Default: true
  • Array OK: no
  • Edit type: calc
  • Animatable: no

name string ​

Trace name shown in the legend and hover labels. Defaults to trace N.

  • Type: string
  • Default: none
  • Array OK: no
  • Edit type: legend+plot
  • Animatable: no

uid string ​

Stable identity used to match traces across updates, so reordered traces are moved instead of rebuilt.

  • Type: string
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: no

showlegend boolean ​

Whether this trace has a legend entry.

  • Type: boolean
  • Default: true
  • Array OK: no
  • Edit type: legend+layout
  • Animatable: no

legend subplotid ​

The legend this trace's item is shown in: 'legend' (layout.legend), 'legend2' (layout.legend2), ….

  • Type: subplotid (legend, legend2, legend3, …)
  • Default: "legend"
  • Array OK: no
  • Edit type: legend+layout
  • Animatable: no

legendgroup string ​

Traces in the same legend group toggle together.

  • Type: string
  • Default: ""
  • Array OK: no
  • Edit type: legend
  • Animatable: no

hovertext string ​

Hover text per point; defaults to text.

  • Type: string
  • Default: ""
  • Array OK: yes (one value per point)
  • Edit type: style
  • Animatable: no

hoverinfo flaglist ​

Which fields hover labels show, in a fixed order; 'skip' also turns hover events off for this trace. Default 'all'.

  • Type: flaglist
  • Flags: "label", "text", "value", "percent", "name" (combine with +)
  • Also accepts: "all" | "none" | "skip"
  • Default: none
  • Array OK: yes (one value per point)
  • Edit type: none
  • Animatable: no

hovertemplate string ​

Template for hover labels, e.g. '%{x}: %{y:.2f}<extra></extra>' (d3-format / d3-time-format after : / |). Overrides hoverinfo.

  • Type: string
  • Default: none
  • Array OK: yes (one value per point)
  • Edit type: none
  • Animatable: no

hoverlabel ​

Hover label style for this trace. Unset fields fall back to layout.hoverlabel (so there are no trace-level defaults).

  • Type: object
  • Edit type: none

hoverlabel.bgcolor color ​

Label background. Default: the point color.

  • Type: color
  • Default: none
  • Array OK: yes (one value per point)
  • Edit type: none
  • Animatable: no

hoverlabel.bordercolor color ​

Label border. Default: contrasting with the background.

  • Type: color
  • Default: none
  • Array OK: yes (one value per point)
  • Edit type: none
  • Animatable: no

hoverlabel.font ​

Label font.

  • Type: object
  • Edit type: none

hoverlabel.font.family string ​

Font family.

  • Type: string
  • Default: none
  • Array OK: yes (one value per point)
  • Edit type: none
  • Animatable: no

hoverlabel.font.size number ​

Font size in px.

  • Type: number ≥ 1
  • Default: none
  • Array OK: yes (one value per point)
  • Edit type: none
  • Animatable: no

hoverlabel.font.color color ​

Font color.

  • Type: color
  • Default: none
  • Array OK: yes (one value per point)
  • Edit type: none
  • Animatable: no

hoverlabel.align enumerated ​

Text alignment inside labels.

  • Type: enumerated
  • Values: "left" | "right" | "auto"
  • Default: none
  • Array OK: yes (one value per point)
  • Edit type: none
  • Animatable: no

hoverlabel.namelength integer ​

Characters of the trace name shown (-1: all, 0: none).

  • Type: integer ≥ -1
  • Default: none
  • Array OK: yes (one value per point)
  • Edit type: none
  • Animatable: no

selectedpoints any ​

Indices of the selected points (set by box/lasso selection, or programmatically). null clears the selection.

  • Type: any
  • Default: none
  • Array OK: no
  • Edit type: style
  • Animatable: no

legendrank number ​

Sort key for legend entries: lower ranks come first (top, or left). Ties keep trace order; traces default to 1000.

  • Type: number
  • Default: 1000
  • Array OK: no
  • Edit type: legend
  • Animatable: no

legendwidth number ​

Width of this trace's item in horizontal legends, overriding legend.entrywidth (same units). Default: its text's.

  • Type: number ≥ 0
  • Default: none
  • Array OK: no
  • Edit type: legend
  • Animatable: no

legendgrouptitle ​

Title of the legend group this trace belongs to.

  • Type: object
  • Edit type: legend

legendgrouptitle.text string ​

Title heading this trace's legend group.

  • Type: string
  • Default: ""
  • Array OK: no
  • Edit type: legend
  • Animatable: no

legendgrouptitle.font ​

Group title font. Unset fields come from legend.grouptitlefont.

  • Type: object
  • Edit type: legend

legendgrouptitle.font.family string ​

Font family.

  • Type: string
  • Default: none
  • Array OK: no
  • Edit type: legend
  • Animatable: no

legendgrouptitle.font.size number ​

Font size in px.

  • Type: number ≥ 1
  • Default: none
  • Array OK: no
  • Edit type: legend
  • Animatable: no

legendgrouptitle.font.color color ​

Font color.

  • Type: color
  • Default: none
  • Array OK: no
  • Edit type: legend
  • Animatable: no

legendgrouptitle.font.weight integer ​

Font weight: a CSS numeric weight (1–1000), normal or bold.

  • Type: integer from 1 to 1000, or "normal" | "bold"
  • Default: none
  • Array OK: no
  • Edit type: legend
  • Animatable: no

legendgrouptitle.font.style enumerated ​

Font style.

  • Type: enumerated
  • Values: "normal" | "italic"
  • Default: none
  • Array OK: no
  • Edit type: legend
  • Animatable: no

opacity number ​

Opacity of the whole trace.

  • Type: number from 0 to 1
  • Default: 1
  • Array OK: no
  • Edit type: style
  • Animatable: yes

meta any ​

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

  • Type: any
  • Default: none
  • Array OK: yes (one value per point)
  • Edit type: plot
  • Animatable: no

customdata data_array ​

Per-point user data, returned in events and available in hover templates.

  • Type: data_array (array or typed array)
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

ids data_array ​

Per-point ids used to match points across animation frames.

  • Type: data_array (array or typed array)
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

dataset string ​

Name of a figure-level dataset (figure.datasets). Data arrays, and per-point attributes whose values cannot start with @ (such as colors and sizes), may then reference its columns as '@column'; on string attributes such as text, '@…' stays literal text.

  • Type: string (non-empty)
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

uirevision any ​

While unchanged, user interaction state for this trace (legend visibility, selections) is kept across updates.

  • Type: any
  • Default: none
  • Array OK: no
  • Edit type: none
  • Animatable: no

styleRules any ​

Conditional per-point styling as JSON (plan E8.5): [{ when: { y: { gt: 10 } }, set: { 'marker.color': 'gold' } }]. when tests fields of the point ('y', 'customdata[1]', 'pointNumber', …) with eq, ne, gt, gte, lt, lte, in, nin, between, regex, and, or and not; set gives per-point (arrayOk) attributes a value on the matching points. Later rules win; other points keep the trace's own value.

  • Type: any
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

domain ​

Where this trace is drawn, as a part of the plot area.

  • Type: object
  • Edit type: plot

domain.x info_array ​

Horizontal extent [start, end] of this trace as fractions of the plot area. Defaults to the layout.grid column when column is set, else [0, 1].

  • Type: info_array [number, number]
  • Default: [0, 1]
  • Array OK: no
  • Edit type: plot
  • Animatable: no

domain.y info_array ​

Vertical extent [start, end] of this trace as fractions of the plot area (from the bottom). Defaults to the layout.grid row when row is set, else [0, 1].

  • Type: info_array [number, number]
  • Default: [0, 1]
  • Array OK: no
  • Edit type: plot
  • Animatable: no

domain.row integer ​

Row of the layout.grid cell this trace is placed in (0 = first row in roworder). Only used with a grid.

  • Type: integer ≥ 0
  • Default: 0
  • Array OK: no
  • Edit type: plot
  • Animatable: no

domain.column integer ​

Column of the layout.grid cell this trace is placed in (0 = leftmost). Only used with a grid.

  • Type: integer ≥ 0
  • Default: 0
  • Array OK: no
  • Edit type: plot
  • Animatable: no

labels data_array ​

Slice labels. Slices with the same label are merged: their values are summed (or occurrences counted without values), and other per-slice attributes use the first non-empty entry.

  • Type: data_array (array or typed array)
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

label0 number ​

Without labels: numeric labels label0 + i·dlabel (only used when values is set).

  • Type: number
  • Default: 0
  • Array OK: no
  • Edit type: calc
  • Animatable: no

dlabel number ​

Label step, see label0.

  • Type: number
  • Default: 1
  • Array OK: no
  • Edit type: calc
  • Animatable: no

values data_array ​

Slice values. Non-numeric entries are skipped; merged slices whose total is negative are dropped. Without values every label counts 1.

  • Type: data_array (array or typed array)
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

marker ​

Slice style.

  • Type: object
  • Edit type: calc

marker.colors data_array ​

Slice colors, one per data point. Unset slices take layout.piecolorway colors, shared by label across all pies of the figure.

  • Type: data_array (array or typed array)
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

marker.line ​

Slice outlines.

  • Type: object
  • Edit type: calc

marker.line.color color ​

Slice outline color, or one per slice.

  • Type: color
  • Default: "#444"
  • Array OK: yes (one value per point)
  • Edit type: style
  • Animatable: no

marker.line.width number ​

Slice outline width in CSS px (centered on the edge), or one per slice.

  • Type: number ≥ 0
  • Default: 0
  • Array OK: yes (one value per point)
  • Edit type: style
  • Animatable: no

marker.pattern ​

Hatch pattern of the slice fill (drawn in screen px, for print and grayscale).

  • Type: object
  • Edit type: style

marker.pattern.shape enumerated ​

Hatch shape: diagonal ('/', '\\', 'x'), horizontal and vertical ('-', '|', '+') lines or dots ('.'); '' for none, or one per slice.

  • Type: enumerated
  • Values: "" | "/" | "\\" | "x" | "-" | "|" | "+" | "."
  • Default: ""
  • Array OK: yes (one value per point)
  • Edit type: style
  • Animatable: no

marker.pattern.fillmode enumerated ​

'replace': the pattern in the fill color on bgcolor (default transparent) replaces the fill; 'overlay': the pattern is drawn over the fill color, in its contrast color at half opacity by default.

  • Type: enumerated
  • Values: "replace" | "overlay"
  • Default: "replace"
  • Array OK: no
  • Edit type: style
  • Animatable: no

marker.pattern.bgcolor color ​

Pattern background. Default: the fill color with fillmode: 'overlay', else transparent, or one per slice.

  • Type: color
  • Default: none
  • Array OK: yes (one value per point)
  • Edit type: style
  • Animatable: no

marker.pattern.fgcolor color ​

Pattern color. Default: the fill color with fillmode: 'replace', else white or dark grey, whichever contrasts with bgcolor, or one per slice.

  • Type: color
  • Default: none
  • Array OK: yes (one value per point)
  • Edit type: style
  • Animatable: no

marker.pattern.fgopacity number ​

Opacity of the pattern color. Default 0.5 with fillmode: 'overlay', else 1.

  • Type: number from 0 to 1
  • Default: none
  • Array OK: no
  • Edit type: style
  • Animatable: no

marker.pattern.size number ​

Size of the pattern's tiles in CSS px: the spacing of its lines or dots, or one per slice.

  • Type: number ≥ 0
  • Default: 8
  • Array OK: yes (one value per point)
  • Edit type: style
  • Animatable: no

marker.pattern.solidity number ​

Fraction of the area the pattern covers: 0 shows only the background, 1 only the pattern color, or one per slice.

  • Type: number from 0 to 1
  • Default: 0.3
  • Array OK: yes (one value per point)
  • Edit type: style
  • Animatable: no

text data_array ​

Text per slice, shown on the slice with the text flag of textinfo, and in hover labels unless hovertext is set.

  • Type: data_array (array or typed array)
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: no

scalegroup string ​

Pies with the same non-empty scale group are sized by their totals: their areas are proportional to the sums of their values.

  • Type: string
  • Default: ""
  • Array OK: no
  • Edit type: calc
  • Animatable: no

textinfo flaglist ​

What slice labels show, in a fixed order (label, text, value, percent), one per line. Default 'percent', or 'text+percent' when text is an array. Use texttemplate for other layouts.

  • Type: flaglist
  • Flags: "label", "text", "value", "percent" (combine with +)
  • Also accepts: "none"
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

texttemplate string ​

Template for slice labels, overriding textinfo: %{label}, %{value}, %{percent}, %{text}, %{color}, %{customdata}, %{meta}, with optional d3 formats (%{percent:.1%}). Without a format, value and percent are formatted like textinfo.

  • Type: string
  • Default: ""
  • Array OK: yes (one value per point)
  • Edit type: plot
  • Animatable: no

textposition enumerated ​

Where slice labels go: inside (shrunk to fit), outside (next to the slice, moved apart to avoid overlaps, with leader lines when moved), auto (inside when it fits unshrunk, else outside), none.

  • Type: enumerated
  • Values: "inside" | "outside" | "auto" | "none"
  • Default: "auto"
  • Array OK: yes (one value per point)
  • Edit type: plot
  • Animatable: no

textfont ​

Font of slice labels. Defaults to layout.font.

  • Type: object
  • Edit type: plot

textfont.family string ​

CSS font-family list.

  • Type: string (non-empty)
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: no

textfont.size number ​

Font size in CSS px, or one per slice.

  • Type: number ≥ 1
  • Default: none
  • Array OK: yes (one value per point)
  • Edit type: plot
  • Animatable: no

textfont.color color ​

Text color, or one per slice.

  • Type: color
  • Default: none
  • Array OK: yes (one value per point)
  • Edit type: style
  • Animatable: no

textfont.weight integer ​

Font weight: a CSS numeric weight (1–1000), normal or bold.

  • Type: integer from 1 to 1000, or "normal" | "bold"
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: no

textfont.style enumerated ​

Font style.

  • Type: enumerated
  • Values: "normal" | "italic"
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: no

insidetextorientation enumerated ​

Orientation of inside labels: horizontal, radial (along the radius), tangential (across it), or auto (whichever is largest).

  • Type: enumerated
  • Values: "horizontal" | "radial" | "tangential" | "auto"
  • Default: "auto"
  • Array OK: no
  • Edit type: plot
  • Animatable: no

insidetextfont ​

Font of labels inside slices. Defaults to textfont, with a color contrasting the slice.

  • Type: object
  • Edit type: plot

insidetextfont.family string ​

CSS font-family list.

  • Type: string (non-empty)
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: no

insidetextfont.size number ​

Font size in CSS px, or one per slice.

  • Type: number ≥ 1
  • Default: none
  • Array OK: yes (one value per point)
  • Edit type: plot
  • Animatable: no

insidetextfont.color color ​

Text color, or one per slice.

  • Type: color
  • Default: none
  • Array OK: yes (one value per point)
  • Edit type: style
  • Animatable: no

insidetextfont.weight integer ​

Font weight: a CSS numeric weight (1–1000), normal or bold.

  • Type: integer from 1 to 1000, or "normal" | "bold"
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: no

insidetextfont.style enumerated ​

Font style.

  • Type: enumerated
  • Values: "normal" | "italic"
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: no

outsidetextfont ​

Font of labels outside slices. Defaults to textfont.

  • Type: object
  • Edit type: plot

outsidetextfont.family string ​

CSS font-family list.

  • Type: string (non-empty)
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: no

outsidetextfont.size number ​

Font size in CSS px, or one per slice.

  • Type: number ≥ 1
  • Default: none
  • Array OK: yes (one value per point)
  • Edit type: plot
  • Animatable: no

outsidetextfont.color color ​

Text color, or one per slice.

  • Type: color
  • Default: none
  • Array OK: yes (one value per point)
  • Edit type: style
  • Animatable: no

outsidetextfont.weight integer ​

Font weight: a CSS numeric weight (1–1000), normal or bold.

  • Type: integer from 1 to 1000, or "normal" | "bold"
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: no

outsidetextfont.style enumerated ​

Font style.

  • Type: enumerated
  • Values: "normal" | "italic"
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: no

title ​

The pie title.

  • Type: object
  • Edit type: plot

title.text string ​

Title of the pie. Empty: no title.

  • Type: string
  • Default: ""
  • Array OK: no
  • Edit type: plot
  • Animatable: no

title.font ​

Title font. Defaults to layout.font.

  • Type: object
  • Edit type: plot

title.font.family string ​

CSS font-family list.

  • Type: string (non-empty)
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: no

title.font.size number ​

Font size in CSS px, or one per slice.

  • Type: number ≥ 1
  • Default: none
  • Array OK: yes (one value per point)
  • Edit type: plot
  • Animatable: no

title.font.color color ​

Text color, or one per slice.

  • Type: color
  • Default: none
  • Array OK: yes (one value per point)
  • Edit type: style
  • Animatable: no

title.font.weight integer ​

Font weight: a CSS numeric weight (1–1000), normal or bold.

  • Type: integer from 1 to 1000, or "normal" | "bold"
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: no

title.font.style enumerated ​

Font style.

  • Type: enumerated
  • Values: "normal" | "italic"
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: no

title.position enumerated ​

Where the title goes. Default 'middle center' (inside the hole) for donuts, else 'top center'; 'middle center' needs a hole.

  • Type: enumerated
  • Values: "top left" | "top center" | "top right" | "middle center" | "bottom left" | "bottom center" | "bottom right"
  • Default: none
  • Array OK: no
  • Edit type: plot
  • Animatable: no

hole number ​

Fraction of the radius cut out of the middle: a donut chart when > 0.

  • Type: number from 0 to 1
  • Default: 0
  • Array OK: no
  • Edit type: calc
  • Animatable: no

sort boolean ​

Order slices from largest to smallest.

  • Type: boolean
  • Default: true
  • Array OK: no
  • Edit type: calc
  • Animatable: no

direction enumerated ​

Direction in which slices follow each other. The first slice always has an edge at the starting angle (12 o'clock for rotation: 0).

  • Type: enumerated
  • Values: "clockwise" | "counterclockwise"
  • Default: "counterclockwise"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

rotation angle ​

Starting angle in degrees, clockwise from 12 o'clock.

  • Type: angle (degrees)
  • Default: 0
  • Array OK: no
  • Edit type: calc
  • Animatable: no

pull number ​

Fraction of the radius slices are pulled out from the center, one value for all slices or one per slice.

  • Type: number from 0 to 1
  • Default: 0
  • Array OK: yes (one value per point)
  • Edit type: calc
  • Animatable: no

depth any ​

Extrusion toward the viewer (Holochart extension, 2.5D): CSS px, a percentage of each shape's width ('60%'), or one number per item. 0 (default) draws the trace flat. Seen in perspective with layout.view3d; in the flat view extruded shapes are lit from the front.

  • Type: any
  • Default: 0
  • Array OK: no
  • Edit type: plot
  • Animatable: no

bevel ​

Rounded edges of extruded shapes (with depth).

  • Type: object
  • Edit type: plot

bevel.size number ​

Radius of the rounded front and side edges, CSS px (at most half the size).

  • Type: number ≥ 0
  • Default: 0
  • Array OK: no
  • Edit type: plot
  • Animatable: no

bevel.segments integer ​

Segments of each rounded edge.

  • Type: integer from 1 to 16
  • Default: 3
  • Array OK: no
  • Edit type: plot
  • Animatable: no

material ​

The material of extruded shapes (with depth): Plotly figures keep the default, plotly.

  • Type: object
  • Edit type: calc

material.type enumerated ​

How surfaces are shaded. plotly: Plotly's lighting model. flat: unlit, colors as given. basic, lambert, phong, standard, physical, toon, matcap: the three.js material of that name, lit by the lights of the scene (scene.lighting) or of the 2.5D view.

  • Type: enumerated
  • Values: "plotly" | "flat" | "basic" | "lambert" | "phong" | "standard" | "physical" | "toon" | "matcap"
  • Default: "plotly"
  • Array OK: no
  • Edit type: calc
  • Animatable: no

material.roughness number ​

Surface roughness (standard, physical). Default: lighting.roughness.

  • Type: number from 0 to 1
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

material.metalness number ​

How metallic the surface is (standard, physical). Default 0.

  • Type: number from 0 to 1
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

material.shininess number ​

Sharpness of the highlights (phong). Default: from lighting.roughness.

  • Type: number ≥ 0
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

material.specular color ​

Color of the highlights (phong). Default: lighting.specular gray.

  • Type: color
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

material.emissive color ​

Color the surface emits regardless of the lights. Default black.

  • Type: color
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

material.emissiveintensity number ​

Strength of emissive. Default 1.

  • Type: number ≥ 0
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

material.reflectivity number ​

How much the environment is reflected (basic, lambert, phong, physical).

  • Type: number from 0 to 1
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

material.envmapintensity number ​

Strength of the environment's light (standard, physical). Default 1.

  • Type: number ≥ 0
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

material.clearcoat number ​

A clear lacquer layer (physical). Default 0.

  • Type: number from 0 to 1
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

material.clearcoatroughness number ​

Roughness of the clear coat (physical). Default 0.

  • Type: number from 0 to 1
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

material.transmission number ​

Transmission, for glass-like surfaces (physical). Default 0.

  • Type: number from 0 to 1
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

material.ior number ​

Index of refraction (physical). Default 1.5.

  • Type: number from 1 to 2.333
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

material.thickness number ​

Thickness of transmissive volumes, scene units (physical).

  • Type: number ≥ 0
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

material.sheen number ​

Velvet-like sheen (physical). Default 0.

  • Type: number from 0 to 1
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

material.sheencolor color ​

Color of the sheen (physical).

  • Type: color
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

material.sheenroughness number ​

Roughness of the sheen (physical). Default 1.

  • Type: number from 0 to 1
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

material.iridescence number ​

Thin-film iridescence (physical). Default 0.

  • Type: number from 0 to 1
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

material.steps integer ​

Number of shading bands (toon).

  • Type: integer from 2 to 16
  • Default: 3
  • Array OK: no
  • Edit type: calc
  • Animatable: no

material.matcap string ​

URL of a matcap image (matcap): the surface takes its colors from it by normal direction.

  • Type: string
  • Default: none
  • Array OK: no
  • Edit type: calc
  • Animatable: no

material.castshadow boolean ​

Cast shadows from the lights of scene.lighting with castshadow (onto three.js material types and the ground plane).

  • Type: boolean
  • Default: false
  • Array OK: no
  • Edit type: calc
  • Animatable: no

material.receiveshadow boolean ​

Receive shadows (three.js material types only).

  • Type: boolean
  • Default: false
  • Array OK: no
  • Edit type: calc
  • Animatable: no

tilt number ​

Tilt of the trace in 2.5D (Holochart extension), degrees: positive looks from above, 0 (default) is the flat view. With depth, slices and tiles show their sides.

  • Type: number from -80 to 80
  • Default: 0
  • Array OK: no
  • Edit type: plot
  • Animatable: yes

perspective number ​

Strength of the perspective of a tilted or extruded trace: 0 is a parallel projection, 1 a strong one.

  • Type: number from 0 to 1
  • Default: 0.5
  • Array OK: no
  • Edit type: plot
  • Animatable: yes

Released under the MIT License.