Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GraphNode

The node shape, retrieved as props in [[FlowterFlowchart.nodes]].

Graph prefix is used so that it won't be confused with the global Node type.

Hierarchy

Index

Properties

Properties

Optional bgcolor

bgcolor: undefined | string

The node's background color.

If specified, this will override the default color, which is DEFAULT_NODE_BGCOLOR

Optional fontSize

fontSize: undefined | number

The node text's font size.

If specified, this will override the default font size, which is DEFAULT_FONT_SIZE

Optional height

height: undefined | number

The node's height.

If specified, this will override DEFAULT_NODE_HEIGHT.

Optional symbol

symbol: NodeSymbol

The node's symbol.

If specified, this will override the default shape, which is NodeSymbol.RECTANGLE

text

text: string

The node's text.

Optional width

width: undefined | number

The node's width.

If specified, this will override DEFAULT_NODE_WIDTH.

Optional x

x: undefined | number

The node's x position in the DOM.

If specified, this will be the position used when rendering. Do be careful when setting this option manually; it might not be rendered in accordance to the rest of the nodes, since their positions are being calculated depending on the edges.

Optional y

y: undefined | number

The node's y position in the DOM.

If specified, this will be the position used when rendering. Do be careful when setting this option manually; it might not be rendered in accordance to the rest of the nodes, since their positions are being calculated depending on the edges.

Generated using TypeDoc