@graphty/graphty-element / catalog / OptionDescriptor

Interface: OptionDescriptor

Defined in: graphty-element/src/catalog/types.ts:446

One configurable option, as plain JSON a form can render with no knowledge of Zod.

Extends

• OptionDescriptorDomain

Properties

advanced?

optional advanced?: boolean

Defined in: graphty-element/src/catalog/types.ts:458

---

attributeType?

optional attributeType?: "string" | "number" | "boolean" | "integer" | "time" | "category" | "mixed"

Defined in: graphty-element/src/catalog/types.ts:456

---

default?

optional default?: unknown

Defined in: graphty-element/src/catalog/types.ts:451

---

description?

optional description?: string

Defined in: graphty-element/src/catalog/types.ts:460

---

group?

optional group?: string

Defined in: graphty-element/src/catalog/types.ts:457

---

internal?

optional internal?: boolean

Defined in: graphty-element/src/catalog/types.ts:459

---

max?

optional max?: string | number | OptionBound

Defined in: graphty-element/src/catalog/types.ts:453

---

min?

optional min?: string | number | OptionBound

Defined in: graphty-element/src/catalog/types.ts:452

---

name

name: string

Defined in: graphty-element/src/catalog/types.ts:447

---

on?

optional on?: "node" | "edge"

Defined in: graphty-element/src/catalog/types.ts:442

Nodes (the default) or edges. Meaningful only for type "attribute" or "partition".

Inherited from

OptionDescriptorDomain.on

---

plainName

plainName: string

Defined in: graphty-element/src/catalog/types.ts:448

---

step?

optional step?: number

Defined in: graphty-element/src/catalog/types.ts:454

---

technicalName?

optional technicalName?: string

Defined in: graphty-element/src/catalog/types.ts:449

---

type

type: "string" | "number" | "boolean" | "unknown" | "enum" | "integer" | "node-set" | "seed" | "node-id" | "attribute" | "partition" | "ordering"

Defined in: graphty-element/src/catalog/types.ts:450

---

unsupportedReason?

optional unsupportedReason?: string

Defined in: graphty-element/src/catalog/types.ts:465

Why type is "unknown", in a sentence naming the construct that could not be classified. Present only when type is "unknown".

---

values?

optional values?: readonly OptionChoice[]

Defined in: graphty-element/src/catalog/types.ts:455