Text Note
LayoutThe TextNote block provides frameless, rich-text on-canvas annotation for documenting block diagram models, equations, operating instructions, and subsystem architectures. It has no signal inputs or outputs and introduces zero computational overhead to the simulation engine. The block features integrated mathematical formula rendering (LaTeX/KaTeX math between dollar signs ), automatic or manual tile sizing, configurable typography and color palettes, and smart dynamic color synchronization with anchored signal wires.
Mathematical Model
The block operates as a static visual layout annotation. Incoming textual strings and styling attributes are rendered directly onto the canvas document object model without affecting numerical solver states:
Text enclosed within dollar signs is parsed and rendered via KaTeX mathematical typesetting:
When textColor = "signal" and the note is anchored to a signal connection wire, the note text dynamically inherits the wire's stroke color:
Parameters
| Parameters | Label | Type | Default | Description |
|---|---|---|---|---|
userNotes |
Content | text | |
|
autoSize |
Auto-size | boolean | true |
|
fontSize |
Size | select | medium |
|
textColor |
Text color | select | default |
Text colour. "Match signal" follows the anchored signal's colour. |
fillColor |
Fill | select | none |
|
border |
Border | select | accent |
|
textAlign |
Align | select | left |
Usage Examples
Example 1: Documenting Physical Plant Differential Equations
Placing a TextNote above an interconnected mass-spring-damper diagram to present the underlying second-order Newton-Euler equation. Writing userNotes = "Newton-Euler Balance:\n" renders a textbook KaTeX equation directly on the canvas, clarifying the mechanical dynamics for students and collaborating engineers.
Example 2: Signal-Matched Wire Callout and Operating Limit Warning
Annotating a critical control voltage connection. Configuring userNotes = "Maximum Motor Armature Voltage: ยฑ24V", textColor = "signal", fillColor = "yellow", and border = "solid". Anchoring the note to the motor driver wire synchronizes text color with the connection wire while the yellow box highlights electrical limits.
Remarks & Best Practices
- KaTeX Mathematical Typesetting: Text enclosed between single dollar signs (e.g.
) is rendered with KaTeX mathematical typography without external plugin dependencies. - Signal Color Synchronization: Selecting
textColor = "signal"automatically tracks the color of the connection line to which the note is anchored, ensuring visual consistency across complex multi-branch diagrams. - Zero Simulation Overhead: Ignored during simulation compilation and topological sorting; causes zero numerical solver delay or memory allocation.
- Markdown Line Breaks: Supports standard multi-line text input with automatic word wrapping.
Related Components
- Area: Visually bounds and groups related functional subsystems with a shaded background container.
- Subsystem: Encapsulates complex block topologies into modular, reusable canvas components.
- NumericDisplay: Real-time numerical signal readout.
- Scope: Multi-channel graphical waveform visualization.