Skip to content

components/flow#

createFlowConfiguration()#

function createFlowConfiguration(config): FlowConfiguration;

Parameters#

Parameter Type
config FlowConfiguration

Returns#

FlowConfiguration

createFlowNodeSet()#

function createFlowNodeSet<T, AttrsMap>(nodeSet): FlowNodeSet;

Type Parameters#

Type Parameter Default type
T extends string -
AttrsMap extends NodeTypeToAttrs<T> NodeTypeToAttrs<T>

Parameters#

Parameter Type
nodeSet FlowNodeSet<T, AttrsMap>

Returns#

FlowNodeSet

FlowSettingsPanel()#

function FlowSettingsPanel(): Element;

Returns#

Element

useFlow()#

function useFlow(configuration): {
  configuration: FlowConfiguration;
  registry: FlowRegistry;
};

Parameters#

Parameter Type
configuration FlowConfiguration

Returns#

{
  configuration: FlowConfiguration;
  registry: FlowRegistry;
}

configuration#

configuration: FlowConfiguration;

registry#

registry: FlowRegistry;

abstract BaseFlowNode#

Type Parameters#

Type Parameter Default type
T extends string string

Constructors#

Constructor#

new BaseFlowNode<T>(): BaseFlowNode<T>;
Returns#

BaseFlowNode<T>

Methods#

render()#

abstract render(props): Element;
Parameters#
Parameter Type
props NodeProps<Node<FlowNodeData<AttrsT>, T>>
Returns#

Element

wrapNode()#

protected wrapNode(
   type, 
   id, 
   children, 
   props?): Element;
Parameters#
Parameter Type
type T
id string
children ReactNode
props? any
Returns#

Element

Properties#

type#

abstract type: T;

GRAPH_UPDATE_EVENT#

const GRAPH_UPDATE_EVENT: "graph-update" = "graph-update";

LOAD_GRAPH_EVENT#

const LOAD_GRAPH_EVENT: "load-graph" = "load-graph";

SAVE_GRAPH_EVENT#

const SAVE_GRAPH_EVENT: "save-graph" = "save-graph";

SET_GRAPH_VARS_EVENT#

const SET_GRAPH_VARS_EVENT: "set-variables" = "set-variables";

Action#

Re-exports Action

BaseDType#

Re-exports BaseDType

ChannelId#

Re-exports ChannelId

Command#

Re-exports Command

DType#

Re-exports DType

DynamicFlowNodeSignature#

Re-exports DynamicFlowNodeSignature

DynamicInput#

Re-exports DynamicInput

FlowArgument#

Re-exports FlowArgument

FlowAttribute#

Re-exports FlowAttribute

FlowAttributeDefinition#

Re-exports FlowAttributeDefinition

FlowCanvas#

Re-exports FlowCanvas

FlowConfiguration#

Re-exports FlowConfiguration

FlowContext#

Re-exports FlowContext

FlowNode#

Re-exports FlowNode

FlowNodeBase#

Re-exports FlowNodeBase

FlowNodeComponent#

Re-exports FlowNodeComponent

FlowNodeData#

Re-exports FlowNodeData

FlowNodeDefinition#

Re-exports FlowNodeDefinition

FlowNodeProps#

Re-exports FlowNodeProps

FlowNodeSet#

Re-exports FlowNodeSet

FlowNodeSettingsComponent#

Re-exports FlowNodeSettingsComponent

FlowNodeSettingsInfo#

Re-exports FlowNodeSettingsInfo

FlowNodeSignature#

Re-exports FlowNodeSignature

FlowNodeWrapper#

Re-exports FlowNodeWrapper

FlowProvider#

Re-exports FlowProvider

FlowRegistry#

Re-exports FlowRegistry

FlowSidebar#

Re-exports FlowSidebar

NodeExecutionStatus#

Re-exports NodeExecutionStatus

NodeTypeToAttrs#

Re-exports NodeTypeToAttrs

RawPlotSegment#

Re-exports RawPlotSegment

SpecialAction#

Re-exports SpecialAction

SpecialCommand#

Re-exports SpecialCommand

useFlowContext#

Re-exports useFlowContext

useFlowNode#

Re-exports useFlowNode