Class FormatNode

Hierarchy (view full)

GraphNode<{
format: Scalar<"string">;
} & Record<string, Scalar<DataType>>, {
result: Scalar<"string" | "groupNameRef">;
}>
- FormatNode
  - FormatGroupNameNode

Index

Constructors

constructor

Accessors

area editor height id name picked previewed rect selected view width

Constructors

constructor

new FormatNode(params?): FormatNode
Parameters
- params: FormatNodeParams = {}
Returns FormatNode
Overrides GraphNode.constructor
- Defined in src/lib/graph-editor/nodes/io/FormatNode.ts:28

Properties

`Optional`afterInitialize

afterInitialize?: (() => void)

controls

controls: {} = ...

Node controls

description

description: undefined | string = ...

factory

factory: undefined | NodeFactory = ...

inConnections

inConnections: {} = ...

inEditor

inEditor: boolean = ...

`Readonly`ingoingDataConnections

ingoingDataConnections: Record<string, Connection<GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>, GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>>[]> = ...

`Readonly`ingoingExecConnections

ingoingExecConnections: Record<string, Connection<GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>, GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>>[]> = ...

`Optional`initializePromise

initializePromise?: Promise<void>

`Optional`initialValues

initialValues?: {
controls?: Record<string, unknown>;
inputs?: Record<string, unknown>;
}

inputs

inputs: {
format?: Input<Scalar<"string">>;
} = ...

Node inputs

inputTypes

inputTypes: Record<string, {
datastructure: "scalar" | "array";
type: SocketType;
}> = ...

label

label: string = ...

needsProcessing

needsProcessing: boolean = ...

`Optional`onRemoveIngoingConnection

onRemoveIngoingConnection?: ((conn: Connection<GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>, GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>>) => void)

outConnections

outConnections: {} = ...

`Readonly`outgoingDataConnections

outgoingDataConnections: Record<string, Connection<GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>, GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>>[]> = ...

`Readonly`outgoingExecConnections

outgoingExecConnections: Record<string, Connection<GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>, GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>>[]> = ...

outputs

outputs: {
result?: Output<Scalar<"string" | "groupNameRef">>;
} = ...

Node outputs

outputTypes

outputTypes: Record<string, {
datastructure: "scalar" | "array";
type: SocketType;
}> = ...

`Protected`params

params: Record<string, unknown> = ...

pos

pos: {
x: number;
y: number;
} = ...

`Readonly`pythonComponent

pythonComponent: PythonNodeComponent

selectedInputs

selectedInputs: [string, Input<Socket<SocketType, "scalar" | "array">>][] = ...

selectedOutputs

selectedOutputs: [string, Output<Socket<SocketType, "scalar" | "array">>][] = ...

`Readonly`socketSelectionComponent

socketSelectionComponent: R_SocketSelection_NC

sortedControls

sortedControls: [string, Control][] = ...

sortedInputs

sortedInputs: [string, Input<Socket<SocketType, "scalar" | "array">>][] = ...

sortedOutputs

sortedOutputs: [string, Output<Socket<SocketType, "scalar" | "array">>][] = ...

state

state: {
name?: string;
} & Partial<Record<string, unknown>> = ...

varsType

varsType: DataType

visible

visible: boolean = ...

`Static`activeFactory

activeFactory: undefined | NodeFactory

`Static`description

description: string = ''

`Static`id

id: string

`Static`nodeCounts

nodeCounts: number = 0

`Static`visible

visible: boolean = true

Accessors

area

get area(): undefined | AreaPlugin<Schemes, AreaExtra>
Returns undefined | AreaPlugin<Schemes, AreaExtra>
Inherited from Node.area
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:307

editor

get editor(): undefined | NodeEditor
Returns undefined | NodeEditor
Inherited from Node.editor
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:303

height

get height(): number
Returns number
Inherited from Node.height
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:277
set height(h): void
Parameters
- h: number
Returns void
Inherited from Node.height
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:280

id

get id(): string
Node id, unique string generated by getUID function

Returns string
Inherited from Node.id
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:443

name

