ChainGraph API Documentation / @badaitech/chaingraph-types / ObjectPortConfig

Interface: ObjectPortConfig<S>

Defined in: packages/chaingraph-types/src/port/base/types.ts:204

Object port configuration

Extends

• BasePortConfig

Type Parameters

S

S extends IObjectSchema = IObjectSchema

Properties

connections?

optional connections: Connection[]

Defined in: packages/chaingraph-types/src/port/base/types.ts:146

Inherited from

BasePortConfig.connections

---

defaultValue?

optional defaultValue: ObjectPortValue<S>

Defined in: packages/chaingraph-types/src/port/base/types.ts:209

---

description?

optional description: string

Defined in: packages/chaingraph-types/src/port/base/types.ts:143

Inherited from

BasePortConfig.description

---

direction?

optional direction: PortDirectionEnum

Defined in: packages/chaingraph-types/src/port/base/types.ts:144

Inherited from

BasePortConfig.direction

---

id?

optional id: string

Defined in: packages/chaingraph-types/src/port/base/types.ts:135

Inherited from

BasePortConfig.id

---

isSchemaMutable?

optional isSchemaMutable: boolean

Defined in: packages/chaingraph-types/src/port/base/types.ts:208

---

key?

optional key: string

Defined in: packages/chaingraph-types/src/port/base/types.ts:141

Inherited from

BasePortConfig.key

---

metadata?

optional metadata: Record<string, unknown>

Defined in: packages/chaingraph-types/src/port/base/types.ts:137

Inherited from

BasePortConfig.metadata

---

name?

optional name: string

Defined in: packages/chaingraph-types/src/port/base/types.ts:136

Inherited from

BasePortConfig.name

---

nodeId?

optional nodeId: string

Defined in: packages/chaingraph-types/src/port/base/types.ts:140

Inherited from

BasePortConfig.nodeId

---

order?

optional order: number

Defined in: packages/chaingraph-types/src/port/base/types.ts:147

Inherited from

BasePortConfig.order

---

parentId?

optional parentId: string

Defined in: packages/chaingraph-types/src/port/base/types.ts:139

Inherited from

BasePortConfig.parentId

---

required?

optional required: boolean

Defined in: packages/chaingraph-types/src/port/base/types.ts:138

Inherited from

BasePortConfig.required

---

schema

schema: S

Defined in: packages/chaingraph-types/src/port/base/types.ts:207

---

title?

optional title: string

Defined in: packages/chaingraph-types/src/port/base/types.ts:142

Inherited from

BasePortConfig.title

---

type

type: "object"

Defined in: packages/chaingraph-types/src/port/base/types.ts:205

Overrides

BasePortConfig.type

---

ui?

optional ui: object & object & object

Defined in: packages/chaingraph-types/src/port/base/types.ts:210

Type Declaration

bgColor?

optional bgColor: string

borderColor?

optional borderColor: string

disabled?

optional disabled: boolean

hidden?

optional hidden: boolean

hideEditor?

optional hideEditor: boolean

hidePort?

optional hidePort: boolean

Type Declaration

allowedTypes?

optional allowedTypes: ("string" | "number" | "boolean" | "object" | "array" | "stream" | "enum" | "any")[]

bgColor?

optional bgColor: string

borderColor?

optional borderColor: string

collapsed?

optional collapsed: boolean

disabled?

optional disabled: boolean

hidden?

optional hidden: boolean

hideEditor?

optional hideEditor: boolean

hideInternalProperties?

optional hideInternalProperties: boolean

hidePort?

optional hidePort: boolean

hidePropertyEditor?

optional hidePropertyEditor: boolean

keyDeletable?

optional keyDeletable: boolean

nodeSchemaCapture?

optional nodeSchemaCapture: object

nodeSchemaCapture.capturedNodeId?

optional capturedNodeId: string

nodeSchemaCapture.enabled?

optional enabled: boolean

Overrides

BasePortConfig.ui