interfaces s–v

Import these from @grafloria/renderer.

Interfaces

SelectPropertyDefinition

Also has every member of PropertyDefinition, listed on its own entry.

Select (dropdown) property definition with options

ts
Copy
interface SelectPropertyDefinition extends PropertyDefinition

Properties

Example

typescript
Copy
const prop: SelectPropertyDefinition = {
  key: 'nodeType',
  label: 'Node Type',
  editor: 'select',
  options: [
    { value: 'table', label: 'Table' },
    { value: 'view', label: 'View' },
    { value: 'procedure', label: 'Stored Procedure', disabled: true }
  ],
  validation: { required: true }
};

SemanticPalette

The host's semantic colour vocabulary (see {@link Theme.categories}). Open-ended: the built-in themes ship the names below, and callers add theirs.

ts
Copy
interface SemanticPalette

Properties

SliderPropertyDefinition

Also has every member of PropertyDefinition, listed on its own entry.

Slider (range) property definition

ts
Copy
interface SliderPropertyDefinition extends PropertyDefinition

Properties

Example

typescript
Copy
const prop: SliderPropertyDefinition = {
  key: 'opacity',
  label: 'Opacity',
  editor: 'slider',
  min: 0,
  max: 100,
  step: 1,
  defaultValue: 100
};

Spacing

Spacing theme (in pixels)

ts
Copy
interface Spacing

Properties

StringPropertyDefinition

Also has every member of PropertyDefinition, listed on its own entry.

String property definition with string-specific validation

ts
Copy
interface StringPropertyDefinition extends PropertyDefinition

Properties

Example

typescript
Copy
const prop: StringPropertyDefinition = {
  key: 'tableName',
  label: 'Table Name',
  editor: 'string',
  validation: {
    required: true,
    minLength: 3,
    maxLength: 50,
    pattern: '^[a-zA-Z][a-zA-Z0-9_]*$'
  }
};

TextAreaPropertyDefinition

Also has every member of PropertyDefinition, listed on its own entry.

Textarea (multi-line text) property definition

ts
Copy
interface TextAreaPropertyDefinition extends PropertyDefinition

Properties

Example

typescript
Copy
const prop: TextAreaPropertyDefinition = {
  key: 'description',
  label: 'Description',
  editor: 'textarea',
  validation: {
    maxLength: 500
  }
};

TextMetrics

Text measurement result.

ts
Copy
interface TextMetrics

Properties

TextStyle

Text styling for measurement.

ts
Copy
interface TextStyle

Properties

Theme

Complete theme definition Supports both CSS Variables (SVG+HTML) and Programmatic (Canvas)

ts
Copy
interface Theme

Properties

Typography

Typography theme

ts
Copy
interface Typography

Properties

ValidationError

Validation error returned from validation functions

ts
Copy
interface ValidationError

Properties

Example

typescript
Copy
const error: ValidationError = {
  message: 'Value must be positive',
  code: 'POSITIVE_VALUE_REQUIRED'
};

ValidationResult

Result of running validation on a property value

ts
Copy
interface ValidationResult

Properties

Example

typescript
Copy
const result: ValidationResult = {
  valid: false,
  errors: [{ message: 'Required field is missing' }]
};

VNode

Virtual Node - Abstract representation of visual element Framework-agnostic, serializable, diffable

Supports both SVG and Canvas rendering modes, as well as HTML content via foreignObject for embedding rich components.

ts
Copy
interface VNode

Properties