get name(): undefined | string
Returns undefined | string
Inherited from Node.name
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:332
set name(n): void
Parameters
- n: string
Returns void
Inherited from Node.name
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:335

picked

get picked(): boolean
Returns boolean
Inherited from Node.picked
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:465

previewed

get previewed(): boolean
Returns boolean
Inherited from Node.previewed
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:447
set previewed(previewed): void
Parameters
- previewed: boolean
Returns void
Inherited from Node.previewed
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:451

rect

get rect(): Rect
Returns Rect
Inherited from Node.rect
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:249

selected

get selected(): boolean
Whether the node is selected. Default is false

Returns boolean
Inherited from Node.selected
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:461

view

get view(): undefined | NodeView
Returns undefined | NodeView
Inherited from Node.view
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:311

width

get width(): number
Returns number
Inherited from Node.width
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:274
set width(w): void
Parameters
- w: number
Returns void
Inherited from Node.width
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:284

Methods

addComponentByClass

addComponentByClass<P, C>(componentClass, params): C
Type Parameters
- P extends Record<string, unknown>
- C extends BaseComponent<ComponentSupportInterface>
Parameters
- componentClass: (new (params: P) => C)
  - - new (params): C
    - Parameters
      params: P
      Returns C
- params: Omit<P, "owner">
Returns C
Inherited from GraphNode.addComponentByClass
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:512

addControl

addControl<K>(key, control): void
Type Parameters
- K extends string
Parameters
- key: K
- control: Control
Returns void
Inherited from GraphNode.addControl
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:489

addInData

addInData<K>(key, params?): Input<({
format: Scalar<"string">;
} & Record<string, Scalar<DataType>>)[K]>
Type Parameters
- K extends string
Parameters
- key: K
- Optionalparams: {
      alwaysShowLabel?: boolean;
      changeType?: ((type: SocketType) => void);
      control?: Partial<InputControlParams<
          | "number"
          | "integer"
          | "vector"
          | "remote-file"
          | "text"
          | "checkbox"
          | "group-name-ref"
          | "textarea"
          | "select">>;
      datastructure?: ({
              format: Scalar<"string">;
          } & Record<string, Scalar<DataType>>)[K]["datastructure"] extends "scalar"
          ? undefined | "scalar"
          : ({
              format: Scalar<"string">;
          } & Record<string, Scalar<DataType>>)[K]["datastructure"];
      description?: string;
      hideLabel?: boolean;
      index?: number;
      initial?: SocketValueType<({
          format: Scalar<"string">;
      } & Record<string, Scalar<DataType>>)[K]["type"]>;
      isRequired?: boolean;
      label?: string;
      options?: string[];
      props?: HTMLInputAttributes;
      type?: ({
          format: Scalar<"string">;
      } & Record<string, Scalar<DataType>>)[K]["type"];
  }
  - OptionalalwaysShowLabel?: boolean
  - OptionalchangeType?: ((type: SocketType) => void)
    - (type): void
      Parameters
      type: SocketType
      Returns void
  - Optionalcontrol?: Partial<InputControlParams<
        | "number"
        | "integer"
        | "vector"
        | "remote-file"
        | "text"
        | "checkbox"
        | "group-name-ref"
        | "textarea"
        | "select">>
  - Optionaldatastructure?: ({
            format: Scalar<"string">;
        } & Record<string, Scalar<DataType>>)[K]["datastructure"] extends "scalar"
        ? undefined | "scalar"
        : ({
            format: Scalar<"string">;
        } & Record<string, Scalar<DataType>>)[K]["datastructure"]
  - Optionaldescription?: string
  - OptionalhideLabel?: boolean
  - Optionalindex?: number
  - Optionalinitial?: SocketValueType<({
    format: Scalar<"string">;
    } & Record<string, Scalar<DataType>>)[K]["type"]>
  - OptionalisRequired?: boolean
  - Optionallabel?: string
  - Optionaloptions?: string[]
  - Optionalprops?: HTMLInputAttributes
  - Optionaltype?: ({
    format: Scalar<"string">;
    } & Record<string, Scalar<DataType>>)[K]["type"]
