Interface: GraphDataOptions
Experimental
Options the graph functions share: the columns of the edge and node tables.
Extends
Extended by
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
categoryOrders? | readonly | Readonly<Record<string, readonly unknown[]>> | Value orders per column: { day: ['Thu', 'Fri', 'Sat', 'Sun'] }. They order the traces and legend (for grouping columns), facets, frames and category axes. Values not listed follow in order of first appearance; listed values without rows still take a color and a facet (as px). | CommonOptions.categoryOrders |
color? | readonly | ColumnRef | Column to color by. | DiscreteColorOptions.color |
colorDiscreteMap? | readonly | Readonly<Record<string, string>> | "identity" | Fixed colors per value of color ({ Asia: 'red' }); other values continue with the sequence. 'identity': the values are colors themselves (no legend entries for them). | DiscreteColorOptions.colorDiscreteMap |
colorDiscreteSequence? | readonly | readonly string[] | Colors for the values of color, in order. Default: the template's colorway. | DiscreteColorOptions.colorDiscreteSequence |
customData? | readonly | readonly ColumnRef[] | Columns put in customdata (first, before hoverData's), e.g. for click handlers. | HoverOptions.customData |
directed? | readonly | boolean | Experimental Whether links have a direction. graph: arrowheads at the target end (default false). chord: the trace's directed (its default is true). adjacencyMatrix: rows are sources and columns targets; otherwise (the default) a link fills both cells. | - |
height? | readonly | number | Figure height in px (layout.height). | CommonOptions.height |
hoverData? | readonly | | readonly ColumnRef[] | Readonly<Record<string, string | boolean>> | More columns for the hover label, through customdata: a list of columns, or an object that adds columns (true), removes lines (false, e.g. { x: false }) or formats them (':.2f', `' | %Y'`). |
hoverName? | readonly | ColumnRef | Column shown in bold at the top of the hover label (hovertext). | HoverOptions.hoverName |
id? | readonly | ColumnRef | Experimental Node column of the ids that source and target refer to. Default 'id'. | - |
label? | readonly | ColumnRef | Experimental Node column of labels (node.label). Default: the ids. | - |
labels? | readonly | Readonly<Record<string, string>> | Display names of columns: { gdpPercap: 'GDP per capita' }. Used for axis titles, hover lines, the legend title, facet labels, the colorbar title and the animation slider. | CommonOptions.labels |
linkColor? | readonly | ColumnRef | Experimental Edge column to color the links by: one color per value, from linkColorMap and then the color sequence. Links have no legend; the value is a line of the hover label. | - |
linkColorMap? | readonly | Readonly<Record<string, string>> | "identity" | Experimental Fixed link colors per value of linkColor; 'identity': the values are colors. | - |
linkHoverData? | readonly | | readonly ColumnRef[] | Readonly<Record<string, string | boolean>> | Experimental More edge columns for the link hover label, like hoverData. | - |
linkLabel? | readonly | ColumnRef | Experimental Edge column of link labels, for the hover label (link.label). | - |
nodes? | readonly | DataInput | Experimental The node table: one row per node. It gives the nodes labels, colors and hover text, sets their order (nodes that only the edges name follow, in order of first appearance) and adds nodes without links. color, hoverName, hoverData, customData and the other node options name its columns. Without it, they can only be arrays with one value per node, in order of first appearance in the edges. | - |
source? | readonly | ColumnRef | Experimental Edge column of the id of the node a link starts at. Default 'source'. | - |
target? | readonly | ColumnRef | Experimental Edge column of the id of the node a link ends at. Default 'target'. | - |
template? | readonly | string | Template | layout.template: a registered name ('plotly-classic') or a template object. Default: unset, so the chart's default template applies (Holochart's holochart look); its colorway, symbol and dash cycles and sequential colorscale are what the figure's colors are taken from. | CommonOptions.template |
title? | readonly | string | Figure title (layout.title.text). | CommonOptions.title |
weight? | readonly | ColumnRef | Experimental Edge column of link weights (link.value). | - |
width? | readonly | number | Figure width in px (layout.width). | CommonOptions.width |