Skip to content
sigma.js sigma.js
v4.0.6 Docs Examples GitHub 12.2K

PropertySchema

Defined in: packages/sigma/src/primitives/schema.ts:40

Schema definition for a single property.

T = unknown

The TypeScript type of the property value

PT extends PropertyType = PropertyType

The property type literal (e.g., “number”, “color”)

V extends boolean = boolean

The variable flag type (true, false, or boolean for unknown)

default: T

Defined in: packages/sigma/src/primitives/schema.ts:45

Default value when not specified


type: PT

Defined in: packages/sigma/src/primitives/schema.ts:42

The data type of this property


optional variable?: V

Defined in: packages/sigma/src/primitives/schema.ts:53

Whether this property can be a variable reference in the declarative API. When true: factory option allows ValueSource<T> (e.g., { attribute: “x” } or 0.5) When false: factory option only allows T Default: false