Returns Input<({
format: Scalar<"string">;
} & Record<string, Scalar<DataType>>)[K]>
Inherited from GraphNode.addInData
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:783

addInExec

addInExec(name?, displayName?): void
Parameters
- name: never = ...
- displayName: string = ''
Returns void
Inherited from GraphNode.addInExec
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:719

addInput

addInput<K>(key, input): void
Type Parameters
- K extends string
Parameters
- key: K
- input: Input<Exclude<({
  format: Scalar<"string">;
  } & Record<string, Scalar<DataType>>)[K], undefined>>
Returns void
Inherited from GraphNode.addInput
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:384

addInputControl

addInputControl<T>(key, params): InputControl<T, "scalar" | "array">
Type Parameters
- T extends
      | "number"
      | "integer"
      | "vector"
      | "remote-file"
      | "text"
      | "checkbox"
      | "group-name-ref"
      | "textarea"
      | "select"
Parameters
- key: string
- params: InputControlParams<T>
Returns InputControl<T, "scalar" | "array">
Inherited from GraphNode.addInputControl
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:890

addOutData

addOutData<K>(key, params): Socket<{
result: Scalar<"string" | "groupNameRef">;
}[K]["type"], "scalar" | {
result: Scalar<"string" | "groupNameRef">;
}[K]["datastructure"]>
Type Parameters
- K extends "result"
Parameters
- key: K
- params: {
      datastructure?: {
          result: Scalar<"string" | "groupNameRef">;
      }[K]["datastructure"];
      description?: string;
      index?: number;
      isArray?: boolean;
      label?: string;
      showLabel?: boolean;
      type: {
          result: Scalar<"string" | "groupNameRef">;
      }[K]["type"];
  }
  - Optionaldatastructure?: {
    result: Scalar<"string" | "groupNameRef">;
    }[K]["datastructure"]
  - Optionaldescription?: string
  - Optionalindex?: number
  - OptionalisArray?: boolean
  - Optionallabel?: string
  - OptionalshowLabel?: boolean
  - type: {
    result: Scalar<"string" | "groupNameRef">;
    }[K]["type"]
Returns Socket<{
result: Scalar<"string" | "groupNameRef">;
}[K]["type"], "scalar" | {
result: Scalar<"string" | "groupNameRef">;
}[K]["datastructure"]>
Inherited from GraphNode.addOutData
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:728

addOutExec

addOutExec(name?, displayName?, isNaturalFlow?): void
Parameters
- name: never = ...
- displayName: string = ''
- isNaturalFlow: boolean = false
Returns void
Inherited from GraphNode.addOutExec
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:903

addOutput

addOutput<K>(key, output): void
Type Parameters
- K extends "result"
Parameters
- key: K
- output: Output<Exclude<{
  result: Scalar<"string" | "groupNameRef">;
  }[K], undefined>>
Returns void
Inherited from GraphNode.addOutput
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:388

applyState

applyState(): void
Returns void
Inherited from GraphNode.applyState
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:528

data

data(inputs?): SocketsValues<{
result: Scalar<"string">;
}>
Parameters
- Optionalinputs: SocketsValues<{
  format: Scalar<"string">;
  } & Record<string, Socket<"any", "scalar" | "array">>>
Returns SocketsValues<{
result: Scalar<"string">;
}>
Overrides GraphNode.data
- Defined in src/lib/graph-editor/nodes/io/FormatNode.ts:74

deselectInput

deselectInput(key): void
Parameters
- key: string
Returns void
Inherited from GraphNode.deselectInput
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:609

deselectOutput

deselectOutput(key): void
Parameters
- key: string
Returns void
Inherited from GraphNode.deselectOutput
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:617

emitResized

emitResized(): Promise<void>
Returns Promise<void>
Inherited from GraphNode.emitResized
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:289

execute

execute(input, forward, forwardExec?): void | Promise<void>
Parameters
- input: never
- forward: ((output: never) => unknown)
  - - (output): unknown
    - Parameters
      output: never
      Returns unknown
