Skip to content
This is the alpha v4 version website. Looking for the v3 documentation?

PropertySchema

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

Schema definition for a single property.

Type Parameters

T

T = unknown

The TypeScript type of the property value

PT

PT extends PropertyType = PropertyType

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

V

V extends boolean = boolean

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

Properties

default

default: T

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

Default value when not specified


type

type: PT

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

The data type of this property


variable?

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