Vyuh Document

Properties inspector ​

The Properties inspector shows the fields of whatever is selected. Every change runs as a command, so it undoes like any other edit.

How the Properties inspector works The selection picks a properties descriptor by element type from the DocumentPropertiesRegistry. The panel shows its tabs, groups and fields, and every change runs as one undoable command. Each level of the panel has an inspector address: destination, tab, group and property. An extension declares its fields with ElementPropertiesContribution, using text, number, color, choice, boolean and code properties. DocumentInspectorConfiguration hides or locks fields by address. Selection paragraph · table · image Descriptor looked up by element type Panel tabs → groups → fields Command one undoable change 1 2 3 4 Equation Equation Layout SOURCE \frac{a}{b} APPEARANCE Text color INSPECTOR ADDRESS destination tab group property ElementPropertiesContribution schemaType · title · icon tabs and sections of properties declared by the element's extension PROPERTY KINDS Text Number Color Choice Boolean Code DocumentInspectorConfiguration hides fields or makes them read-only by address.
From selection to command

Configure access ​

DocumentInspectorConfiguration hides fields or makes them read-only. A DocumentInspectorAddress names a destination, tab, group or property; overrides can also change a label, order or presentation.

dart
import 'package:vyuh_document_editor/vyuh_document_editor.dart';
import 'package:vyuh_document_editor/document_editor_workspace.dart'
    show DocumentInspectorAccess, DocumentInspectorConfiguration;

final inspector = DocumentInspectorConfiguration(
  defaultPropertyAccess: DocumentInspectorAccess.readOnly,
);

// Pass inspector to DocumentPropertiesWorkspace(configuration: inspector).
// For a property allow-list, set defaultPropertyAccess to hidden and provide
// overrides for stable DocumentInspectorAddress values in the registry.
// Unaddressed legacy fields are not filtered by defaultPropertyAccess.

Pass the configuration to DocumentPropertiesWorkspace or DocumentPropertiesPanel. For an allow-list, set defaultPropertyAccess to hidden and override the addresses you allow. An override cannot widen its group's access, and the inspector never grants edit rights the schema or document protection deny.

A custom presentation builder receives the default control. Decorate it and keep its command.

Common properties first ​

Everyday fields (formatting, alignment, spacing, sizes, margins, cell formatting) are open. Advanced groups (pagination rules, section internals, floating anchors) start collapsed. Opening a group changes nothing in the document.

Graphic element properties ​

generatedGraphicLayoutProperties gives equations, Mermaid and diagrams their width, height, orientation and crop fields, all through the element's writeGeometry command.

Next ​