- forwardExec: boolean = true
Returns void | Promise<void>
Inherited from GraphNode.execute
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:704

fetchInputs

fetchInputs(): Promise<SocketsValues<{
format: Scalar<"string">;
} & Record<string, Scalar<DataType>>>>
Returns Promise<SocketsValues<{
format: Scalar<"string">;
} & Record<string, Scalar<DataType>>>>
Inherited from GraphNode.fetchInputs
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:629

getArea

getArea(): undefined | AreaPlugin<Schemes, AreaExtra>
Returns undefined | AreaPlugin<Schemes, AreaExtra>
Inherited from GraphNode.getArea
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:655

getConnections

getConnections(): Connection<GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>, GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>>[]
Returns Connection<GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>, GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>>[]
Inherited from GraphNode.getConnections
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:392

getData

getData<K>(key, inputs?): SocketValueWithDatastructure<SocketValueType<({
format: Scalar<"string">;
} & Record<string, Scalar<DataType>>)[K]["type"]>, ({
format: Scalar<"string">;
} & Record<string, Scalar<DataType>>)[K]["datastructure"]>
Type Parameters
- K extends string
Parameters
- key: K
- Optionalinputs: Record<string, unknown>
Returns SocketValueWithDatastructure<SocketValueType<({
format: Scalar<"string">;
} & Record<string, Scalar<DataType>>)[K]["type"]>, ({
format: Scalar<"string">;
} & Record<string, Scalar<DataType>>)[K]["datastructure"]>
Inherited from GraphNode.getData
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:945

getDataflowEngine

getDataflowEngine(): undefined | DataflowEngine<Schemes>
Returns undefined | DataflowEngine<Schemes>
Inherited from GraphNode.getDataflowEngine
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:643

getDataWithInputs

getDataWithInputs<K>(key): Promise<SocketValueWithDatastructure<SocketValueType<({
format: Scalar<"string">;
} & Record<string, Scalar<DataType>>)[K]["type"]>, ({
format: Scalar<"string">;
} & Record<string, Scalar<DataType>>)[K]["datastructure"]>>
Type Parameters
- K extends string
Parameters
- key: K
Returns Promise<SocketValueWithDatastructure<SocketValueType<({
format: Scalar<"string">;
} & Record<string, Scalar<DataType>>)[K]["type"]>, ({
format: Scalar<"string">;
} & Record<string, Scalar<DataType>>)[K]["datastructure"]>>
Inherited from GraphNode.getDataWithInputs
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:936

getEditor

getEditor(): undefined | NodeEditor
Returns undefined | NodeEditor
Inherited from GraphNode.getEditor
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:647

getFactory

getFactory(): undefined | NodeFactory
Returns undefined | NodeFactory
Inherited from GraphNode.getFactory
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:378

getFormatVariablesKeys

getFormatVariablesKeys(): Record<string, string>
Returns Record<string, string>
- Defined in src/lib/graph-editor/nodes/io/FormatNode.ts:57

getNaturalFlow

getNaturalFlow(): undefined | string
Returns undefined | string
Inherited from GraphNode.getNaturalFlow
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:625

getOutData

getOutData(): Record<string, unknown>
Returns Record<string, unknown>
Inherited from GraphNode.getOutData
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:998

getOutgoers

getOutgoers(key): null | GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>[]
Parameters
- key: string
Returns null | GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>[]
Inherited from GraphNode.getOutgoers
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:499

getPosition

getPosition(): undefined | {
x: number;
y: number;
}
Returns undefined | {
x: number;
y: number;
}
Inherited from GraphNode.getPosition
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:524

getState

getState(): Record<string, unknown>
Returns Record<string, unknown>
Inherited from GraphNode.getState
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:381

getValues

getValues(inputs?): Record<string, unknown>
Parameters
- Optionalinputs: Record<string, unknown>
Returns Record<string, unknown>
- Defined in src/lib/graph-editor/nodes/io/FormatNode.ts:66

getWaitForChildrenPromises

getWaitForChildrenPromises(output): Promise<void>
Parameters
- output: never
Returns Promise<void>
Inherited from GraphNode.getWaitForChildrenPromises
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:698

getWaitPromises

getWaitPromises(nodes): Promise<void>[]
Parameters
- nodes: GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>[]
Returns Promise<void>[]
Inherited from GraphNode.getWaitPromises
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:932

hasControl

hasControl<K>(key): boolean
Type Parameters
- K extends string
Parameters
- key: K
Returns boolean
Inherited from GraphNode.hasControl
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:486

hasInput

hasInput<K>(key): boolean
Type Parameters
- K extends string
Parameters
- key: K
Returns boolean
Inherited from GraphNode.hasInput
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:469

hasOutput

hasOutput<K>(key): boolean
Type Parameters
- K extends "result"
Parameters
- key: K
Returns boolean
Inherited from GraphNode.hasOutput
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:480

makeInputControl

makeInputControl<T, D>(params): InputControl<T, "scalar" | "array">
Type Parameters
- T extends
      | "number"
      | "integer"
      | "vector"
      | "remote-file"
      | "text"
      | "checkbox"
      | "group-name-ref"
      | "textarea"
      | "select"
- D extends "scalar" | "array" = "scalar" | "array"
Parameters
- params: InputControlParams<T, D>
Returns InputControl<T, "scalar" | "array">
Inherited from GraphNode.makeInputControl
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:875

oldAddInData

oldAddInData<N>(__namedParameters): Input<Socket<SocketType, "scalar" | "array">>
Type Parameters
- N
Parameters
- __namedParameters: InDataParams<N>
Returns Input<Socket<SocketType, "scalar" | "array">>
Inherited from GraphNode.oldAddInData
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:855

oldAddOutData

oldAddOutData(__namedParameters): void
Parameters
- __namedParameters: OutDataParams
Returns void
Inherited from GraphNode.oldAddOutData
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:762

onEndExecute

onEndExecute(): void
Returns void
Inherited from GraphNode.onEndExecute
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:660

processDataflow

processDataflow(): void
Returns void
Inherited from GraphNode.processDataflow
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:917

removeControl

removeControl(key): void
Parameters
- key: string
Returns void
Inherited from GraphNode.removeControl
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:492

removeInput

removeInput(key): void
Parameters
- key: string
Returns void
Inherited from GraphNode.removeInput
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:472

removeOutput

removeOutput(key): void
Parameters
- key: "result"
Returns void
Inherited from GraphNode.removeOutput
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:483

selectInput

selectInput(key): void
Parameters
- key: string
Returns void
Inherited from GraphNode.selectInput
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:605

selectOutput

selectOutput(key): void
Parameters
- key: string
Returns void
Inherited from GraphNode.selectOutput
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:613

setData

setData(key, value): void
Parameters
- key: string
- value: unknown
Returns void
Inherited from GraphNode.setData
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:991

setFactory

setFactory(nodeFactory): void
Parameters
- nodeFactory: NodeFactory
Returns void
Inherited from GraphNode.setFactory
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:651

setNaturalFlow

setNaturalFlow(outExec): void
Parameters
- outExec: undefined | string
Returns void
Inherited from GraphNode.setNaturalFlow
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:621

setState

setState(state): void
Parameters
- state: Record<string, unknown>
Returns void
Inherited from GraphNode.setState
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:495

toJSON

toJSON(): NodeSaveData
Returns NodeSaveData
Inherited from GraphNode.toJSON
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:532

updateDataInputs

updateDataInputs(inputs?): void
Parameters
- Optionalinputs: Record<string, unknown>
Returns void
- Defined in src/lib/graph-editor/nodes/io/FormatNode.ts:91

updateElement

updateElement(type?, id?): void
Parameters
- type:
      | "node"
      | "connection"
      | "socket"
      | "control" = 'node'
- Optionalid: string
Returns void
Inherited from GraphNode.updateElement
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:1002

waitForEndExecutePromise

waitForEndExecutePromise(): Promise<void>
Returns Promise<void>
Inherited from GraphNode.waitForEndExecutePromise
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:670

`Static`fromJSON

fromJSON(data, __namedParameters): Promise<GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>>
Parameters
- data: NodeSaveData
- __namedParameters: {
  factory?: NodeFactory;
  }
  - Optionalfactory?: NodeFactory
Returns Promise<GraphNode<Record<string, Socket<SocketType, "scalar" | "array">>, {}, {}, Record<string, unknown>, Record<string, unknown>>>
Inherited from GraphNode.fromJSON
- Defined in src/lib/graph-editor/nodes/Node.svelte.ts:572

Class FormatNode

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns FormatNode

Properties

OptionalafterInitialize

controls

description

factory

inConnections

inEditor

ReadonlyingoingDataConnections

ReadonlyingoingExecConnections

OptionalinitializePromise

OptionalinitialValues

inputs

inputTypes

label

needsProcessing

OptionalonRemoveIngoingConnection

outConnections

ReadonlyoutgoingDataConnections

ReadonlyoutgoingExecConnections

outputs

outputTypes

Protectedparams

pos

ReadonlypythonComponent

selectedInputs

selectedOutputs

ReadonlysocketSelectionComponent

sortedControls

sortedInputs

sortedOutputs

state

varsType

visible

StaticactiveFactory

Staticdescription

Staticid

StaticnodeCounts

Staticvisible

Accessors

area

Returns undefined | AreaPlugin<Schemes, AreaExtra>

editor

Returns undefined | NodeEditor

height

Returns number

Parameters

Returns void

id

Returns string

name

Returns undefined | string

Parameters

Returns void

picked

Returns boolean

previewed

Returns boolean

Parameters

Returns void

rect

Returns Rect

selected

Returns boolean

view

Returns undefined | NodeView

width

Returns number

Parameters

Returns void

`Optional`afterInitialize

`Readonly`ingoingDataConnections

`Readonly`ingoingExecConnections

`Optional`initializePromise

`Optional`initialValues

`Optional`onRemoveIngoingConnection

`Readonly`outgoingDataConnections

`Readonly`outgoingExecConnections

`Protected`params

`Readonly`pythonComponent

`Readonly`socketSelectionComponent

`Static`activeFactory

`Static`description

`Static`id

`Static`nodeCounts

`Static`visible

`Optional`alwaysShowLabel?: boolean

`Optional`changeType?: ((type: SocketType) => void)

`Optional`control?: Partial<InputControlParams<
| "number"
| "integer"
| "vector"
| "remote-file"
| "text"
| "checkbox"
| "group-name-ref"
| "textarea"
| "select">>

`Optional`datastructure?: ({
format: Scalar<"string">;
} & Record<string, Scalar<DataType>>)[K]["datastructure"] extends "scalar"
? undefined | "scalar"
: ({
format: Scalar<"string">;
} & Record<string, Scalar<DataType>>)[K]["datastructure"]

`Optional`description?: string

`Optional`hideLabel?: boolean

`Optional`index?: number

`Optional`initial?: SocketValueType<({
format: Scalar<"string">;
} & Record<string, Scalar<DataType>>)[K]["type"]>

`Optional`isRequired?: boolean

`Optional`label?: string

`Optional`options?: string[]

`Optional`props?: HTMLInputAttributes

`Optional`type?: ({
format: Scalar<"string">;
} & Record<string, Scalar<DataType>>)[K]["type"]

Returns Input<({
format: Scalar<"string">;
} & Record<string, Scalar<DataType>>)[K]>

`Optional`datastructure?: {
result: Scalar<"string" | "groupNameRef">;
}[K]["datastructure"]

`Optional`description?: string

`Optional`index?: number

`Optional`isArray?: boolean

`Optional`label?: string

`Optional`showLabel?: boolean

type: {
result: Scalar<"string" | "groupNameRef">;
}[K]["type"]

Returns Socket<{
result: Scalar<"string" | "groupNameRef">;
}[K]["type"], "scalar" | {
result: Scalar<"string" | "groupNameRef">;
}[K]["datastructure"]>

Returns SocketsValues<{
result: Scalar<"string">;
}>