# @grethel-labs/excaliplant — API reference > Generated from JSDoc by [`docs/scripts/build-docs.mjs`](./scripts/build-docs.mjs) > on every `npm run build:docs` run. Do not edit this file by hand. > **v0.19.5** · MIT This is the auto-generated API reference for `@grethel-labs/excaliplant`. The shape of the public API is documented in [`README.md`](../README.md); this document is the exhaustive view across every exported symbol in [`index.mjs`](../index.mjs) and [`src/`](../src/). ## Table of contents - [`(package root)`](#package-root) - [`diagrams/activity/assets`](#diagramsactivityassets) - [`diagrams/activity/docs`](#diagramsactivitydocs) - [`diagrams/activity/layout`](#diagramsactivitylayout) - [`diagrams/activity/module`](#diagramsactivitymodule) - [`diagrams/activity/parser`](#diagramsactivityparser) - [`diagrams/activity/plugins/syntax`](#diagramsactivitypluginssyntax) - [`diagrams/activity/render`](#diagramsactivityrender) - [`diagrams/activity/security`](#diagramsactivitysecurity) - [`diagrams/activity/tests`](#diagramsactivitytests) - [`diagrams/archimate/assets`](#diagramsarchimateassets) - [`diagrams/archimate/docs`](#diagramsarchimatedocs) - [`diagrams/archimate/docs/coverage_examples`](#diagramsarchimatedocscoverage_examples) - [`diagrams/archimate/layout`](#diagramsarchimatelayout) - [`diagrams/archimate/module`](#diagramsarchimatemodule) - [`diagrams/archimate/parser`](#diagramsarchimateparser) - [`diagrams/archimate/render`](#diagramsarchimaterender) - [`diagrams/archimate/security`](#diagramsarchimatesecurity) - [`diagrams/archimate/tests`](#diagramsarchimatetests) - [`diagrams/base/artifacts`](#diagramsbaseartifacts) - [`diagrams/base/assets`](#diagramsbaseassets) - [`diagrams/base/dependencies`](#diagramsbasedependencies) - [`diagrams/base/docs`](#diagramsbasedocs) - [`diagrams/base/layout`](#diagramsbaselayout) - [`diagrams/base/module`](#diagramsbasemodule) - [`diagrams/base/parser`](#diagramsbaseparser) - [`diagrams/base/renderer`](#diagramsbaserenderer) - [`diagrams/base/security`](#diagramsbasesecurity) - [`diagrams/base/tests`](#diagramsbasetests) - [`diagrams/chart/assets`](#diagramschartassets) - [`diagrams/chart/docs`](#diagramschartdocs) - [`diagrams/chart/docs/coverage_examples`](#diagramschartdocscoverage_examples) - [`diagrams/chart/layout`](#diagramschartlayout) - [`diagrams/chart/module`](#diagramschartmodule) - [`diagrams/chart/parser`](#diagramschartparser) - [`diagrams/chart/render`](#diagramschartrender) - [`diagrams/chart/security`](#diagramschartsecurity) - [`diagrams/chart/tests`](#diagramscharttests) - [`diagrams/chen/assets`](#diagramschenassets) - [`diagrams/chen/docs`](#diagramschendocs) - [`diagrams/chen/docs/coverage_examples`](#diagramschendocscoverage_examples) - [`diagrams/chen/layout`](#diagramschenlayout) - [`diagrams/chen/module`](#diagramschenmodule) - [`diagrams/chen/parser`](#diagramschenparser) - [`diagrams/chen/render`](#diagramschenrender) - [`diagrams/chen/security`](#diagramschensecurity) - [`diagrams/chen/tests`](#diagramschentests) - [`diagrams/chronology/assets`](#diagramschronologyassets) - [`diagrams/chronology/docs`](#diagramschronologydocs) - [`diagrams/chronology/docs/coverage_examples`](#diagramschronologydocscoverage_examples) - [`diagrams/chronology/layout`](#diagramschronologylayout) - [`diagrams/chronology/module`](#diagramschronologymodule) - [`diagrams/chronology/parser`](#diagramschronologyparser) - [`diagrams/chronology/render`](#diagramschronologyrender) - [`diagrams/chronology/security`](#diagramschronologysecurity) - [`diagrams/chronology/tests`](#diagramschronologytests) - [`diagrams/class/assets`](#diagramsclassassets) - [`diagrams/class/docs`](#diagramsclassdocs) - [`diagrams/class/docs/coverage_examples`](#diagramsclassdocscoverage_examples) - [`diagrams/class/layout`](#diagramsclasslayout) - [`diagrams/class/module`](#diagramsclassmodule) - [`diagrams/class/parser`](#diagramsclassparser) - [`diagrams/class/plugins/syntax`](#diagramsclasspluginssyntax) - [`diagrams/class/render`](#diagramsclassrender) - [`diagrams/class/security`](#diagramsclasssecurity) - [`diagrams/class/style`](#diagramsclassstyle) - [`diagrams/class/tests`](#diagramsclasstests) - [`diagrams/class/tests/output`](#diagramsclasstestsoutput) - [`diagrams/component/assets`](#diagramscomponentassets) - [`diagrams/component/docs`](#diagramscomponentdocs) - [`diagrams/component/docs/coverage_examples`](#diagramscomponentdocscoverage_examples) - [`diagrams/component/layout`](#diagramscomponentlayout) - [`diagrams/component/module`](#diagramscomponentmodule) - [`diagrams/component/parser`](#diagramscomponentparser) - [`diagrams/component/plugins/syntax`](#diagramscomponentpluginssyntax) - [`diagrams/component/render`](#diagramscomponentrender) - [`diagrams/component/security`](#diagramscomponentsecurity) - [`diagrams/component/tests`](#diagramscomponenttests) - [`diagrams/component/tests/output`](#diagramscomponenttestsoutput) - [`diagrams/deployment/assets`](#diagramsdeploymentassets) - [`diagrams/deployment/docs`](#diagramsdeploymentdocs) - [`diagrams/deployment/docs/coverage_examples`](#diagramsdeploymentdocscoverage_examples) - [`diagrams/deployment/layout`](#diagramsdeploymentlayout) - [`diagrams/deployment/module`](#diagramsdeploymentmodule) - [`diagrams/deployment/parser`](#diagramsdeploymentparser) - [`diagrams/deployment/plugins/syntax`](#diagramsdeploymentpluginssyntax) - [`diagrams/deployment/render`](#diagramsdeploymentrender) - [`diagrams/deployment/security`](#diagramsdeploymentsecurity) - [`diagrams/deployment/tests`](#diagramsdeploymenttests) - [`diagrams/deployment/tests/output`](#diagramsdeploymenttestsoutput) - [`diagrams/ditaa/assets`](#diagramsditaaassets) - [`diagrams/ditaa/docs`](#diagramsditaadocs) - [`diagrams/ditaa/docs/coverage_examples`](#diagramsditaadocscoverage_examples) - [`diagrams/ditaa/layout`](#diagramsditaalayout) - [`diagrams/ditaa/module`](#diagramsditaamodule) - [`diagrams/ditaa/parser`](#diagramsditaaparser) - [`diagrams/ditaa/render`](#diagramsditaarender) - [`diagrams/ditaa/security`](#diagramsditaasecurity) - [`diagrams/ditaa/tests`](#diagramsditaatests) - [`diagrams/ebnf/assets`](#diagramsebnfassets) - [`diagrams/ebnf/docs`](#diagramsebnfdocs) - [`diagrams/ebnf/docs/coverage_examples`](#diagramsebnfdocscoverage_examples) - [`diagrams/ebnf/layout`](#diagramsebnflayout) - [`diagrams/ebnf/module`](#diagramsebnfmodule) - [`diagrams/ebnf/parser`](#diagramsebnfparser) - [`diagrams/ebnf/render`](#diagramsebnfrender) - [`diagrams/ebnf/security`](#diagramsebnfsecurity) - [`diagrams/ebnf/tests`](#diagramsebnftests) - [`diagrams/files/assets`](#diagramsfilesassets) - [`diagrams/files/docs`](#diagramsfilesdocs) - [`diagrams/files/docs/coverage_examples`](#diagramsfilesdocscoverage_examples) - [`diagrams/files/layout`](#diagramsfileslayout) - [`diagrams/files/module`](#diagramsfilesmodule) - [`diagrams/files/parser`](#diagramsfilesparser) - [`diagrams/files/render`](#diagramsfilesrender) - [`diagrams/files/security`](#diagramsfilessecurity) - [`diagrams/files/tests`](#diagramsfilestests) - [`diagrams/gantt/assets`](#diagramsganttassets) - [`diagrams/gantt/docs`](#diagramsganttdocs) - [`diagrams/gantt/docs/coverage_examples`](#diagramsganttdocscoverage_examples) - [`diagrams/gantt/layout`](#diagramsganttlayout) - [`diagrams/gantt/module`](#diagramsganttmodule) - [`diagrams/gantt/parser`](#diagramsganttparser) - [`diagrams/gantt/render`](#diagramsganttrender) - [`diagrams/gantt/security`](#diagramsganttsecurity) - [`diagrams/gantt/tests`](#diagramsgantttests) - [`diagrams/ie/assets`](#diagramsieassets) - [`diagrams/ie/docs`](#diagramsiedocs) - [`diagrams/ie/docs/coverage_examples`](#diagramsiedocscoverage_examples) - [`diagrams/ie/layout`](#diagramsielayout) - [`diagrams/ie/module`](#diagramsiemodule) - [`diagrams/ie/parser`](#diagramsieparser) - [`diagrams/ie/render`](#diagramsierender) - [`diagrams/ie/security`](#diagramsiesecurity) - [`diagrams/ie/tests`](#diagramsietests) - [`diagrams/index`](#diagramsindex) - [`diagrams/json/assets`](#diagramsjsonassets) - [`diagrams/json/docs`](#diagramsjsondocs) - [`diagrams/json/docs/coverage_examples`](#diagramsjsondocscoverage_examples) - [`diagrams/json/layout`](#diagramsjsonlayout) - [`diagrams/json/module`](#diagramsjsonmodule) - [`diagrams/json/parser`](#diagramsjsonparser) - [`diagrams/json/render`](#diagramsjsonrender) - [`diagrams/json/security`](#diagramsjsonsecurity) - [`diagrams/json/tests`](#diagramsjsontests) - [`diagrams/math/assets`](#diagramsmathassets) - [`diagrams/math/docs`](#diagramsmathdocs) - [`diagrams/math/docs/coverage_examples`](#diagramsmathdocscoverage_examples) - [`diagrams/math/layout`](#diagramsmathlayout) - [`diagrams/math/module`](#diagramsmathmodule) - [`diagrams/math/parser`](#diagramsmathparser) - [`diagrams/math/render`](#diagramsmathrender) - [`diagrams/math/security`](#diagramsmathsecurity) - [`diagrams/math/tests`](#diagramsmathtests) - [`diagrams/mindmap/assets`](#diagramsmindmapassets) - [`diagrams/mindmap/docs`](#diagramsmindmapdocs) - [`diagrams/mindmap/docs/coverage_examples`](#diagramsmindmapdocscoverage_examples) - [`diagrams/mindmap/layout`](#diagramsmindmaplayout) - [`diagrams/mindmap/module`](#diagramsmindmapmodule) - [`diagrams/mindmap/parser`](#diagramsmindmapparser) - [`diagrams/mindmap/render`](#diagramsmindmaprender) - [`diagrams/mindmap/security`](#diagramsmindmapsecurity) - [`diagrams/mindmap/tests`](#diagramsmindmaptests) - [`diagrams/nwdiag/assets`](#diagramsnwdiagassets) - [`diagrams/nwdiag/docs`](#diagramsnwdiagdocs) - [`diagrams/nwdiag/docs/coverage_examples`](#diagramsnwdiagdocscoverage_examples) - [`diagrams/nwdiag/layout`](#diagramsnwdiaglayout) - [`diagrams/nwdiag/module`](#diagramsnwdiagmodule) - [`diagrams/nwdiag/parser`](#diagramsnwdiagparser) - [`diagrams/nwdiag/render`](#diagramsnwdiagrender) - [`diagrams/nwdiag/security`](#diagramsnwdiagsecurity) - [`diagrams/nwdiag/tests`](#diagramsnwdiagtests) - [`diagrams/object/assets`](#diagramsobjectassets) - [`diagrams/object/docs`](#diagramsobjectdocs) - [`diagrams/object/docs/coverage_examples`](#diagramsobjectdocscoverage_examples) - [`diagrams/object/layout`](#diagramsobjectlayout) - [`diagrams/object/module`](#diagramsobjectmodule) - [`diagrams/object/parser`](#diagramsobjectparser) - [`diagrams/object/plugins/syntax`](#diagramsobjectpluginssyntax) - [`diagrams/object/render`](#diagramsobjectrender) - [`diagrams/object/security`](#diagramsobjectsecurity) - [`diagrams/object/tests`](#diagramsobjecttests) - [`diagrams/object/tests/output`](#diagramsobjecttestsoutput) - [`diagrams/regex/assets`](#diagramsregexassets) - [`diagrams/regex/docs`](#diagramsregexdocs) - [`diagrams/regex/docs/coverage_examples`](#diagramsregexdocscoverage_examples) - [`diagrams/regex/layout`](#diagramsregexlayout) - [`diagrams/regex/module`](#diagramsregexmodule) - [`diagrams/regex/parser`](#diagramsregexparser) - [`diagrams/regex/render`](#diagramsregexrender) - [`diagrams/regex/security`](#diagramsregexsecurity) - [`diagrams/regex/tests`](#diagramsregextests) - [`diagrams/salt/assets`](#diagramssaltassets) - [`diagrams/salt/docs`](#diagramssaltdocs) - [`diagrams/salt/docs/coverage_examples`](#diagramssaltdocscoverage_examples) - [`diagrams/salt/layout`](#diagramssaltlayout) - [`diagrams/salt/module`](#diagramssaltmodule) - [`diagrams/salt/parser`](#diagramssaltparser) - [`diagrams/salt/render`](#diagramssaltrender) - [`diagrams/salt/security`](#diagramssaltsecurity) - [`diagrams/salt/tests`](#diagramssalttests) - [`diagrams/sequence/assets`](#diagramssequenceassets) - [`diagrams/sequence/context`](#diagramssequencecontext) - [`diagrams/sequence/docs`](#diagramssequencedocs) - [`diagrams/sequence/docs/coverage_examples`](#diagramssequencedocscoverage_examples) - [`diagrams/sequence/layout`](#diagramssequencelayout) - [`diagrams/sequence/layout_engine`](#diagramssequencelayout_engine) - [`diagrams/sequence/module`](#diagramssequencemodule) - [`diagrams/sequence/parser`](#diagramssequenceparser) - [`diagrams/sequence/plugins/advanced`](#diagramssequencepluginsadvanced) - [`diagrams/sequence/plugins/fragments`](#diagramssequencepluginsfragments) - [`diagrams/sequence/plugins/messages`](#diagramssequencepluginsmessages) - [`diagrams/sequence/plugins/notes`](#diagramssequencepluginsnotes) - [`diagrams/sequence/plugins/participants`](#diagramssequencepluginsparticipants) - [`diagrams/sequence/plugins/preamble`](#diagramssequencepluginspreamble) - [`diagrams/sequence/render`](#diagramssequencerender) - [`diagrams/sequence/render_excalidraw`](#diagramssequencerender_excalidraw) - [`diagrams/sequence/security`](#diagramssequencesecurity) - [`diagrams/sequence/spacing`](#diagramssequencespacing) - [`diagrams/sequence/tests`](#diagramssequencetests) - [`diagrams/sequence/tests/output`](#diagramssequencetestsoutput) - [`diagrams/shared/common_plugins/title`](#diagramssharedcommon_pluginstitle) - [`diagrams/shared/data_runtime`](#diagramsshareddata_runtime) - [`diagrams/shared/er_runtime`](#diagramsshareder_runtime) - [`diagrams/shared/graph_context`](#diagramssharedgraph_context) - [`diagrams/shared/graph_parser`](#diagramssharedgraph_parser) - [`diagrams/shared/graph_plugins/association_class`](#diagramssharedgraph_pluginsassociation_class) - [`diagrams/shared/graph_plugins/class_block`](#diagramssharedgraph_pluginsclass_block) - [`diagrams/shared/graph_plugins/connections`](#diagramssharedgraph_pluginsconnections) - [`diagrams/shared/graph_plugins/containers`](#diagramssharedgraph_pluginscontainers) - [`diagrams/shared/graph_plugins/filters`](#diagramssharedgraph_pluginsfilters) - [`diagrams/shared/graph_plugins/notes`](#diagramssharedgraph_pluginsnotes) - [`diagrams/shared/graph_plugins/ports`](#diagramssharedgraph_pluginsports) - [`diagrams/shared/graph_plugins/preamble`](#diagramssharedgraph_pluginspreamble) - [`diagrams/shared/graph_plugins/shapes`](#diagramssharedgraph_pluginsshapes) - [`diagrams/shared/graph_runtime`](#diagramssharedgraph_runtime) - [`diagrams/shared/planning_runtime`](#diagramssharedplanning_runtime) - [`diagrams/shared/railroad_runtime`](#diagramssharedrailroad_runtime) - [`diagrams/shared/special_runtime`](#diagramssharedspecial_runtime) - [`diagrams/shared/tree_runtime`](#diagramssharedtree_runtime) - [`diagrams/state/assets`](#diagramsstateassets) - [`diagrams/state/docs`](#diagramsstatedocs) - [`diagrams/state/docs/coverage_examples`](#diagramsstatedocscoverage_examples) - [`diagrams/state/layout`](#diagramsstatelayout) - [`diagrams/state/module`](#diagramsstatemodule) - [`diagrams/state/parser`](#diagramsstateparser) - [`diagrams/state/plugins/syntax`](#diagramsstatepluginssyntax) - [`diagrams/state/render`](#diagramsstaterender) - [`diagrams/state/security`](#diagramsstatesecurity) - [`diagrams/state/tests`](#diagramsstatetests) - [`diagrams/state/tests/output`](#diagramsstatetestsoutput) - [`diagrams/timing/assets`](#diagramstimingassets) - [`diagrams/timing/docs`](#diagramstimingdocs) - [`diagrams/timing/docs/coverage_examples`](#diagramstimingdocscoverage_examples) - [`diagrams/timing/layout`](#diagramstiminglayout) - [`diagrams/timing/module`](#diagramstimingmodule) - [`diagrams/timing/parser`](#diagramstimingparser) - [`diagrams/timing/plugins/syntax`](#diagramstimingpluginssyntax) - [`diagrams/timing/render`](#diagramstimingrender) - [`diagrams/timing/render_excalidraw`](#diagramstimingrender_excalidraw) - [`diagrams/timing/security`](#diagramstimingsecurity) - [`diagrams/timing/tests`](#diagramstimingtests) - [`diagrams/use-case/assets`](#diagramsuse-caseassets) - [`diagrams/use-case/docs`](#diagramsuse-casedocs) - [`diagrams/use-case/layout`](#diagramsuse-caselayout) - [`diagrams/use-case/module`](#diagramsuse-casemodule) - [`diagrams/use-case/parser`](#diagramsuse-caseparser) - [`diagrams/use-case/plugins/actors`](#diagramsuse-casepluginsactors) - [`diagrams/use-case/plugins/containers`](#diagramsuse-casepluginscontainers) - [`diagrams/use-case/plugins/notes`](#diagramsuse-casepluginsnotes) - [`diagrams/use-case/plugins/relationships`](#diagramsuse-casepluginsrelationships) - [`diagrams/use-case/plugins/usecases`](#diagramsuse-casepluginsusecases) - [`diagrams/use-case/render`](#diagramsuse-caserender) - [`diagrams/use-case/security`](#diagramsuse-casesecurity) - [`diagrams/use-case/tests`](#diagramsuse-casetests) - [`diagrams/wbs/assets`](#diagramswbsassets) - [`diagrams/wbs/docs`](#diagramswbsdocs) - [`diagrams/wbs/docs/coverage_examples`](#diagramswbsdocscoverage_examples) - [`diagrams/wbs/layout`](#diagramswbslayout) - [`diagrams/wbs/module`](#diagramswbsmodule) - [`diagrams/wbs/parser`](#diagramswbsparser) - [`diagrams/wbs/render`](#diagramswbsrender) - [`diagrams/wbs/security`](#diagramswbssecurity) - [`diagrams/wbs/tests`](#diagramswbstests) - [`diagrams/yaml/assets`](#diagramsyamlassets) - [`diagrams/yaml/docs`](#diagramsyamldocs) - [`diagrams/yaml/docs/coverage_examples`](#diagramsyamldocscoverage_examples) - [`diagrams/yaml/layout`](#diagramsyamllayout) - [`diagrams/yaml/module`](#diagramsyamlmodule) - [`diagrams/yaml/parser`](#diagramsyamlparser) - [`diagrams/yaml/render`](#diagramsyamlrender) - [`diagrams/yaml/security`](#diagramsyamlsecurity) - [`diagrams/yaml/tests`](#diagramsyamltests) - [`general/layout/elk_layout`](#generallayoutelk_layout) - [`general/layout/sizing`](#generallayoutsizing) - [`general/model/diagram`](#generalmodeldiagram) - [`general/platform/asset_base`](#generalplatformasset_base) - [`general/platform/diagnostics`](#generalplatformdiagnostics) - [`general/platform/security_base`](#generalplatformsecurity_base) - [`general/platform/services`](#generalplatformservices) - [`general/render/canvas_svg`](#generalrendercanvas_svg) - [`general/render/excalidraw`](#generalrenderexcalidraw) - [`general/render/png`](#generalrenderpng) - [`general/render/rng`](#generalrenderrng) - [`general/render/schema`](#generalrenderschema) - [`general/render/svg`](#generalrendersvg) - [`general/style/colors`](#generalstylecolors) - [`general/style/font`](#generalstylefont) - [`general/style/style`](#generalstylestyle) - [`general/style/text`](#generalstyletext) - [`main/builtin`](#mainbuiltin) - [`main/dependencies`](#maindependencies) - [`main/introspection`](#mainintrospection) - [`main/metadata`](#mainmetadata) - [`main/parser`](#mainparser) - [`main/pipeline`](#mainpipeline) - [`main/registry`](#mainregistry) - [`util/parser_engine`](#utilparser_engine) - [`util/plantuml_utils`](#utilplantuml_utils) --- ## `(package root)` _Source: [`index.mjs`](index.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------ | -------- | ----------- | | [`RenderResult`](#renderresult-package-root) | class | public | | [`renderPlantUml`](#renderplantuml-package-root) | function | unspecified | | [`renderDiagram`](#renderdiagram-package-root) | function | unspecified | #### `RenderResult` ```ts class RenderResult ``` Chainable result returned by `renderPlantUml` / `renderDiagram`. Awaiting the result yields the Excalidraw JSON document, so existing callers (`const doc = await renderPlantUml(text)`) keep working. On top of that, the result exposes `.toSvg()` and `.toPng()` so a caller can write: ```js const r = renderPlantUml(text); const svg = await r.toSvg(); const png = await r.toPng({ width: 4800 }); ``` Both helpers lazily await the underlying document — so calling `toSvg()` / `toPng()` directly on the unawaited result works too. **Members** ##### `RenderResult.constructor` ```ts constructor(docPromise); ``` ##### `RenderResult.then` ```ts then(onFulfilled, onRejected); ``` Thenable: `await result` yields the Excalidraw JSON document. | Param | Type | Description | | -------------------------- | --------------------- | ----------- | --- | | `onFulfilled` _(optional)_ | `(value: object) => T | Promise` | — | | `onRejected` _(optional)_ | `(reason: any) => R | Promise` | — | **Returns:** `Promise` #### `renderPlantUml` ```ts function renderPlantUml(plantuml, opts = {}); ``` Render a PlantUML source string to an Excalidraw JSON document. The return value is a thenable {@link RenderResult}: `await` it for the Excalidraw JSON, or call `.toSvg()` / `.toPng()` on it to get the rasterised diagram in one chained call. **Parameters** | Name | Type | Description | | ------------------- | -------- | ----------------------------------------------------------------- | | `plantuml` | `string` | PlantUML text (see src/main/parser.mjs for the supported subset). | | `opts` _(optional)_ | `object` | — | **Returns:** `RenderResult` — Thenable wrapping the Excalidraw JSON document. #### `renderDiagram` ```ts function renderDiagram(diagram, opts = {}); ``` Render an already-built Diagram model. Useful for callers that want to bypass the PlantUML parser and feed shapes programmatically. **Parameters** | Name | Type | Description | | ------------------- | -------------------------------------------------- | ---------------------------------------------------------- | --- | | `diagram` | `import("./src/general/model/diagram.mjs").Diagram | import("./src/general/model/diagram.mjs").SequenceDiagram` | — | | `opts` _(optional)_ | `object` | — | **Returns:** `RenderResult` --- ## `diagrams/activity/assets` _Source: [`src/diagrams/activity/assets.mjs`](src/diagrams/activity/assets.mjs)_ Activity diagram asset manifest. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------ | ----- | ---------- | | [`ActivityDiagramAssets`](#activitydiagramassets-diagramsactivityassets) | class | public | #### `ActivityDiagramAssets` ```ts class ActivityDiagramAssets extends BaseModuleAssets ``` Activity diagram asset manifest. --- ## `diagrams/activity/docs` _Source: [`src/diagrams/activity/docs.mjs`](src/diagrams/activity/docs.mjs)_ Activity diagram documentation manifest. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------ | ----- | ---------- | | [`ActivityDiagramDocs`](#activitydiagramdocs-diagramsactivitydocs) | class | public | #### `ActivityDiagramDocs` ```ts class ActivityDiagramDocs extends BaseModuleDocs ``` Activity diagram documentation manifest. --- ## `diagrams/activity/layout` _Source: [`src/diagrams/activity/layout.mjs`](src/diagrams/activity/layout.mjs)_ Activity diagram layout engine. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------ | ----- | ---------- | | [`ActivityDiagramLayout`](#activitydiagramlayout-diagramsactivitylayout) | class | public | #### `ActivityDiagramLayout` ```ts class ActivityDiagramLayout extends BaseModuleLayout ``` Activity diagram layout contract. --- ## `diagrams/activity/module` _Source: [`src/diagrams/activity/module.mjs`](src/diagrams/activity/module.mjs)_ Built-in activity diagram module. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------ | ----- | ---------- | | [`ActivityDiagramModule`](#activitydiagrammodule-diagramsactivitymodule) | class | public | | [`activityDiagramModule`](#activitydiagrammodule-diagramsactivitymodule) | const | public | #### `ActivityDiagramModule` ```ts class ActivityDiagramModule extends BaseDiagramModule ``` #### `activityDiagramModule` ```ts const activityDiagramModule; ``` --- ## `diagrams/activity/parser` _Source: [`src/diagrams/activity/parser.mjs`](src/diagrams/activity/parser.mjs)_ Activity diagram parser contract and detection. ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------------------- | -------- | ---------- | | [`DEFAULT_ACTIVITY_PLUGINS`](#default_activity_plugins-diagramsactivityparser) | const | public | | [`createActivityContext`](#createactivitycontext-diagramsactivityparser) | const | public | | [`prepareActivitySourceLines`](#prepareactivitysourcelines-diagramsactivityparser) | const | public | | [`ActivityDiagramParser`](#activitydiagramparser-diagramsactivityparser) | class | public | | [`activityDiagramParser`](#activitydiagramparser-diagramsactivityparser) | const | public | | [`detectActivityDiagram`](#detectactivitydiagram-diagramsactivityparser) | function | public | #### `DEFAULT_ACTIVITY_PLUGINS` ```ts const DEFAULT_ACTIVITY_PLUGINS; ``` Default plugins for activity diagram parsing. #### `createActivityContext` ```ts const createActivityContext; ``` #### `prepareActivitySourceLines` ```ts const prepareActivitySourceLines; ``` #### `ActivityDiagramParser` ```ts class ActivityDiagramParser extends BaseModuleParser ``` #### `activityDiagramParser` ```ts const activityDiagramParser; ``` #### `detectActivityDiagram` ```ts function detectActivityDiagram(text); ``` Detect if content is an activity diagram. **Parameters** | Name | Type | Description | | ------ | -------- | ---------------- | | `text` | `string` | PlantUML source. | **Returns:** `boolean` --- ## `diagrams/activity/plugins/syntax` _Source: [`src/diagrams/activity/plugins/syntax.mjs`](src/diagrams/activity/plugins/syntax.mjs)_ Activity diagram parser plugin. ### Exports | Name | Kind | Visibility | | ----------------------------------------------------------------------------------------- | -------- | ----------- | | [`createActivityParseContext`](#createactivityparsecontext-diagramsactivitypluginssyntax) | function | public | | [`prepareActivityLines`](#prepareactivitylines-diagramsactivitypluginssyntax) | function | public | | [`activitySyntaxPlugin`](#activitysyntaxplugin-diagramsactivitypluginssyntax) | const | unspecified | #### `createActivityParseContext` ```ts function createActivityParseContext(); ``` **Returns:** `any` #### `prepareActivityLines` ```ts function prepareActivityLines(lines); ``` Join multiline `:action ... ;` blocks before the generic line engine runs. **Parameters** | Name | Type | Description | | ------- | ---------- | ----------- | | `lines` | `string[]` | — | **Returns:** `string[]` #### `activitySyntaxPlugin` ```ts const activitySyntaxPlugin; ``` ### Type definitions #### `ActivityEdge` ```ts {from:string,to:string,label?:string,dashed?:boolean,hidden?:boolean} ``` #### `ActivityNodeSpec` ```ts { id?: string, title: string, shape?: string, stereotype?: string, members?: string[], link?: string, tooltip?: string, connect?: boolean, activate?: boolean, edgeLabel?: string, dashed?: boolean, } ``` id?: string, title: string, shape?: string, stereotype?: string, members?: string[], link?: string, tooltip?: string, connect?: boolean, activate?: boolean, edgeLabel?: string, dashed?: boolean, }} ActivityNodeSpec --- ## `diagrams/activity/render` _Source: [`src/diagrams/activity/render.mjs`](src/diagrams/activity/render.mjs)_ Activity diagram renderer. ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------------- | ----- | ---------- | | [`ActivityDiagramRenderer`](#activitydiagramrenderer-diagramsactivityrender) | class | public | #### `ActivityDiagramRenderer` ```ts class ActivityDiagramRenderer extends BaseModuleRenderer ``` Activity diagram renderer contract. --- ## `diagrams/activity/security` _Source: [`src/diagrams/activity/security.mjs`](src/diagrams/activity/security.mjs)_ Activity diagram security profile. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------ | ----- | ---------- | | [`ActivityDiagramSecurity`](#activitydiagramsecurity-diagramsactivitysecurity) | class | public | #### `ActivityDiagramSecurity` ```ts class ActivityDiagramSecurity extends BaseModuleSecurity ``` Activity diagram security profile. --- ## `diagrams/activity/tests` _Source: [`src/diagrams/activity/tests.mjs`](src/diagrams/activity/tests.mjs)_ Activity diagram test manifest. ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------- | ----- | ---------- | | [`ActivityDiagramTests`](#activitydiagramtests-diagramsactivitytests) | class | public | #### `ActivityDiagramTests` ```ts class ActivityDiagramTests extends BaseModuleTests ``` Activity diagram test manifest. --- ## `diagrams/archimate/assets` _Source: [`src/diagrams/archimate/assets.mjs`](src/diagrams/archimate/assets.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------- | ----- | ---------- | | [`ArchimateDiagramAssets`](#archimatediagramassets-diagramsarchimateassets) | class | public | | [`archimateDiagramAssets`](#archimatediagramassets-diagramsarchimateassets) | const | public | #### `ArchimateDiagramAssets` ```ts class ArchimateDiagramAssets extends BaseModuleAssets ``` #### `archimateDiagramAssets` ```ts const archimateDiagramAssets; ``` --- ## `diagrams/archimate/docs` _Source: [`src/diagrams/archimate/docs.mjs`](src/diagrams/archimate/docs.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------- | ----- | ---------- | | [`ArchimateDiagramDocs`](#archimatediagramdocs-diagramsarchimatedocs) | class | public | | [`archimateDiagramDocs`](#archimatediagramdocs-diagramsarchimatedocs) | const | public | #### `ArchimateDiagramDocs` ```ts class ArchimateDiagramDocs extends BaseModuleDocs ``` #### `archimateDiagramDocs` ```ts const archimateDiagramDocs; ``` --- ## `diagrams/archimate/docs/coverage_examples` _Source: [`src/diagrams/archimate/docs/coverage_examples.mjs`](src/diagrams/archimate/docs/coverage_examples.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------------------------ | ----- | ---------- | | [`archimateCoverageExamples`](#archimatecoverageexamples-diagramsarchimatedocscoverage_examples) | const | public | #### `archimateCoverageExamples` ```ts const archimateCoverageExamples; ``` --- ## `diagrams/archimate/layout` _Source: [`src/diagrams/archimate/layout.mjs`](src/diagrams/archimate/layout.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------- | ----- | ---------- | | [`ArchimateDiagramLayout`](#archimatediagramlayout-diagramsarchimatelayout) | class | public | | [`archimateDiagramLayout`](#archimatediagramlayout-diagramsarchimatelayout) | const | public | #### `ArchimateDiagramLayout` ```ts class ArchimateDiagramLayout extends BaseModuleLayout ``` #### `archimateDiagramLayout` ```ts const archimateDiagramLayout; ``` --- ## `diagrams/archimate/module` _Source: [`src/diagrams/archimate/module.mjs`](src/diagrams/archimate/module.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------- | ----- | ---------- | | [`ArchimateDiagramModule`](#archimatediagrammodule-diagramsarchimatemodule) | class | public | | [`archimateDiagramModule`](#archimatediagrammodule-diagramsarchimatemodule) | const | public | #### `ArchimateDiagramModule` ```ts class ArchimateDiagramModule extends GraphModuleBase ``` #### `archimateDiagramModule` ```ts const archimateDiagramModule; ``` --- ## `diagrams/archimate/parser` _Source: [`src/diagrams/archimate/parser.mjs`](src/diagrams/archimate/parser.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------------- | -------- | ---------- | | [`archimateSyntaxPlugin`](#archimatesyntaxplugin-diagramsarchimateparser) | const | public | | [`DEFAULT_ARCHIMATE_PLUGINS`](#default_archimate_plugins-diagramsarchimateparser) | const | public | | [`createArchimateParseContext`](#createarchimateparsecontext-diagramsarchimateparser) | function | public | | [`prepareArchimateLines`](#preparearchimatelines-diagramsarchimateparser) | function | public | | [`detectArchimateDiagram`](#detectarchimatediagram-diagramsarchimateparser) | function | public | | [`ArchimateDiagramParser`](#archimatediagramparser-diagramsarchimateparser) | class | public | | [`archimateDiagramParser`](#archimatediagramparser-diagramsarchimateparser) | const | public | #### `archimateSyntaxPlugin` ```ts const archimateSyntaxPlugin; ``` #### `DEFAULT_ARCHIMATE_PLUGINS` ```ts const DEFAULT_ARCHIMATE_PLUGINS; ``` #### `createArchimateParseContext` ```ts function createArchimateParseContext(); ``` #### `prepareArchimateLines` ```ts function prepareArchimateLines(lines); ``` #### `detectArchimateDiagram` ```ts function detectArchimateDiagram(text); ``` #### `ArchimateDiagramParser` ```ts class ArchimateDiagramParser extends BaseModuleParser ``` #### `archimateDiagramParser` ```ts const archimateDiagramParser; ``` --- ## `diagrams/archimate/render` _Source: [`src/diagrams/archimate/render.mjs`](src/diagrams/archimate/render.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------- | ----- | ---------- | | [`ARCHIMATE_RENDERERS`](#archimate_renderers-diagramsarchimaterender) | const | public | | [`ArchimateDiagramRenderer`](#archimatediagramrenderer-diagramsarchimaterender) | class | public | | [`archimateDiagramRenderer`](#archimatediagramrenderer-diagramsarchimaterender) | const | public | #### `ARCHIMATE_RENDERERS` ```ts const ARCHIMATE_RENDERERS; ``` #### `ArchimateDiagramRenderer` ```ts class ArchimateDiagramRenderer extends BaseModuleRenderer ``` #### `archimateDiagramRenderer` ```ts const archimateDiagramRenderer; ``` --- ## `diagrams/archimate/security` _Source: [`src/diagrams/archimate/security.mjs`](src/diagrams/archimate/security.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------------- | ----- | ---------- | | [`ArchimateDiagramSecurity`](#archimatediagramsecurity-diagramsarchimatesecurity) | class | public | | [`archimateDiagramSecurity`](#archimatediagramsecurity-diagramsarchimatesecurity) | const | public | #### `ArchimateDiagramSecurity` ```ts class ArchimateDiagramSecurity extends BaseModuleSecurity ``` #### `archimateDiagramSecurity` ```ts const archimateDiagramSecurity; ``` --- ## `diagrams/archimate/tests` _Source: [`src/diagrams/archimate/tests.mjs`](src/diagrams/archimate/tests.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------ | ----- | ---------- | | [`ArchimateDiagramTests`](#archimatediagramtests-diagramsarchimatetests) | class | public | | [`archimateDiagramTests`](#archimatediagramtests-diagramsarchimatetests) | const | public | #### `ArchimateDiagramTests` ```ts class ArchimateDiagramTests extends BaseModuleTests ``` #### `archimateDiagramTests` ```ts const archimateDiagramTests; ``` --- ## `diagrams/base/artifacts` _Source: [`src/diagrams/base/artifacts.mjs`](src/diagrams/base/artifacts.mjs)_ Base artifact ownership helpers for diagram modules. ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------- | -------- | ----------- | | [`freezeOwnedArtifacts`](#freezeownedartifacts-diagramsbaseartifacts) | function | unspecified | #### `freezeOwnedArtifacts` ```ts function freezeOwnedArtifacts(artifacts); ``` **Parameters** | Name | Type | Description | | ----------- | --------------------- | ----------- | ---------------- | | `artifacts` | `ModuleOwnedArtifacts | undefined` | Owned artifacts. | **Returns:** `ModuleOwnedArtifacts` ### Type definitions #### `ModuleOwnedArtifacts` ```ts object; ``` --- ## `diagrams/base/assets` _Source: [`src/diagrams/base/assets.mjs`](src/diagrams/base/assets.mjs)_ Base asset contract for diagram modules. ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------- | ----- | ---------- | | [`BaseModuleAssets`](#basemoduleassets-diagramsbaseassets) | class | public | #### `BaseModuleAssets` ```ts class BaseModuleAssets ``` Base contract for module-owned asset policy. **Members** ##### `BaseModuleAssets.constructor` ```ts constructor((manifest = {})); ``` ##### `BaseModuleAssets.manifest` ```ts manifest(); ``` --- ## `diagrams/base/dependencies` _Source: [`src/diagrams/base/dependencies.mjs`](src/diagrams/base/dependencies.mjs)_ Base dependency contract for diagram modules. ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------- | -------- | ----------- | | [`freezeDependency`](#freezedependency-diagramsbasedependencies) | function | unspecified | #### `freezeDependency` ```ts function freezeDependency(dependency); ``` **Parameters** | Name | Type | Description | | ------------ | ---------------------- | ---------------- | | `dependency` | `ModuleDependencySpec` | Dependency spec. | **Returns:** `ModuleDependencySpec` ### Type definitions #### `ModuleDependencySpec` ```ts object; ``` --- ## `diagrams/base/docs` _Source: [`src/diagrams/base/docs.mjs`](src/diagrams/base/docs.mjs)_ Base documentation contract for diagram modules. ### Exports | Name | Kind | Visibility | | ---------------------------------------------------- | -------- | ----------- | | [`BaseModuleDocs`](#basemoduledocs-diagramsbasedocs) | class | public | | [`freezeDocs`](#freezedocs-diagramsbasedocs) | function | unspecified | #### `BaseModuleDocs` ```ts class BaseModuleDocs ``` Base contract for module-owned documentation metadata. **Members** ##### `BaseModuleDocs.constructor` ```ts constructor((manifest = /** @type {ModuleDocsManifest} */ {})); ``` ##### `BaseModuleDocs.manifest` ```ts manifest(); ``` #### `freezeDocs` ```ts function freezeDocs(docs); ``` ### Type definitions #### `ModuleDocsManifest` ```ts object; ``` --- ## `diagrams/base/layout` _Source: [`src/diagrams/base/layout.mjs`](src/diagrams/base/layout.mjs)_ Base layout contract for diagram modules. ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------- | ----- | ---------- | | [`BaseModuleLayout`](#basemodulelayout-diagramsbaselayout) | class | public | #### `BaseModuleLayout` ```ts class BaseModuleLayout ``` Base contract for module-owned layout implementations. **Members** ##### `BaseModuleLayout.constructor` ```ts constructor((options = {})); ``` ##### `BaseModuleLayout.layout` ```ts layout(model, context); ``` | Param | Type | Description | | --------- | -------- | --------------- | | `model` | `object` | Diagram model. | | `context` | `object` | Layout context. | **Returns:** `object|Promise|void|Promise` ### Type definitions #### `BaseModuleLayoutOptions` ```ts object; ``` --- ## `diagrams/base/module` _Source: [`src/diagrams/base/module.mjs`](src/diagrams/base/module.mjs)_ Base diagram module classes. ### Exports | Name | Kind | Visibility | | -------------------------------------------------------------------------- | ----- | ---------- | | [`BaseDiagramModule`](#basediagrammodule-diagramsbasemodule) | class | public | | [`GraphModuleBase`](#graphmodulebase-diagramsbasemodule) | class | public | | [`TimelineModuleBase`](#timelinemodulebase-diagramsbasemodule) | class | public | | [`TreeModuleBase`](#treemodulebase-diagramsbasemodule) | class | public | | [`DataModuleBase`](#datamodulebase-diagramsbasemodule) | class | public | | [`ExternalBridgeModuleBase`](#externalbridgemodulebase-diagramsbasemodule) | class | public | #### `BaseDiagramModule` ```ts class BaseDiagramModule ``` Abstract base for every diagram module. **Members** ##### `BaseDiagramModule.constructor` ```ts constructor(options); ``` ##### `BaseDiagramModule.parserPlugins` ```ts parserPlugins(); ``` ##### `BaseDiagramModule.prepareLines` ```ts prepareLines(lines); ``` ##### `BaseDiagramModule.detect` ```ts detect(text); ``` ##### `BaseDiagramModule.createParseContext` ```ts createParseContext(); ``` ##### `BaseDiagramModule.securityProfile` ```ts securityProfile(); ``` ##### `BaseDiagramModule.docsManifest` ```ts docsManifest(); ``` ##### `BaseDiagramModule.testManifest` ```ts testManifest(); ``` ##### `BaseDiagramModule.assetManifest` ```ts assetManifest(); ``` ##### `BaseDiagramModule.dependencySpecs` ```ts dependencySpecs(); ``` ##### `BaseDiagramModule.layout` ```ts layout(model, context); ``` Module-specific layout adapter. Defaults to a no-op when no layout is declared. | Param | Type | Description | | --------- | -------- | --------------- | | `model` | `object` | Diagram model. | | `context` | `object` | Layout context. | **Returns:** `object|Promise|void|Promise` ##### `BaseDiagramModule.renderers` ```ts renderers(); ``` ##### `BaseDiagramModule.toManifest` ```ts toManifest(); ``` #### `GraphModuleBase` ```ts class GraphModuleBase extends BaseDiagramModule ``` **Members** ##### `GraphModuleBase.constructor` ```ts constructor(options); ``` #### `TimelineModuleBase` ```ts class TimelineModuleBase extends BaseDiagramModule ``` **Members** ##### `TimelineModuleBase.constructor` ```ts constructor(options); ``` #### `TreeModuleBase` ```ts class TreeModuleBase extends BaseDiagramModule ``` **Members** ##### `TreeModuleBase.constructor` ```ts constructor(options); ``` #### `DataModuleBase` ```ts class DataModuleBase extends BaseDiagramModule ``` **Members** ##### `DataModuleBase.constructor` ```ts constructor(options); ``` #### `ExternalBridgeModuleBase` ```ts class ExternalBridgeModuleBase extends BaseDiagramModule ``` **Members** ##### `ExternalBridgeModuleBase.constructor` ```ts constructor(options); ``` ### Type definitions #### `BaseDiagramModuleOptions` ```ts object; ``` --- ## `diagrams/base/parser` _Source: [`src/diagrams/base/parser.mjs`](src/diagrams/base/parser.mjs)_ Base parser contract for diagram modules. ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------- | ----- | ---------- | | [`BaseModuleParser`](#basemoduleparser-diagramsbaseparser) | class | public | #### `BaseModuleParser` ```ts class BaseModuleParser ``` Base contract for module-owned parser implementations. **Members** ##### `BaseModuleParser.constructor` ```ts constructor((options = {})); ``` ##### `BaseModuleParser.plugins` ```ts plugins(); ``` ##### `BaseModuleParser.prepareLines` ```ts prepareLines(lines); ``` ##### `BaseModuleParser.detect` ```ts detect(text); ``` ##### `BaseModuleParser.createParseContext` ```ts createParseContext(); ``` ### Type definitions #### `BaseModuleParserOptions` ```ts object; ``` --- ## `diagrams/base/renderer` _Source: [`src/diagrams/base/renderer.mjs`](src/diagrams/base/renderer.mjs)_ Base renderer contract for diagram modules. ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------- | ----- | ---------- | | [`BaseModuleRenderer`](#basemodulerenderer-diagramsbaserenderer) | class | public | #### `BaseModuleRenderer` ```ts class BaseModuleRenderer ``` Base contract for module-owned renderer implementations. **Members** ##### `BaseModuleRenderer.constructor` ```ts constructor((options = {})); ``` ##### `BaseModuleRenderer.renderers` ```ts renderers(); ``` ### Type definitions #### `BaseModuleRendererOptions` ```ts object; ``` --- ## `diagrams/base/security` _Source: [`src/diagrams/base/security.mjs`](src/diagrams/base/security.mjs)_ Base security contract for diagram modules. ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------- | ----- | ---------- | | [`BaseModuleSecurity`](#basemodulesecurity-diagramsbasesecurity) | class | public | #### `BaseModuleSecurity` ```ts class BaseModuleSecurity ``` Base contract for module-owned security policy. **Members** ##### `BaseModuleSecurity.constructor` ```ts constructor((profile = {})); ``` ##### `BaseModuleSecurity.profile` ```ts profile(); ``` --- ## `diagrams/base/tests` _Source: [`src/diagrams/base/tests.mjs`](src/diagrams/base/tests.mjs)_ Base test contract for diagram modules. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------- | -------- | ----------- | | [`BaseModuleTests`](#basemoduletests-diagramsbasetests) | class | public | | [`freezeTests`](#freezetests-diagramsbasetests) | function | unspecified | #### `BaseModuleTests` ```ts class BaseModuleTests ``` Base contract for module-owned test metadata. **Members** ##### `BaseModuleTests.constructor` ```ts constructor((manifest = /** @type {ModuleTestManifest} */ {})); ``` ##### `BaseModuleTests.manifest` ```ts manifest(); ``` #### `freezeTests` ```ts function freezeTests(tests); ``` ### Type definitions #### `ModuleTestManifest` ```ts object; ``` --- ## `diagrams/chart/assets` _Source: [`src/diagrams/chart/assets.mjs`](src/diagrams/chart/assets.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------- | ----- | ---------- | | [`ChartDiagramAssets`](#chartdiagramassets-diagramschartassets) | class | public | | [`chartDiagramAssets`](#chartdiagramassets-diagramschartassets) | const | public | #### `ChartDiagramAssets` ```ts class ChartDiagramAssets extends BaseModuleAssets ``` #### `chartDiagramAssets` ```ts const chartDiagramAssets; ``` --- ## `diagrams/chart/docs` _Source: [`src/diagrams/chart/docs.mjs`](src/diagrams/chart/docs.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------- | ----- | ---------- | | [`ChartDiagramDocs`](#chartdiagramdocs-diagramschartdocs) | class | public | | [`chartDiagramDocs`](#chartdiagramdocs-diagramschartdocs) | const | public | #### `ChartDiagramDocs` ```ts class ChartDiagramDocs extends BaseModuleDocs ``` #### `chartDiagramDocs` ```ts const chartDiagramDocs; ``` --- ## `diagrams/chart/docs/coverage_examples` _Source: [`src/diagrams/chart/docs/coverage_examples.mjs`](src/diagrams/chart/docs/coverage_examples.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------------ | ----- | ---------- | | [`chartCoverageExamples`](#chartcoverageexamples-diagramschartdocscoverage_examples) | const | public | #### `chartCoverageExamples` ```ts const chartCoverageExamples; ``` --- ## `diagrams/chart/layout` _Source: [`src/diagrams/chart/layout.mjs`](src/diagrams/chart/layout.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------- | ----- | ---------- | | [`chartDiagramLayout`](#chartdiagramlayout-diagramschartlayout) | const | public | | [`ChartDiagramLayout`](#chartdiagramlayout-diagramschartlayout) | const | public | #### `chartDiagramLayout` ```ts const chartDiagramLayout; ``` #### `ChartDiagramLayout` ```ts const ChartDiagramLayout; ``` --- ## `diagrams/chart/module` _Source: [`src/diagrams/chart/module.mjs`](src/diagrams/chart/module.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------- | ----- | ---------- | | [`ChartDiagramModule`](#chartdiagrammodule-diagramschartmodule) | class | public | | [`chartDiagramModule`](#chartdiagrammodule-diagramschartmodule) | const | public | #### `ChartDiagramModule` ```ts class ChartDiagramModule extends GraphModuleBase ``` #### `chartDiagramModule` ```ts const chartDiagramModule; ``` --- ## `diagrams/chart/parser` _Source: [`src/diagrams/chart/parser.mjs`](src/diagrams/chart/parser.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------- | -------- | ---------- | | [`chartSyntaxPlugin`](#chartsyntaxplugin-diagramschartparser) | const | public | | [`DEFAULT_CHART_PLUGINS`](#default_chart_plugins-diagramschartparser) | const | public | | [`createChartParseContext`](#createchartparsecontext-diagramschartparser) | function | public | | [`prepareChartLines`](#preparechartlines-diagramschartparser) | const | public | | [`detectChartDiagram`](#detectchartdiagram-diagramschartparser) | const | public | | [`ChartDiagramParser`](#chartdiagramparser-diagramschartparser) | class | public | | [`chartDiagramParser`](#chartdiagramparser-diagramschartparser) | const | public | #### `chartSyntaxPlugin` ```ts const chartSyntaxPlugin; ``` #### `DEFAULT_CHART_PLUGINS` ```ts const DEFAULT_CHART_PLUGINS; ``` #### `createChartParseContext` ```ts function createChartParseContext(); ``` #### `prepareChartLines` ```ts const prepareChartLines; ``` #### `detectChartDiagram` ```ts const detectChartDiagram; ``` #### `ChartDiagramParser` ```ts class ChartDiagramParser extends BaseModuleParser ``` #### `chartDiagramParser` ```ts const chartDiagramParser; ``` --- ## `diagrams/chart/render` _Source: [`src/diagrams/chart/render.mjs`](src/diagrams/chart/render.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------- | ----- | ---------- | | [`CHART_RENDERERS`](#chart_renderers-diagramschartrender) | const | public | | [`chartDiagramRenderer`](#chartdiagramrenderer-diagramschartrender) | const | public | | [`ChartDiagramRenderer`](#chartdiagramrenderer-diagramschartrender) | const | public | #### `CHART_RENDERERS` ```ts const CHART_RENDERERS; ``` #### `chartDiagramRenderer` ```ts const chartDiagramRenderer; ``` #### `ChartDiagramRenderer` ```ts const ChartDiagramRenderer; ``` --- ## `diagrams/chart/security` _Source: [`src/diagrams/chart/security.mjs`](src/diagrams/chart/security.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------- | ----- | ---------- | | [`ChartDiagramSecurity`](#chartdiagramsecurity-diagramschartsecurity) | class | public | | [`chartDiagramSecurity`](#chartdiagramsecurity-diagramschartsecurity) | const | public | #### `ChartDiagramSecurity` ```ts class ChartDiagramSecurity extends BaseModuleSecurity ``` #### `chartDiagramSecurity` ```ts const chartDiagramSecurity; ``` --- ## `diagrams/chart/tests` _Source: [`src/diagrams/chart/tests.mjs`](src/diagrams/chart/tests.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`ChartDiagramTests`](#chartdiagramtests-diagramscharttests) | class | public | | [`chartDiagramTests`](#chartdiagramtests-diagramscharttests) | const | public | #### `ChartDiagramTests` ```ts class ChartDiagramTests extends BaseModuleTests ``` #### `chartDiagramTests` ```ts const chartDiagramTests; ``` --- ## `diagrams/chen/assets` _Source: [`src/diagrams/chen/assets.mjs`](src/diagrams/chen/assets.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`ChenDiagramAssets`](#chendiagramassets-diagramschenassets) | class | public | | [`chenDiagramAssets`](#chendiagramassets-diagramschenassets) | const | public | #### `ChenDiagramAssets` ```ts class ChenDiagramAssets extends BaseModuleAssets ``` #### `chenDiagramAssets` ```ts const chenDiagramAssets; ``` --- ## `diagrams/chen/docs` _Source: [`src/diagrams/chen/docs.mjs`](src/diagrams/chen/docs.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------ | ----- | ---------- | | [`ChenDiagramDocs`](#chendiagramdocs-diagramschendocs) | class | public | | [`chenDiagramDocs`](#chendiagramdocs-diagramschendocs) | const | public | #### `ChenDiagramDocs` ```ts class ChenDiagramDocs extends BaseModuleDocs ``` #### `chenDiagramDocs` ```ts const chenDiagramDocs; ``` --- ## `diagrams/chen/docs/coverage_examples` _Source: [`src/diagrams/chen/docs/coverage_examples.mjs`](src/diagrams/chen/docs/coverage_examples.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------------- | ----- | ---------- | | [`chenCoverageExamples`](#chencoverageexamples-diagramschendocscoverage_examples) | const | public | #### `chenCoverageExamples` ```ts const chenCoverageExamples; ``` --- ## `diagrams/chen/layout` _Source: [`src/diagrams/chen/layout.mjs`](src/diagrams/chen/layout.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`chenDiagramLayout`](#chendiagramlayout-diagramschenlayout) | const | public | | [`ChenDiagramLayout`](#chendiagramlayout-diagramschenlayout) | const | public | #### `chenDiagramLayout` ```ts const chenDiagramLayout; ``` #### `ChenDiagramLayout` ```ts const ChenDiagramLayout; ``` --- ## `diagrams/chen/module` _Source: [`src/diagrams/chen/module.mjs`](src/diagrams/chen/module.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`ChenDiagramModule`](#chendiagrammodule-diagramschenmodule) | class | public | | [`chenDiagramModule`](#chendiagrammodule-diagramschenmodule) | const | public | #### `ChenDiagramModule` ```ts class ChenDiagramModule extends GraphModuleBase ``` #### `chenDiagramModule` ```ts const chenDiagramModule; ``` --- ## `diagrams/chen/parser` _Source: [`src/diagrams/chen/parser.mjs`](src/diagrams/chen/parser.mjs)_ ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------- | ----- | ---------- | | [`chenDeclarationPlugin`](#chendeclarationplugin-diagramschenparser) | const | public | | [`chenConnectionPlugin`](#chenconnectionplugin-diagramschenparser) | const | public | | [`DEFAULT_CHEN_PLUGINS`](#default_chen_plugins-diagramschenparser) | const | public | | [`createChenParseContext`](#createchenparsecontext-diagramschenparser) | const | public | | [`prepareChenLines`](#preparechenlines-diagramschenparser) | const | public | | [`detectChenDiagram`](#detectchendiagram-diagramschenparser) | const | public | | [`ChenDiagramParser`](#chendiagramparser-diagramschenparser) | class | public | | [`chenDiagramParser`](#chendiagramparser-diagramschenparser) | const | public | #### `chenDeclarationPlugin` ```ts const chenDeclarationPlugin; ``` #### `chenConnectionPlugin` ```ts const chenConnectionPlugin; ``` #### `DEFAULT_CHEN_PLUGINS` ```ts const DEFAULT_CHEN_PLUGINS; ``` #### `createChenParseContext` ```ts const createChenParseContext; ``` #### `prepareChenLines` ```ts const prepareChenLines; ``` #### `detectChenDiagram` ```ts const detectChenDiagram; ``` #### `ChenDiagramParser` ```ts class ChenDiagramParser extends BaseModuleParser ``` #### `chenDiagramParser` ```ts const chenDiagramParser; ``` --- ## `diagrams/chen/render` _Source: [`src/diagrams/chen/render.mjs`](src/diagrams/chen/render.mjs)_ ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------- | ----- | ---------- | | [`CHEN_RENDERERS`](#chen_renderers-diagramschenrender) | const | public | | [`ChenDiagramRenderer`](#chendiagramrenderer-diagramschenrender) | class | public | | [`chenDiagramRenderer`](#chendiagramrenderer-diagramschenrender) | const | public | #### `CHEN_RENDERERS` ```ts const CHEN_RENDERERS; ``` #### `ChenDiagramRenderer` ```ts class ChenDiagramRenderer extends BaseModuleRenderer ``` #### `chenDiagramRenderer` ```ts const chenDiagramRenderer; ``` --- ## `diagrams/chen/security` _Source: [`src/diagrams/chen/security.mjs`](src/diagrams/chen/security.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------ | ----- | ---------- | | [`ChenDiagramSecurity`](#chendiagramsecurity-diagramschensecurity) | class | public | | [`chenDiagramSecurity`](#chendiagramsecurity-diagramschensecurity) | const | public | #### `ChenDiagramSecurity` ```ts class ChenDiagramSecurity extends BaseModuleSecurity ``` #### `chenDiagramSecurity` ```ts const chenDiagramSecurity; ``` --- ## `diagrams/chen/tests` _Source: [`src/diagrams/chen/tests.mjs`](src/diagrams/chen/tests.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------- | ----- | ---------- | | [`ChenDiagramTests`](#chendiagramtests-diagramschentests) | class | public | | [`chenDiagramTests`](#chendiagramtests-diagramschentests) | const | public | #### `ChenDiagramTests` ```ts class ChenDiagramTests extends BaseModuleTests ``` #### `chenDiagramTests` ```ts const chenDiagramTests; ``` --- ## `diagrams/chronology/assets` _Source: [`src/diagrams/chronology/assets.mjs`](src/diagrams/chronology/assets.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------ | ----- | ---------- | | [`ChronologyDiagramAssets`](#chronologydiagramassets-diagramschronologyassets) | class | public | | [`chronologyDiagramAssets`](#chronologydiagramassets-diagramschronologyassets) | const | public | #### `ChronologyDiagramAssets` ```ts class ChronologyDiagramAssets extends BaseModuleAssets ``` #### `chronologyDiagramAssets` ```ts const chronologyDiagramAssets; ``` --- ## `diagrams/chronology/docs` _Source: [`src/diagrams/chronology/docs.mjs`](src/diagrams/chronology/docs.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------ | ----- | ---------- | | [`ChronologyDiagramDocs`](#chronologydiagramdocs-diagramschronologydocs) | class | public | | [`chronologyDiagramDocs`](#chronologydiagramdocs-diagramschronologydocs) | const | public | #### `ChronologyDiagramDocs` ```ts class ChronologyDiagramDocs extends BaseModuleDocs ``` #### `chronologyDiagramDocs` ```ts const chronologyDiagramDocs; ``` --- ## `diagrams/chronology/docs/coverage_examples` _Source: [`src/diagrams/chronology/docs/coverage_examples.mjs`](src/diagrams/chronology/docs/coverage_examples.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------------------------------- | ----- | ---------- | | [`chronologyCoverageExamples`](#chronologycoverageexamples-diagramschronologydocscoverage_examples) | const | public | #### `chronologyCoverageExamples` ```ts const chronologyCoverageExamples; ``` --- ## `diagrams/chronology/layout` _Source: [`src/diagrams/chronology/layout.mjs`](src/diagrams/chronology/layout.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------ | ----- | ---------- | | [`chronologyDiagramLayout`](#chronologydiagramlayout-diagramschronologylayout) | const | public | | [`ChronologyDiagramLayout`](#chronologydiagramlayout-diagramschronologylayout) | const | public | #### `chronologyDiagramLayout` ```ts const chronologyDiagramLayout; ``` #### `ChronologyDiagramLayout` ```ts const ChronologyDiagramLayout; ``` --- ## `diagrams/chronology/module` _Source: [`src/diagrams/chronology/module.mjs`](src/diagrams/chronology/module.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------ | ----- | ---------- | | [`ChronologyDiagramModule`](#chronologydiagrammodule-diagramschronologymodule) | class | public | | [`chronologyDiagramModule`](#chronologydiagrammodule-diagramschronologymodule) | const | public | #### `ChronologyDiagramModule` ```ts class ChronologyDiagramModule extends TimelineModuleBase ``` #### `chronologyDiagramModule` ```ts const chronologyDiagramModule; ``` --- ## `diagrams/chronology/parser` _Source: [`src/diagrams/chronology/parser.mjs`](src/diagrams/chronology/parser.mjs)_ ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------------------------- | ----- | ---------- | | [`chronologySyntaxPlugin`](#chronologysyntaxplugin-diagramschronologyparser) | const | public | | [`DEFAULT_CHRONOLOGY_PLUGINS`](#default_chronology_plugins-diagramschronologyparser) | const | public | | [`createChronologyParseContext`](#createchronologyparsecontext-diagramschronologyparser) | const | public | | [`prepareChronologyLines`](#preparechronologylines-diagramschronologyparser) | const | public | | [`detectChronologyDiagram`](#detectchronologydiagram-diagramschronologyparser) | const | public | | [`ChronologyDiagramParser`](#chronologydiagramparser-diagramschronologyparser) | class | public | | [`chronologyDiagramParser`](#chronologydiagramparser-diagramschronologyparser) | const | public | #### `chronologySyntaxPlugin` ```ts const chronologySyntaxPlugin; ``` #### `DEFAULT_CHRONOLOGY_PLUGINS` ```ts const DEFAULT_CHRONOLOGY_PLUGINS; ``` #### `createChronologyParseContext` ```ts const createChronologyParseContext; ``` #### `prepareChronologyLines` ```ts const prepareChronologyLines; ``` #### `detectChronologyDiagram` ```ts const detectChronologyDiagram; ``` #### `ChronologyDiagramParser` ```ts class ChronologyDiagramParser extends BaseModuleParser ``` #### `chronologyDiagramParser` ```ts const chronologyDiagramParser; ``` ### Type definitions #### `PlanningItemSpec` ```ts import("../shared/planning_runtime.mjs").PlanningItemSpec; ``` --- ## `diagrams/chronology/render` _Source: [`src/diagrams/chronology/render.mjs`](src/diagrams/chronology/render.mjs)_ ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------------------- | ----- | ---------- | | [`CHRONOLOGY_RENDERERS`](#chronology_renderers-diagramschronologyrender) | const | public | | [`chronologyDiagramRenderer`](#chronologydiagramrenderer-diagramschronologyrender) | const | public | | [`ChronologyDiagramRenderer`](#chronologydiagramrenderer-diagramschronologyrender) | const | public | #### `CHRONOLOGY_RENDERERS` ```ts const CHRONOLOGY_RENDERERS; ``` #### `chronologyDiagramRenderer` ```ts const chronologyDiagramRenderer; ``` #### `ChronologyDiagramRenderer` ```ts const ChronologyDiagramRenderer; ``` --- ## `diagrams/chronology/security` _Source: [`src/diagrams/chronology/security.mjs`](src/diagrams/chronology/security.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------------ | ----- | ---------- | | [`ChronologyDiagramSecurity`](#chronologydiagramsecurity-diagramschronologysecurity) | class | public | | [`chronologyDiagramSecurity`](#chronologydiagramsecurity-diagramschronologysecurity) | const | public | #### `ChronologyDiagramSecurity` ```ts class ChronologyDiagramSecurity extends BaseModuleSecurity ``` #### `chronologyDiagramSecurity` ```ts const chronologyDiagramSecurity; ``` --- ## `diagrams/chronology/tests` _Source: [`src/diagrams/chronology/tests.mjs`](src/diagrams/chronology/tests.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------- | ----- | ---------- | | [`ChronologyDiagramTests`](#chronologydiagramtests-diagramschronologytests) | class | public | | [`chronologyDiagramTests`](#chronologydiagramtests-diagramschronologytests) | const | public | #### `ChronologyDiagramTests` ```ts class ChronologyDiagramTests extends BaseModuleTests ``` #### `chronologyDiagramTests` ```ts const chronologyDiagramTests; ``` --- ## `diagrams/class/assets` _Source: [`src/diagrams/class/assets.mjs`](src/diagrams/class/assets.mjs)_ Class diagram asset contract. ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------- | ----- | ---------- | | [`ClassDiagramAssets`](#classdiagramassets-diagramsclassassets) | class | public | | [`classDiagramAssets`](#classdiagramassets-diagramsclassassets) | const | public | #### `ClassDiagramAssets` ```ts class ClassDiagramAssets extends BaseModuleAssets ``` #### `classDiagramAssets` ```ts const classDiagramAssets; ``` --- ## `diagrams/class/docs` _Source: [`src/diagrams/class/docs.mjs`](src/diagrams/class/docs.mjs)_ Class diagram documentation contract. ### Exports | Name | Kind | Visibility | | --------------------------------------------------------- | ----- | ---------- | | [`ClassDiagramDocs`](#classdiagramdocs-diagramsclassdocs) | class | public | | [`classDiagramDocs`](#classdiagramdocs-diagramsclassdocs) | const | public | #### `ClassDiagramDocs` ```ts class ClassDiagramDocs extends BaseModuleDocs ``` #### `classDiagramDocs` ```ts const classDiagramDocs; ``` --- ## `diagrams/class/docs/coverage_examples` _Source: [`src/diagrams/class/docs/coverage_examples.mjs`](src/diagrams/class/docs/coverage_examples.mjs)_ Class-diagram coverage examples owned by the class module. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------------------ | ----- | ---------- | | [`CLASS_COMPONENT_EXAMPLES`](#class_component_examples-diagramsclassdocscoverage_examples) | const | public | #### `CLASS_COMPONENT_EXAMPLES` ```ts const CLASS_COMPONENT_EXAMPLES; ``` --- ## `diagrams/class/layout` _Source: [`src/diagrams/class/layout.mjs`](src/diagrams/class/layout.mjs)_ Class diagram layout adapter. ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------- | ----- | ---------- | | [`layoutClassDiagram`](#layoutclassdiagram-diagramsclasslayout) | const | public | | [`ClassDiagramLayout`](#classdiagramlayout-diagramsclasslayout) | class | public | | [`classDiagramLayout`](#classdiagramlayout-diagramsclasslayout) | const | public | #### `layoutClassDiagram` ```ts const layoutClassDiagram; ``` #### `ClassDiagramLayout` ```ts class ClassDiagramLayout extends BaseModuleLayout ``` #### `classDiagramLayout` ```ts const classDiagramLayout; ``` --- ## `diagrams/class/module` _Source: [`src/diagrams/class/module.mjs`](src/diagrams/class/module.mjs)_ Built-in class diagram module. ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------- | ----- | ---------- | | [`ClassDiagramModule`](#classdiagrammodule-diagramsclassmodule) | class | public | | [`classDiagramModule`](#classdiagrammodule-diagramsclassmodule) | const | public | #### `ClassDiagramModule` ```ts class ClassDiagramModule extends GraphModuleBase ``` #### `classDiagramModule` ```ts const classDiagramModule; ``` --- ## `diagrams/class/parser` _Source: [`src/diagrams/class/parser.mjs`](src/diagrams/class/parser.mjs)_ Class diagram parser contract. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------- | -------- | ----------- | | [`DEFAULT_CLASS_PLUGINS`](#default_class_plugins-diagramsclassparser) | const | public | | [`createClassParseContext`](#createclassparsecontext-diagramsclassparser) | function | public | | [`prepareClassLines`](#prepareclasslines-diagramsclassparser) | const | public | | [`ClassDiagramParser`](#classdiagramparser-diagramsclassparser) | class | public | | [`classDiagramParser`](#classdiagramparser-diagramsclassparser) | const | public | | [`detectClassDiagram`](#detectclassdiagram-diagramsclassparser) | function | unspecified | #### `DEFAULT_CLASS_PLUGINS` ```ts const DEFAULT_CLASS_PLUGINS; ``` #### `createClassParseContext` ```ts function createClassParseContext(); ``` #### `prepareClassLines` ```ts const prepareClassLines; ``` #### `ClassDiagramParser` ```ts class ClassDiagramParser extends BaseModuleParser ``` #### `classDiagramParser` ```ts const classDiagramParser; ``` #### `detectClassDiagram` ```ts function detectClassDiagram(text); ``` **Parameters** | Name | Type | Description | | ------ | -------- | -------------------- | | `text` | `string` | Raw PlantUML source. | **Returns:** `boolean` --- ## `diagrams/class/plugins/syntax` _Source: [`src/diagrams/class/plugins/syntax.mjs`](src/diagrams/class/plugins/syntax.mjs)_ Class-diagram specific syntax that does not belong in the shared graph plugins. ### Exports | Name | Kind | Visibility | | -------------------------------------------------------------------------------------- | ----- | ----------- | | [`classMemberLinePlugin`](#classmemberlineplugin-diagramsclasspluginssyntax) | const | unspecified | | [`classJsonObjectPlugin`](#classjsonobjectplugin-diagramsclasspluginssyntax) | const | unspecified | | [`qualifiedAssociationPlugin`](#qualifiedassociationplugin-diagramsclasspluginssyntax) | const | unspecified | #### `classMemberLinePlugin` ```ts const classMemberLinePlugin; ``` Official class syntax allows `Class : fieldOrMethod` outside the block. #### `classJsonObjectPlugin` ```ts const classJsonObjectPlugin; ``` Display JSON data inside a class diagram. The graph model has no JSON table primitive, so JSON rows are represented as deterministic members on a map box. Object blocks use the existing object shape. #### `qualifiedAssociationPlugin` ```ts const qualifiedAssociationPlugin; ``` Qualified associations: `Class [qualifier] -- Other`. The qualifier is exposed as a source-side port so renderers can anchor the edge close to the named qualifier/member. --- ## `diagrams/class/render` _Source: [`src/diagrams/class/render.mjs`](src/diagrams/class/render.mjs)_ Class diagram renderer adapters. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------- | ----- | ---------- | | [`CLASS_RENDERERS`](#class_renderers-diagramsclassrender) | const | public | | [`ClassDiagramRenderer`](#classdiagramrenderer-diagramsclassrender) | class | public | | [`classDiagramRenderer`](#classdiagramrenderer-diagramsclassrender) | const | public | #### `CLASS_RENDERERS` ```ts const CLASS_RENDERERS; ``` #### `ClassDiagramRenderer` ```ts class ClassDiagramRenderer extends BaseModuleRenderer ``` #### `classDiagramRenderer` ```ts const classDiagramRenderer; ``` --- ## `diagrams/class/security` _Source: [`src/diagrams/class/security.mjs`](src/diagrams/class/security.mjs)_ Class diagram security contract. ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------- | ----- | ---------- | | [`ClassDiagramSecurity`](#classdiagramsecurity-diagramsclasssecurity) | class | public | | [`classDiagramSecurity`](#classdiagramsecurity-diagramsclasssecurity) | const | public | #### `ClassDiagramSecurity` ```ts class ClassDiagramSecurity extends BaseModuleSecurity ``` #### `classDiagramSecurity` ```ts const classDiagramSecurity; ``` --- ## `diagrams/class/style` _Source: [`src/diagrams/class/style.mjs`](src/diagrams/class/style.mjs)_ Class diagram style defaults. ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------------------- | ----- | ---------- | | [`CLASS_DIAGRAM_STYLE_DEFAULTS`](#class_diagram_style_defaults-diagramsclassstyle) | const | public | #### `CLASS_DIAGRAM_STYLE_DEFAULTS` ```ts const CLASS_DIAGRAM_STYLE_DEFAULTS; ``` --- ## `diagrams/class/tests` _Source: [`src/diagrams/class/tests.mjs`](src/diagrams/class/tests.mjs)_ Class diagram test contract. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`ClassDiagramTests`](#classdiagramtests-diagramsclasstests) | class | public | | [`classDiagramTests`](#classdiagramtests-diagramsclasstests) | const | public | #### `ClassDiagramTests` ```ts class ClassDiagramTests extends BaseModuleTests ``` #### `classDiagramTests` ```ts const classDiagramTests; ``` --- ## `diagrams/class/tests/output` _Source: [`src/diagrams/class/tests/output.mjs`](src/diagrams/class/tests/output.mjs)_ ### Exports | Name | Kind | Visibility | | -------------------------------------------------------------------------- | -------- | ----------- | | [`CLASS_TEST_OUTPUT_DIR`](#class_test_output_dir-diagramsclasstestsoutput) | const | unspecified | | [`writeClassOutput`](#writeclassoutput-diagramsclasstestsoutput) | function | unspecified | #### `CLASS_TEST_OUTPUT_DIR` ```ts const CLASS_TEST_OUTPUT_DIR; ``` Absolute path to the Class module's generated test-review artefacts. #### `writeClassOutput` ```ts function writeClassOutput(filename, content); ``` Write a Class-module test artefact to `src/diagrams/class/tests/output/`. **Parameters** | Name | Type | Description | | ---------- | -------- | ------------------------------------------------------------- | ----------- | ----------------- | | `filename` | `string` | File name or relative path below the module output directory. | | `content` | `string | Buffer | Uint8Array` | Content to write. | --- ## `diagrams/component/assets` _Source: [`src/diagrams/component/assets.mjs`](src/diagrams/component/assets.mjs)_ Component diagram asset contract. ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------- | ----- | ---------- | | [`ComponentDiagramAssets`](#componentdiagramassets-diagramscomponentassets) | class | public | | [`componentDiagramAssets`](#componentdiagramassets-diagramscomponentassets) | const | public | #### `ComponentDiagramAssets` ```ts class ComponentDiagramAssets extends BaseModuleAssets ``` #### `componentDiagramAssets` ```ts const componentDiagramAssets; ``` --- ## `diagrams/component/docs` _Source: [`src/diagrams/component/docs.mjs`](src/diagrams/component/docs.mjs)_ Component diagram documentation contract. ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------- | ----- | ---------- | | [`ComponentDiagramDocs`](#componentdiagramdocs-diagramscomponentdocs) | class | public | | [`componentDiagramDocs`](#componentdiagramdocs-diagramscomponentdocs) | const | public | #### `ComponentDiagramDocs` ```ts class ComponentDiagramDocs extends BaseModuleDocs ``` #### `componentDiagramDocs` ```ts const componentDiagramDocs; ``` --- ## `diagrams/component/docs/coverage_examples` _Source: [`src/diagrams/component/docs/coverage_examples.mjs`](src/diagrams/component/docs/coverage_examples.mjs)_ Component-diagram coverage examples owned by the component module. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------------------------------ | ----- | ---------- | | [`COMPONENT_COMPONENT_EXAMPLES`](#component_component_examples-diagramscomponentdocscoverage_examples) | const | public | #### `COMPONENT_COMPONENT_EXAMPLES` ```ts const COMPONENT_COMPONENT_EXAMPLES; ``` --- ## `diagrams/component/layout` _Source: [`src/diagrams/component/layout.mjs`](src/diagrams/component/layout.mjs)_ Component diagram layout adapter. ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------- | ----- | ---------- | | [`layoutComponentDiagram`](#layoutcomponentdiagram-diagramscomponentlayout) | const | public | | [`ComponentDiagramLayout`](#componentdiagramlayout-diagramscomponentlayout) | class | public | | [`componentDiagramLayout`](#componentdiagramlayout-diagramscomponentlayout) | const | public | #### `layoutComponentDiagram` ```ts const layoutComponentDiagram; ``` #### `ComponentDiagramLayout` ```ts class ComponentDiagramLayout extends BaseModuleLayout ``` #### `componentDiagramLayout` ```ts const componentDiagramLayout; ``` --- ## `diagrams/component/module` _Source: [`src/diagrams/component/module.mjs`](src/diagrams/component/module.mjs)_ Built-in component diagram module. ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------- | ----- | ---------- | | [`ComponentDiagramModule`](#componentdiagrammodule-diagramscomponentmodule) | class | public | | [`componentDiagramModule`](#componentdiagrammodule-diagramscomponentmodule) | const | public | #### `ComponentDiagramModule` ```ts class ComponentDiagramModule extends GraphModuleBase ``` #### `componentDiagramModule` ```ts const componentDiagramModule; ``` --- ## `diagrams/component/parser` _Source: [`src/diagrams/component/parser.mjs`](src/diagrams/component/parser.mjs)_ Component diagram parser contract. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------------- | -------- | ----------- | | [`DEFAULT_COMPONENT_PLUGINS`](#default_component_plugins-diagramscomponentparser) | const | public | | [`createComponentParseContext`](#createcomponentparsecontext-diagramscomponentparser) | function | public | | [`prepareComponentLines`](#preparecomponentlines-diagramscomponentparser) | const | public | | [`ComponentDiagramParser`](#componentdiagramparser-diagramscomponentparser) | class | public | | [`componentDiagramParser`](#componentdiagramparser-diagramscomponentparser) | const | public | | [`detectComponentDiagram`](#detectcomponentdiagram-diagramscomponentparser) | function | unspecified | #### `DEFAULT_COMPONENT_PLUGINS` ```ts const DEFAULT_COMPONENT_PLUGINS; ``` #### `createComponentParseContext` ```ts function createComponentParseContext(); ``` #### `prepareComponentLines` ```ts const prepareComponentLines; ``` #### `ComponentDiagramParser` ```ts class ComponentDiagramParser extends BaseModuleParser ``` #### `componentDiagramParser` ```ts const componentDiagramParser; ``` #### `detectComponentDiagram` ```ts function detectComponentDiagram(text); ``` **Parameters** | Name | Type | Description | | ------ | -------- | -------------------- | | `text` | `string` | Raw PlantUML source. | **Returns:** `boolean` --- ## `diagrams/component/plugins/syntax` _Source: [`src/diagrams/component/plugins/syntax.mjs`](src/diagrams/component/plugins/syntax.mjs)_ Component-diagram specific syntax plugins. ### Exports | Name | Kind | Visibility | | -------------------------------------------------------------------------------------------------------- | ----- | ----------- | | [`componentBracketDeclarationPlugin`](#componentbracketdeclarationplugin-diagramscomponentpluginssyntax) | const | unspecified | | [`componentJsonPlugin`](#componentjsonplugin-diagramscomponentpluginssyntax) | const | unspecified | #### `componentBracketDeclarationPlugin` ```ts const componentBracketDeclarationPlugin; ``` Official `component [Label] as Alias` and long-description component block. #### `componentJsonPlugin` ```ts const componentJsonPlugin; ``` JSON display in component diagrams. --- ## `diagrams/component/render` _Source: [`src/diagrams/component/render.mjs`](src/diagrams/component/render.mjs)_ Component diagram renderer adapters. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------- | ----- | ---------- | | [`COMPONENT_RENDERERS`](#component_renderers-diagramscomponentrender) | const | public | | [`ComponentDiagramRenderer`](#componentdiagramrenderer-diagramscomponentrender) | class | public | | [`componentDiagramRenderer`](#componentdiagramrenderer-diagramscomponentrender) | const | public | #### `COMPONENT_RENDERERS` ```ts const COMPONENT_RENDERERS; ``` #### `ComponentDiagramRenderer` ```ts class ComponentDiagramRenderer extends BaseModuleRenderer ``` #### `componentDiagramRenderer` ```ts const componentDiagramRenderer; ``` --- ## `diagrams/component/security` _Source: [`src/diagrams/component/security.mjs`](src/diagrams/component/security.mjs)_ Component diagram security contract. ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------------- | ----- | ---------- | | [`ComponentDiagramSecurity`](#componentdiagramsecurity-diagramscomponentsecurity) | class | public | | [`componentDiagramSecurity`](#componentdiagramsecurity-diagramscomponentsecurity) | const | public | #### `ComponentDiagramSecurity` ```ts class ComponentDiagramSecurity extends BaseModuleSecurity ``` #### `componentDiagramSecurity` ```ts const componentDiagramSecurity; ``` --- ## `diagrams/component/tests` _Source: [`src/diagrams/component/tests.mjs`](src/diagrams/component/tests.mjs)_ Component diagram test contract. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------ | ----- | ---------- | | [`ComponentDiagramTests`](#componentdiagramtests-diagramscomponenttests) | class | public | | [`componentDiagramTests`](#componentdiagramtests-diagramscomponenttests) | const | public | #### `ComponentDiagramTests` ```ts class ComponentDiagramTests extends BaseModuleTests ``` #### `componentDiagramTests` ```ts const componentDiagramTests; ``` --- ## `diagrams/component/tests/output` _Source: [`src/diagrams/component/tests/output.mjs`](src/diagrams/component/tests/output.mjs)_ ### Exports | Name | Kind | Visibility | | -------------------------------------------------------------------------------------- | -------- | ----------- | | [`COMPONENT_TEST_OUTPUT_DIR`](#component_test_output_dir-diagramscomponenttestsoutput) | const | unspecified | | [`writeComponentOutput`](#writecomponentoutput-diagramscomponenttestsoutput) | function | unspecified | #### `COMPONENT_TEST_OUTPUT_DIR` ```ts const COMPONENT_TEST_OUTPUT_DIR; ``` Absolute path to the Component module's generated test-review artefacts. #### `writeComponentOutput` ```ts function writeComponentOutput(filename, content); ``` Write a Component-module test artefact to `src/diagrams/component/tests/output/`. **Parameters** | Name | Type | Description | | ---------- | -------- | ------------------------------------------------------------- | ----------- | ----------------- | | `filename` | `string` | File name or relative path below the module output directory. | | `content` | `string | Buffer | Uint8Array` | Content to write. | --- ## `diagrams/deployment/assets` _Source: [`src/diagrams/deployment/assets.mjs`](src/diagrams/deployment/assets.mjs)_ Deployment diagram asset contract. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------ | ----- | ---------- | | [`DeploymentDiagramAssets`](#deploymentdiagramassets-diagramsdeploymentassets) | class | public | | [`deploymentDiagramAssets`](#deploymentdiagramassets-diagramsdeploymentassets) | const | public | #### `DeploymentDiagramAssets` ```ts class DeploymentDiagramAssets extends BaseModuleAssets ``` #### `deploymentDiagramAssets` ```ts const deploymentDiagramAssets; ``` --- ## `diagrams/deployment/docs` _Source: [`src/diagrams/deployment/docs.mjs`](src/diagrams/deployment/docs.mjs)_ Deployment diagram documentation contract. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------ | ----- | ---------- | | [`DeploymentDiagramDocs`](#deploymentdiagramdocs-diagramsdeploymentdocs) | class | public | | [`deploymentDiagramDocs`](#deploymentdiagramdocs-diagramsdeploymentdocs) | const | public | #### `DeploymentDiagramDocs` ```ts class DeploymentDiagramDocs extends BaseModuleDocs ``` #### `deploymentDiagramDocs` ```ts const deploymentDiagramDocs; ``` --- ## `diagrams/deployment/docs/coverage_examples` _Source: [`src/diagrams/deployment/docs/coverage_examples.mjs`](src/diagrams/deployment/docs/coverage_examples.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------------------------------------- | ----- | ----------- | | [`DEPLOYMENT_COMPONENT_EXAMPLES`](#deployment_component_examples-diagramsdeploymentdocscoverage_examples) | const | unspecified | #### `DEPLOYMENT_COMPONENT_EXAMPLES` ```ts const DEPLOYMENT_COMPONENT_EXAMPLES; ``` Renderable PlantUML examples for the deployment-diagram feature coverage page. --- ## `diagrams/deployment/layout` _Source: [`src/diagrams/deployment/layout.mjs`](src/diagrams/deployment/layout.mjs)_ Deployment diagram layout adapter. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------ | ----- | ---------- | | [`layoutDeploymentDiagram`](#layoutdeploymentdiagram-diagramsdeploymentlayout) | const | public | | [`DeploymentDiagramLayout`](#deploymentdiagramlayout-diagramsdeploymentlayout) | class | public | | [`deploymentDiagramLayout`](#deploymentdiagramlayout-diagramsdeploymentlayout) | const | public | #### `layoutDeploymentDiagram` ```ts const layoutDeploymentDiagram; ``` #### `DeploymentDiagramLayout` ```ts class DeploymentDiagramLayout extends BaseModuleLayout ``` #### `deploymentDiagramLayout` ```ts const deploymentDiagramLayout; ``` --- ## `diagrams/deployment/module` _Source: [`src/diagrams/deployment/module.mjs`](src/diagrams/deployment/module.mjs)_ Built-in deployment diagram module. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------ | ----- | ---------- | | [`DeploymentDiagramModule`](#deploymentdiagrammodule-diagramsdeploymentmodule) | class | public | | [`deploymentDiagramModule`](#deploymentdiagrammodule-diagramsdeploymentmodule) | const | public | #### `DeploymentDiagramModule` ```ts class DeploymentDiagramModule extends GraphModuleBase ``` #### `deploymentDiagramModule` ```ts const deploymentDiagramModule; ``` --- ## `diagrams/deployment/parser` _Source: [`src/diagrams/deployment/parser.mjs`](src/diagrams/deployment/parser.mjs)_ Deployment diagram parser contract. ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------------------------- | -------- | ----------- | | [`DEFAULT_DEPLOYMENT_PLUGINS`](#default_deployment_plugins-diagramsdeploymentparser) | const | public | | [`createDeploymentParseContext`](#createdeploymentparsecontext-diagramsdeploymentparser) | function | public | | [`prepareDeploymentLines`](#preparedeploymentlines-diagramsdeploymentparser) | const | public | | [`DeploymentDiagramParser`](#deploymentdiagramparser-diagramsdeploymentparser) | class | public | | [`deploymentDiagramParser`](#deploymentdiagramparser-diagramsdeploymentparser) | const | public | | [`detectDeploymentDiagram`](#detectdeploymentdiagram-diagramsdeploymentparser) | function | unspecified | #### `DEFAULT_DEPLOYMENT_PLUGINS` ```ts const DEFAULT_DEPLOYMENT_PLUGINS; ``` #### `createDeploymentParseContext` ```ts function createDeploymentParseContext(); ``` #### `prepareDeploymentLines` ```ts const prepareDeploymentLines; ``` #### `DeploymentDiagramParser` ```ts class DeploymentDiagramParser extends BaseModuleParser ``` #### `deploymentDiagramParser` ```ts const deploymentDiagramParser; ``` #### `detectDeploymentDiagram` ```ts function detectDeploymentDiagram(text); ``` **Parameters** | Name | Type | Description | | ------ | -------- | -------------------- | | `text` | `string` | Raw PlantUML source. | **Returns:** `boolean` --- ## `diagrams/deployment/plugins/syntax` _Source: [`src/diagrams/deployment/plugins/syntax.mjs`](src/diagrams/deployment/plugins/syntax.mjs)_ Deployment-diagram specific syntax plugins. ### Exports | Name | Kind | Visibility | | ----------------------------------------------------------------------------------------------------- | ----- | ----------- | | [`deploymentLongDescriptionPlugin`](#deploymentlongdescriptionplugin-diagramsdeploymentpluginssyntax) | const | unspecified | #### `deploymentLongDescriptionPlugin` ```ts const deploymentLongDescriptionPlugin; ``` Official deployment long descriptions: ```plantuml folder folder [ long description ] ``` --- ## `diagrams/deployment/render` _Source: [`src/diagrams/deployment/render.mjs`](src/diagrams/deployment/render.mjs)_ Deployment diagram renderer adapters. ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------------------- | ----- | ---------- | | [`DEPLOYMENT_RENDERERS`](#deployment_renderers-diagramsdeploymentrender) | const | public | | [`DeploymentDiagramRenderer`](#deploymentdiagramrenderer-diagramsdeploymentrender) | class | public | | [`deploymentDiagramRenderer`](#deploymentdiagramrenderer-diagramsdeploymentrender) | const | public | #### `DEPLOYMENT_RENDERERS` ```ts const DEPLOYMENT_RENDERERS; ``` #### `DeploymentDiagramRenderer` ```ts class DeploymentDiagramRenderer extends BaseModuleRenderer ``` #### `deploymentDiagramRenderer` ```ts const deploymentDiagramRenderer; ``` --- ## `diagrams/deployment/security` _Source: [`src/diagrams/deployment/security.mjs`](src/diagrams/deployment/security.mjs)_ Deployment diagram security contract. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------------ | ----- | ---------- | | [`DeploymentDiagramSecurity`](#deploymentdiagramsecurity-diagramsdeploymentsecurity) | class | public | | [`deploymentDiagramSecurity`](#deploymentdiagramsecurity-diagramsdeploymentsecurity) | const | public | #### `DeploymentDiagramSecurity` ```ts class DeploymentDiagramSecurity extends BaseModuleSecurity ``` #### `deploymentDiagramSecurity` ```ts const deploymentDiagramSecurity; ``` --- ## `diagrams/deployment/tests` _Source: [`src/diagrams/deployment/tests.mjs`](src/diagrams/deployment/tests.mjs)_ Deployment diagram test contract. ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------- | ----- | ---------- | | [`DeploymentDiagramTests`](#deploymentdiagramtests-diagramsdeploymenttests) | class | public | | [`deploymentDiagramTests`](#deploymentdiagramtests-diagramsdeploymenttests) | const | public | #### `DeploymentDiagramTests` ```ts class DeploymentDiagramTests extends BaseModuleTests ``` #### `deploymentDiagramTests` ```ts const deploymentDiagramTests; ``` --- ## `diagrams/deployment/tests/output` _Source: [`src/diagrams/deployment/tests/output.mjs`](src/diagrams/deployment/tests/output.mjs)_ ### Exports | Name | Kind | Visibility | | ----------------------------------------------------------------------------------------- | ---------------- | ----------- | | [`DEPLOYMENT_TEST_OUTPUT_DIR`](#deployment_test_output_dir-diagramsdeploymenttestsoutput) | const | unspecified | | [`writeDeploymentOutput`](#writedeploymentoutput-diagramsdeploymenttestsoutput) | function (async) | unspecified | #### `DEPLOYMENT_TEST_OUTPUT_DIR` ```ts const DEPLOYMENT_TEST_OUTPUT_DIR; ``` #### `writeDeploymentOutput` ```ts async function writeDeploymentOutput(filename, content); ``` Write a file to the deployment test output directory. **Parameters** | Name | Type | Description | | ---------- | -------- | ----------- | | `filename` | `string` | — | | `content` | `string` | — | **Returns:** `Promise` --- ## `diagrams/ditaa/assets` _Source: [`src/diagrams/ditaa/assets.mjs`](src/diagrams/ditaa/assets.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------- | ----- | ---------- | | [`DitaaDiagramAssets`](#ditaadiagramassets-diagramsditaaassets) | class | public | | [`ditaaDiagramAssets`](#ditaadiagramassets-diagramsditaaassets) | const | public | #### `DitaaDiagramAssets` ```ts class DitaaDiagramAssets extends BaseModuleAssets ``` #### `ditaaDiagramAssets` ```ts const ditaaDiagramAssets; ``` --- ## `diagrams/ditaa/docs` _Source: [`src/diagrams/ditaa/docs.mjs`](src/diagrams/ditaa/docs.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------- | ----- | ---------- | | [`DitaaDiagramDocs`](#ditaadiagramdocs-diagramsditaadocs) | class | public | | [`ditaaDiagramDocs`](#ditaadiagramdocs-diagramsditaadocs) | const | public | #### `DitaaDiagramDocs` ```ts class DitaaDiagramDocs extends BaseModuleDocs ``` #### `ditaaDiagramDocs` ```ts const ditaaDiagramDocs; ``` --- ## `diagrams/ditaa/docs/coverage_examples` _Source: [`src/diagrams/ditaa/docs/coverage_examples.mjs`](src/diagrams/ditaa/docs/coverage_examples.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------------ | ----- | ---------- | | [`ditaaCoverageExamples`](#ditaacoverageexamples-diagramsditaadocscoverage_examples) | const | public | #### `ditaaCoverageExamples` ```ts const ditaaCoverageExamples; ``` --- ## `diagrams/ditaa/layout` _Source: [`src/diagrams/ditaa/layout.mjs`](src/diagrams/ditaa/layout.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------- | ----- | ---------- | | [`ditaaDiagramLayout`](#ditaadiagramlayout-diagramsditaalayout) | const | public | | [`DitaaDiagramLayout`](#ditaadiagramlayout-diagramsditaalayout) | const | public | #### `ditaaDiagramLayout` ```ts const ditaaDiagramLayout; ``` #### `DitaaDiagramLayout` ```ts const DitaaDiagramLayout; ``` --- ## `diagrams/ditaa/module` _Source: [`src/diagrams/ditaa/module.mjs`](src/diagrams/ditaa/module.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------- | ----- | ---------- | | [`DitaaDiagramModule`](#ditaadiagrammodule-diagramsditaamodule) | class | public | | [`ditaaDiagramModule`](#ditaadiagrammodule-diagramsditaamodule) | const | public | #### `DitaaDiagramModule` ```ts class DitaaDiagramModule extends GraphModuleBase ``` #### `ditaaDiagramModule` ```ts const ditaaDiagramModule; ``` --- ## `diagrams/ditaa/parser` _Source: [`src/diagrams/ditaa/parser.mjs`](src/diagrams/ditaa/parser.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------- | -------- | ---------- | | [`ditaaSyntaxPlugin`](#ditaasyntaxplugin-diagramsditaaparser) | const | public | | [`DEFAULT_DITAA_PLUGINS`](#default_ditaa_plugins-diagramsditaaparser) | const | public | | [`createDitaaParseContext`](#createditaaparsecontext-diagramsditaaparser) | function | public | | [`prepareDitaaLines`](#prepareditaalines-diagramsditaaparser) | const | public | | [`detectDitaaDiagram`](#detectditaadiagram-diagramsditaaparser) | const | public | | [`DitaaDiagramParser`](#ditaadiagramparser-diagramsditaaparser) | class | public | | [`ditaaDiagramParser`](#ditaadiagramparser-diagramsditaaparser) | const | public | #### `ditaaSyntaxPlugin` ```ts const ditaaSyntaxPlugin; ``` #### `DEFAULT_DITAA_PLUGINS` ```ts const DEFAULT_DITAA_PLUGINS; ``` #### `createDitaaParseContext` ```ts function createDitaaParseContext(); ``` #### `prepareDitaaLines` ```ts const prepareDitaaLines; ``` #### `detectDitaaDiagram` ```ts const detectDitaaDiagram; ``` #### `DitaaDiagramParser` ```ts class DitaaDiagramParser extends BaseModuleParser ``` #### `ditaaDiagramParser` ```ts const ditaaDiagramParser; ``` --- ## `diagrams/ditaa/render` _Source: [`src/diagrams/ditaa/render.mjs`](src/diagrams/ditaa/render.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------- | ----- | ---------- | | [`DITAA_RENDERERS`](#ditaa_renderers-diagramsditaarender) | const | public | | [`ditaaDiagramRenderer`](#ditaadiagramrenderer-diagramsditaarender) | const | public | | [`DitaaDiagramRenderer`](#ditaadiagramrenderer-diagramsditaarender) | const | public | #### `DITAA_RENDERERS` ```ts const DITAA_RENDERERS; ``` #### `ditaaDiagramRenderer` ```ts const ditaaDiagramRenderer; ``` #### `DitaaDiagramRenderer` ```ts const DitaaDiagramRenderer; ``` --- ## `diagrams/ditaa/security` _Source: [`src/diagrams/ditaa/security.mjs`](src/diagrams/ditaa/security.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------- | ----- | ---------- | | [`DitaaDiagramSecurity`](#ditaadiagramsecurity-diagramsditaasecurity) | class | public | | [`ditaaDiagramSecurity`](#ditaadiagramsecurity-diagramsditaasecurity) | const | public | #### `DitaaDiagramSecurity` ```ts class DitaaDiagramSecurity extends BaseModuleSecurity ``` #### `ditaaDiagramSecurity` ```ts const ditaaDiagramSecurity; ``` --- ## `diagrams/ditaa/tests` _Source: [`src/diagrams/ditaa/tests.mjs`](src/diagrams/ditaa/tests.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`DitaaDiagramTests`](#ditaadiagramtests-diagramsditaatests) | class | public | | [`ditaaDiagramTests`](#ditaadiagramtests-diagramsditaatests) | const | public | #### `DitaaDiagramTests` ```ts class DitaaDiagramTests extends BaseModuleTests ``` #### `ditaaDiagramTests` ```ts const ditaaDiagramTests; ``` --- ## `diagrams/ebnf/assets` _Source: [`src/diagrams/ebnf/assets.mjs`](src/diagrams/ebnf/assets.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`EbnfDiagramAssets`](#ebnfdiagramassets-diagramsebnfassets) | class | public | | [`ebnfDiagramAssets`](#ebnfdiagramassets-diagramsebnfassets) | const | public | #### `EbnfDiagramAssets` ```ts class EbnfDiagramAssets extends BaseModuleAssets ``` #### `ebnfDiagramAssets` ```ts const ebnfDiagramAssets; ``` --- ## `diagrams/ebnf/docs` _Source: [`src/diagrams/ebnf/docs.mjs`](src/diagrams/ebnf/docs.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------ | ----- | ---------- | | [`EbnfDiagramDocs`](#ebnfdiagramdocs-diagramsebnfdocs) | class | public | | [`ebnfDiagramDocs`](#ebnfdiagramdocs-diagramsebnfdocs) | const | public | #### `EbnfDiagramDocs` ```ts class EbnfDiagramDocs extends BaseModuleDocs ``` #### `ebnfDiagramDocs` ```ts const ebnfDiagramDocs; ``` --- ## `diagrams/ebnf/docs/coverage_examples` _Source: [`src/diagrams/ebnf/docs/coverage_examples.mjs`](src/diagrams/ebnf/docs/coverage_examples.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------------- | ----- | ---------- | | [`ebnfCoverageExamples`](#ebnfcoverageexamples-diagramsebnfdocscoverage_examples) | const | public | #### `ebnfCoverageExamples` ```ts const ebnfCoverageExamples; ``` --- ## `diagrams/ebnf/layout` _Source: [`src/diagrams/ebnf/layout.mjs`](src/diagrams/ebnf/layout.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`EbnfDiagramLayout`](#ebnfdiagramlayout-diagramsebnflayout) | class | public | | [`ebnfDiagramLayout`](#ebnfdiagramlayout-diagramsebnflayout) | const | public | #### `EbnfDiagramLayout` ```ts class EbnfDiagramLayout extends BaseModuleLayout ``` #### `ebnfDiagramLayout` ```ts const ebnfDiagramLayout; ``` --- ## `diagrams/ebnf/module` _Source: [`src/diagrams/ebnf/module.mjs`](src/diagrams/ebnf/module.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`EbnfDiagramModule`](#ebnfdiagrammodule-diagramsebnfmodule) | class | public | | [`ebnfDiagramModule`](#ebnfdiagrammodule-diagramsebnfmodule) | const | public | #### `EbnfDiagramModule` ```ts class EbnfDiagramModule extends GraphModuleBase ``` #### `ebnfDiagramModule` ```ts const ebnfDiagramModule; ``` --- ## `diagrams/ebnf/parser` _Source: [`src/diagrams/ebnf/parser.mjs`](src/diagrams/ebnf/parser.mjs)_ EBNF diagram parser contract. ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------- | -------- | ---------- | | [`ebnfSyntaxPlugin`](#ebnfsyntaxplugin-diagramsebnfparser) | const | public | | [`DEFAULT_EBNF_PLUGINS`](#default_ebnf_plugins-diagramsebnfparser) | const | public | | [`detectEbnfDiagram`](#detectebnfdiagram-diagramsebnfparser) | function | public | | [`prepareEbnfLines`](#prepareebnflines-diagramsebnfparser) | function | public | | [`createEbnfParseContext`](#createebnfparsecontext-diagramsebnfparser) | function | public | | [`EbnfDiagramParser`](#ebnfdiagramparser-diagramsebnfparser) | class | public | | [`ebnfDiagramParser`](#ebnfdiagramparser-diagramsebnfparser) | const | public | #### `ebnfSyntaxPlugin` ```ts const ebnfSyntaxPlugin; ``` #### `DEFAULT_EBNF_PLUGINS` ```ts const DEFAULT_EBNF_PLUGINS; ``` #### `detectEbnfDiagram` ```ts function detectEbnfDiagram(text); ``` #### `prepareEbnfLines` ```ts function prepareEbnfLines(lines); ``` #### `createEbnfParseContext` ```ts function createEbnfParseContext(); ``` #### `EbnfDiagramParser` ```ts class EbnfDiagramParser extends BaseModuleParser ``` #### `ebnfDiagramParser` ```ts const ebnfDiagramParser; ``` --- ## `diagrams/ebnf/render` _Source: [`src/diagrams/ebnf/render.mjs`](src/diagrams/ebnf/render.mjs)_ ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------- | ----- | ---------- | | [`EBNF_RENDERERS`](#ebnf_renderers-diagramsebnfrender) | const | public | | [`EbnfDiagramRenderer`](#ebnfdiagramrenderer-diagramsebnfrender) | class | public | | [`ebnfDiagramRenderer`](#ebnfdiagramrenderer-diagramsebnfrender) | const | public | #### `EBNF_RENDERERS` ```ts const EBNF_RENDERERS; ``` #### `EbnfDiagramRenderer` ```ts class EbnfDiagramRenderer extends BaseModuleRenderer ``` #### `ebnfDiagramRenderer` ```ts const ebnfDiagramRenderer; ``` --- ## `diagrams/ebnf/security` _Source: [`src/diagrams/ebnf/security.mjs`](src/diagrams/ebnf/security.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------ | ----- | ---------- | | [`EbnfDiagramSecurity`](#ebnfdiagramsecurity-diagramsebnfsecurity) | class | public | | [`ebnfDiagramSecurity`](#ebnfdiagramsecurity-diagramsebnfsecurity) | const | public | #### `EbnfDiagramSecurity` ```ts class EbnfDiagramSecurity extends BaseModuleSecurity ``` #### `ebnfDiagramSecurity` ```ts const ebnfDiagramSecurity; ``` --- ## `diagrams/ebnf/tests` _Source: [`src/diagrams/ebnf/tests.mjs`](src/diagrams/ebnf/tests.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------- | ----- | ---------- | | [`EbnfDiagramTests`](#ebnfdiagramtests-diagramsebnftests) | class | public | | [`ebnfDiagramTests`](#ebnfdiagramtests-diagramsebnftests) | const | public | #### `EbnfDiagramTests` ```ts class EbnfDiagramTests extends BaseModuleTests ``` #### `ebnfDiagramTests` ```ts const ebnfDiagramTests; ``` --- ## `diagrams/files/assets` _Source: [`src/diagrams/files/assets.mjs`](src/diagrams/files/assets.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------- | ----- | ---------- | | [`FilesDiagramAssets`](#filesdiagramassets-diagramsfilesassets) | class | public | | [`filesDiagramAssets`](#filesdiagramassets-diagramsfilesassets) | const | public | #### `FilesDiagramAssets` ```ts class FilesDiagramAssets extends BaseModuleAssets ``` #### `filesDiagramAssets` ```ts const filesDiagramAssets; ``` --- ## `diagrams/files/docs` _Source: [`src/diagrams/files/docs.mjs`](src/diagrams/files/docs.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------- | ----- | ---------- | | [`FilesDiagramDocs`](#filesdiagramdocs-diagramsfilesdocs) | class | public | | [`filesDiagramDocs`](#filesdiagramdocs-diagramsfilesdocs) | const | public | #### `FilesDiagramDocs` ```ts class FilesDiagramDocs extends BaseModuleDocs ``` #### `filesDiagramDocs` ```ts const filesDiagramDocs; ``` --- ## `diagrams/files/docs/coverage_examples` _Source: [`src/diagrams/files/docs/coverage_examples.mjs`](src/diagrams/files/docs/coverage_examples.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------------ | ----- | ---------- | | [`filesCoverageExamples`](#filescoverageexamples-diagramsfilesdocscoverage_examples) | const | public | #### `filesCoverageExamples` ```ts const filesCoverageExamples; ``` --- ## `diagrams/files/layout` _Source: [`src/diagrams/files/layout.mjs`](src/diagrams/files/layout.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------- | ----- | ---------- | | [`FilesDiagramLayout`](#filesdiagramlayout-diagramsfileslayout) | class | public | | [`filesDiagramLayout`](#filesdiagramlayout-diagramsfileslayout) | const | public | #### `FilesDiagramLayout` ```ts class FilesDiagramLayout extends BaseModuleLayout ``` #### `filesDiagramLayout` ```ts const filesDiagramLayout; ``` --- ## `diagrams/files/module` _Source: [`src/diagrams/files/module.mjs`](src/diagrams/files/module.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------- | ----- | ---------- | | [`FilesDiagramModule`](#filesdiagrammodule-diagramsfilesmodule) | class | public | | [`filesDiagramModule`](#filesdiagrammodule-diagramsfilesmodule) | const | public | #### `FilesDiagramModule` ```ts class FilesDiagramModule extends TreeModuleBase ``` #### `filesDiagramModule` ```ts const filesDiagramModule; ``` --- ## `diagrams/files/parser` _Source: [`src/diagrams/files/parser.mjs`](src/diagrams/files/parser.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------- | ----- | ---------- | | [`filesSyntaxPlugin`](#filessyntaxplugin-diagramsfilesparser) | const | public | | [`DEFAULT_FILES_PLUGINS`](#default_files_plugins-diagramsfilesparser) | const | public | | [`createFilesParseContext`](#createfilesparsecontext-diagramsfilesparser) | const | public | | [`prepareFilesLines`](#preparefileslines-diagramsfilesparser) | const | public | | [`detectFilesDiagram`](#detectfilesdiagram-diagramsfilesparser) | const | public | | [`FilesDiagramParser`](#filesdiagramparser-diagramsfilesparser) | class | public | | [`filesDiagramParser`](#filesdiagramparser-diagramsfilesparser) | const | public | #### `filesSyntaxPlugin` ```ts const filesSyntaxPlugin; ``` #### `DEFAULT_FILES_PLUGINS` ```ts const DEFAULT_FILES_PLUGINS; ``` #### `createFilesParseContext` ```ts const createFilesParseContext; ``` #### `prepareFilesLines` ```ts const prepareFilesLines; ``` #### `detectFilesDiagram` ```ts const detectFilesDiagram; ``` #### `FilesDiagramParser` ```ts class FilesDiagramParser extends BaseModuleParser ``` #### `filesDiagramParser` ```ts const filesDiagramParser; ``` --- ## `diagrams/files/render` _Source: [`src/diagrams/files/render.mjs`](src/diagrams/files/render.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------- | ----- | ---------- | | [`FILES_RENDERERS`](#files_renderers-diagramsfilesrender) | const | public | | [`FilesDiagramRenderer`](#filesdiagramrenderer-diagramsfilesrender) | class | public | | [`filesDiagramRenderer`](#filesdiagramrenderer-diagramsfilesrender) | const | public | #### `FILES_RENDERERS` ```ts const FILES_RENDERERS; ``` #### `FilesDiagramRenderer` ```ts class FilesDiagramRenderer extends BaseModuleRenderer ``` #### `filesDiagramRenderer` ```ts const filesDiagramRenderer; ``` --- ## `diagrams/files/security` _Source: [`src/diagrams/files/security.mjs`](src/diagrams/files/security.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------- | ----- | ---------- | | [`FilesDiagramSecurity`](#filesdiagramsecurity-diagramsfilessecurity) | class | public | | [`filesDiagramSecurity`](#filesdiagramsecurity-diagramsfilessecurity) | const | public | #### `FilesDiagramSecurity` ```ts class FilesDiagramSecurity extends BaseModuleSecurity ``` #### `filesDiagramSecurity` ```ts const filesDiagramSecurity; ``` --- ## `diagrams/files/tests` _Source: [`src/diagrams/files/tests.mjs`](src/diagrams/files/tests.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`FilesDiagramTests`](#filesdiagramtests-diagramsfilestests) | class | public | | [`filesDiagramTests`](#filesdiagramtests-diagramsfilestests) | const | public | #### `FilesDiagramTests` ```ts class FilesDiagramTests extends BaseModuleTests ``` #### `filesDiagramTests` ```ts const filesDiagramTests; ``` --- ## `diagrams/gantt/assets` _Source: [`src/diagrams/gantt/assets.mjs`](src/diagrams/gantt/assets.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------- | ----- | ---------- | | [`GanttDiagramAssets`](#ganttdiagramassets-diagramsganttassets) | class | public | | [`ganttDiagramAssets`](#ganttdiagramassets-diagramsganttassets) | const | public | #### `GanttDiagramAssets` ```ts class GanttDiagramAssets extends BaseModuleAssets ``` #### `ganttDiagramAssets` ```ts const ganttDiagramAssets; ``` --- ## `diagrams/gantt/docs` _Source: [`src/diagrams/gantt/docs.mjs`](src/diagrams/gantt/docs.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------- | ----- | ---------- | | [`GanttDiagramDocs`](#ganttdiagramdocs-diagramsganttdocs) | class | public | | [`ganttDiagramDocs`](#ganttdiagramdocs-diagramsganttdocs) | const | public | #### `GanttDiagramDocs` ```ts class GanttDiagramDocs extends BaseModuleDocs ``` #### `ganttDiagramDocs` ```ts const ganttDiagramDocs; ``` --- ## `diagrams/gantt/docs/coverage_examples` _Source: [`src/diagrams/gantt/docs/coverage_examples.mjs`](src/diagrams/gantt/docs/coverage_examples.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------------ | ----- | ---------- | | [`ganttCoverageExamples`](#ganttcoverageexamples-diagramsganttdocscoverage_examples) | const | public | #### `ganttCoverageExamples` ```ts const ganttCoverageExamples; ``` --- ## `diagrams/gantt/layout` _Source: [`src/diagrams/gantt/layout.mjs`](src/diagrams/gantt/layout.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------- | ----- | ---------- | | [`GanttDiagramLayout`](#ganttdiagramlayout-diagramsganttlayout) | class | public | | [`ganttDiagramLayout`](#ganttdiagramlayout-diagramsganttlayout) | const | public | #### `GanttDiagramLayout` ```ts class GanttDiagramLayout extends BaseModuleLayout ``` #### `ganttDiagramLayout` ```ts const ganttDiagramLayout; ``` --- ## `diagrams/gantt/module` _Source: [`src/diagrams/gantt/module.mjs`](src/diagrams/gantt/module.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------- | ----- | ---------- | | [`GanttDiagramModule`](#ganttdiagrammodule-diagramsganttmodule) | class | public | | [`ganttDiagramModule`](#ganttdiagrammodule-diagramsganttmodule) | const | public | #### `GanttDiagramModule` ```ts class GanttDiagramModule extends TimelineModuleBase ``` #### `ganttDiagramModule` ```ts const ganttDiagramModule; ``` --- ## `diagrams/gantt/parser` _Source: [`src/diagrams/gantt/parser.mjs`](src/diagrams/gantt/parser.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------- | ----- | ---------- | | [`ganttSyntaxPlugin`](#ganttsyntaxplugin-diagramsganttparser) | const | public | | [`DEFAULT_GANTT_PLUGINS`](#default_gantt_plugins-diagramsganttparser) | const | public | | [`createGanttParseContext`](#createganttparsecontext-diagramsganttparser) | const | public | | [`prepareGanttLines`](#prepareganttlines-diagramsganttparser) | const | public | | [`detectGanttDiagram`](#detectganttdiagram-diagramsganttparser) | const | public | | [`GanttDiagramParser`](#ganttdiagramparser-diagramsganttparser) | class | public | | [`ganttDiagramParser`](#ganttdiagramparser-diagramsganttparser) | const | public | #### `ganttSyntaxPlugin` ```ts const ganttSyntaxPlugin; ``` #### `DEFAULT_GANTT_PLUGINS` ```ts const DEFAULT_GANTT_PLUGINS; ``` #### `createGanttParseContext` ```ts const createGanttParseContext; ``` #### `prepareGanttLines` ```ts const prepareGanttLines; ``` #### `detectGanttDiagram` ```ts const detectGanttDiagram; ``` #### `GanttDiagramParser` ```ts class GanttDiagramParser extends BaseModuleParser ``` #### `ganttDiagramParser` ```ts const ganttDiagramParser; ``` --- ## `diagrams/gantt/render` _Source: [`src/diagrams/gantt/render.mjs`](src/diagrams/gantt/render.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------- | ----- | ---------- | | [`GANTT_RENDERERS`](#gantt_renderers-diagramsganttrender) | const | public | | [`GanttDiagramRenderer`](#ganttdiagramrenderer-diagramsganttrender) | class | public | | [`ganttDiagramRenderer`](#ganttdiagramrenderer-diagramsganttrender) | const | public | #### `GANTT_RENDERERS` ```ts const GANTT_RENDERERS; ``` #### `GanttDiagramRenderer` ```ts class GanttDiagramRenderer extends BaseModuleRenderer ``` #### `ganttDiagramRenderer` ```ts const ganttDiagramRenderer; ``` --- ## `diagrams/gantt/security` _Source: [`src/diagrams/gantt/security.mjs`](src/diagrams/gantt/security.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------- | ----- | ---------- | | [`GanttDiagramSecurity`](#ganttdiagramsecurity-diagramsganttsecurity) | class | public | | [`ganttDiagramSecurity`](#ganttdiagramsecurity-diagramsganttsecurity) | const | public | #### `GanttDiagramSecurity` ```ts class GanttDiagramSecurity extends BaseModuleSecurity ``` #### `ganttDiagramSecurity` ```ts const ganttDiagramSecurity; ``` --- ## `diagrams/gantt/tests` _Source: [`src/diagrams/gantt/tests.mjs`](src/diagrams/gantt/tests.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`GanttDiagramTests`](#ganttdiagramtests-diagramsgantttests) | class | public | | [`ganttDiagramTests`](#ganttdiagramtests-diagramsgantttests) | const | public | #### `GanttDiagramTests` ```ts class GanttDiagramTests extends BaseModuleTests ``` #### `ganttDiagramTests` ```ts const ganttDiagramTests; ``` --- ## `diagrams/ie/assets` _Source: [`src/diagrams/ie/assets.mjs`](src/diagrams/ie/assets.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------ | ----- | ---------- | | [`IeDiagramAssets`](#iediagramassets-diagramsieassets) | class | public | | [`ieDiagramAssets`](#iediagramassets-diagramsieassets) | const | public | #### `IeDiagramAssets` ```ts class IeDiagramAssets extends BaseModuleAssets ``` #### `ieDiagramAssets` ```ts const ieDiagramAssets; ``` --- ## `diagrams/ie/docs` _Source: [`src/diagrams/ie/docs.mjs`](src/diagrams/ie/docs.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------ | ----- | ---------- | | [`IeDiagramDocs`](#iediagramdocs-diagramsiedocs) | class | public | | [`ieDiagramDocs`](#iediagramdocs-diagramsiedocs) | const | public | #### `IeDiagramDocs` ```ts class IeDiagramDocs extends BaseModuleDocs ``` #### `ieDiagramDocs` ```ts const ieDiagramDocs; ``` --- ## `diagrams/ie/docs/coverage_examples` _Source: [`src/diagrams/ie/docs/coverage_examples.mjs`](src/diagrams/ie/docs/coverage_examples.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------- | ----- | ---------- | | [`ieCoverageExamples`](#iecoverageexamples-diagramsiedocscoverage_examples) | const | public | #### `ieCoverageExamples` ```ts const ieCoverageExamples; ``` --- ## `diagrams/ie/layout` _Source: [`src/diagrams/ie/layout.mjs`](src/diagrams/ie/layout.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------ | ----- | ---------- | | [`ieDiagramLayout`](#iediagramlayout-diagramsielayout) | const | public | | [`IeDiagramLayout`](#iediagramlayout-diagramsielayout) | const | public | #### `ieDiagramLayout` ```ts const ieDiagramLayout; ``` #### `IeDiagramLayout` ```ts const IeDiagramLayout; ``` --- ## `diagrams/ie/module` _Source: [`src/diagrams/ie/module.mjs`](src/diagrams/ie/module.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------ | ----- | ---------- | | [`IeDiagramModule`](#iediagrammodule-diagramsiemodule) | class | public | | [`ieDiagramModule`](#iediagrammodule-diagramsiemodule) | const | public | #### `IeDiagramModule` ```ts class IeDiagramModule extends GraphModuleBase ``` #### `ieDiagramModule` ```ts const ieDiagramModule; ``` --- ## `diagrams/ie/parser` _Source: [`src/diagrams/ie/parser.mjs`](src/diagrams/ie/parser.mjs)_ ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------- | -------- | ---------- | | [`ieEntityPlugin`](#ieentityplugin-diagramsieparser) | const | public | | [`ieRelationshipPlugin`](#ierelationshipplugin-diagramsieparser) | const | public | | [`DEFAULT_IE_PLUGINS`](#default_ie_plugins-diagramsieparser) | const | public | | [`createIeParseContext`](#createieparsecontext-diagramsieparser) | const | public | | [`prepareIeLines`](#prepareielines-diagramsieparser) | const | public | | [`detectIeDiagram`](#detectiediagram-diagramsieparser) | function | public | | [`IeDiagramParser`](#iediagramparser-diagramsieparser) | class | public | | [`ieDiagramParser`](#iediagramparser-diagramsieparser) | const | public | #### `ieEntityPlugin` ```ts const ieEntityPlugin; ``` #### `ieRelationshipPlugin` ```ts const ieRelationshipPlugin; ``` #### `DEFAULT_IE_PLUGINS` ```ts const DEFAULT_IE_PLUGINS; ``` #### `createIeParseContext` ```ts const createIeParseContext; ``` #### `prepareIeLines` ```ts const prepareIeLines; ``` #### `detectIeDiagram` ```ts function detectIeDiagram(text); ``` #### `IeDiagramParser` ```ts class IeDiagramParser extends BaseModuleParser ``` #### `ieDiagramParser` ```ts const ieDiagramParser; ``` --- ## `diagrams/ie/render` _Source: [`src/diagrams/ie/render.mjs`](src/diagrams/ie/render.mjs)_ ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------- | ----- | ---------- | | [`IE_RENDERERS`](#ie_renderers-diagramsierender) | const | public | | [`IeDiagramRenderer`](#iediagramrenderer-diagramsierender) | class | public | | [`ieDiagramRenderer`](#iediagramrenderer-diagramsierender) | const | public | #### `IE_RENDERERS` ```ts const IE_RENDERERS; ``` #### `IeDiagramRenderer` ```ts class IeDiagramRenderer extends BaseModuleRenderer ``` #### `ieDiagramRenderer` ```ts const ieDiagramRenderer; ``` --- ## `diagrams/ie/security` _Source: [`src/diagrams/ie/security.mjs`](src/diagrams/ie/security.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`IeDiagramSecurity`](#iediagramsecurity-diagramsiesecurity) | class | public | | [`ieDiagramSecurity`](#iediagramsecurity-diagramsiesecurity) | const | public | #### `IeDiagramSecurity` ```ts class IeDiagramSecurity extends BaseModuleSecurity ``` #### `ieDiagramSecurity` ```ts const ieDiagramSecurity; ``` --- ## `diagrams/ie/tests` _Source: [`src/diagrams/ie/tests.mjs`](src/diagrams/ie/tests.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------- | ----- | ---------- | | [`IeDiagramTests`](#iediagramtests-diagramsietests) | class | public | | [`ieDiagramTests`](#iediagramtests-diagramsietests) | const | public | #### `IeDiagramTests` ```ts class IeDiagramTests extends BaseModuleTests ``` #### `ieDiagramTests` ```ts const ieDiagramTests; ``` --- ## `diagrams/index` _Source: [`src/diagrams/index.mjs`](src/diagrams/index.mjs)_ Built-in diagram module collection. The main program collects diagram modules from this static repo-internal index at runtime. Each diagram type owns its own folder below `src/diagrams/`. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------- | ----- | ---------- | | [`BUILTIN_DIAGRAM_MODULES`](#builtin_diagram_modules-diagramsindex) | const | public | #### `BUILTIN_DIAGRAM_MODULES` ```ts const BUILTIN_DIAGRAM_MODULES; ``` --- ## `diagrams/json/assets` _Source: [`src/diagrams/json/assets.mjs`](src/diagrams/json/assets.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`JsonDiagramAssets`](#jsondiagramassets-diagramsjsonassets) | class | public | | [`jsonDiagramAssets`](#jsondiagramassets-diagramsjsonassets) | const | public | #### `JsonDiagramAssets` ```ts class JsonDiagramAssets extends BaseModuleAssets ``` #### `jsonDiagramAssets` ```ts const jsonDiagramAssets; ``` --- ## `diagrams/json/docs` _Source: [`src/diagrams/json/docs.mjs`](src/diagrams/json/docs.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------ | ----- | ---------- | | [`JsonDiagramDocs`](#jsondiagramdocs-diagramsjsondocs) | class | public | | [`jsonDiagramDocs`](#jsondiagramdocs-diagramsjsondocs) | const | public | #### `JsonDiagramDocs` ```ts class JsonDiagramDocs extends BaseModuleDocs ``` #### `jsonDiagramDocs` ```ts const jsonDiagramDocs; ``` --- ## `diagrams/json/docs/coverage_examples` _Source: [`src/diagrams/json/docs/coverage_examples.mjs`](src/diagrams/json/docs/coverage_examples.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------------- | ----- | ---------- | | [`jsonCoverageExamples`](#jsoncoverageexamples-diagramsjsondocscoverage_examples) | const | public | #### `jsonCoverageExamples` ```ts const jsonCoverageExamples; ``` --- ## `diagrams/json/layout` _Source: [`src/diagrams/json/layout.mjs`](src/diagrams/json/layout.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`JsonDiagramLayout`](#jsondiagramlayout-diagramsjsonlayout) | class | public | | [`jsonDiagramLayout`](#jsondiagramlayout-diagramsjsonlayout) | const | public | #### `JsonDiagramLayout` ```ts class JsonDiagramLayout extends BaseModuleLayout ``` #### `jsonDiagramLayout` ```ts const jsonDiagramLayout; ``` --- ## `diagrams/json/module` _Source: [`src/diagrams/json/module.mjs`](src/diagrams/json/module.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`JsonDiagramModule`](#jsondiagrammodule-diagramsjsonmodule) | class | public | | [`jsonDiagramModule`](#jsondiagrammodule-diagramsjsonmodule) | const | public | #### `JsonDiagramModule` ```ts class JsonDiagramModule extends DataModuleBase ``` #### `jsonDiagramModule` ```ts const jsonDiagramModule; ``` --- ## `diagrams/json/parser` _Source: [`src/diagrams/json/parser.mjs`](src/diagrams/json/parser.mjs)_ ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------- | ----- | ----------- | | [`jsonSyntaxPlugin`](#jsonsyntaxplugin-diagramsjsonparser) | const | public | | [`DEFAULT_JSON_PLUGINS`](#default_json_plugins-diagramsjsonparser) | const | public | | [`detectJsonDiagram`](#detectjsondiagram-diagramsjsonparser) | const | public | | [`prepareJsonLines`](#preparejsonlines-diagramsjsonparser) | const | unspecified | | [`createJsonParseContext`](#createjsonparsecontext-diagramsjsonparser) | const | public | | [`JsonDiagramParser`](#jsondiagramparser-diagramsjsonparser) | class | public | | [`jsonDiagramParser`](#jsondiagramparser-diagramsjsonparser) | const | public | #### `jsonSyntaxPlugin` ```ts const jsonSyntaxPlugin; ``` #### `DEFAULT_JSON_PLUGINS` ```ts const DEFAULT_JSON_PLUGINS; ``` #### `detectJsonDiagram` ```ts const detectJsonDiagram; ``` #### `prepareJsonLines` ```ts const prepareJsonLines; ``` #### `createJsonParseContext` ```ts const createJsonParseContext; ``` #### `JsonDiagramParser` ```ts class JsonDiagramParser extends BaseModuleParser ``` #### `jsonDiagramParser` ```ts const jsonDiagramParser; ``` --- ## `diagrams/json/render` _Source: [`src/diagrams/json/render.mjs`](src/diagrams/json/render.mjs)_ ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------- | ----- | ---------- | | [`JSON_RENDERERS`](#json_renderers-diagramsjsonrender) | const | public | | [`JsonDiagramRenderer`](#jsondiagramrenderer-diagramsjsonrender) | class | public | | [`jsonDiagramRenderer`](#jsondiagramrenderer-diagramsjsonrender) | const | public | #### `JSON_RENDERERS` ```ts const JSON_RENDERERS; ``` #### `JsonDiagramRenderer` ```ts class JsonDiagramRenderer extends BaseModuleRenderer ``` #### `jsonDiagramRenderer` ```ts const jsonDiagramRenderer; ``` --- ## `diagrams/json/security` _Source: [`src/diagrams/json/security.mjs`](src/diagrams/json/security.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------ | ----- | ---------- | | [`JsonDiagramSecurity`](#jsondiagramsecurity-diagramsjsonsecurity) | class | public | | [`jsonDiagramSecurity`](#jsondiagramsecurity-diagramsjsonsecurity) | const | public | #### `JsonDiagramSecurity` ```ts class JsonDiagramSecurity extends BaseModuleSecurity ``` #### `jsonDiagramSecurity` ```ts const jsonDiagramSecurity; ``` --- ## `diagrams/json/tests` _Source: [`src/diagrams/json/tests.mjs`](src/diagrams/json/tests.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------- | ----- | ---------- | | [`JsonDiagramTests`](#jsondiagramtests-diagramsjsontests) | class | public | | [`jsonDiagramTests`](#jsondiagramtests-diagramsjsontests) | const | public | #### `JsonDiagramTests` ```ts class JsonDiagramTests extends BaseModuleTests ``` #### `jsonDiagramTests` ```ts const jsonDiagramTests; ``` --- ## `diagrams/math/assets` _Source: [`src/diagrams/math/assets.mjs`](src/diagrams/math/assets.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`MathDiagramAssets`](#mathdiagramassets-diagramsmathassets) | class | public | | [`mathDiagramAssets`](#mathdiagramassets-diagramsmathassets) | const | public | #### `MathDiagramAssets` ```ts class MathDiagramAssets extends BaseModuleAssets ``` #### `mathDiagramAssets` ```ts const mathDiagramAssets; ``` --- ## `diagrams/math/docs` _Source: [`src/diagrams/math/docs.mjs`](src/diagrams/math/docs.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------ | ----- | ---------- | | [`MathDiagramDocs`](#mathdiagramdocs-diagramsmathdocs) | class | public | | [`mathDiagramDocs`](#mathdiagramdocs-diagramsmathdocs) | const | public | #### `MathDiagramDocs` ```ts class MathDiagramDocs extends BaseModuleDocs ``` #### `mathDiagramDocs` ```ts const mathDiagramDocs; ``` --- ## `diagrams/math/docs/coverage_examples` _Source: [`src/diagrams/math/docs/coverage_examples.mjs`](src/diagrams/math/docs/coverage_examples.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------------- | ----- | ---------- | | [`mathCoverageExamples`](#mathcoverageexamples-diagramsmathdocscoverage_examples) | const | public | #### `mathCoverageExamples` ```ts const mathCoverageExamples; ``` --- ## `diagrams/math/layout` _Source: [`src/diagrams/math/layout.mjs`](src/diagrams/math/layout.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`MathDiagramLayout`](#mathdiagramlayout-diagramsmathlayout) | class | public | | [`mathDiagramLayout`](#mathdiagramlayout-diagramsmathlayout) | const | public | #### `MathDiagramLayout` ```ts class MathDiagramLayout extends BaseModuleLayout ``` #### `mathDiagramLayout` ```ts const mathDiagramLayout; ``` --- ## `diagrams/math/module` _Source: [`src/diagrams/math/module.mjs`](src/diagrams/math/module.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`MathDiagramModule`](#mathdiagrammodule-diagramsmathmodule) | class | public | | [`mathDiagramModule`](#mathdiagrammodule-diagramsmathmodule) | const | public | #### `MathDiagramModule` ```ts class MathDiagramModule extends GraphModuleBase ``` #### `mathDiagramModule` ```ts const mathDiagramModule; ``` --- ## `diagrams/math/parser` _Source: [`src/diagrams/math/parser.mjs`](src/diagrams/math/parser.mjs)_ ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------- | -------- | ---------- | | [`mathSyntaxPlugin`](#mathsyntaxplugin-diagramsmathparser) | const | public | | [`DEFAULT_MATH_PLUGINS`](#default_math_plugins-diagramsmathparser) | const | public | | [`detectMathDiagram`](#detectmathdiagram-diagramsmathparser) | function | public | | [`prepareMathLines`](#preparemathlines-diagramsmathparser) | function | public | | [`createMathParseContext`](#createmathparsecontext-diagramsmathparser) | function | public | | [`MathDiagramParser`](#mathdiagramparser-diagramsmathparser) | class | public | | [`mathDiagramParser`](#mathdiagramparser-diagramsmathparser) | const | public | #### `mathSyntaxPlugin` ```ts const mathSyntaxPlugin; ``` #### `DEFAULT_MATH_PLUGINS` ```ts const DEFAULT_MATH_PLUGINS; ``` #### `detectMathDiagram` ```ts function detectMathDiagram(text); ``` #### `prepareMathLines` ```ts function prepareMathLines(lines); ``` #### `createMathParseContext` ```ts function createMathParseContext(); ``` #### `MathDiagramParser` ```ts class MathDiagramParser extends BaseModuleParser ``` #### `mathDiagramParser` ```ts const mathDiagramParser; ``` --- ## `diagrams/math/render` _Source: [`src/diagrams/math/render.mjs`](src/diagrams/math/render.mjs)_ ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------- | ----- | ---------- | | [`MATH_RENDERERS`](#math_renderers-diagramsmathrender) | const | public | | [`MathDiagramRenderer`](#mathdiagramrenderer-diagramsmathrender) | class | public | | [`mathDiagramRenderer`](#mathdiagramrenderer-diagramsmathrender) | const | public | #### `MATH_RENDERERS` ```ts const MATH_RENDERERS; ``` #### `MathDiagramRenderer` ```ts class MathDiagramRenderer extends BaseModuleRenderer ``` #### `mathDiagramRenderer` ```ts const mathDiagramRenderer; ``` --- ## `diagrams/math/security` _Source: [`src/diagrams/math/security.mjs`](src/diagrams/math/security.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------ | ----- | ---------- | | [`MathDiagramSecurity`](#mathdiagramsecurity-diagramsmathsecurity) | class | public | | [`mathDiagramSecurity`](#mathdiagramsecurity-diagramsmathsecurity) | const | public | #### `MathDiagramSecurity` ```ts class MathDiagramSecurity extends BaseModuleSecurity ``` #### `mathDiagramSecurity` ```ts const mathDiagramSecurity; ``` --- ## `diagrams/math/tests` _Source: [`src/diagrams/math/tests.mjs`](src/diagrams/math/tests.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------- | ----- | ---------- | | [`MathDiagramTests`](#mathdiagramtests-diagramsmathtests) | class | public | | [`mathDiagramTests`](#mathdiagramtests-diagramsmathtests) | const | public | #### `MathDiagramTests` ```ts class MathDiagramTests extends BaseModuleTests ``` #### `mathDiagramTests` ```ts const mathDiagramTests; ``` --- ## `diagrams/mindmap/assets` _Source: [`src/diagrams/mindmap/assets.mjs`](src/diagrams/mindmap/assets.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------- | ----- | ---------- | | [`MindmapDiagramAssets`](#mindmapdiagramassets-diagramsmindmapassets) | class | public | | [`mindmapDiagramAssets`](#mindmapdiagramassets-diagramsmindmapassets) | const | public | #### `MindmapDiagramAssets` ```ts class MindmapDiagramAssets extends BaseModuleAssets ``` #### `mindmapDiagramAssets` ```ts const mindmapDiagramAssets; ``` --- ## `diagrams/mindmap/docs` _Source: [`src/diagrams/mindmap/docs.mjs`](src/diagrams/mindmap/docs.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------- | ----- | ---------- | | [`MindmapDiagramDocs`](#mindmapdiagramdocs-diagramsmindmapdocs) | class | public | | [`mindmapDiagramDocs`](#mindmapdiagramdocs-diagramsmindmapdocs) | const | public | #### `MindmapDiagramDocs` ```ts class MindmapDiagramDocs extends BaseModuleDocs ``` #### `mindmapDiagramDocs` ```ts const mindmapDiagramDocs; ``` --- ## `diagrams/mindmap/docs/coverage_examples` _Source: [`src/diagrams/mindmap/docs/coverage_examples.mjs`](src/diagrams/mindmap/docs/coverage_examples.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------------------ | ----- | ---------- | | [`mindmapCoverageExamples`](#mindmapcoverageexamples-diagramsmindmapdocscoverage_examples) | const | public | #### `mindmapCoverageExamples` ```ts const mindmapCoverageExamples; ``` --- ## `diagrams/mindmap/layout` _Source: [`src/diagrams/mindmap/layout.mjs`](src/diagrams/mindmap/layout.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------- | ----- | ---------- | | [`MindmapDiagramLayout`](#mindmapdiagramlayout-diagramsmindmaplayout) | class | public | | [`mindmapDiagramLayout`](#mindmapdiagramlayout-diagramsmindmaplayout) | const | public | #### `MindmapDiagramLayout` ```ts class MindmapDiagramLayout extends BaseModuleLayout ``` #### `mindmapDiagramLayout` ```ts const mindmapDiagramLayout; ``` --- ## `diagrams/mindmap/module` _Source: [`src/diagrams/mindmap/module.mjs`](src/diagrams/mindmap/module.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------- | ----- | ---------- | | [`MindmapDiagramModule`](#mindmapdiagrammodule-diagramsmindmapmodule) | class | public | | [`mindmapDiagramModule`](#mindmapdiagrammodule-diagramsmindmapmodule) | const | public | #### `MindmapDiagramModule` ```ts class MindmapDiagramModule extends TreeModuleBase ``` #### `mindmapDiagramModule` ```ts const mindmapDiagramModule; ``` --- ## `diagrams/mindmap/parser` _Source: [`src/diagrams/mindmap/parser.mjs`](src/diagrams/mindmap/parser.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------- | ----- | ---------- | | [`mindmapSyntaxPlugin`](#mindmapsyntaxplugin-diagramsmindmapparser) | const | public | | [`DEFAULT_MINDMAP_PLUGINS`](#default_mindmap_plugins-diagramsmindmapparser) | const | public | | [`createMindmapParseContext`](#createmindmapparsecontext-diagramsmindmapparser) | const | public | | [`prepareMindmapLines`](#preparemindmaplines-diagramsmindmapparser) | const | public | | [`detectMindmapDiagram`](#detectmindmapdiagram-diagramsmindmapparser) | const | public | | [`MindmapDiagramParser`](#mindmapdiagramparser-diagramsmindmapparser) | class | public | | [`mindmapDiagramParser`](#mindmapdiagramparser-diagramsmindmapparser) | const | public | #### `mindmapSyntaxPlugin` ```ts const mindmapSyntaxPlugin; ``` #### `DEFAULT_MINDMAP_PLUGINS` ```ts const DEFAULT_MINDMAP_PLUGINS; ``` #### `createMindmapParseContext` ```ts const createMindmapParseContext; ``` #### `prepareMindmapLines` ```ts const prepareMindmapLines; ``` #### `detectMindmapDiagram` ```ts const detectMindmapDiagram; ``` #### `MindmapDiagramParser` ```ts class MindmapDiagramParser extends BaseModuleParser ``` #### `mindmapDiagramParser` ```ts const mindmapDiagramParser; ``` --- ## `diagrams/mindmap/render` _Source: [`src/diagrams/mindmap/render.mjs`](src/diagrams/mindmap/render.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------- | ----- | ---------- | | [`MINDMAP_RENDERERS`](#mindmap_renderers-diagramsmindmaprender) | const | public | | [`MindmapDiagramRenderer`](#mindmapdiagramrenderer-diagramsmindmaprender) | class | public | | [`mindmapDiagramRenderer`](#mindmapdiagramrenderer-diagramsmindmaprender) | const | public | #### `MINDMAP_RENDERERS` ```ts const MINDMAP_RENDERERS; ``` #### `MindmapDiagramRenderer` ```ts class MindmapDiagramRenderer extends BaseModuleRenderer ``` #### `mindmapDiagramRenderer` ```ts const mindmapDiagramRenderer; ``` --- ## `diagrams/mindmap/security` _Source: [`src/diagrams/mindmap/security.mjs`](src/diagrams/mindmap/security.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------- | ----- | ---------- | | [`MindmapDiagramSecurity`](#mindmapdiagramsecurity-diagramsmindmapsecurity) | class | public | | [`mindmapDiagramSecurity`](#mindmapdiagramsecurity-diagramsmindmapsecurity) | const | public | #### `MindmapDiagramSecurity` ```ts class MindmapDiagramSecurity extends BaseModuleSecurity ``` #### `mindmapDiagramSecurity` ```ts const mindmapDiagramSecurity; ``` --- ## `diagrams/mindmap/tests` _Source: [`src/diagrams/mindmap/tests.mjs`](src/diagrams/mindmap/tests.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------ | ----- | ---------- | | [`MindmapDiagramTests`](#mindmapdiagramtests-diagramsmindmaptests) | class | public | | [`mindmapDiagramTests`](#mindmapdiagramtests-diagramsmindmaptests) | const | public | #### `MindmapDiagramTests` ```ts class MindmapDiagramTests extends BaseModuleTests ``` #### `mindmapDiagramTests` ```ts const mindmapDiagramTests; ``` --- ## `diagrams/nwdiag/assets` _Source: [`src/diagrams/nwdiag/assets.mjs`](src/diagrams/nwdiag/assets.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------ | ----- | ---------- | | [`NwdiagDiagramAssets`](#nwdiagdiagramassets-diagramsnwdiagassets) | class | public | | [`nwdiagDiagramAssets`](#nwdiagdiagramassets-diagramsnwdiagassets) | const | public | #### `NwdiagDiagramAssets` ```ts class NwdiagDiagramAssets extends BaseModuleAssets ``` #### `nwdiagDiagramAssets` ```ts const nwdiagDiagramAssets; ``` --- ## `diagrams/nwdiag/docs` _Source: [`src/diagrams/nwdiag/docs.mjs`](src/diagrams/nwdiag/docs.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`NwdiagDiagramDocs`](#nwdiagdiagramdocs-diagramsnwdiagdocs) | class | public | | [`nwdiagDiagramDocs`](#nwdiagdiagramdocs-diagramsnwdiagdocs) | const | public | #### `NwdiagDiagramDocs` ```ts class NwdiagDiagramDocs extends BaseModuleDocs ``` #### `nwdiagDiagramDocs` ```ts const nwdiagDiagramDocs; ``` --- ## `diagrams/nwdiag/docs/coverage_examples` _Source: [`src/diagrams/nwdiag/docs/coverage_examples.mjs`](src/diagrams/nwdiag/docs/coverage_examples.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------------------- | ----- | ---------- | | [`nwdiagCoverageExamples`](#nwdiagcoverageexamples-diagramsnwdiagdocscoverage_examples) | const | public | #### `nwdiagCoverageExamples` ```ts const nwdiagCoverageExamples; ``` --- ## `diagrams/nwdiag/layout` _Source: [`src/diagrams/nwdiag/layout.mjs`](src/diagrams/nwdiag/layout.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------ | ----- | ---------- | | [`NwdiagDiagramLayout`](#nwdiagdiagramlayout-diagramsnwdiaglayout) | class | public | | [`nwdiagDiagramLayout`](#nwdiagdiagramlayout-diagramsnwdiaglayout) | const | public | #### `NwdiagDiagramLayout` ```ts class NwdiagDiagramLayout extends BaseModuleLayout ``` #### `nwdiagDiagramLayout` ```ts const nwdiagDiagramLayout; ``` --- ## `diagrams/nwdiag/module` _Source: [`src/diagrams/nwdiag/module.mjs`](src/diagrams/nwdiag/module.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------ | ----- | ---------- | | [`NwdiagDiagramModule`](#nwdiagdiagrammodule-diagramsnwdiagmodule) | class | public | | [`nwdiagDiagramModule`](#nwdiagdiagrammodule-diagramsnwdiagmodule) | const | public | #### `NwdiagDiagramModule` ```ts class NwdiagDiagramModule extends GraphModuleBase ``` #### `nwdiagDiagramModule` ```ts const nwdiagDiagramModule; ``` --- ## `diagrams/nwdiag/parser` _Source: [`src/diagrams/nwdiag/parser.mjs`](src/diagrams/nwdiag/parser.mjs)_ ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------------- | -------- | ---------- | | [`nwdiagSyntaxPlugin`](#nwdiagsyntaxplugin-diagramsnwdiagparser) | const | public | | [`DEFAULT_NWDIAG_PLUGINS`](#default_nwdiag_plugins-diagramsnwdiagparser) | const | public | | [`createNwdiagParseContext`](#createnwdiagparsecontext-diagramsnwdiagparser) | function | public | | [`prepareNwdiagLines`](#preparenwdiaglines-diagramsnwdiagparser) | function | public | | [`detectNwdiagDiagram`](#detectnwdiagdiagram-diagramsnwdiagparser) | function | public | | [`NwdiagDiagramParser`](#nwdiagdiagramparser-diagramsnwdiagparser) | class | public | | [`nwdiagDiagramParser`](#nwdiagdiagramparser-diagramsnwdiagparser) | const | public | #### `nwdiagSyntaxPlugin` ```ts const nwdiagSyntaxPlugin; ``` #### `DEFAULT_NWDIAG_PLUGINS` ```ts const DEFAULT_NWDIAG_PLUGINS; ``` #### `createNwdiagParseContext` ```ts function createNwdiagParseContext(); ``` #### `prepareNwdiagLines` ```ts function prepareNwdiagLines(lines); ``` #### `detectNwdiagDiagram` ```ts function detectNwdiagDiagram(text); ``` #### `NwdiagDiagramParser` ```ts class NwdiagDiagramParser extends BaseModuleParser ``` #### `nwdiagDiagramParser` ```ts const nwdiagDiagramParser; ``` --- ## `diagrams/nwdiag/render` _Source: [`src/diagrams/nwdiag/render.mjs`](src/diagrams/nwdiag/render.mjs)_ ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------- | ----- | ---------- | | [`NWDIAG_RENDERERS`](#nwdiag_renderers-diagramsnwdiagrender) | const | public | | [`NwdiagDiagramRenderer`](#nwdiagdiagramrenderer-diagramsnwdiagrender) | class | public | | [`nwdiagDiagramRenderer`](#nwdiagdiagramrenderer-diagramsnwdiagrender) | const | public | #### `NWDIAG_RENDERERS` ```ts const NWDIAG_RENDERERS; ``` #### `NwdiagDiagramRenderer` ```ts class NwdiagDiagramRenderer extends BaseModuleRenderer ``` #### `nwdiagDiagramRenderer` ```ts const nwdiagDiagramRenderer; ``` --- ## `diagrams/nwdiag/security` _Source: [`src/diagrams/nwdiag/security.mjs`](src/diagrams/nwdiag/security.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------ | ----- | ---------- | | [`NwdiagDiagramSecurity`](#nwdiagdiagramsecurity-diagramsnwdiagsecurity) | class | public | | [`nwdiagDiagramSecurity`](#nwdiagdiagramsecurity-diagramsnwdiagsecurity) | const | public | #### `NwdiagDiagramSecurity` ```ts class NwdiagDiagramSecurity extends BaseModuleSecurity ``` #### `nwdiagDiagramSecurity` ```ts const nwdiagDiagramSecurity; ``` --- ## `diagrams/nwdiag/tests` _Source: [`src/diagrams/nwdiag/tests.mjs`](src/diagrams/nwdiag/tests.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------- | ----- | ---------- | | [`NwdiagDiagramTests`](#nwdiagdiagramtests-diagramsnwdiagtests) | class | public | | [`nwdiagDiagramTests`](#nwdiagdiagramtests-diagramsnwdiagtests) | const | public | #### `NwdiagDiagramTests` ```ts class NwdiagDiagramTests extends BaseModuleTests ``` #### `nwdiagDiagramTests` ```ts const nwdiagDiagramTests; ``` --- ## `diagrams/object/assets` _Source: [`src/diagrams/object/assets.mjs`](src/diagrams/object/assets.mjs)_ Object diagram asset contract. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------ | ----- | ---------- | | [`ObjectDiagramAssets`](#objectdiagramassets-diagramsobjectassets) | class | public | | [`objectDiagramAssets`](#objectdiagramassets-diagramsobjectassets) | const | public | #### `ObjectDiagramAssets` ```ts class ObjectDiagramAssets extends BaseModuleAssets ``` #### `objectDiagramAssets` ```ts const objectDiagramAssets; ``` --- ## `diagrams/object/docs` _Source: [`src/diagrams/object/docs.mjs`](src/diagrams/object/docs.mjs)_ Object diagram documentation contract. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`ObjectDiagramDocs`](#objectdiagramdocs-diagramsobjectdocs) | class | public | | [`objectDiagramDocs`](#objectdiagramdocs-diagramsobjectdocs) | const | public | #### `ObjectDiagramDocs` ```ts class ObjectDiagramDocs extends BaseModuleDocs ``` #### `objectDiagramDocs` ```ts const objectDiagramDocs; ``` --- ## `diagrams/object/docs/coverage_examples` _Source: [`src/diagrams/object/docs/coverage_examples.mjs`](src/diagrams/object/docs/coverage_examples.mjs)_ Object-diagram coverage examples owned by the object module. ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------------------------- | ----- | ---------- | | [`OBJECT_COMPONENT_EXAMPLES`](#object_component_examples-diagramsobjectdocscoverage_examples) | const | public | #### `OBJECT_COMPONENT_EXAMPLES` ```ts const OBJECT_COMPONENT_EXAMPLES; ``` --- ## `diagrams/object/layout` _Source: [`src/diagrams/object/layout.mjs`](src/diagrams/object/layout.mjs)_ Object diagram layout adapter. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------ | ----- | ---------- | | [`layoutObjectDiagram`](#layoutobjectdiagram-diagramsobjectlayout) | const | public | | [`ObjectDiagramLayout`](#objectdiagramlayout-diagramsobjectlayout) | class | public | | [`objectDiagramLayout`](#objectdiagramlayout-diagramsobjectlayout) | const | public | #### `layoutObjectDiagram` ```ts const layoutObjectDiagram; ``` #### `ObjectDiagramLayout` ```ts class ObjectDiagramLayout extends BaseModuleLayout ``` #### `objectDiagramLayout` ```ts const objectDiagramLayout; ``` --- ## `diagrams/object/module` _Source: [`src/diagrams/object/module.mjs`](src/diagrams/object/module.mjs)_ Built-in object diagram module. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------ | ----- | ---------- | | [`ObjectDiagramModule`](#objectdiagrammodule-diagramsobjectmodule) | class | public | | [`objectDiagramModule`](#objectdiagrammodule-diagramsobjectmodule) | const | public | #### `ObjectDiagramModule` ```ts class ObjectDiagramModule extends GraphModuleBase ``` #### `objectDiagramModule` ```ts const objectDiagramModule; ``` --- ## `diagrams/object/parser` _Source: [`src/diagrams/object/parser.mjs`](src/diagrams/object/parser.mjs)_ Object diagram parser contract. ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------------- | -------- | ----------- | | [`DEFAULT_OBJECT_PLUGINS`](#default_object_plugins-diagramsobjectparser) | const | public | | [`createObjectParseContext`](#createobjectparsecontext-diagramsobjectparser) | function | public | | [`prepareObjectLines`](#prepareobjectlines-diagramsobjectparser) | function | public | | [`ObjectDiagramParser`](#objectdiagramparser-diagramsobjectparser) | class | public | | [`objectDiagramParser`](#objectdiagramparser-diagramsobjectparser) | const | public | | [`detectObjectDiagram`](#detectobjectdiagram-diagramsobjectparser) | function | unspecified | #### `DEFAULT_OBJECT_PLUGINS` ```ts const DEFAULT_OBJECT_PLUGINS; ``` #### `createObjectParseContext` ```ts function createObjectParseContext(); ``` #### `prepareObjectLines` ```ts function prepareObjectLines(lines); ``` **Parameters** | Name | Type | Description | | ------- | ---------- | ------------------- | | `lines` | `string[]` | Raw PlantUML lines. | **Returns:** `string[]` — Lines prepared for object-diagram parsing. #### `ObjectDiagramParser` ```ts class ObjectDiagramParser extends BaseModuleParser ``` #### `objectDiagramParser` ```ts const objectDiagramParser; ``` #### `detectObjectDiagram` ```ts function detectObjectDiagram(text); ``` **Parameters** | Name | Type | Description | | ------ | -------- | -------------------- | | `text` | `string` | Raw PlantUML source. | **Returns:** `boolean` --- ## `diagrams/object/plugins/syntax` _Source: [`src/diagrams/object/plugins/syntax.mjs`](src/diagrams/object/plugins/syntax.mjs)_ Object-diagram specific syntax plugins. ### Exports | Name | Kind | Visibility | | ----------------------------------------------------------------------------------- | ----- | ----------- | | [`objectDeclarationPlugin`](#objectdeclarationplugin-diagramsobjectpluginssyntax) | const | unspecified | | [`mapDeclarationPlugin`](#mapdeclarationplugin-diagramsobjectpluginssyntax) | const | unspecified | | [`jsonDeclarationPlugin`](#jsondeclarationplugin-diagramsobjectpluginssyntax) | const | unspecified | | [`objectFieldPlugin`](#objectfieldplugin-diagramsobjectpluginssyntax) | const | unspecified | | [`diamondDeclarationPlugin`](#diamonddeclarationplugin-diagramsobjectpluginssyntax) | const | unspecified | #### `objectDeclarationPlugin` ```ts const objectDeclarationPlugin; ``` #### `mapDeclarationPlugin` ```ts const mapDeclarationPlugin; ``` #### `jsonDeclarationPlugin` ```ts const jsonDeclarationPlugin; ``` #### `objectFieldPlugin` ```ts const objectFieldPlugin; ``` #### `diamondDeclarationPlugin` ```ts const diamondDeclarationPlugin; ``` ### Type definitions #### `ParsedDeclaration` ```ts {id:string,title:string,stereotype:string} ``` --- ## `diagrams/object/render` _Source: [`src/diagrams/object/render.mjs`](src/diagrams/object/render.mjs)_ Object diagram renderer adapters. ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------- | ----- | ---------- | | [`OBJECT_RENDERERS`](#object_renderers-diagramsobjectrender) | const | public | | [`ObjectDiagramRenderer`](#objectdiagramrenderer-diagramsobjectrender) | class | public | | [`objectDiagramRenderer`](#objectdiagramrenderer-diagramsobjectrender) | const | public | #### `OBJECT_RENDERERS` ```ts const OBJECT_RENDERERS; ``` #### `ObjectDiagramRenderer` ```ts class ObjectDiagramRenderer extends BaseModuleRenderer ``` #### `objectDiagramRenderer` ```ts const objectDiagramRenderer; ``` --- ## `diagrams/object/security` _Source: [`src/diagrams/object/security.mjs`](src/diagrams/object/security.mjs)_ Object diagram security contract. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------ | ----- | ---------- | | [`ObjectDiagramSecurity`](#objectdiagramsecurity-diagramsobjectsecurity) | class | public | | [`objectDiagramSecurity`](#objectdiagramsecurity-diagramsobjectsecurity) | const | public | #### `ObjectDiagramSecurity` ```ts class ObjectDiagramSecurity extends BaseModuleSecurity ``` #### `objectDiagramSecurity` ```ts const objectDiagramSecurity; ``` --- ## `diagrams/object/tests` _Source: [`src/diagrams/object/tests.mjs`](src/diagrams/object/tests.mjs)_ Object diagram test contract. ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------- | ----- | ---------- | | [`ObjectDiagramTests`](#objectdiagramtests-diagramsobjecttests) | class | public | | [`objectDiagramTests`](#objectdiagramtests-diagramsobjecttests) | const | public | #### `ObjectDiagramTests` ```ts class ObjectDiagramTests extends BaseModuleTests ``` #### `objectDiagramTests` ```ts const objectDiagramTests; ``` --- ## `diagrams/object/tests/output` _Source: [`src/diagrams/object/tests/output.mjs`](src/diagrams/object/tests/output.mjs)_ ### Exports | Name | Kind | Visibility | | ----------------------------------------------------------------------------- | ---------------- | ----------- | | [`OBJECT_TEST_OUTPUT_DIR`](#object_test_output_dir-diagramsobjecttestsoutput) | const | unspecified | | [`writeObjectOutput`](#writeobjectoutput-diagramsobjecttestsoutput) | function (async) | unspecified | #### `OBJECT_TEST_OUTPUT_DIR` ```ts const OBJECT_TEST_OUTPUT_DIR; ``` #### `writeObjectOutput` ```ts async function writeObjectOutput(filename, content); ``` Write a file to the object test output directory. **Parameters** | Name | Type | Description | | ---------- | -------- | ----------- | | `filename` | `string` | — | | `content` | `string` | — | **Returns:** `Promise` --- ## `diagrams/regex/assets` _Source: [`src/diagrams/regex/assets.mjs`](src/diagrams/regex/assets.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------- | ----- | ---------- | | [`RegexDiagramAssets`](#regexdiagramassets-diagramsregexassets) | class | public | | [`regexDiagramAssets`](#regexdiagramassets-diagramsregexassets) | const | public | #### `RegexDiagramAssets` ```ts class RegexDiagramAssets extends BaseModuleAssets ``` #### `regexDiagramAssets` ```ts const regexDiagramAssets; ``` --- ## `diagrams/regex/docs` _Source: [`src/diagrams/regex/docs.mjs`](src/diagrams/regex/docs.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------- | ----- | ---------- | | [`RegexDiagramDocs`](#regexdiagramdocs-diagramsregexdocs) | class | public | | [`regexDiagramDocs`](#regexdiagramdocs-diagramsregexdocs) | const | public | #### `RegexDiagramDocs` ```ts class RegexDiagramDocs extends BaseModuleDocs ``` #### `regexDiagramDocs` ```ts const regexDiagramDocs; ``` --- ## `diagrams/regex/docs/coverage_examples` _Source: [`src/diagrams/regex/docs/coverage_examples.mjs`](src/diagrams/regex/docs/coverage_examples.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------------ | ----- | ---------- | | [`regexCoverageExamples`](#regexcoverageexamples-diagramsregexdocscoverage_examples) | const | public | #### `regexCoverageExamples` ```ts const regexCoverageExamples; ``` --- ## `diagrams/regex/layout` _Source: [`src/diagrams/regex/layout.mjs`](src/diagrams/regex/layout.mjs)_ Regex diagram layout adapter. ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------- | ----- | ---------- | | [`RegexDiagramLayout`](#regexdiagramlayout-diagramsregexlayout) | class | public | | [`regexDiagramLayout`](#regexdiagramlayout-diagramsregexlayout) | const | public | #### `RegexDiagramLayout` ```ts class RegexDiagramLayout extends BaseModuleLayout ``` #### `regexDiagramLayout` ```ts const regexDiagramLayout; ``` --- ## `diagrams/regex/module` _Source: [`src/diagrams/regex/module.mjs`](src/diagrams/regex/module.mjs)_ Built-in regex diagram module. ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------- | ----- | ---------- | | [`RegexDiagramModule`](#regexdiagrammodule-diagramsregexmodule) | class | public | | [`regexDiagramModule`](#regexdiagrammodule-diagramsregexmodule) | const | public | #### `RegexDiagramModule` ```ts class RegexDiagramModule extends GraphModuleBase ``` #### `regexDiagramModule` ```ts const regexDiagramModule; ``` --- ## `diagrams/regex/parser` _Source: [`src/diagrams/regex/parser.mjs`](src/diagrams/regex/parser.mjs)_ Regex diagram parser contract. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------- | -------- | ---------- | | [`regexSyntaxPlugin`](#regexsyntaxplugin-diagramsregexparser) | const | public | | [`DEFAULT_REGEX_PLUGINS`](#default_regex_plugins-diagramsregexparser) | const | public | | [`detectRegexDiagram`](#detectregexdiagram-diagramsregexparser) | function | public | | [`prepareRegexLines`](#prepareregexlines-diagramsregexparser) | function | public | | [`createRegexParseContext`](#createregexparsecontext-diagramsregexparser) | function | public | | [`RegexDiagramParser`](#regexdiagramparser-diagramsregexparser) | class | public | | [`regexDiagramParser`](#regexdiagramparser-diagramsregexparser) | const | public | #### `regexSyntaxPlugin` ```ts const regexSyntaxPlugin; ``` #### `DEFAULT_REGEX_PLUGINS` ```ts const DEFAULT_REGEX_PLUGINS; ``` #### `detectRegexDiagram` ```ts function detectRegexDiagram(text); ``` #### `prepareRegexLines` ```ts function prepareRegexLines(lines); ``` #### `createRegexParseContext` ```ts function createRegexParseContext(); ``` #### `RegexDiagramParser` ```ts class RegexDiagramParser extends BaseModuleParser ``` #### `regexDiagramParser` ```ts const regexDiagramParser; ``` --- ## `diagrams/regex/render` _Source: [`src/diagrams/regex/render.mjs`](src/diagrams/regex/render.mjs)_ Regex diagram renderer adapters. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------- | ----- | ---------- | | [`REGEX_RENDERERS`](#regex_renderers-diagramsregexrender) | const | public | | [`RegexDiagramRenderer`](#regexdiagramrenderer-diagramsregexrender) | class | public | | [`regexDiagramRenderer`](#regexdiagramrenderer-diagramsregexrender) | const | public | #### `REGEX_RENDERERS` ```ts const REGEX_RENDERERS; ``` #### `RegexDiagramRenderer` ```ts class RegexDiagramRenderer extends BaseModuleRenderer ``` #### `regexDiagramRenderer` ```ts const regexDiagramRenderer; ``` --- ## `diagrams/regex/security` _Source: [`src/diagrams/regex/security.mjs`](src/diagrams/regex/security.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------- | ----- | ---------- | | [`RegexDiagramSecurity`](#regexdiagramsecurity-diagramsregexsecurity) | class | public | | [`regexDiagramSecurity`](#regexdiagramsecurity-diagramsregexsecurity) | const | public | #### `RegexDiagramSecurity` ```ts class RegexDiagramSecurity extends BaseModuleSecurity ``` #### `regexDiagramSecurity` ```ts const regexDiagramSecurity; ``` --- ## `diagrams/regex/tests` _Source: [`src/diagrams/regex/tests.mjs`](src/diagrams/regex/tests.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`RegexDiagramTests`](#regexdiagramtests-diagramsregextests) | class | public | | [`regexDiagramTests`](#regexdiagramtests-diagramsregextests) | const | public | #### `RegexDiagramTests` ```ts class RegexDiagramTests extends BaseModuleTests ``` #### `regexDiagramTests` ```ts const regexDiagramTests; ``` --- ## `diagrams/salt/assets` _Source: [`src/diagrams/salt/assets.mjs`](src/diagrams/salt/assets.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`SaltDiagramAssets`](#saltdiagramassets-diagramssaltassets) | class | public | | [`saltDiagramAssets`](#saltdiagramassets-diagramssaltassets) | const | public | #### `SaltDiagramAssets` ```ts class SaltDiagramAssets extends BaseModuleAssets ``` #### `saltDiagramAssets` ```ts const saltDiagramAssets; ``` --- ## `diagrams/salt/docs` _Source: [`src/diagrams/salt/docs.mjs`](src/diagrams/salt/docs.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------ | ----- | ---------- | | [`SaltDiagramDocs`](#saltdiagramdocs-diagramssaltdocs) | class | public | | [`saltDiagramDocs`](#saltdiagramdocs-diagramssaltdocs) | const | public | #### `SaltDiagramDocs` ```ts class SaltDiagramDocs extends BaseModuleDocs ``` #### `saltDiagramDocs` ```ts const saltDiagramDocs; ``` --- ## `diagrams/salt/docs/coverage_examples` _Source: [`src/diagrams/salt/docs/coverage_examples.mjs`](src/diagrams/salt/docs/coverage_examples.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------------- | ----- | ---------- | | [`saltCoverageExamples`](#saltcoverageexamples-diagramssaltdocscoverage_examples) | const | public | #### `saltCoverageExamples` ```ts const saltCoverageExamples; ``` --- ## `diagrams/salt/layout` _Source: [`src/diagrams/salt/layout.mjs`](src/diagrams/salt/layout.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`SaltDiagramLayout`](#saltdiagramlayout-diagramssaltlayout) | class | public | | [`saltDiagramLayout`](#saltdiagramlayout-diagramssaltlayout) | const | public | #### `SaltDiagramLayout` ```ts class SaltDiagramLayout extends BaseModuleLayout ``` #### `saltDiagramLayout` ```ts const saltDiagramLayout; ``` --- ## `diagrams/salt/module` _Source: [`src/diagrams/salt/module.mjs`](src/diagrams/salt/module.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`SaltDiagramModule`](#saltdiagrammodule-diagramssaltmodule) | class | public | | [`saltDiagramModule`](#saltdiagrammodule-diagramssaltmodule) | const | public | #### `SaltDiagramModule` ```ts class SaltDiagramModule extends GraphModuleBase ``` #### `saltDiagramModule` ```ts const saltDiagramModule; ``` --- ## `diagrams/salt/parser` _Source: [`src/diagrams/salt/parser.mjs`](src/diagrams/salt/parser.mjs)_ ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------- | -------- | ---------- | | [`saltSyntaxPlugin`](#saltsyntaxplugin-diagramssaltparser) | const | public | | [`DEFAULT_SALT_PLUGINS`](#default_salt_plugins-diagramssaltparser) | const | public | | [`createSaltParseContext`](#createsaltparsecontext-diagramssaltparser) | function | public | | [`prepareSaltLines`](#preparesaltlines-diagramssaltparser) | function | public | | [`detectSaltDiagram`](#detectsaltdiagram-diagramssaltparser) | function | public | | [`SaltDiagramParser`](#saltdiagramparser-diagramssaltparser) | class | public | | [`saltDiagramParser`](#saltdiagramparser-diagramssaltparser) | const | public | #### `saltSyntaxPlugin` ```ts const saltSyntaxPlugin; ``` #### `DEFAULT_SALT_PLUGINS` ```ts const DEFAULT_SALT_PLUGINS; ``` #### `createSaltParseContext` ```ts function createSaltParseContext(); ``` #### `prepareSaltLines` ```ts function prepareSaltLines(lines); ``` #### `detectSaltDiagram` ```ts function detectSaltDiagram(text); ``` #### `SaltDiagramParser` ```ts class SaltDiagramParser extends BaseModuleParser ``` #### `saltDiagramParser` ```ts const saltDiagramParser; ``` --- ## `diagrams/salt/render` _Source: [`src/diagrams/salt/render.mjs`](src/diagrams/salt/render.mjs)_ ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------- | ----- | ---------- | | [`SALT_RENDERERS`](#salt_renderers-diagramssaltrender) | const | public | | [`SaltDiagramRenderer`](#saltdiagramrenderer-diagramssaltrender) | class | public | | [`saltDiagramRenderer`](#saltdiagramrenderer-diagramssaltrender) | const | public | #### `SALT_RENDERERS` ```ts const SALT_RENDERERS; ``` #### `SaltDiagramRenderer` ```ts class SaltDiagramRenderer extends BaseModuleRenderer ``` #### `saltDiagramRenderer` ```ts const saltDiagramRenderer; ``` --- ## `diagrams/salt/security` _Source: [`src/diagrams/salt/security.mjs`](src/diagrams/salt/security.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------ | ----- | ---------- | | [`SaltDiagramSecurity`](#saltdiagramsecurity-diagramssaltsecurity) | class | public | | [`saltDiagramSecurity`](#saltdiagramsecurity-diagramssaltsecurity) | const | public | #### `SaltDiagramSecurity` ```ts class SaltDiagramSecurity extends BaseModuleSecurity ``` #### `saltDiagramSecurity` ```ts const saltDiagramSecurity; ``` --- ## `diagrams/salt/tests` _Source: [`src/diagrams/salt/tests.mjs`](src/diagrams/salt/tests.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------- | ----- | ---------- | | [`SaltDiagramTests`](#saltdiagramtests-diagramssalttests) | class | public | | [`saltDiagramTests`](#saltdiagramtests-diagramssalttests) | const | public | #### `SaltDiagramTests` ```ts class SaltDiagramTests extends BaseModuleTests ``` #### `saltDiagramTests` ```ts const saltDiagramTests; ``` --- ## `diagrams/sequence/assets` _Source: [`src/diagrams/sequence/assets.mjs`](src/diagrams/sequence/assets.mjs)_ Sequence diagram asset contract. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------ | ----- | ---------- | | [`SequenceDiagramAssets`](#sequencediagramassets-diagramssequenceassets) | class | public | | [`sequenceDiagramAssets`](#sequencediagramassets-diagramssequenceassets) | const | public | #### `SequenceDiagramAssets` ```ts class SequenceDiagramAssets extends BaseModuleAssets ``` #### `sequenceDiagramAssets` ```ts const sequenceDiagramAssets; ``` --- ## `diagrams/sequence/context` _Source: [`src/diagrams/sequence/context.mjs`](src/diagrams/sequence/context.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------- | -------- | ---------- | | [`createSequenceContext`](#createsequencecontext-diagramssequencecontext) | function | public | #### `createSequenceContext` ```ts function createSequenceContext(); ``` Construct the mutable parsing context shared by all sequence-diagram plugins during a single `parsePlantUml` invocation. **Returns:** `{ readonly result: import("../../general/model/diagram.mjs").SequenceDiagram, diagram: import("../../general/model/diagram.mjs").SequenceDiagram, setTitle(t: string): void, setCaption(t: string): void, setHeader(t: string): void, setFooter(t: string): void, setLegend(t: string): void, setMainframe(t: string): void, ensureParticipant(id: string): import("../../general/model/diagram.mjs").Participant, declareParticipant(spec: object): import("../../general/model/diagram.mjs").Participant, nextMessageId(): string, nextNoteId(): string, nextFragmentId(): string, nextActivationId(): string, nextMarkerId(): string, nextReferenceId(): string, nextParticipantGroupId(): string, currentSeq(): number, lastSeq(): number, addMessage(spec: object): import("../../general/model/diagram.mjs").Message, addNote(spec: object): void, addMarker(kind: string, label?: string, size?: number): void, addReference(spec: object): void, startFragment(kind: string, label?: string, secondaryLabel?: string, color?: string): void, splitFragmentOperand(label?: string): boolean, endFragment(): boolean, startActivation(participant: import("../../general/model/diagram.mjs").Participant, color?: string, seq?: number, caller?: import("../../general/model/diagram.mjs").Participant|null): void, endActivation(participant: import("../../general/model/diagram.mjs").Participant, seq?: number): boolean, addReturnMessage(label?: string): boolean, markCreated(participant: import("../../general/model/diagram.mjs").Participant, seq?: number): void, markDestroyed(participant: import("../../general/model/diagram.mjs").Participant, seq?: number): void, setAutonumber(enabled: boolean, start?: number, step?: number, format?: string): void, setAutoactivate(enabled: boolean): void, applyAutoactivation(message: import("../../general/model/diagram.mjs").Message, lifecycle?: string): void, setSequenceStyle(key: keyof import("../../general/model/diagram.mjs").SequenceDiagram["style"], value: string): void, setFootboxVisible(visible: boolean): void, setHideUnlinked(visible: boolean): void, startParticipantGroup(label?: string, color?: string): void, endParticipantGroup(): boolean, }` --- ## `diagrams/sequence/docs` _Source: [`src/diagrams/sequence/docs.mjs`](src/diagrams/sequence/docs.mjs)_ Sequence diagram documentation contract. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------ | ----- | ---------- | | [`SequenceDiagramDocs`](#sequencediagramdocs-diagramssequencedocs) | class | public | | [`sequenceDiagramDocs`](#sequencediagramdocs-diagramssequencedocs) | const | public | #### `SequenceDiagramDocs` ```ts class SequenceDiagramDocs extends BaseModuleDocs ``` #### `sequenceDiagramDocs` ```ts const sequenceDiagramDocs; ``` --- ## `diagrams/sequence/docs/coverage_examples` _Source: [`src/diagrams/sequence/docs/coverage_examples.mjs`](src/diagrams/sequence/docs/coverage_examples.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------------------------------- | ----- | ----------- | | [`SEQUENCE_COMPONENT_EXAMPLES`](#sequence_component_examples-diagramssequencedocscoverage_examples) | const | unspecified | | [`SEQUENCE_SUPPORT_MATRIX`](#sequence_support_matrix-diagramssequencedocscoverage_examples) | const | unspecified | #### `SEQUENCE_COMPONENT_EXAMPLES` ```ts const SEQUENCE_COMPONENT_EXAMPLES; ``` Renderable PlantUML examples for the sequence-diagram feature coverage page. #### `SEQUENCE_SUPPORT_MATRIX` ```ts const SEQUENCE_SUPPORT_MATRIX; ``` --- ## `diagrams/sequence/layout` _Source: [`src/diagrams/sequence/layout.mjs`](src/diagrams/sequence/layout.mjs)_ Sequence diagram layout adapter. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------ | ---------------- | ----------- | | [`layoutSequenceDiagram`](#layoutsequencediagram-diagramssequencelayout) | function (async) | unspecified | | [`SequenceDiagramLayout`](#sequencediagramlayout-diagramssequencelayout) | class | public | | [`sequenceDiagramLayout`](#sequencediagramlayout-diagramssequencelayout) | const | public | #### `layoutSequenceDiagram` ```ts async function layoutSequenceDiagram(model); ``` **Parameters** | Name | Type | Description | | ------- | -------- | --------------- | | `model` | `object` | Sequence model. | **Returns:** `Promise` #### `SequenceDiagramLayout` ```ts class SequenceDiagramLayout extends BaseModuleLayout ``` #### `sequenceDiagramLayout` ```ts const sequenceDiagramLayout; ``` --- ## `diagrams/sequence/layout_engine` _Source: [`src/diagrams/sequence/layout_engine.mjs`](src/diagrams/sequence/layout_engine.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------- | -------- | ---------- | | [`layoutSequenceDiagram`](#layoutsequencediagram-diagramssequencelayout_engine) | function | public | #### `layoutSequenceDiagram` ```ts function layoutSequenceDiagram(diagram); ``` Lay out a SequenceDiagram (see `src/general/model/diagram.mjs`) on a tabular grid: lifelines along x, time along y. Mutates the model in-place — every participant, message and note receives final `x`/`y` coordinates. **Parameters** | Name | Type | Description | | --------- | ----------------------------------------------------------- | ----------- | | `diagram` | `import("../../general/model/diagram.mjs").SequenceDiagram` | — | --- ## `diagrams/sequence/module` _Source: [`src/diagrams/sequence/module.mjs`](src/diagrams/sequence/module.mjs)_ Built-in sequence diagram module. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------ | ----- | ---------- | | [`SequenceDiagramModule`](#sequencediagrammodule-diagramssequencemodule) | class | public | | [`sequenceDiagramModule`](#sequencediagrammodule-diagramssequencemodule) | const | public | #### `SequenceDiagramModule` ```ts class SequenceDiagramModule extends TimelineModuleBase ``` #### `sequenceDiagramModule` ```ts const sequenceDiagramModule; ``` --- ## `diagrams/sequence/parser` _Source: [`src/diagrams/sequence/parser.mjs`](src/diagrams/sequence/parser.mjs)_ Sequence diagram parser contract. ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------------------- | -------- | ----------- | | [`DEFAULT_SEQUENCE_PLUGINS`](#default_sequence_plugins-diagramssequenceparser) | const | public | | [`createSequenceParseContext`](#createsequenceparsecontext-diagramssequenceparser) | const | public | | [`SequenceDiagramParser`](#sequencediagramparser-diagramssequenceparser) | class | public | | [`sequenceDiagramParser`](#sequencediagramparser-diagramssequenceparser) | const | public | | [`detectSequenceDiagram`](#detectsequencediagram-diagramssequenceparser) | function | unspecified | #### `DEFAULT_SEQUENCE_PLUGINS` ```ts const DEFAULT_SEQUENCE_PLUGINS; ``` #### `createSequenceParseContext` ```ts const createSequenceParseContext; ``` #### `SequenceDiagramParser` ```ts class SequenceDiagramParser extends BaseModuleParser ``` #### `sequenceDiagramParser` ```ts const sequenceDiagramParser; ``` #### `detectSequenceDiagram` ```ts function detectSequenceDiagram(text); ``` **Parameters** | Name | Type | Description | | ------ | -------- | -------------------- | | `text` | `string` | Raw PlantUML source. | **Returns:** `boolean` --- ## `diagrams/sequence/plugins/advanced` _Source: [`src/diagrams/sequence/plugins/advanced.mjs`](src/diagrams/sequence/plugins/advanced.mjs)_ ### Exports | Name | Kind | Visibility | | ----------------------------------------------------------------------------------- | ----- | ----------- | | [`sequenceAdvancedPlugin`](#sequenceadvancedplugin-diagramssequencepluginsadvanced) | const | unspecified | #### `sequenceAdvancedPlugin` ```ts const sequenceAdvancedPlugin; ``` Miscellaneous PlantUML sequence constructs. --- ## `diagrams/sequence/plugins/fragments` _Source: [`src/diagrams/sequence/plugins/fragments.mjs`](src/diagrams/sequence/plugins/fragments.mjs)_ ### Exports | Name | Kind | Visibility | | -------------------------------------------------------------------- | ----- | ----------- | | [`fragmentPlugin`](#fragmentplugin-diagramssequencepluginsfragments) | const | unspecified | #### `fragmentPlugin` ```ts const fragmentPlugin; ``` Combined fragment lines for sequence diagrams. --- ## `diagrams/sequence/plugins/messages` _Source: [`src/diagrams/sequence/plugins/messages.mjs`](src/diagrams/sequence/plugins/messages.mjs)_ ### Exports | Name | Kind | Visibility | | ----------------------------------------------------------------- | ----- | ----------- | | [`messagePlugin`](#messageplugin-diagramssequencepluginsmessages) | const | unspecified | #### `messagePlugin` ```ts const messagePlugin; ``` --- ## `diagrams/sequence/plugins/notes` _Source: [`src/diagrams/sequence/plugins/notes.mjs`](src/diagrams/sequence/plugins/notes.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------ | ----- | ----------- | | [`noteSidePlugin`](#notesideplugin-diagramssequencepluginsnotes) | const | unspecified | | [`noteOverPlugin`](#noteoverplugin-diagramssequencepluginsnotes) | const | unspecified | | [`noteAcrossPlugin`](#noteacrossplugin-diagramssequencepluginsnotes) | const | unspecified | | [`noteSideBlockPlugin`](#notesideblockplugin-diagramssequencepluginsnotes) | const | unspecified | | [`noteOverBlockPlugin`](#noteoverblockplugin-diagramssequencepluginsnotes) | const | unspecified | | [`noteAcrossBlockPlugin`](#noteacrossblockplugin-diagramssequencepluginsnotes) | const | unspecified | #### `noteSidePlugin` ```ts const noteSidePlugin; ``` Single-line side note: `note left|right [of ] : text`. #### `noteOverPlugin` ```ts const noteOverPlugin; ``` Single-line `note over A[, B] : text`. #### `noteAcrossPlugin` ```ts const noteAcrossPlugin; ``` Single-line `note across : text`. #### `noteSideBlockPlugin` ```ts const noteSideBlockPlugin; ``` Multi-line side-note block. #### `noteOverBlockPlugin` ```ts const noteOverBlockPlugin; ``` Multi-line `note over` block. #### `noteAcrossBlockPlugin` ```ts const noteAcrossBlockPlugin; ``` Multi-line `note across` block. --- ## `diagrams/sequence/plugins/participants` _Source: [`src/diagrams/sequence/plugins/participants.mjs`](src/diagrams/sequence/plugins/participants.mjs)_ ### Exports | Name | Kind | Visibility | | ----------------------------------------------------------------------------- | ----- | ----------- | | [`participantPlugin`](#participantplugin-diagramssequencepluginsparticipants) | const | unspecified | #### `participantPlugin` ```ts const participantPlugin; ``` Sequence-diagram participant declaration. --- ## `diagrams/sequence/plugins/preamble` _Source: [`src/diagrams/sequence/plugins/preamble.mjs`](src/diagrams/sequence/plugins/preamble.mjs)_ ### Exports | Name | Kind | Visibility | | ----------------------------------------------------------------------- | ----- | ----------- | | [`titlePlugin`](#titleplugin-diagramssequencepluginspreamble) | const | unspecified | | [`skinparamPlugin`](#skinparamplugin-diagramssequencepluginspreamble) | const | unspecified | | [`styleBlockPlugin`](#styleblockplugin-diagramssequencepluginspreamble) | const | unspecified | #### `titlePlugin` ```ts const titlePlugin; ``` `title …` line for sequence diagrams. #### `skinparamPlugin` ```ts const skinparamPlugin; ``` Small, deterministic subset of sequence skinparams that maps directly onto renderer style fields. Other skinparams are consumed tolerantly. #### `styleBlockPlugin` ```ts const styleBlockPlugin; ``` CSS-like PlantUML `` blocks are consumed without applying them until the renderer has a complete safe style mapping. --- ## `diagrams/sequence/render` _Source: [`src/diagrams/sequence/render.mjs`](src/diagrams/sequence/render.mjs)_ Sequence diagram renderer adapters. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------ | -------- | ----------- | | [`renderSequenceExcalidraw`](#rendersequenceexcalidraw-diagramssequencerender) | function | unspecified | | [`SEQUENCE_RENDERERS`](#sequence_renderers-diagramssequencerender) | const | public | | [`SequenceDiagramRenderer`](#sequencediagramrenderer-diagramssequencerender) | class | public | | [`sequenceDiagramRenderer`](#sequencediagramrenderer-diagramssequencerender) | const | public | #### `renderSequenceExcalidraw` ```ts function renderSequenceExcalidraw(model, opts); ``` **Parameters** | Name | Type | Description | | ------- | -------- | --------------- | | `model` | `object` | Sequence model. | | `opts` | `object` | Render options. | **Returns:** `object` #### `SEQUENCE_RENDERERS` ```ts const SEQUENCE_RENDERERS; ``` #### `SequenceDiagramRenderer` ```ts class SequenceDiagramRenderer extends BaseModuleRenderer ``` #### `sequenceDiagramRenderer` ```ts const sequenceDiagramRenderer; ``` --- ## `diagrams/sequence/render_excalidraw` _Source: [`src/diagrams/sequence/render_excalidraw.mjs`](src/diagrams/sequence/render_excalidraw.mjs)_ ### Exports | Name | Kind | Visibility | | ----------------------------------------------------------------------------------- | -------- | ----------- | | [`exportSequenceDiagram`](#exportsequencediagram-diagramssequencerender_excalidraw) | function | unspecified | #### `exportSequenceDiagram` ```ts function exportSequenceDiagram(diagram, { sourceLabel, primitives }); ``` Render a SequenceDiagram into an Excalidraw JSON document. **Parameters** | Name | Type | Description | | --------- | ----------------------------------------------------------- | ----------------- | | `diagram` | `import("../../general/model/diagram.mjs").SequenceDiagram` | Sequence diagram. | | `ctx` | `object` | Render context. | **Returns:** `object` — Excalidraw JSON document. --- ## `diagrams/sequence/security` _Source: [`src/diagrams/sequence/security.mjs`](src/diagrams/sequence/security.mjs)_ Sequence diagram security contract. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------ | ----- | ---------- | | [`SequenceDiagramSecurity`](#sequencediagramsecurity-diagramssequencesecurity) | class | public | | [`sequenceDiagramSecurity`](#sequencediagramsecurity-diagramssequencesecurity) | const | public | #### `SequenceDiagramSecurity` ```ts class SequenceDiagramSecurity extends BaseModuleSecurity ``` #### `sequenceDiagramSecurity` ```ts const sequenceDiagramSecurity; ``` --- ## `diagrams/sequence/spacing` _Source: [`src/diagrams/sequence/spacing.mjs`](src/diagrams/sequence/spacing.mjs)_ ### Exports | Name | Kind | Visibility | | ----------------------------------------------------------------------------- | -------- | ----------- | | [`SEQUENCE_ARROWHEAD_SIZE`](#sequence_arrowhead_size-diagramssequencespacing) | const | unspecified | | [`SEQUENCE_SPACING`](#sequence_spacing-diagramssequencespacing) | const | public | | [`timelineItemGap`](#timelineitemgap-diagramssequencespacing) | function | public | | [`arrowLabelBudget`](#arrowlabelbudget-diagramssequencespacing) | function | public | #### `SEQUENCE_ARROWHEAD_SIZE` ```ts const SEQUENCE_ARROWHEAD_SIZE; ``` Default visual size reserved for rendered arrowheads in px. #### `SEQUENCE_SPACING` ```ts const SEQUENCE_SPACING; ``` Central spacing values for sequence diagrams. #### `timelineItemGap` ```ts function timelineItemGap(); ``` Symmetric vertical gap before and after every visible timeline item. **Returns:** `number` — Timeline item gap in px. #### `arrowLabelBudget` ```ts function arrowLabelBudget(arrowLength, start, end); ``` Horizontal label budget after arrowheads have claimed their visual tips. **Parameters** | Name | Type | Description | | ------------- | ---------------------------- | ---------------------------- | ---------- | --------------- | | `arrowLength` | `number` | Absolute arrow length in px. | | `start` | `{size?:number,head?:string} | null | undefined` | Start endpoint. | | `end` | `{size?:number,head?:string} | null | undefined` | End endpoint. | **Returns:** `number` — Safe label width in px. --- ## `diagrams/sequence/tests` _Source: [`src/diagrams/sequence/tests.mjs`](src/diagrams/sequence/tests.mjs)_ Sequence diagram test contract. ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------- | ----- | ---------- | | [`SequenceDiagramTests`](#sequencediagramtests-diagramssequencetests) | class | public | | [`sequenceDiagramTests`](#sequencediagramtests-diagramssequencetests) | const | public | #### `SequenceDiagramTests` ```ts class SequenceDiagramTests extends BaseModuleTests ``` #### `sequenceDiagramTests` ```ts const sequenceDiagramTests; ``` --- ## `diagrams/sequence/tests/output` _Source: [`src/diagrams/sequence/tests/output.mjs`](src/diagrams/sequence/tests/output.mjs)_ ### Exports | Name | Kind | Visibility | | ----------------------------------------------------------------------------------- | -------- | ----------- | | [`SEQUENCE_TEST_OUTPUT_DIR`](#sequence_test_output_dir-diagramssequencetestsoutput) | const | unspecified | | [`writeSequenceOutput`](#writesequenceoutput-diagramssequencetestsoutput) | function | unspecified | #### `SEQUENCE_TEST_OUTPUT_DIR` ```ts const SEQUENCE_TEST_OUTPUT_DIR; ``` Absolute path to the Sequence module's generated test-review artefacts. #### `writeSequenceOutput` ```ts function writeSequenceOutput(filename, content); ``` Write a Sequence-module test artefact to `src/diagrams/sequence/tests/output/`. **Parameters** | Name | Type | Description | | ---------- | -------- | ------------------------------------------------------------- | ----------- | ----------------- | | `filename` | `string` | File name or relative path below the module output directory. | | `content` | `string | Buffer | Uint8Array` | Content to write. | --- ## `diagrams/shared/common_plugins/title` _Source: [`src/diagrams/shared/common_plugins/title.mjs`](src/diagrams/shared/common_plugins/title.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------- | -------- | ---------- | | [`createTitlePlugin`](#createtitleplugin-diagramssharedcommon_pluginstitle) | function | public | #### `createTitlePlugin` ```ts function createTitlePlugin(name); ``` Create a `title ...` parser plugin for any diagram context that exposes `setTitle(title)`. **Parameters** | Name | Type | Description | | ------ | -------- | ------------------- | | `name` | `string` | Stable plugin name. | **Returns:** `import("../../../util/parser_engine.mjs").Plugin` — Title parser plugin. --- ## `diagrams/shared/data_runtime` _Source: [`src/diagrams/shared/data_runtime.mjs`](src/diagrams/shared/data_runtime.mjs)_ Shared parser/runtime helpers for PlantUML JSON/YAML data diagrams. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------ | -------- | ----------- | | [`dataRenderers`](#datarenderers-diagramsshareddata_runtime) | const | public | | [`layoutDataDiagram`](#layoutdatadiagram-diagramsshareddata_runtime) | const | public | | [`detectDataDiagram`](#detectdatadiagram-diagramsshareddata_runtime) | function | unspecified | | [`prepareDataLines`](#preparedatalines-diagramsshareddata_runtime) | function | unspecified | | [`createDataParseContext`](#createdataparsecontext-diagramsshareddata_runtime) | function | unspecified | | [`collectDataLine`](#collectdataline-diagramsshareddata_runtime) | function | unspecified | | [`finalizeDataDiagram`](#finalizedatadiagram-diagramsshareddata_runtime) | function | unspecified | | [`parseYaml`](#parseyaml-diagramsshareddata_runtime) | function | unspecified | #### `dataRenderers` ```ts const dataRenderers; ``` #### `layoutDataDiagram` ```ts const layoutDataDiagram; ``` #### `detectDataDiagram` ```ts function detectDataDiagram(text, startDirective, endDirective); ``` #### `prepareDataLines` ```ts function prepareDataLines(lines, startDirective, endDirective); ``` #### `createDataParseContext` ```ts function createDataParseContext(kind); ``` #### `collectDataLine` ```ts function collectDataLine(ctx, line); ``` #### `finalizeDataDiagram` ```ts function finalizeDataDiagram(ctx, kind); ``` #### `parseYaml` ```ts function parseYaml(lines); ``` --- ## `diagrams/shared/er_runtime` _Source: [`src/diagrams/shared/er_runtime.mjs`](src/diagrams/shared/er_runtime.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------ | -------- | ----------- | | [`erRenderers`](#errenderers-diagramsshareder_runtime) | const | public | | [`erDiagramRenderer`](#erdiagramrenderer-diagramsshareder_runtime) | const | public | | [`layoutErDiagram`](#layouterdiagram-diagramsshareder_runtime) | const | public | | [`createErParseContext`](#createerparsecontext-diagramsshareder_runtime) | function | unspecified | | [`parseErName`](#parseername-diagramsshareder_runtime) | function | unspecified | | [`addErBox`](#adderbox-diagramsshareder_runtime) | function | unspecified | | [`addErMember`](#addermember-diagramsshareder_runtime) | function | unspecified | | [`parseErEndpoint`](#parseerendpoint-diagramsshareder_runtime) | function | unspecified | | [`queueErConnection`](#queueerconnection-diagramsshareder_runtime) | function | unspecified | #### `erRenderers` ```ts const erRenderers; ``` #### `erDiagramRenderer` ```ts const erDiagramRenderer; ``` #### `layoutErDiagram` ```ts const layoutErDiagram; ``` #### `createErParseContext` ```ts function createErParseContext(kind); ``` **Parameters** | Name | Type | Description | | ------ | -------- | ------------- | | `kind` | `string` | Diagram kind. | **Returns:** `Record` #### `parseErName` ```ts function parseErName(raw); ``` **Parameters** | Name | Type | Description | | ----- | -------- | ------------------------------ | | `raw` | `string` | Raw PlantUML declaration tail. | **Returns:** `{id:string,title:string}` #### `addErBox` ```ts function addErBox(ctx, raw, shape, stereotype); ``` **Parameters** | Name | Type | Description | | ------------ | --------------------- | ------------------ | | `ctx` | `Record` | Parser context. | | `raw` | `string` | Name or alias. | | `shape` | `string` | Model shape. | | `stereotype` | `string` | Stereotype marker. | **Returns:** `import("../../general/model/diagram.mjs").Box` #### `addErMember` ```ts function addErMember(box, raw); ``` **Parameters** | Name | Type | Description | | ----- | ----------------------------------------------- | ---------------- | | `box` | `import("../../general/model/diagram.mjs").Box` | Target box. | | `raw` | `string` | Raw member line. | #### `parseErEndpoint` ```ts function parseErEndpoint(raw); ``` **Parameters** | Name | Type | Description | | ----- | -------- | ------------------- | | `raw` | `string` | Raw endpoint token. | **Returns:** `string` #### `queueErConnection` ```ts function queueErConnection(ctx, spec); ``` **Parameters** | Name | Type | Description | | ------ | --------------------- | ------------------------- | | `ctx` | `Record` | Parser context. | | `spec` | `object` | Connection specification. | --- ## `diagrams/shared/graph_context` _Source: [`src/diagrams/shared/graph_context.mjs`](src/diagrams/shared/graph_context.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------- | -------- | ---------- | | [`createComponentContext`](#createcomponentcontext-diagramssharedgraph_context) | function | public | #### `createComponentContext` ```ts function createComponentContext(); ``` Construct the mutable parsing context that component plugins share during a single `parsePlantUml` invocation. The returned object exposes high-level helpers (`addBox`, `openContainer`, …) so that plugins never touch the model classes directly. **Returns:** `{ readonly result: import("../../general/model/diagram.mjs").Diagram, diagram: import("../../general/model/diagram.mjs").Diagram, boxes: Map, setTitle(t: string): void, openContainer(spec: { id: string, title: string, kind: string }): void, closeContainer(): void, addBox(spec: object): import("../../general/model/diagram.mjs").Box, queueConnection(spec: object): void, queueBoxLink(spec: object): void, queueNote(spec: object): void, queueLinkNote(spec: object): void, setGraphStyle(key: keyof import("../../general/model/diagram.mjs").Diagram["style"], value: string): void, addPort(spec: object): void, removeBox(id: string): void, queueFilter(spec: object): void, setAutoVivifyConnections(enabled: boolean, shape?: string): void, nextNoteId(): string, finalize(): void, }` --- ## `diagrams/shared/graph_parser` _Source: [`src/diagrams/shared/graph_parser.mjs`](src/diagrams/shared/graph_parser.mjs)_ Shared parser building blocks for graph-like PlantUML diagram modules. ### Exports | Name | Kind | Visibility | | -------------------------------------------------------------------------------- | ----- | ---------- | | [`DEFAULT_GRAPH_PLUGINS`](#default_graph_plugins-diagramssharedgraph_parser) | const | public | | [`createGraphParseContext`](#creategraphparsecontext-diagramssharedgraph_parser) | const | public | #### `DEFAULT_GRAPH_PLUGINS` ```ts const DEFAULT_GRAPH_PLUGINS; ``` #### `createGraphParseContext` ```ts const createGraphParseContext; ``` --- ## `diagrams/shared/graph_plugins/association_class` _Source: [`src/diagrams/shared/graph_plugins/association_class.mjs`](src/diagrams/shared/graph_plugins/association_class.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------------------------ | ----- | ----------- | | [`associationClassPlugin`](#associationclassplugin-diagramssharedgraph_pluginsassociation_class) | const | unspecified | #### `associationClassPlugin` ```ts const associationClassPlugin; ``` Parse PlantUML association-class declarations. The model has no edge-to-edge attachment yet, so the association class is represented as a class box connected to both association endpoints with dashed metadata edges. --- ## `diagrams/shared/graph_plugins/class_block` _Source: [`src/diagrams/shared/graph_plugins/class_block.mjs`](src/diagrams/shared/graph_plugins/class_block.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------ | -------- | ----------- | | [`parseClassHeader`](#parseclassheader-diagramssharedgraph_pluginsclass_block) | function | unspecified | | [`classBlockPlugin`](#classblockplugin-diagramssharedgraph_pluginsclass_block) | const | unspecified | #### `parseClassHeader` ```ts function parseClassHeader(line); ``` Parse a class-diagram header line. Returns `null` when the line does not start with `class | interface | enum` (optionally preceded by an `abstract` modifier). Designed to be lenient about ordering of the `<>`, `extends` and `implements` clauses since PlantUML itself accepts them in either order. **Parameters** | Name | Type | Description | | ------ | -------- | ----------- | | `line` | `string` | — | **Returns:** `ClassHeader|null` #### `classBlockPlugin` ```ts const classBlockPlugin; ``` Class-diagram block plugin. Runs before the generic keyword-shape plugin so class-family declarations with `[extends|implements] [{ … }]` are routed here, while everything else (`component`, `database`, …) keeps flowing through {@link shapeKeywordPlugin}. ### Type definitions #### `ClassHeader` ```ts { shape: "class"|"interface"|"enum"|"annotation"|"record"|"protocol"|"struct"|"exception"|"metaclass"|"stereotype"|"dataclass"|"circle"|"entity", isAbstract: boolean, name: string, alias: string|null, generics: string, stereotype: string, extendsList: string[], implementsList: string[], description: string, opensBrace: boolean, } ``` shape: "class"|"interface"|"enum"|"annotation"|"record"|"protocol"|"struct"|"exception"|"metaclass"|"stereotype"|"dataclass"|"circle"|"entity", isAbstract: boolean, name: string, alias: string|null, generics: string, stereotype: string, extendsList: string[], implementsList: string[], description: string, opensBrace: boolean, }} ClassHeader --- ## `diagrams/shared/graph_plugins/connections` _Source: [`src/diagrams/shared/graph_plugins/connections.mjs`](src/diagrams/shared/graph_plugins/connections.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------ | ----- | ----------- | | [`connectionPlugin`](#connectionplugin-diagramssharedgraph_pluginsconnections) | const | unspecified | #### `connectionPlugin` ```ts const connectionPlugin; ``` Generic component-style connection: `A op B [: label]`. All arrow flavours are decoded by `classifyArrow()` — extend that to support a new operator. --- ## `diagrams/shared/graph_plugins/containers` _Source: [`src/diagrams/shared/graph_plugins/containers.mjs`](src/diagrams/shared/graph_plugins/containers.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------- | ----- | ----------- | | [`containerPlugin`](#containerplugin-diagramssharedgraph_pluginscontainers) | const | unspecified | #### `containerPlugin` ```ts const containerPlugin; ``` Container keywords (`package`, `frame`, …) plus `together`. Always opens a brace; the matching `}` is consumed by `closeBracePlugin`. --- ## `diagrams/shared/graph_plugins/filters` _Source: [`src/diagrams/shared/graph_plugins/filters.mjs`](src/diagrams/shared/graph_plugins/filters.mjs)_ ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------------- | ----- | ----------- | | [`graphFilterPlugin`](#graphfilterplugin-diagramssharedgraph_pluginsfilters) | const | unspecified | #### `graphFilterPlugin` ```ts const graphFilterPlugin; ``` PlantUML graph visibility commands. `remove ` affects the parsed model; `hide/show ...` forms are consumed so strict parsing stays compatible while rendering support can grow per command over time. --- ## `diagrams/shared/graph_plugins/notes` _Source: [`src/diagrams/shared/graph_plugins/notes.mjs`](src/diagrams/shared/graph_plugins/notes.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------ | ----- | ----------- | | [`noteOfPlugin`](#noteofplugin-diagramssharedgraph_pluginsnotes) | const | unspecified | | [`noteFreePlugin`](#notefreeplugin-diagramssharedgraph_pluginsnotes) | const | unspecified | | [`noteBlockPlugin`](#noteblockplugin-diagramssharedgraph_pluginsnotes) | const | unspecified | | [`noteOnLinkPlugin`](#noteonlinkplugin-diagramssharedgraph_pluginsnotes) | const | unspecified | #### `noteOfPlugin` ```ts const noteOfPlugin; ``` Single-line note: `note of : text`. #### `noteFreePlugin` ```ts const noteFreePlugin; ``` Free-floating note declared as a stand-alone box: `note "text" as Nx`. #### `noteBlockPlugin` ```ts const noteBlockPlugin; ``` Multi-line note block, terminated by `end note`. #### `noteOnLinkPlugin` ```ts const noteOnLinkPlugin; ``` Attach a note to the most recently parsed connection. --- ## `diagrams/shared/graph_plugins/ports` _Source: [`src/diagrams/shared/graph_plugins/ports.mjs`](src/diagrams/shared/graph_plugins/ports.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ----------- | | [`portPlugin`](#portplugin-diagramssharedgraph_pluginsports) | const | unspecified | #### `portPlugin` ```ts const portPlugin; ``` Component `port`, `portin` and `portout` declarations. The declaration must name the owning component with `Component::port`, matching the endpoint form accepted by the connection parser. --- ## `diagrams/shared/graph_plugins/preamble` _Source: [`src/diagrams/shared/graph_plugins/preamble.mjs`](src/diagrams/shared/graph_plugins/preamble.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------- | ----- | ----------- | | [`titlePlugin`](#titleplugin-diagramssharedgraph_pluginspreamble) | const | unspecified | | [`closeBracePlugin`](#closebraceplugin-diagramssharedgraph_pluginspreamble) | const | unspecified | | [`skinparamPlugin`](#skinparamplugin-diagramssharedgraph_pluginspreamble) | const | unspecified | | [`styleBlockPlugin`](#styleblockplugin-diagramssharedgraph_pluginspreamble) | const | unspecified | | [`directionPlugin`](#directionplugin-diagramssharedgraph_pluginspreamble) | const | unspecified | | [`urlOfPlugin`](#urlofplugin-diagramssharedgraph_pluginspreamble) | const | unspecified | | [`presentationPlugin`](#presentationplugin-diagramssharedgraph_pluginspreamble) | const | unspecified | #### `titlePlugin` ```ts const titlePlugin; ``` `title …` line. #### `closeBracePlugin` ```ts const closeBracePlugin; ``` Closing `}` for any open container. #### `skinparamPlugin` ```ts const skinparamPlugin; ``` Apply a safe subset of PlantUML graph skinparams. Unknown keys are consumed tolerantly so strict parsing remains compatible with broader PlantUML files. #### `styleBlockPlugin` ```ts const styleBlockPlugin; ``` CSS-like PlantUML `` blocks are parsed only for a safe colour subset that maps directly onto renderer style fields. #### `directionPlugin` ```ts const directionPlugin; ``` Shared graph direction hints such as `left to right direction`. #### `urlOfPlugin` ```ts const urlOfPlugin; ``` PlantUML URL directives attach link metadata to an already declared or later-declared graph element, for example `url of Dog is [[https://...]]`. #### `presentationPlugin` ```ts const presentationPlugin; ``` Shared graph presentation commands that are currently stored as metadata or tolerated for strict parsing. --- ## `diagrams/shared/graph_plugins/shapes` _Source: [`src/diagrams/shared/graph_plugins/shapes.mjs`](src/diagrams/shared/graph_plugins/shapes.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------- | ----- | ----------- | | [`bracketBoxPlugin`](#bracketboxplugin-diagramssharedgraph_pluginsshapes) | const | unspecified | | [`usecaseParensPlugin`](#usecaseparensplugin-diagramssharedgraph_pluginsshapes) | const | unspecified | | [`shapeKeywordPlugin`](#shapekeywordplugin-diagramssharedgraph_pluginsshapes) | const | unspecified | #### `bracketBoxPlugin` ```ts const bracketBoxPlugin; ``` Bracket shorthand: `[Label] [as alias] [: description]`. #### `usecaseParensPlugin` ```ts const usecaseParensPlugin; ``` Use-case parens shorthand: `(Label) [as alias]`. #### `shapeKeywordPlugin` ```ts const shapeKeywordPlugin; ``` Keyword-prefixed shape (`component`, `actor`, `database`, …) plus the special-cased `class X { … }` member block. --- ## `diagrams/shared/graph_runtime` _Source: [`src/diagrams/shared/graph_runtime.mjs`](src/diagrams/shared/graph_runtime.mjs)_ Shared runtime adapters for graph-like diagram modules. ### Exports | Name | Kind | Visibility | | ----------------------------------------------------------------------------- | ---------------- | ----------- | | [`layoutGraphModel`](#layoutgraphmodel-diagramssharedgraph_runtime) | function (async) | unspecified | | [`renderGraphExcalidraw`](#rendergraphexcalidraw-diagramssharedgraph_runtime) | function | unspecified | | [`GRAPH_RENDERERS`](#graph_renderers-diagramssharedgraph_runtime) | const | public | #### `layoutGraphModel` ```ts async function layoutGraphModel(model); ``` **Parameters** | Name | Type | Description | | ------- | -------- | -------------- | | `model` | `object` | Diagram model. | **Returns:** `Promise` #### `renderGraphExcalidraw` ```ts function renderGraphExcalidraw(model, opts); ``` **Parameters** | Name | Type | Description | | ------- | -------- | --------------- | | `model` | `object` | Diagram model. | | `opts` | `object` | Render options. | **Returns:** `object` #### `GRAPH_RENDERERS` ```ts const GRAPH_RENDERERS; ``` --- ## `diagrams/shared/planning_runtime` _Source: [`src/diagrams/shared/planning_runtime.mjs`](src/diagrams/shared/planning_runtime.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------------------ | -------- | ----------- | | [`planningRenderers`](#planningrenderers-diagramssharedplanning_runtime) | const | public | | [`layoutPlanningDiagram`](#layoutplanningdiagram-diagramssharedplanning_runtime) | const | public | | [`createPlanningParseContext`](#createplanningparsecontext-diagramssharedplanning_runtime) | function | unspecified | | [`addPlanningItem`](#addplanningitem-diagramssharedplanning_runtime) | function | unspecified | | [`addPlanningDependency`](#addplanningdependency-diagramssharedplanning_runtime) | function | unspecified | | [`preparePlanningLines`](#prepareplanninglines-diagramssharedplanning_runtime) | function | unspecified | #### `planningRenderers` ```ts const planningRenderers; ``` #### `layoutPlanningDiagram` ```ts const layoutPlanningDiagram; ``` #### `createPlanningParseContext` ```ts function createPlanningParseContext(kind, title); ``` #### `addPlanningItem` ```ts function addPlanningItem(ctx, rawTitle, spec = {}); ``` #### `addPlanningDependency` ```ts function addPlanningDependency(ctx, fromTitle, toTitle, label = ""); ``` #### `preparePlanningLines` ```ts function preparePlanningLines(lines, directives); ``` ### Type definitions #### `PlanningItemSpec` ```ts object; ``` --- ## `diagrams/shared/railroad_runtime` _Source: [`src/diagrams/shared/railroad_runtime.mjs`](src/diagrams/shared/railroad_runtime.mjs)_ Shared parser/runtime helpers for railroad-like grammar diagrams. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------------------ | -------- | ----------- | | [`railroadRenderers`](#railroadrenderers-diagramssharedrailroad_runtime) | const | public | | [`layoutRailroadDiagram`](#layoutrailroaddiagram-diagramssharedrailroad_runtime) | const | public | | [`detectRailroadDiagram`](#detectrailroaddiagram-diagramssharedrailroad_runtime) | function | unspecified | | [`prepareRailroadLines`](#preparerailroadlines-diagramssharedrailroad_runtime) | function | unspecified | | [`createRailroadParseContext`](#createrailroadparsecontext-diagramssharedrailroad_runtime) | function | unspecified | | [`collectRailroadLine`](#collectrailroadline-diagramssharedrailroad_runtime) | function | unspecified | | [`finalizeRailroadDiagram`](#finalizerailroaddiagram-diagramssharedrailroad_runtime) | function | unspecified | | [`parseRegexBody`](#parseregexbody-diagramssharedrailroad_runtime) | function | unspecified | | [`parseEbnfBody`](#parseebnfbody-diagramssharedrailroad_runtime) | function | unspecified | #### `railroadRenderers` ```ts const railroadRenderers; ``` #### `layoutRailroadDiagram` ```ts const layoutRailroadDiagram; ``` #### `detectRailroadDiagram` ```ts function detectRailroadDiagram(text, startDirective, endDirective); ``` **Parameters** | Name | Type | Description | | ---------------- | -------- | ---------------- | | `text` | `string` | Source text. | | `startDirective` | `string` | Start directive. | | `endDirective` | `string` | End directive. | **Returns:** `boolean` #### `prepareRailroadLines` ```ts function prepareRailroadLines(lines, startDirective, endDirective); ``` **Parameters** | Name | Type | Description | | ---------------- | ---------- | ----------------- | | `lines` | `string[]` | Raw source lines. | | `startDirective` | `string` | Start directive. | | `endDirective` | `string` | End directive. | **Returns:** `string[]` #### `createRailroadParseContext` ```ts function createRailroadParseContext(kind); ``` **Parameters** | Name | Type | Description | | ------ | -------- | ----------- | ------------- | | `kind` | `"regex" | "ebnf"` | Diagram kind. | **Returns:** `Record` #### `collectRailroadLine` ```ts function collectRailroadLine(ctx, line); ``` **Parameters** | Name | Type | Description | | ------ | --------------------- | -------------- | | `ctx` | `Record` | Parse context. | | `line` | `string` | Source line. | **Returns:** `boolean` #### `finalizeRailroadDiagram` ```ts function finalizeRailroadDiagram(ctx, kind); ``` **Parameters** | Name | Type | Description | | ------ | --------------------- | -------------- | ------------- | | `ctx` | `Record` | Parse context. | | `kind` | `"regex" | "ebnf"` | Diagram kind. | **Returns:** `Diagram` #### `parseRegexBody` ```ts function parseRegexBody(lines); ``` **Parameters** | Name | Type | Description | | ------- | ---------- | ------------------ | | `lines` | `string[]` | Regex source body. | **Returns:** `Array<{name:string, tokens:Array<{label:string,type:string}>}>` #### `parseEbnfBody` ```ts function parseEbnfBody(lines); ``` **Parameters** | Name | Type | Description | | ------- | ---------- | ----------------- | | `lines` | `string[]` | EBNF source body. | **Returns:** `Array<{name:string, tokens:Array<{label:string,type:string}>}>` --- ## `diagrams/shared/special_runtime` _Source: [`src/diagrams/shared/special_runtime.mjs`](src/diagrams/shared/special_runtime.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------------------- | -------- | ----------- | | [`specialRenderers`](#specialrenderers-diagramssharedspecial_runtime) | const | public | | [`layoutSpecialDiagram`](#layoutspecialdiagram-diagramssharedspecial_runtime) | const | public | | [`createSpecialParseContext`](#createspecialparsecontext-diagramssharedspecial_runtime) | function | unspecified | | [`addSpecialBox`](#addspecialbox-diagramssharedspecial_runtime) | function | unspecified | | [`finalizeDitaa`](#finalizeditaa-diagramssharedspecial_runtime) | function | unspecified | | [`finalizeChart`](#finalizechart-diagramssharedspecial_runtime) | function | unspecified | #### `specialRenderers` ```ts const specialRenderers; ``` #### `layoutSpecialDiagram` ```ts const layoutSpecialDiagram; ``` #### `createSpecialParseContext` ```ts function createSpecialParseContext(kind, title); ``` #### `addSpecialBox` ```ts function addSpecialBox(ctx, id, title, members, stereotype = ""); ``` #### `finalizeDitaa` ```ts function finalizeDitaa(ctx); ``` #### `finalizeChart` ```ts function finalizeChart(ctx); ``` --- ## `diagrams/shared/tree_runtime` _Source: [`src/diagrams/shared/tree_runtime.mjs`](src/diagrams/shared/tree_runtime.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------ | -------- | ----------- | | [`treeRenderers`](#treerenderers-diagramssharedtree_runtime) | const | public | | [`layoutTreeDiagram`](#layouttreediagram-diagramssharedtree_runtime) | const | public | | [`createTreeParseContext`](#createtreeparsecontext-diagramssharedtree_runtime) | function | unspecified | | [`addTreeNode`](#addtreenode-diagramssharedtree_runtime) | function | unspecified | | [`addFilePath`](#addfilepath-diagramssharedtree_runtime) | function | unspecified | | [`prepareTreeLines`](#preparetreelines-diagramssharedtree_runtime) | function | unspecified | | [`parseHierarchyLine`](#parsehierarchyline-diagramssharedtree_runtime) | function | unspecified | #### `treeRenderers` ```ts const treeRenderers; ``` #### `layoutTreeDiagram` ```ts const layoutTreeDiagram; ``` #### `createTreeParseContext` ```ts function createTreeParseContext(kind, title); ``` #### `addTreeNode` ```ts function addTreeNode(ctx, level, label, shape = "rectangle", stereotype = ""); ``` #### `addFilePath` ```ts function addFilePath(ctx, rawPath); ``` #### `prepareTreeLines` ```ts function prepareTreeLines(lines, directives); ``` #### `parseHierarchyLine` ```ts function parseHierarchyLine(line); ``` --- ## `diagrams/state/assets` _Source: [`src/diagrams/state/assets.mjs`](src/diagrams/state/assets.mjs)_ State diagram asset manifest. ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------- | ----- | ---------- | | [`StateDiagramAssets`](#statediagramassets-diagramsstateassets) | class | public | | [`stateDiagramAssets`](#statediagramassets-diagramsstateassets) | const | public | #### `StateDiagramAssets` ```ts class StateDiagramAssets extends BaseModuleAssets ``` #### `stateDiagramAssets` ```ts const stateDiagramAssets; ``` --- ## `diagrams/state/docs` _Source: [`src/diagrams/state/docs.mjs`](src/diagrams/state/docs.mjs)_ State diagram documentation manifest. ### Exports | Name | Kind | Visibility | | --------------------------------------------------------- | ----- | ---------- | | [`StateDiagramDocs`](#statediagramdocs-diagramsstatedocs) | class | public | | [`stateDiagramDocs`](#statediagramdocs-diagramsstatedocs) | const | public | #### `StateDiagramDocs` ```ts class StateDiagramDocs extends BaseModuleDocs ``` #### `stateDiagramDocs` ```ts const stateDiagramDocs; ``` --- ## `diagrams/state/docs/coverage_examples` _Source: [`src/diagrams/state/docs/coverage_examples.mjs`](src/diagrams/state/docs/coverage_examples.mjs)_ State-diagram coverage examples owned by the state module. ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------------------------- | ----- | ---------- | | [`STATE_COVERAGE_EXAMPLES`](#state_coverage_examples-diagramsstatedocscoverage_examples) | const | public | #### `STATE_COVERAGE_EXAMPLES` ```ts const STATE_COVERAGE_EXAMPLES; ``` --- ## `diagrams/state/layout` _Source: [`src/diagrams/state/layout.mjs`](src/diagrams/state/layout.mjs)_ State diagram layout contract. ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------- | ---------------- | ---------- | | [`layoutStateDiagram`](#layoutstatediagram-diagramsstatelayout) | function (async) | public | | [`StateDiagramLayout`](#statediagramlayout-diagramsstatelayout) | class | public | | [`stateDiagramLayout`](#statediagramlayout-diagramsstatelayout) | const | public | #### `layoutStateDiagram` ```ts async function layoutStateDiagram(model, _context); ``` **Parameters** | Name | Type | Description | | ---------- | -------- | ----------- | | `model` | `object` | — | | `_context` | `object` | — | **Returns:** `Promise` #### `StateDiagramLayout` ```ts class StateDiagramLayout extends BaseModuleLayout ``` #### `stateDiagramLayout` ```ts const stateDiagramLayout; ``` --- ## `diagrams/state/module` _Source: [`src/diagrams/state/module.mjs`](src/diagrams/state/module.mjs)_ Built-in state diagram module. ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------- | ----- | ---------- | | [`StateDiagramModule`](#statediagrammodule-diagramsstatemodule) | class | public | | [`stateDiagramModule`](#statediagrammodule-diagramsstatemodule) | const | public | #### `StateDiagramModule` ```ts class StateDiagramModule extends GraphModuleBase ``` #### `stateDiagramModule` ```ts const stateDiagramModule; ``` --- ## `diagrams/state/parser` _Source: [`src/diagrams/state/parser.mjs`](src/diagrams/state/parser.mjs)_ State diagram parser contract. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------- | -------- | ----------- | | [`DEFAULT_STATE_PLUGINS`](#default_state_plugins-diagramsstateparser) | const | public | | [`createStateParseContext`](#createstateparsecontext-diagramsstateparser) | function | public | | [`prepareStateLines`](#preparestatelines-diagramsstateparser) | function | public | | [`StateDiagramParser`](#statediagramparser-diagramsstateparser) | class | public | | [`stateDiagramParser`](#statediagramparser-diagramsstateparser) | const | public | | [`detectStateDiagram`](#detectstatediagram-diagramsstateparser) | function | unspecified | #### `DEFAULT_STATE_PLUGINS` ```ts const DEFAULT_STATE_PLUGINS; ``` #### `createStateParseContext` ```ts function createStateParseContext(); ``` #### `prepareStateLines` ```ts function prepareStateLines(lines); ``` **Parameters** | Name | Type | Description | | ------- | ---------- | ------------------- | | `lines` | `string[]` | Raw PlantUML lines. | **Returns:** `string[]` — Lines prepared for state-diagram parsing. #### `StateDiagramParser` ```ts class StateDiagramParser extends BaseModuleParser ``` #### `stateDiagramParser` ```ts const stateDiagramParser; ``` #### `detectStateDiagram` ```ts function detectStateDiagram(text); ``` **Parameters** | Name | Type | Description | | ------ | -------- | -------------------- | | `text` | `string` | Raw PlantUML source. | **Returns:** `boolean` --- ## `diagrams/state/plugins/syntax` _Source: [`src/diagrams/state/plugins/syntax.mjs`](src/diagrams/state/plugins/syntax.mjs)_ State-diagram specific syntax plugins. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------------------ | ----- | ---------- | | [`stateDeclarationPlugin`](#statedeclarationplugin-diagramsstatepluginssyntax) | const | public | | [`pseudostateDeclarationPlugin`](#pseudostatedeclarationplugin-diagramsstatepluginssyntax) | const | public | | [`compositeStatePlugin`](#compositestateplugin-diagramsstatepluginssyntax) | const | public | | [`stateDescriptionPlugin`](#statedescriptionplugin-diagramsstatepluginssyntax) | const | public | | [`stateTransitionPlugin`](#statetransitionplugin-diagramsstatepluginssyntax) | const | public | | [`concurrentRegionPlugin`](#concurrentregionplugin-diagramsstatepluginssyntax) | const | public | #### `stateDeclarationPlugin` ```ts const stateDeclarationPlugin; ``` State declaration plugin. Handles: state Name, state "Long Name" as alias, state Name { ... } #### `pseudostateDeclarationPlugin` ```ts const pseudostateDeclarationPlugin; ``` Pseudostate declaration plugin. Handles: [*], [H], [H*] and their shorthand forms #### `compositeStatePlugin` ```ts const compositeStatePlugin; ``` Composite state plugin. Handles nested state blocks and concurrent regions. #### `stateDescriptionPlugin` ```ts const stateDescriptionPlugin; ``` State description plugin. Handles: StateName : description text #### `stateTransitionPlugin` ```ts const stateTransitionPlugin; ``` State transition plugin. Handles state pseudo endpoints such as `[*]`. #### `concurrentRegionPlugin` ```ts const concurrentRegionPlugin; ``` Concurrent region plugin. Handles -- and || separators within composite states. ### Type definitions #### `ParsedState` ```ts {id:string,title:string,kind:string,stereotype:string} ``` --- ## `diagrams/state/render` _Source: [`src/diagrams/state/render.mjs`](src/diagrams/state/render.mjs)_ State diagram renderer contract. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------- | ----- | ---------- | | [`STATE_RENDERERS`](#state_renderers-diagramsstaterender) | const | public | | [`StateDiagramRenderer`](#statediagramrenderer-diagramsstaterender) | class | public | | [`stateDiagramRenderer`](#statediagramrenderer-diagramsstaterender) | const | public | #### `STATE_RENDERERS` ```ts const STATE_RENDERERS; ``` #### `StateDiagramRenderer` ```ts class StateDiagramRenderer extends BaseModuleRenderer ``` #### `stateDiagramRenderer` ```ts const stateDiagramRenderer; ``` --- ## `diagrams/state/security` _Source: [`src/diagrams/state/security.mjs`](src/diagrams/state/security.mjs)_ State diagram security profile. ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------- | ----- | ---------- | | [`StateDiagramSecurity`](#statediagramsecurity-diagramsstatesecurity) | class | public | | [`stateDiagramSecurity`](#statediagramsecurity-diagramsstatesecurity) | const | public | #### `StateDiagramSecurity` ```ts class StateDiagramSecurity extends BaseModuleSecurity ``` #### `stateDiagramSecurity` ```ts const stateDiagramSecurity; ``` --- ## `diagrams/state/tests` _Source: [`src/diagrams/state/tests.mjs`](src/diagrams/state/tests.mjs)_ State diagram test manifest. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`StateDiagramTests`](#statediagramtests-diagramsstatetests) | class | public | | [`stateDiagramTests`](#statediagramtests-diagramsstatetests) | const | public | #### `StateDiagramTests` ```ts class StateDiagramTests extends BaseModuleTests ``` #### `stateDiagramTests` ```ts const stateDiagramTests; ``` --- ## `diagrams/state/tests/output` _Source: [`src/diagrams/state/tests/output.mjs`](src/diagrams/state/tests/output.mjs)_ State diagram test output utilities. ### Exports | Name | Kind | Visibility | | -------------------------------------------------------------------------- | -------- | ---------- | | [`STATE_TEST_OUTPUT_DIR`](#state_test_output_dir-diagramsstatetestsoutput) | const | public | | [`writeStateOutput`](#writestateoutput-diagramsstatetestsoutput) | function | public | #### `STATE_TEST_OUTPUT_DIR` ```ts const STATE_TEST_OUTPUT_DIR; ``` #### `writeStateOutput` ```ts function writeStateOutput(filename, content); ``` **Parameters** | Name | Type | Description | | ---------- | -------- | ----------- | | `filename` | `string` | — | | `content` | `string` | — | --- ## `diagrams/timing/assets` _Source: [`src/diagrams/timing/assets.mjs`](src/diagrams/timing/assets.mjs)_ Timing diagram asset manifest. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------ | ----- | ---------- | | [`TimingDiagramAssets`](#timingdiagramassets-diagramstimingassets) | class | public | | [`timingDiagramAssets`](#timingdiagramassets-diagramstimingassets) | const | public | #### `TimingDiagramAssets` ```ts class TimingDiagramAssets extends BaseModuleAssets ``` #### `timingDiagramAssets` ```ts const timingDiagramAssets; ``` --- ## `diagrams/timing/docs` _Source: [`src/diagrams/timing/docs.mjs`](src/diagrams/timing/docs.mjs)_ Timing diagram documentation manifest. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`TimingDiagramDocs`](#timingdiagramdocs-diagramstimingdocs) | class | public | | [`timingDiagramDocs`](#timingdiagramdocs-diagramstimingdocs) | const | public | #### `TimingDiagramDocs` ```ts class TimingDiagramDocs extends BaseModuleDocs ``` #### `timingDiagramDocs` ```ts const timingDiagramDocs; ``` --- ## `diagrams/timing/docs/coverage_examples` _Source: [`src/diagrams/timing/docs/coverage_examples.mjs`](src/diagrams/timing/docs/coverage_examples.mjs)_ Timing-diagram coverage examples owned by the timing module. ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------------------------- | ----- | ---------- | | [`TIMING_COMPONENT_EXAMPLES`](#timing_component_examples-diagramstimingdocscoverage_examples) | const | public | #### `TIMING_COMPONENT_EXAMPLES` ```ts const TIMING_COMPONENT_EXAMPLES; ``` --- ## `diagrams/timing/layout` _Source: [`src/diagrams/timing/layout.mjs`](src/diagrams/timing/layout.mjs)_ Timing diagram layout contract. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------ | -------- | ----------- | | [`layoutTimingDiagram`](#layouttimingdiagram-diagramstiminglayout) | function | public | | [`timeToX`](#timetox-diagramstiminglayout) | function | unspecified | | [`TimingDiagramLayout`](#timingdiagramlayout-diagramstiminglayout) | class | public | | [`timingDiagramLayout`](#timingdiagramlayout-diagramstiminglayout) | const | public | #### `layoutTimingDiagram` ```ts function layoutTimingDiagram(diagram); ``` Compute deterministic geometry for a timing diagram. **Parameters** | Name | Type | Description | | --------- | --------------------------------------------------------- | ----------- | | `diagram` | `import("../../general/model/diagram.mjs").TimingDiagram` | — | **Returns:** `void` #### `timeToX` ```ts function timeToX(diagram, time); ``` **Parameters** | Name | Type | Description | | --------- | --------------------------------------------------------- | ----------- | | `diagram` | `import("../../general/model/diagram.mjs").TimingDiagram` | — | | `time` | `number` | — | **Returns:** `number` #### `TimingDiagramLayout` ```ts class TimingDiagramLayout extends BaseModuleLayout ``` #### `timingDiagramLayout` ```ts const timingDiagramLayout; ``` --- ## `diagrams/timing/module` _Source: [`src/diagrams/timing/module.mjs`](src/diagrams/timing/module.mjs)_ Built-in timing diagram module. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------ | ----- | ---------- | | [`TimingDiagramModule`](#timingdiagrammodule-diagramstimingmodule) | class | public | | [`timingDiagramModule`](#timingdiagrammodule-diagramstimingmodule) | const | public | #### `TimingDiagramModule` ```ts class TimingDiagramModule extends TimelineModuleBase ``` #### `timingDiagramModule` ```ts const timingDiagramModule; ``` --- ## `diagrams/timing/parser` _Source: [`src/diagrams/timing/parser.mjs`](src/diagrams/timing/parser.mjs)_ Timing diagram parser contract and detection. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------ | ----- | ---------- | | [`DEFAULT_TIMING_PLUGINS`](#default_timing_plugins-diagramstimingparser) | const | public | | [`TimingDiagramParser`](#timingdiagramparser-diagramstimingparser) | class | public | | [`timingDiagramParser`](#timingdiagramparser-diagramstimingparser) | const | public | #### `DEFAULT_TIMING_PLUGINS` ```ts const DEFAULT_TIMING_PLUGINS; ``` #### `TimingDiagramParser` ```ts class TimingDiagramParser extends BaseModuleParser ``` #### `timingDiagramParser` ```ts const timingDiagramParser; ``` --- ## `diagrams/timing/plugins/syntax` _Source: [`src/diagrams/timing/plugins/syntax.mjs`](src/diagrams/timing/plugins/syntax.mjs)_ PlantUML timing-diagram syntax plugin. ### Exports | Name | Kind | Visibility | | ----------------------------------------------------------------------------------- | -------- | ----------- | | [`createTimingParseContext`](#createtimingparsecontext-diagramstimingpluginssyntax) | function | unspecified | | [`prepareTimingLines`](#preparetiminglines-diagramstimingpluginssyntax) | function | unspecified | | [`detectTimingDiagram`](#detecttimingdiagram-diagramstimingpluginssyntax) | function | unspecified | | [`timingSyntaxPlugin`](#timingsyntaxplugin-diagramstimingpluginssyntax) | const | public | #### `createTimingParseContext` ```ts function createTimingParseContext(); ``` #### `prepareTimingLines` ```ts function prepareTimingLines(lines); ``` #### `detectTimingDiagram` ```ts function detectTimingDiagram(source); ``` **Parameters** | Name | Type | Description | | -------- | -------- | ----------- | | `source` | `string` | — | **Returns:** `boolean` #### `timingSyntaxPlugin` ```ts const timingSyntaxPlugin; ``` Timing syntax plugin. --- ## `diagrams/timing/render` _Source: [`src/diagrams/timing/render.mjs`](src/diagrams/timing/render.mjs)_ Timing diagram renderer contract. ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------- | ----- | ---------- | | [`TIMING_RENDERERS`](#timing_renderers-diagramstimingrender) | const | public | | [`TimingDiagramRenderer`](#timingdiagramrenderer-diagramstimingrender) | class | public | | [`timingDiagramRenderer`](#timingdiagramrenderer-diagramstimingrender) | const | public | #### `TIMING_RENDERERS` ```ts const TIMING_RENDERERS; ``` #### `TimingDiagramRenderer` ```ts class TimingDiagramRenderer extends BaseModuleRenderer ``` #### `timingDiagramRenderer` ```ts const timingDiagramRenderer; ``` --- ## `diagrams/timing/render_excalidraw` _Source: [`src/diagrams/timing/render_excalidraw.mjs`](src/diagrams/timing/render_excalidraw.mjs)_ Excalidraw renderer for timing diagrams. ### Exports | Name | Kind | Visibility | | ----------------------------------------------------------------------------- | -------- | ---------- | | [`exportTimingDiagram`](#exporttimingdiagram-diagramstimingrender_excalidraw) | function | public | #### `exportTimingDiagram` ```ts function exportTimingDiagram(diagram, opts = {}); ``` **Parameters** | Name | Type | Description | | ------------------- | --------------------------------------------------------- | ----------- | | `diagram` | `import("../../general/model/diagram.mjs").TimingDiagram` | — | | `opts` _(optional)_ | `object` | — | **Returns:** `object` ### Type definitions #### `Pt` ```ts {x:number,y:number} ``` --- ## `diagrams/timing/security` _Source: [`src/diagrams/timing/security.mjs`](src/diagrams/timing/security.mjs)_ Timing diagram security profile. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------ | ----- | ---------- | | [`TimingDiagramSecurity`](#timingdiagramsecurity-diagramstimingsecurity) | class | public | | [`timingDiagramSecurity`](#timingdiagramsecurity-diagramstimingsecurity) | const | public | #### `TimingDiagramSecurity` ```ts class TimingDiagramSecurity extends BaseModuleSecurity ``` #### `timingDiagramSecurity` ```ts const timingDiagramSecurity; ``` --- ## `diagrams/timing/tests` _Source: [`src/diagrams/timing/tests.mjs`](src/diagrams/timing/tests.mjs)_ Timing diagram test manifest. ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------- | ----- | ---------- | | [`TimingDiagramTests`](#timingdiagramtests-diagramstimingtests) | class | public | | [`timingDiagramTests`](#timingdiagramtests-diagramstimingtests) | const | public | #### `TimingDiagramTests` ```ts class TimingDiagramTests extends BaseModuleTests ``` #### `timingDiagramTests` ```ts const timingDiagramTests; ``` --- ## `diagrams/use-case/assets` _Source: [`src/diagrams/use-case/assets.mjs`](src/diagrams/use-case/assets.mjs)_ Use-case diagram asset manifest. ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------- | ----- | ---------- | | [`UseCaseDiagramAssets`](#usecasediagramassets-diagramsuse-caseassets) | class | public | | [`useCaseDiagramAssets`](#usecasediagramassets-diagramsuse-caseassets) | const | public | #### `UseCaseDiagramAssets` ```ts class UseCaseDiagramAssets extends BaseModuleAssets ``` #### `useCaseDiagramAssets` ```ts const useCaseDiagramAssets; ``` --- ## `diagrams/use-case/docs` _Source: [`src/diagrams/use-case/docs.mjs`](src/diagrams/use-case/docs.mjs)_ Use-case diagram documentation manifest. ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------- | ----- | ---------- | | [`UseCaseDiagramDocs`](#usecasediagramdocs-diagramsuse-casedocs) | class | public | | [`useCaseDiagramDocs`](#usecasediagramdocs-diagramsuse-casedocs) | const | public | #### `UseCaseDiagramDocs` ```ts class UseCaseDiagramDocs extends BaseModuleDocs ``` #### `useCaseDiagramDocs` ```ts const useCaseDiagramDocs; ``` --- ## `diagrams/use-case/layout` _Source: [`src/diagrams/use-case/layout.mjs`](src/diagrams/use-case/layout.mjs)_ Use-case diagram layout contract. ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------- | ----- | ---------- | | [`UseCaseDiagramLayout`](#usecasediagramlayout-diagramsuse-caselayout) | class | public | | [`useCaseDiagramLayout`](#usecasediagramlayout-diagramsuse-caselayout) | const | public | #### `UseCaseDiagramLayout` ```ts class UseCaseDiagramLayout extends BaseModuleLayout ``` #### `useCaseDiagramLayout` ```ts const useCaseDiagramLayout; ``` --- ## `diagrams/use-case/module` _Source: [`src/diagrams/use-case/module.mjs`](src/diagrams/use-case/module.mjs)_ Built-in use-case diagram module. ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------- | ----- | ---------- | | [`UseCaseDiagramModule`](#usecasediagrammodule-diagramsuse-casemodule) | class | public | | [`useCaseDiagramModule`](#usecasediagrammodule-diagramsuse-casemodule) | const | public | #### `UseCaseDiagramModule` ```ts class UseCaseDiagramModule extends GraphModuleBase ``` #### `useCaseDiagramModule` ```ts const useCaseDiagramModule; ``` --- ## `diagrams/use-case/parser` _Source: [`src/diagrams/use-case/parser.mjs`](src/diagrams/use-case/parser.mjs)_ Use-case diagram parser contract. ### Exports | Name | Kind | Visibility | | -------------------------------------------------------------------------------- | -------- | ----------- | | [`detectUseCaseDiagram`](#detectusecasediagram-diagramsuse-caseparser) | function | unspecified | | [`DEFAULT_USE_CASE_PLUGINS`](#default_use_case_plugins-diagramsuse-caseparser) | const | public | | [`createUseCaseParseContext`](#createusecaseparsecontext-diagramsuse-caseparser) | function | unspecified | | [`prepareUseCaseLines`](#prepareusecaselines-diagramsuse-caseparser) | function | unspecified | | [`UseCaseDiagramParser`](#usecasediagramparser-diagramsuse-caseparser) | class | public | | [`useCaseDiagramParser`](#usecasediagramparser-diagramsuse-caseparser) | const | public | #### `detectUseCaseDiagram` ```ts function detectUseCaseDiagram(source); ``` Detects if source is a use-case diagram. **Parameters** | Name | Type | Description | | -------- | -------- | --------------- | | `source` | `string` | PlantUML source | **Returns:** `boolean` #### `DEFAULT_USE_CASE_PLUGINS` ```ts const DEFAULT_USE_CASE_PLUGINS; ``` #### `createUseCaseParseContext` ```ts function createUseCaseParseContext(); ``` Create a parse context for use-case diagrams. **Returns:** `object` #### `prepareUseCaseLines` ```ts function prepareUseCaseLines(lines); ``` Prepare lines for parsing (normalize, strip comments, etc.). **Parameters** | Name | Type | Description | | ------- | ---------- | ----------- | | `lines` | `string[]` | — | **Returns:** `string[]` #### `UseCaseDiagramParser` ```ts class UseCaseDiagramParser extends BaseModuleParser ``` #### `useCaseDiagramParser` ```ts const useCaseDiagramParser; ``` --- ## `diagrams/use-case/plugins/actors` _Source: [`src/diagrams/use-case/plugins/actors.mjs`](src/diagrams/use-case/plugins/actors.mjs)_ Actor plugin for use-case diagrams. ### Exports | Name | Kind | Visibility | | ----------------------------------------------------------- | ----- | ---------- | | [`actorPlugin`](#actorplugin-diagramsuse-casepluginsactors) | const | public | #### `actorPlugin` ```ts const actorPlugin; ``` --- ## `diagrams/use-case/plugins/containers` _Source: [`src/diagrams/use-case/plugins/containers.mjs`](src/diagrams/use-case/plugins/containers.mjs)_ Container plugin for use-case diagrams (packages, rectangles). ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------------- | ----- | ---------- | | [`useCaseContainerPlugin`](#usecasecontainerplugin-diagramsuse-casepluginscontainers) | const | public | #### `useCaseContainerPlugin` ```ts const useCaseContainerPlugin; ``` --- ## `diagrams/use-case/plugins/notes` _Source: [`src/diagrams/use-case/plugins/notes.mjs`](src/diagrams/use-case/plugins/notes.mjs)_ Note plugin for use-case diagrams. ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------- | ----- | ---------- | | [`useCaseNotePlugin`](#usecasenoteplugin-diagramsuse-casepluginsnotes) | const | public | #### `useCaseNotePlugin` ```ts const useCaseNotePlugin; ``` --- ## `diagrams/use-case/plugins/relationships` _Source: [`src/diagrams/use-case/plugins/relationships.mjs`](src/diagrams/use-case/plugins/relationships.mjs)_ Relationship plugin for use-case diagrams. ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------------------------------- | ----- | ---------- | | [`useCaseRelationshipPlugin`](#usecaserelationshipplugin-diagramsuse-casepluginsrelationships) | const | public | #### `useCaseRelationshipPlugin` ```ts const useCaseRelationshipPlugin; ``` --- ## `diagrams/use-case/plugins/usecases` _Source: [`src/diagrams/use-case/plugins/usecases.mjs`](src/diagrams/use-case/plugins/usecases.mjs)_ Usecase plugin for use-case diagrams. ### Exports | Name | Kind | Visibility | | ----------------------------------------------------------------- | ----- | ---------- | | [`usecasePlugin`](#usecaseplugin-diagramsuse-casepluginsusecases) | const | public | #### `usecasePlugin` ```ts const usecasePlugin; ``` --- ## `diagrams/use-case/render` _Source: [`src/diagrams/use-case/render.mjs`](src/diagrams/use-case/render.mjs)_ Use-case diagram renderer contract. ### Exports | Name | Kind | Visibility | | -------------------------------------------------------------------------- | ----- | ---------- | | [`UseCaseDiagramRenderer`](#usecasediagramrenderer-diagramsuse-caserender) | class | public | | [`useCaseDiagramRenderer`](#usecasediagramrenderer-diagramsuse-caserender) | const | public | #### `UseCaseDiagramRenderer` ```ts class UseCaseDiagramRenderer extends BaseModuleRenderer ``` #### `useCaseDiagramRenderer` ```ts const useCaseDiagramRenderer; ``` --- ## `diagrams/use-case/security` _Source: [`src/diagrams/use-case/security.mjs`](src/diagrams/use-case/security.mjs)_ Use-case diagram security profile. ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------------- | ----- | ---------- | | [`UseCaseDiagramSecurity`](#usecasediagramsecurity-diagramsuse-casesecurity) | class | public | | [`useCaseDiagramSecurity`](#usecasediagramsecurity-diagramsuse-casesecurity) | const | public | #### `UseCaseDiagramSecurity` ```ts class UseCaseDiagramSecurity extends BaseModuleSecurity ``` #### `useCaseDiagramSecurity` ```ts const useCaseDiagramSecurity; ``` --- ## `diagrams/use-case/tests` _Source: [`src/diagrams/use-case/tests.mjs`](src/diagrams/use-case/tests.mjs)_ Use-case diagram test manifest. ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------- | ----- | ---------- | | [`UseCaseDiagramTests`](#usecasediagramtests-diagramsuse-casetests) | class | public | | [`useCaseDiagramTests`](#usecasediagramtests-diagramsuse-casetests) | const | public | #### `UseCaseDiagramTests` ```ts class UseCaseDiagramTests extends BaseModuleTests ``` #### `useCaseDiagramTests` ```ts const useCaseDiagramTests; ``` --- ## `diagrams/wbs/assets` _Source: [`src/diagrams/wbs/assets.mjs`](src/diagrams/wbs/assets.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------- | ----- | ---------- | | [`WbsDiagramAssets`](#wbsdiagramassets-diagramswbsassets) | class | public | | [`wbsDiagramAssets`](#wbsdiagramassets-diagramswbsassets) | const | public | #### `WbsDiagramAssets` ```ts class WbsDiagramAssets extends BaseModuleAssets ``` #### `wbsDiagramAssets` ```ts const wbsDiagramAssets; ``` --- ## `diagrams/wbs/docs` _Source: [`src/diagrams/wbs/docs.mjs`](src/diagrams/wbs/docs.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------- | ----- | ---------- | | [`WbsDiagramDocs`](#wbsdiagramdocs-diagramswbsdocs) | class | public | | [`wbsDiagramDocs`](#wbsdiagramdocs-diagramswbsdocs) | const | public | #### `WbsDiagramDocs` ```ts class WbsDiagramDocs extends BaseModuleDocs ``` #### `wbsDiagramDocs` ```ts const wbsDiagramDocs; ``` --- ## `diagrams/wbs/docs/coverage_examples` _Source: [`src/diagrams/wbs/docs/coverage_examples.mjs`](src/diagrams/wbs/docs/coverage_examples.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------ | ----- | ---------- | | [`wbsCoverageExamples`](#wbscoverageexamples-diagramswbsdocscoverage_examples) | const | public | #### `wbsCoverageExamples` ```ts const wbsCoverageExamples; ``` --- ## `diagrams/wbs/layout` _Source: [`src/diagrams/wbs/layout.mjs`](src/diagrams/wbs/layout.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------- | ----- | ---------- | | [`WbsDiagramLayout`](#wbsdiagramlayout-diagramswbslayout) | class | public | | [`wbsDiagramLayout`](#wbsdiagramlayout-diagramswbslayout) | const | public | #### `WbsDiagramLayout` ```ts class WbsDiagramLayout extends BaseModuleLayout ``` #### `wbsDiagramLayout` ```ts const wbsDiagramLayout; ``` --- ## `diagrams/wbs/module` _Source: [`src/diagrams/wbs/module.mjs`](src/diagrams/wbs/module.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------- | ----- | ---------- | | [`WbsDiagramModule`](#wbsdiagrammodule-diagramswbsmodule) | class | public | | [`wbsDiagramModule`](#wbsdiagrammodule-diagramswbsmodule) | const | public | #### `WbsDiagramModule` ```ts class WbsDiagramModule extends TreeModuleBase ``` #### `wbsDiagramModule` ```ts const wbsDiagramModule; ``` --- ## `diagrams/wbs/parser` _Source: [`src/diagrams/wbs/parser.mjs`](src/diagrams/wbs/parser.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------- | ----- | ---------- | | [`wbsSyntaxPlugin`](#wbssyntaxplugin-diagramswbsparser) | const | public | | [`DEFAULT_WBS_PLUGINS`](#default_wbs_plugins-diagramswbsparser) | const | public | | [`createWbsParseContext`](#createwbsparsecontext-diagramswbsparser) | const | public | | [`prepareWbsLines`](#preparewbslines-diagramswbsparser) | const | public | | [`detectWbsDiagram`](#detectwbsdiagram-diagramswbsparser) | const | public | | [`WbsDiagramParser`](#wbsdiagramparser-diagramswbsparser) | class | public | | [`wbsDiagramParser`](#wbsdiagramparser-diagramswbsparser) | const | public | #### `wbsSyntaxPlugin` ```ts const wbsSyntaxPlugin; ``` #### `DEFAULT_WBS_PLUGINS` ```ts const DEFAULT_WBS_PLUGINS; ``` #### `createWbsParseContext` ```ts const createWbsParseContext; ``` #### `prepareWbsLines` ```ts const prepareWbsLines; ``` #### `detectWbsDiagram` ```ts const detectWbsDiagram; ``` #### `WbsDiagramParser` ```ts class WbsDiagramParser extends BaseModuleParser ``` #### `wbsDiagramParser` ```ts const wbsDiagramParser; ``` --- ## `diagrams/wbs/render` _Source: [`src/diagrams/wbs/render.mjs`](src/diagrams/wbs/render.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------- | ----- | ---------- | | [`WBS_RENDERERS`](#wbs_renderers-diagramswbsrender) | const | public | | [`WbsDiagramRenderer`](#wbsdiagramrenderer-diagramswbsrender) | class | public | | [`wbsDiagramRenderer`](#wbsdiagramrenderer-diagramswbsrender) | const | public | #### `WBS_RENDERERS` ```ts const WBS_RENDERERS; ``` #### `WbsDiagramRenderer` ```ts class WbsDiagramRenderer extends BaseModuleRenderer ``` #### `wbsDiagramRenderer` ```ts const wbsDiagramRenderer; ``` --- ## `diagrams/wbs/security` _Source: [`src/diagrams/wbs/security.mjs`](src/diagrams/wbs/security.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------- | ----- | ---------- | | [`WbsDiagramSecurity`](#wbsdiagramsecurity-diagramswbssecurity) | class | public | | [`wbsDiagramSecurity`](#wbsdiagramsecurity-diagramswbssecurity) | const | public | #### `WbsDiagramSecurity` ```ts class WbsDiagramSecurity extends BaseModuleSecurity ``` #### `wbsDiagramSecurity` ```ts const wbsDiagramSecurity; ``` --- ## `diagrams/wbs/tests` _Source: [`src/diagrams/wbs/tests.mjs`](src/diagrams/wbs/tests.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------ | ----- | ---------- | | [`WbsDiagramTests`](#wbsdiagramtests-diagramswbstests) | class | public | | [`wbsDiagramTests`](#wbsdiagramtests-diagramswbstests) | const | public | #### `WbsDiagramTests` ```ts class WbsDiagramTests extends BaseModuleTests ``` #### `wbsDiagramTests` ```ts const wbsDiagramTests; ``` --- ## `diagrams/yaml/assets` _Source: [`src/diagrams/yaml/assets.mjs`](src/diagrams/yaml/assets.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`YamlDiagramAssets`](#yamldiagramassets-diagramsyamlassets) | class | public | | [`yamlDiagramAssets`](#yamldiagramassets-diagramsyamlassets) | const | public | #### `YamlDiagramAssets` ```ts class YamlDiagramAssets extends BaseModuleAssets ``` #### `yamlDiagramAssets` ```ts const yamlDiagramAssets; ``` --- ## `diagrams/yaml/docs` _Source: [`src/diagrams/yaml/docs.mjs`](src/diagrams/yaml/docs.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------ | ----- | ---------- | | [`YamlDiagramDocs`](#yamldiagramdocs-diagramsyamldocs) | class | public | | [`yamlDiagramDocs`](#yamldiagramdocs-diagramsyamldocs) | const | public | #### `YamlDiagramDocs` ```ts class YamlDiagramDocs extends BaseModuleDocs ``` #### `yamlDiagramDocs` ```ts const yamlDiagramDocs; ``` --- ## `diagrams/yaml/docs/coverage_examples` _Source: [`src/diagrams/yaml/docs/coverage_examples.mjs`](src/diagrams/yaml/docs/coverage_examples.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------------- | ----- | ---------- | | [`yamlCoverageExamples`](#yamlcoverageexamples-diagramsyamldocscoverage_examples) | const | public | #### `yamlCoverageExamples` ```ts const yamlCoverageExamples; ``` --- ## `diagrams/yaml/layout` _Source: [`src/diagrams/yaml/layout.mjs`](src/diagrams/yaml/layout.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`YamlDiagramLayout`](#yamldiagramlayout-diagramsyamllayout) | class | public | | [`yamlDiagramLayout`](#yamldiagramlayout-diagramsyamllayout) | const | public | #### `YamlDiagramLayout` ```ts class YamlDiagramLayout extends BaseModuleLayout ``` #### `yamlDiagramLayout` ```ts const yamlDiagramLayout; ``` --- ## `diagrams/yaml/module` _Source: [`src/diagrams/yaml/module.mjs`](src/diagrams/yaml/module.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------ | ----- | ---------- | | [`YamlDiagramModule`](#yamldiagrammodule-diagramsyamlmodule) | class | public | | [`yamlDiagramModule`](#yamldiagrammodule-diagramsyamlmodule) | const | public | #### `YamlDiagramModule` ```ts class YamlDiagramModule extends DataModuleBase ``` #### `yamlDiagramModule` ```ts const yamlDiagramModule; ``` --- ## `diagrams/yaml/parser` _Source: [`src/diagrams/yaml/parser.mjs`](src/diagrams/yaml/parser.mjs)_ ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------- | ----- | ----------- | | [`yamlSyntaxPlugin`](#yamlsyntaxplugin-diagramsyamlparser) | const | public | | [`DEFAULT_YAML_PLUGINS`](#default_yaml_plugins-diagramsyamlparser) | const | public | | [`detectYamlDiagram`](#detectyamldiagram-diagramsyamlparser) | const | public | | [`prepareYamlLines`](#prepareyamllines-diagramsyamlparser) | const | unspecified | | [`createYamlParseContext`](#createyamlparsecontext-diagramsyamlparser) | const | public | | [`YamlDiagramParser`](#yamldiagramparser-diagramsyamlparser) | class | public | | [`yamlDiagramParser`](#yamldiagramparser-diagramsyamlparser) | const | public | #### `yamlSyntaxPlugin` ```ts const yamlSyntaxPlugin; ``` #### `DEFAULT_YAML_PLUGINS` ```ts const DEFAULT_YAML_PLUGINS; ``` #### `detectYamlDiagram` ```ts const detectYamlDiagram; ``` #### `prepareYamlLines` ```ts const prepareYamlLines; ``` #### `createYamlParseContext` ```ts const createYamlParseContext; ``` #### `YamlDiagramParser` ```ts class YamlDiagramParser extends BaseModuleParser ``` #### `yamlDiagramParser` ```ts const yamlDiagramParser; ``` --- ## `diagrams/yaml/render` _Source: [`src/diagrams/yaml/render.mjs`](src/diagrams/yaml/render.mjs)_ ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------- | ----- | ---------- | | [`YAML_RENDERERS`](#yaml_renderers-diagramsyamlrender) | const | public | | [`YamlDiagramRenderer`](#yamldiagramrenderer-diagramsyamlrender) | class | public | | [`yamlDiagramRenderer`](#yamldiagramrenderer-diagramsyamlrender) | const | public | #### `YAML_RENDERERS` ```ts const YAML_RENDERERS; ``` #### `YamlDiagramRenderer` ```ts class YamlDiagramRenderer extends BaseModuleRenderer ``` #### `yamlDiagramRenderer` ```ts const yamlDiagramRenderer; ``` --- ## `diagrams/yaml/security` _Source: [`src/diagrams/yaml/security.mjs`](src/diagrams/yaml/security.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------ | ----- | ---------- | | [`YamlDiagramSecurity`](#yamldiagramsecurity-diagramsyamlsecurity) | class | public | | [`yamlDiagramSecurity`](#yamldiagramsecurity-diagramsyamlsecurity) | const | public | #### `YamlDiagramSecurity` ```ts class YamlDiagramSecurity extends BaseModuleSecurity ``` #### `yamlDiagramSecurity` ```ts const yamlDiagramSecurity; ``` --- ## `diagrams/yaml/tests` _Source: [`src/diagrams/yaml/tests.mjs`](src/diagrams/yaml/tests.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------- | ----- | ---------- | | [`YamlDiagramTests`](#yamldiagramtests-diagramsyamltests) | class | public | | [`yamlDiagramTests`](#yamldiagramtests-diagramsyamltests) | const | public | #### `YamlDiagramTests` ```ts class YamlDiagramTests extends BaseModuleTests ``` #### `yamlDiagramTests` ```ts const yamlDiagramTests; ``` --- ## `general/layout/elk_layout` _Source: [`src/general/layout/elk_layout.mjs`](src/general/layout/elk_layout.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------- | ---------------- | ----------- | | [`layoutDiagram`](#layoutdiagram-generallayoutelk_layout) | function (async) | unspecified | #### `layoutDiagram` ```ts async function layoutDiagram(diagram); ``` Lay out a `Diagram` (or `SequenceDiagram`) in place: assigns absolute `x`/`y` coordinates and edge waypoints to every shape. Component / use-case / deployment diagrams are routed via ELK (`elkjs`, layered algorithm + orthogonal routing). Sequence diagrams use a deterministic tabular layout. **Parameters** | Name | Type | Description | | --------- | --------------------------------------- | ----------------------------------------------- | ---------------------- | | `diagram` | `import("../model/diagram.mjs").Diagram | import("../model/diagram.mjs").SequenceDiagram` | The diagram to mutate. | **Returns:** `Promise` ### Type definitions #### `Pt` ```ts {x:number,y:number} ``` --- ## `general/layout/sizing` _Source: [`src/general/layout/sizing.mjs`](src/general/layout/sizing.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------- | -------- | ---------- | | [`SIZING`](#sizing-generallayoutsizing) | const | public | | [`sizeDiagram`](#sizediagram-generallayoutsizing) | function | public | #### `SIZING` ```ts const SIZING; ``` Default padding / spacing constants used by {@link sizeDiagram}. Exposed so renderers and downstream layout passes can read the same numbers. #### `sizeDiagram` ```ts function sizeDiagram(diagram); ``` First sizing pass. Walks every plane / subplane / box in the diagram and writes width / height onto the model. Must run before the ELK layout pass so positions can be assigned. **Parameters** | Name | Type | Description | | --------- | ---------------------------------------- | ------------------------------------------------ | | `diagram` | `import("../model/diagram.mjs").Diagram` | Diagram model whose elements are sized in place. | **Returns:** `void` — Mutates `diagram` directly; nothing is returned. --- ## `general/model/diagram` _Source: [`src/general/model/diagram.mjs`](src/general/model/diagram.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------- | ----- | ---------- | | [`SIDES`](#sides-generalmodeldiagram) | const | public | | [`SHAPES`](#shapes-generalmodeldiagram) | const | public | | [`ARROW_HEADS`](#arrow_heads-generalmodeldiagram) | const | public | | [`ARROW_ANCHORS`](#arrow_anchors-generalmodeldiagram) | const | public | | [`ARROW_DIRECTIONS`](#arrow_directions-generalmodeldiagram) | const | public | | [`ARROW_LINE_STYLES`](#arrow_line_styles-generalmodeldiagram) | const | public | | [`SEQUENCE_ARROW_HEADS`](#sequence_arrow_heads-generalmodeldiagram) | const | public | | [`SEQUENCE_ARROW_ANCHORS`](#sequence_arrow_anchors-generalmodeldiagram) | const | public | | [`SEQUENCE_ARROW_DIRECTIONS`](#sequence_arrow_directions-generalmodeldiagram) | const | public | | [`SEQUENCE_ARROW_LINE_STYLES`](#sequence_arrow_line_styles-generalmodeldiagram) | const | public | | [`DEFAULT_ARROW_HEAD_SIZE`](#default_arrow_head_size-generalmodeldiagram) | const | public | | [`ArrowEndpoint`](#arrowendpoint-generalmodeldiagram) | class | public | | [`ArrowLine`](#arrowline-generalmodeldiagram) | class | public | | [`ArrowLabel`](#arrowlabel-generalmodeldiagram) | class | public | | [`DiagramArrow`](#diagramarrow-generalmodeldiagram) | class | public | | [`Box`](#box-generalmodeldiagram) | class | public | | [`Subplane`](#subplane-generalmodeldiagram) | class | public | | [`Plane`](#plane-generalmodeldiagram) | class | public | | [`Connection`](#connection-generalmodeldiagram) | class | public | | [`Diagram`](#diagram-generalmodeldiagram) | class | public | | [`Participant`](#participant-generalmodeldiagram) | class | public | | [`SequenceArrowEndpoint`](#sequencearrowendpoint-generalmodeldiagram) | class | public | | [`SequenceArrowLine`](#sequencearrowline-generalmodeldiagram) | class | public | | [`SequenceArrow`](#sequencearrow-generalmodeldiagram) | class | public | | [`Message`](#message-generalmodeldiagram) | class | public | | [`SequenceNote`](#sequencenote-generalmodeldiagram) | class | public | | [`SequenceFragment`](#sequencefragment-generalmodeldiagram) | class | public | | [`SequenceActivation`](#sequenceactivation-generalmodeldiagram) | class | public | | [`SequenceMarker`](#sequencemarker-generalmodeldiagram) | class | public | | [`SequenceReference`](#sequencereference-generalmodeldiagram) | class | public | | [`SequenceParticipantGroup`](#sequenceparticipantgroup-generalmodeldiagram) | class | public | | [`SequenceDiagram`](#sequencediagram-generalmodeldiagram) | class | public | | [`TimingParticipant`](#timingparticipant-generalmodeldiagram) | class | public | | [`TimingEvent`](#timingevent-generalmodeldiagram) | class | public | | [`TimingMessage`](#timingmessage-generalmodeldiagram) | class | public | | [`TimingConstraint`](#timingconstraint-generalmodeldiagram) | class | public | | [`TimingHighlight`](#timinghighlight-generalmodeldiagram) | class | public | | [`TimingNote`](#timingnote-generalmodeldiagram) | class | public | | [`TimingDiagram`](#timingdiagram-generalmodeldiagram) | class | public | #### `SIDES` ```ts const SIDES; ``` Anchor sides for box ports / connection routing. #### `SHAPES` ```ts const SHAPES; ``` Logical box shapes the parser may attach to a {@link Box}. The renderer turns each into the corresponding Excalidraw primitive. #### `ARROW_HEADS` ```ts const ARROW_HEADS; ``` Generic arrow endpoint head kinds. These are model-level semantics; renderers map them to native primitives or generated SVG marker shapes. #### `ARROW_ANCHORS` ```ts const ARROW_ANCHORS; ``` Generic arrow endpoint anchors. Component diagrams use `node`/`port`, sequence diagrams use `participant`, and boundary arrows use diagram/short anchors. #### `ARROW_DIRECTIONS` ```ts const ARROW_DIRECTIONS; ``` Generic arrow direction semantics. #### `ARROW_LINE_STYLES` ```ts const ARROW_LINE_STYLES; ``` Generic arrow line styles. #### `SEQUENCE_ARROW_HEADS` ```ts const SEQUENCE_ARROW_HEADS; ``` Sequence-arrow endpoint head kinds. @public #### `SEQUENCE_ARROW_ANCHORS` ```ts const SEQUENCE_ARROW_ANCHORS; ``` Sequence-arrow endpoint anchors. @public #### `SEQUENCE_ARROW_DIRECTIONS` ```ts const SEQUENCE_ARROW_DIRECTIONS; ``` Sequence-arrow direction semantics. @public #### `SEQUENCE_ARROW_LINE_STYLES` ```ts const SEQUENCE_ARROW_LINE_STYLES; ``` Sequence-arrow line styles. @public #### `DEFAULT_ARROW_HEAD_SIZE` ```ts const DEFAULT_ARROW_HEAD_SIZE; ``` Default visual endpoint glyph size in px. @public #### `ArrowEndpoint` ```ts class ArrowEndpoint ``` One endpoint of a reusable diagram arrow. **Members** ##### `ArrowEndpoint.constructor` ```ts constructor( ({ head = "none", anchor = "node", excalidrawArrowhead = null, label = "", size = DEFAULT_ARROW_HEAD_SIZE, direction = "auto", } = {}), ); ``` | Param | Type | Description | | ------------------- | -------- | ----------- | | `spec` _(optional)_ | `object` | — | #### `ArrowLine` ```ts class ArrowLine ``` Reusable visual line segment for arrows. **Members** ##### `ArrowLine.constructor` ```ts constructor(({ style = "solid", color = "", slant = 0, route = "straight", points = [] } = {})); ``` | Param | Type | Description | | ------------------- | -------- | ----------- | | `spec` _(optional)_ | `object` | — | #### `ArrowLabel` ```ts class ArrowLabel ``` Label attached to an arrow line or endpoint. **Members** ##### `ArrowLabel.constructor` ```ts constructor(({ text = "", placement = "center", segmentIndex = null } = {})); ``` | Param | Type | Description | | ------------------- | -------- | ----------- | | `spec` _(optional)_ | `object` | — | #### `DiagramArrow` ```ts class DiagramArrow ``` Diagram-agnostic arrow: start endpoint, line, end endpoint, plus labels. **Members** ##### `DiagramArrow.constructor` ```ts constructor( ({ start = {}, end = {}, line = {}, labels = [], source = "", direction = "right" } = {}), ); ``` | Param | Type | Description | | ------------------- | -------- | ----------- | | `spec` _(optional)_ | `object` | — | #### `Box` ```ts class Box ``` A single component-style node in the diagram model. Boxes carry their own geometry once the layout pass has run; before layout, the geometry fields are zero. **Members** ##### `Box.constructor` ```ts constructor({ id, title, description = "", shape = "rectangle", stereotype = "", members = [], link = "", tooltip = "", }); ``` | Param | Type | Description | | ------ | -------- | ----------- | | `spec` | `object` | — | ##### `Box.centre` ```ts centre(); ``` #### `Subplane` ```ts class Subplane ``` A nested grouping inside a {@link Plane} (e.g. PlantUML `frame`, `folder`, `together`). Subplanes only contain boxes; arbitrary nesting is intentionally not supported. **Members** ##### `Subplane.constructor` ```ts constructor({ id, title, kind = "subplane" }); ``` | Param | Type | Description | | ------ | -------- | ----------- | | `spec` | `object` | — | ##### `Subplane.addBox` ```ts addBox(box); ``` Attach `box` to this subplane and back-link its parent. | Param | Type | Description | | ----- | ----- | --------------- | | `box` | `Box` | The box to add. | **Returns:** `Box` — The same box (for chaining). #### `Plane` ```ts class Plane ``` A top-level container in a component-style {@link Diagram} (PlantUML `package`, `frame`, `node` …). Holds boxes and subplanes. **Members** ##### `Plane.constructor` ```ts constructor({ id, title, color = null, kind = "package" }); ``` | Param | Type | Description | | ------ | -------- | ----------- | | `spec` | `object` | — | ##### `Plane.addSubplane` ```ts addSubplane(subplane); ``` Attach a {@link Subplane} as a child of this plane. | Param | Type | Description | | ---------- | ---------- | -------------------- | | `subplane` | `Subplane` | The subplane to add. | **Returns:** `Subplane` — The same subplane (for chaining). ##### `Plane.addBox` ```ts addBox(box); ``` Attach a {@link Box} directly as a child (bypassing any subplane). | Param | Type | Description | | ----- | ----- | --------------- | | `box` | `Box` | The box to add. | **Returns:** `Box` — The same box (for chaining). #### `Connection` ```ts class Connection ``` Directed connection between two {@link Box}es. Arrowhead values map directly onto Excalidraw's start/end arrowhead strings: `arrow | triangle | triangle_outline | diamond | diamond_outline | dot | bar | circle | circle_outline | null`. **Members** ##### `Connection.constructor` ```ts constructor({ id, from, to, label = "", kind = "default", dashed = false, startArrowhead = null, endArrowhead = "arrow", directionHint = null, fromMul = "", toMul = "", arrow = null, link = "", tooltip = "", }); ``` | Param | Type | Description | | ------ | -------- | ----------- | | `spec` | `object` | — | #### `Diagram` ```ts class Diagram ``` Component / deployment / use-case style diagram. Top-level container for {@link Plane}s and inter-plane {@link Connection}s. **Members** ##### `Diagram.addPlane` ```ts addPlane(plane); ``` Register a top-level plane. | Param | Type | Description | | ------- | ------- | ----------------- | | `plane` | `Plane` | The plane to add. | **Returns:** `Plane` — The same plane (for chaining). ##### `Diagram.addConnection` ```ts addConnection(connection); ``` Register a connection and back-link it from both endpoint boxes. | Param | Type | Description | | ------------ | ------------ | ---------------------- | | `connection` | `Connection` | The connection to add. | **Returns:** `Connection` — The same connection (for chaining). ##### `Diagram.allBoxes` ```ts allBoxes(); ``` ##### `Diagram.boxById` ```ts boxById(id); ``` Look up a box by its stable id. | Param | Type | Description | | ----- | -------- | ------------------------- | | `id` | `string` | The box id to search for. | **Returns:** `Box | null` — The box, or `null` if no plane contains it. #### `Participant` ```ts class Participant ``` One lifeline in a {@link SequenceDiagram}. **Members** ##### `Participant.constructor` ```ts constructor({ id, title, shape = "participant", stereotype = "", color = "", order = null }); ``` | Param | Type | Description | | ------ | -------- | ----------- | | `spec` | `object` | — | #### `SequenceArrowEndpoint` ```ts class SequenceArrowEndpoint extends ArrowEndpoint ``` One endpoint of a sequence message arrow. **Members** ##### `SequenceArrowEndpoint.constructor` ```ts constructor((spec = {})); ``` | Param | Type | Description | | ------------------- | -------- | ----------- | | `spec` _(optional)_ | `object` | — | #### `SequenceArrowLine` ```ts class SequenceArrowLine extends ArrowLine ``` Visual line segment of a sequence message arrow. **Members** ##### `SequenceArrowLine.constructor` ```ts constructor((spec = {})); ``` | Param | Type | Description | | ------------------- | -------- | ----------- | | `spec` _(optional)_ | `object` | — | #### `SequenceArrow` ```ts class SequenceArrow extends DiagramArrow ``` Object-oriented representation of a PlantUML sequence message arrow: start endpoint, line segment, and end endpoint. **Members** ##### `SequenceArrow.constructor` ```ts constructor(({ start = {}, end = {}, line = {}, source = "", direction = "right" } = {})); ``` | Param | Type | Description | | ------------------- | -------- | ----------- | | `spec` _(optional)_ | `object` | — | #### `Message` ```ts class Message ``` A message arrow exchanged between two {@link Participant}s. **Members** ##### `Message.constructor` ```ts constructor({ id, from, to, label = "", dashed = false, kind = "sync", startArrowhead = null, endArrowhead = "arrow", arrow = null, color = "", link = "", tooltip = "", }); ``` | Param | Type | Description | | ------ | -------- | ----------- | | `spec` | `object` | — | #### `SequenceNote` ```ts class SequenceNote ``` Free-form note attached to one or two {@link Participant}s in a {@link SequenceDiagram}. **Members** ##### `SequenceNote.constructor` ```ts constructor({ id, text, side, target, target2 = null, shape = "note", color = "", link = "", tooltip = "", }); ``` | Param | Type | Description | | ------ | -------- | ----------- | | `spec` | `object` | — | #### `SequenceFragment` ```ts class SequenceFragment ``` Combined fragment in a sequence diagram (`opt`, `loop`, `alt`, `par`, `break`, `critical`, `group`). A fragment owns one or more operands; each operand spans a declaration-order range on the sequence timeline. **Members** ##### `SequenceFragment.constructor` ```ts constructor({ id, kind, label = "", secondaryLabel = "", color = "", operands = [] }); ``` | Param | Type | Description | | ------ | -------- | ----------- | | `spec` | `object` | — | #### `SequenceActivation` ```ts class SequenceActivation ``` Activation bar on a participant lifeline. **Members** ##### `SequenceActivation.constructor` ```ts constructor({ id, participant, startSeq, endSeq = startSeq, color = "", depth = 0, side = 0, nestSide = 1, caller = null, }); ``` | Param | Type | Description | | ------ | -------- | ----------- | | `spec` | `object` | — | #### `SequenceMarker` ```ts class SequenceMarker ``` Timeline marker such as dividers (`== label ==`), delays (`...`), and vertical spacers. **Members** ##### `SequenceMarker.constructor` ```ts constructor({ id, kind, label = "", size = 0 }); ``` | Param | Type | Description | | ------ | -------- | ----------- | | `spec` | `object` | — | #### `SequenceReference` ```ts class SequenceReference ``` `ref over ...` reference frame in a sequence diagram. **Members** ##### `SequenceReference.constructor` ```ts constructor({ id, label, target, target2 = null }); ``` | Param | Type | Description | | ------ | -------- | ----------- | | `spec` | `object` | — | #### `SequenceParticipantGroup` ```ts class SequenceParticipantGroup ``` Participant grouping box declared with PlantUML `box ... end box`. **Members** ##### `SequenceParticipantGroup.constructor` ```ts constructor({ id, label = "", color = "" }); ``` | Param | Type | Description | | ------ | -------- | ----------- | | `spec` | `object` | — | #### `SequenceDiagram` ```ts class SequenceDiagram ``` Sequence diagram model: lifelines, messages, notes, fragments and other timeline decorations laid out on a vertical time axis. **Members** ##### `SequenceDiagram.addParticipant` ```ts addParticipant(p); ``` Register a lifeline. | Param | Type | Description | | ----- | ------------- | ---------------- | | `p` | `Participant` | Lifeline to add. | **Returns:** `Participant` — The same lifeline (for chaining). ##### `SequenceDiagram.addMessage` ```ts addMessage(m); ``` Register a message arrow. | Param | Type | Description | | ----- | --------- | --------------- | | `m` | `Message` | Message to add. | **Returns:** `Message` — The same message (for chaining). ##### `SequenceDiagram.addNote` ```ts addNote(n); ``` Register a free-form note. | Param | Type | Description | | ----- | -------------- | ------------ | | `n` | `SequenceNote` | Note to add. | **Returns:** `SequenceNote` — The same note (for chaining). ##### `SequenceDiagram.addFragment` ```ts addFragment(f); ``` Register a combined sequence fragment. | Param | Type | Description | | ----- | ------------------ | ---------------- | | `f` | `SequenceFragment` | Fragment to add. | **Returns:** `SequenceFragment` — The same fragment (for chaining). ##### `SequenceDiagram.addActivation` ```ts addActivation(a); ``` Register an activation bar. | Param | Type | Description | | ----- | -------------------- | ------------------ | | `a` | `SequenceActivation` | Activation to add. | **Returns:** `SequenceActivation` — The same activation. ##### `SequenceDiagram.addMarker` ```ts addMarker(m); ``` Register a sequence marker. | Param | Type | Description | | ----- | ---------------- | -------------- | | `m` | `SequenceMarker` | Marker to add. | **Returns:** `SequenceMarker` — The same marker. ##### `SequenceDiagram.addReference` ```ts addReference(r); ``` Register a reference frame. | Param | Type | Description | | ----- | ------------------- | ----------------- | | `r` | `SequenceReference` | Reference to add. | **Returns:** `SequenceReference` — The same reference. ##### `SequenceDiagram.addParticipantGroup` ```ts addParticipantGroup(g); ``` Register a participant group. | Param | Type | Description | | ----- | -------------------------- | ------------- | | `g` | `SequenceParticipantGroup` | Group to add. | **Returns:** `SequenceParticipantGroup` — The same group. ##### `SequenceDiagram.participantById` ```ts participantById(id); ``` Look up a lifeline by id. | Param | Type | Description | | ----- | -------- | -------------------------- | | `id` | `string` | Participant id to look up. | **Returns:** `Participant | null` — The lifeline, or `null` when missing. #### `TimingParticipant` ```ts class TimingParticipant ``` A participant/signal row in a UML timing diagram. **Members** ##### `TimingParticipant.constructor` ```ts constructor({ id, title, kind = "robust", compact = false, period = 1, pulse = 0, offset = 0, min = null, max = null, stereotype = "", }); ``` | Param | Type | Description | | ------ | -------- | ----------- | | `spec` | `object` | — | #### `TimingEvent` ```ts class TimingEvent ``` A signal value at a specific timing point. **Members** ##### `TimingEvent.constructor` ```ts constructor({ participantId, time, value, note = "", color = "", hidden = false }); ``` | Param | Type | Description | | ------ | -------- | ----------- | | `spec` | `object` | — | #### `TimingMessage` ```ts class TimingMessage ``` Point-to-point message drawn between timing participants. **Members** ##### `TimingMessage.constructor` ```ts constructor({ fromId, toId, fromTime, toTime, label = "" }); ``` | Param | Type | Description | | ------ | -------- | ----------- | | `spec` | `object` | — | #### `TimingConstraint` ```ts class TimingConstraint ``` Duration constraint between two timing points. **Members** ##### `TimingConstraint.constructor` ```ts constructor({ participantId = "", fromTime, toTime, label = "" }); ``` | Param | Type | Description | | ------ | -------- | ----------- | | `spec` | `object` | — | #### `TimingHighlight` ```ts class TimingHighlight ``` Highlighted timing interval. **Members** ##### `TimingHighlight.constructor` ```ts constructor({ fromTime, toTime, label = "", color = "" }); ``` | Param | Type | Description | | ------ | -------- | ----------- | | `spec` | `object` | — | #### `TimingNote` ```ts class TimingNote ``` Note attached above or below a timing participant. **Members** ##### `TimingNote.constructor` ```ts constructor({ side, participantId, text, time = 0 }); ``` | Param | Type | Description | | ------ | -------- | ----------- | | `spec` | `object` | — | #### `TimingDiagram` ```ts class TimingDiagram ``` UML timing diagram model. **Members** ##### `TimingDiagram.constructor` ```ts constructor(({ title = "" } = {})); ``` ##### `TimingDiagram.addParticipant` ```ts addParticipant(spec); ``` | Param | Type | Description | | ------ | ------------------ | ----------- | ----------------- | | `spec` | `TimingParticipant | any` | Participant spec. | **Returns:** `TimingParticipant` ##### `TimingDiagram.participantById` ```ts participantById(id); ``` ##### `TimingDiagram.addEvent` ```ts addEvent(spec); ``` ##### `TimingDiagram.addMessage` ```ts addMessage(spec); ``` ##### `TimingDiagram.addConstraint` ```ts addConstraint(spec); ``` ##### `TimingDiagram.addHighlight` ```ts addHighlight(spec); ``` ##### `TimingDiagram.addNote` ```ts addNote(spec); ``` --- ## `general/platform/asset_base` _Source: [`src/general/platform/asset_base.mjs`](src/general/platform/asset_base.mjs)_ Asset manifest helpers for diagram modules. ### Exports | Name | Kind | Visibility | | ----------------------------------------------------------------------------- | -------- | ---------- | | [`EMPTY_ASSET_MANIFEST`](#empty_asset_manifest-generalplatformasset_base) | const | public | | [`normalizeAssetManifest`](#normalizeassetmanifest-generalplatformasset_base) | function | public | | [`createAssetBase`](#createassetbase-generalplatformasset_base) | function | public | #### `EMPTY_ASSET_MANIFEST` ```ts const EMPTY_ASSET_MANIFEST; ``` #### `normalizeAssetManifest` ```ts function normalizeAssetManifest(manifest = {}); ``` Normalize a partial asset manifest into immutable arrays. **Parameters** | Name | Type | Description | | ----------------------- | ------------------------------ | ----------- | | `manifest` _(optional)_ | `Partial` | — | **Returns:** `ModuleAssetManifest` #### `createAssetBase` ```ts function createAssetBase(options); ``` Create the host asset-base facade. **Parameters** | Name | Type | Description | | --------- | ------------------------------------------------------------------------------ | ----------- | | `options` | `{securityBase: ReturnType}` | Options. | **Returns:** `Readonly<{emptyManifest: ModuleAssetManifest, normalizeManifest(manifest?:Partial): ModuleAssetManifest, resolveAsset(manifest:ModuleAssetManifest, request:import("./security_base.mjs").ModuleAssetRequest, context:import("./security_base.mjs").SecurityContext): import("./security_base.mjs").ModuleAssetResult}>` ### Type definitions #### `ModuleAssetManifest` ```ts object; ``` --- ## `general/platform/diagnostics` _Source: [`src/general/platform/diagnostics.mjs`](src/general/platform/diagnostics.mjs)_ Shared diagnostic helpers for parser, module, security and renderer boundaries. ### Exports | Name | Kind | Visibility | | ---------------------------------------------------------------------------- | -------- | ---------- | | [`DIAGNOSTIC_SEVERITIES`](#diagnostic_severities-generalplatformdiagnostics) | const | public | | [`createDiagnostic`](#creatediagnostic-generalplatformdiagnostics) | function | public | | [`isFatalDiagnostic`](#isfataldiagnostic-generalplatformdiagnostics) | function | public | | [`DiagnosticError`](#diagnosticerror-generalplatformdiagnostics) | class | public | #### `DIAGNOSTIC_SEVERITIES` ```ts const DIAGNOSTIC_SEVERITIES; ``` #### `createDiagnostic` ```ts function createDiagnostic(spec = {}); ``` Create a normalised diagnostic record. **Parameters** | Name | Type | Description | | ------ | --------------------- | ------------------ | | `spec` | `Partial` | Diagnostic fields. | **Returns:** `Diagnostic` #### `isFatalDiagnostic` ```ts function isFatalDiagnostic(diagnostic); ``` Whether a diagnostic must stop the affected operation. **Parameters** | Name | Type | Description | | ------------ | ------------ | ---------------------- | | `diagnostic` | `Diagnostic` | Diagnostic to inspect. | **Returns:** `boolean` #### `DiagnosticError` ```ts class DiagnosticError extends Error ``` Error wrapper for fatal diagnostics. The message is intentionally diagnostic-oriented and avoids leaking internal stack details into generated artifacts. **Members** ##### `DiagnosticError.constructor` ```ts constructor(diagnostic, (options = {})); ``` | Param | Type | Description | | ---------------------- | ------------------ | ----------------- | | `diagnostic` | `Diagnostic` | Fatal diagnostic. | | `options` _(optional)_ | `{cause?:unknown}` | — | ### Type definitions #### `DiagnosticSeverity` ```ts "info" | "warning" | "error" | "fatal"; ``` #### `Diagnostic` ```ts object; ``` --- ## `general/platform/security_base` _Source: [`src/general/platform/security_base.mjs`](src/general/platform/security_base.mjs)_ Central security and failure-safety platform for diagram modules. The helpers here are deliberately framework-neutral. Parser, layout and renderer code can share the same deny-by-default policy without importing each other. ### Exports | Name | Kind | Visibility | | -------------------------------------------------------------------------------------------------- | -------- | ---------- | | [`DEFAULT_ALLOWED_LINK_PROTOCOLS`](#default_allowed_link_protocols-generalplatformsecurity_base) | const | public | | [`DEFAULT_FAILURE_POLICY`](#default_failure_policy-generalplatformsecurity_base) | const | public | | [`DEFAULT_MODULE_SECURITY_PROFILE`](#default_module_security_profile-generalplatformsecurity_base) | const | public | | [`SecurityError`](#securityerror-generalplatformsecurity_base) | class | public | | [`createModuleSecurityProfile`](#createmodulesecurityprofile-generalplatformsecurity_base) | function | public | | [`escapeAttribute`](#escapeattribute-generalplatformsecurity_base) | function | public | | [`escapeText`](#escapetext-generalplatformsecurity_base) | function | public | | [`createSecurityBase`](#createsecuritybase-generalplatformsecurity_base) | function | public | | [`FailureBoundary`](#failureboundary-generalplatformsecurity_base) | class | public | #### `DEFAULT_ALLOWED_LINK_PROTOCOLS` ```ts const DEFAULT_ALLOWED_LINK_PROTOCOLS; ``` #### `DEFAULT_FAILURE_POLICY` ```ts const DEFAULT_FAILURE_POLICY; ``` #### `DEFAULT_MODULE_SECURITY_PROFILE` ```ts const DEFAULT_MODULE_SECURITY_PROFILE; ``` #### `SecurityError` ```ts class SecurityError extends DiagnosticError ``` Security-specific fatal error. **Members** ##### `SecurityError.constructor` ```ts constructor(diagnostic, (options = {})); ``` | Param | Type | Description | | ---------------------- | ---------------------------------------- | ----------------- | | `diagnostic` | `import("./diagnostics.mjs").Diagnostic` | Fatal diagnostic. | | `options` _(optional)_ | `{cause?:unknown}` | — | #### `createModuleSecurityProfile` ```ts function createModuleSecurityProfile(overrides = {}); ``` Build a complete security profile from partial overrides. **Parameters** | Name | Type | Description | | ------------------------ | -------------------------------- | ----------- | | `overrides` _(optional)_ | `Partial` | — | **Returns:** `ModuleSecurityProfile` #### `escapeAttribute` ```ts function escapeAttribute(value); ``` Escape a string for safe SVG/XML attribute interpolation. **Parameters** | Name | Type | Description | | ------- | -------- | ----------- | | `value` | `string` | Raw string. | **Returns:** `string` — Escaped string. #### `escapeText` ```ts function escapeText(value); ``` Escape a string for safe SVG/XML text interpolation. **Parameters** | Name | Type | Description | | ------- | -------- | ----------- | | `value` | `string` | Raw string. | **Returns:** `string` — Escaped string. #### `createSecurityBase` ```ts function createSecurityBase(); ``` Create the shared security-base facade. **Returns:** `Readonly<{ defaultProfileFor(kind:string): ModuleSecurityProfile, createContext(profile:ModuleSecurityProfile,input?:Record): SecurityContext, escapeText(value:string,context?:SecurityContext): string, escapeAttribute(value:string,context?:SecurityContext): string, sanitizeUrl(url:string,context:SecurityContext): SanitizedUrl, sanitizeStyle(style:Record,context:SecurityContext): Record, resolveAsset(asset:ModuleAssetRequest,context:SecurityContext): ModuleAssetResult, accountCost(amount:number,context:SecurityContext): void, assertCapability(capability:string,context:SecurityContext): void, createFailureBoundary(phase:string,context:SecurityContext): FailureBoundary, assertSafeArtifact(artifact:object,context:SecurityContext): void, reportDiagnostic(diagnostic:Partial,context:SecurityContext): import("./diagnostics.mjs").Diagnostic, }>` #### `FailureBoundary` ```ts class FailureBoundary ``` Failure boundary around a module phase. **Members** ##### `FailureBoundary.constructor` ```ts constructor(phase, context, securityBase); ``` | Param | Type | Description | | -------------- | --------------------------------------- | ----------------- | | `phase` | `string` | Phase name. | | `context` | `SecurityContext` | Security context. | | `securityBase` | `ReturnType` | Security facade. | ##### `FailureBoundary.run` ```ts run(action); ``` Run synchronous work inside the boundary. | Param | Type | Description | | -------- | --------- | -------------- | | `action` | `() => T` | Work callback. | **Returns:** `T` ##### `FailureBoundary.wrap` ```ts wrap(error); ``` | Param | Type | Description | | ------- | --------- | ----------------- | | `error` | `unknown` | Error to convert. | **Returns:** `SecurityError` ### Type definitions #### `ModuleFailurePolicy` ```ts object; ``` #### `ModuleSecurityProfile` ```ts object; ``` #### `SecurityContext` ```ts object; ``` #### `SanitizedUrl` ```ts object; ``` #### `ModuleAssetRequest` ```ts object; ``` #### `ModuleAssetResult` ```ts object; ``` --- ## `general/platform/services` _Source: [`src/general/platform/services.mjs`](src/general/platform/services.mjs)_ Host-provided platform services for diagram modules. These are not diagram modules. They describe shared capabilities such as security, style, text, arrows and reusable model/layout services that diagram modules can request through dependency specs. ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------------------------------- | -------- | ---------- | | [`DEFAULT_PLATFORM_SERVICE_MANIFESTS`](#default_platform_service_manifests-generalplatformservices) | const | public | | [`PlatformServiceRegistry`](#platformserviceregistry-generalplatformservices) | class | public | | [`defaultPlatformServiceRegistry`](#defaultplatformserviceregistry-generalplatformservices) | const | public | | [`validatePlatformService`](#validateplatformservice-generalplatformservices) | function | public | | [`satisfiesVersion`](#satisfiesversion-generalplatformservices) | function | public | #### `DEFAULT_PLATFORM_SERVICE_MANIFESTS` ```ts const DEFAULT_PLATFORM_SERVICE_MANIFESTS; ``` #### `PlatformServiceRegistry` ```ts class PlatformServiceRegistry ``` Registry for host services that diagram modules may depend on. **Members** ##### `PlatformServiceRegistry.constructor` ```ts constructor((options = {})); ``` ##### `PlatformServiceRegistry.register` ```ts register(service); ``` | Param | Type | Description | | --------- | ------------------------- | ----------------- | | `service` | `PlatformServiceManifest` | Service manifest. | **Returns:** `this` ##### `PlatformServiceRegistry.freeze` ```ts freeze(); ``` ##### `PlatformServiceRegistry.get` ```ts get(kind); ``` ##### `PlatformServiceRegistry.list` ```ts list(); ``` ##### `PlatformServiceRegistry.manifests` ```ts manifests(); ``` #### `defaultPlatformServiceRegistry` ```ts const defaultPlatformServiceRegistry; ``` #### `validatePlatformService` ```ts function validatePlatformService(service); ``` **Parameters** | Name | Type | Description | | --------- | --------- | ------------------ | | `service` | `unknown` | Service candidate. | **Returns:** `asserts service is PlatformServiceManifest` #### `satisfiesVersion` ```ts function satisfiesVersion(version, range); ``` Minimal semantic-version range check for the closed-world dependency graph. Supports exact versions, `*`, and caret ranges such as `^1.0.0`. **Parameters** | Name | Type | Description | | --------- | -------- | ----------------- | | `version` | `string` | Concrete version. | | `range` | `string` | Requested range. | **Returns:** `boolean` ### Type definitions #### `PlatformServiceManifest` ```ts object; ``` --- ## `general/render/canvas_svg` _Source: [`src/general/render/canvas_svg.mjs`](src/general/render/canvas_svg.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------------------------------- | -------- | ----------- | | [`DEFAULT_CANVAS_WIDTH`](#default_canvas_width-generalrendercanvas_svg) | const | unspecified | | [`MIN_CANVAS_WIDTH`](#min_canvas_width-generalrendercanvas_svg) | const | unspecified | | [`MAX_CANVAS_WIDTH`](#max_canvas_width-generalrendercanvas_svg) | const | unspecified | | [`DEFAULT_ASPECT_RATIO`](#default_aspect_ratio-generalrendercanvas_svg) | const | unspecified | | [`excalidrawJsonToCanvasSvg`](#excalidrawjsontocanvassvg-generalrendercanvas_svg) | function | unspecified | #### `DEFAULT_CANVAS_WIDTH` ```ts const DEFAULT_CANVAS_WIDTH; ``` #### `MIN_CANVAS_WIDTH` ```ts const MIN_CANVAS_WIDTH; ``` #### `MAX_CANVAS_WIDTH` ```ts const MAX_CANVAS_WIDTH; ``` #### `DEFAULT_ASPECT_RATIO` ```ts const DEFAULT_ASPECT_RATIO; ``` #### `excalidrawJsonToCanvasSvg` ```ts function excalidrawJsonToCanvasSvg(doc, opts = {}); ``` Convert an Excalidraw JSON document to an SVG that has been letter-boxed onto a fixed-aspect canvas. **Parameters** | Name | Type | Description | | ------------------- | -------- | ------------------------- | | `doc` | `object` | Excalidraw JSON document. | | `opts` _(optional)_ | `object` | — | **Returns:** `string` — A canvas-sized SVG document. --- ## `general/render/excalidraw` _Source: [`src/general/render/excalidraw.mjs`](src/general/render/excalidraw.mjs)_ ### Exports | Name | Kind | Visibility | | --------------------------------------------------------- | -------- | ---------- | | [`exportDiagram`](#exportdiagram-generalrenderexcalidraw) | function | public | #### `exportDiagram` ```ts function exportDiagram(diagram, opts = {}); ``` Render a laid-out diagram to an Excalidraw JSON document. The output is **deterministic** by default: identical input always produces a byte-identical document, because element ids and seeds are sourced from a stable hash of `sourceLabel` + diagram title. Pass `opts.rng = Math.random` to opt back into non-deterministic randomness (e.g. when running in an editor that expects unique seeds across sessions). **Parameters** | Name | Type | Description | | ------------------- | --------------------------------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------ | | `diagram` | `import("../model/diagram.mjs").Diagram | import("../model/diagram.mjs").SequenceDiagram` | A diagram that has already been processed by `layoutDiagram` from `src/general/layout/elk_layout.mjs`. | | `opts` _(optional)_ | `object` | — | **Returns:** `object` — Excalidraw JSON. ### Type definitions #### `Pt` ```ts {x:number,y:number} ``` Internal placement model for both edge and endpoint labels. --- ## `general/render/png` _Source: [`src/general/render/png.mjs`](src/general/render/png.mjs)_ ### Exports | Name | Kind | Visibility | | ---------------------------------------- | -------- | ----------- | | [`svgToPng`](#svgtopng-generalrenderpng) | function | unspecified | #### `svgToPng` ```ts function svgToPng(svgText, opts = {}); ``` Rasterise an SVG document to PNG. **Parameters** | Name | Type | Description | | ------------------- | -------- | ----------- | | `svgText` | `string` | — | | `opts` _(optional)_ | `object` | — | **Returns:** `Buffer` — PNG bytes. **Throws:** - {RangeError} If `opts.width` is not a positive integer. --- ## `general/render/rng` _Source: [`src/general/render/rng.mjs`](src/general/render/rng.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------ | -------- | ---------- | | [`stableHash32`](#stablehash32-generalrenderrng) | function | internal | | [`createSeededRng`](#createseededrng-generalrenderrng) | function | internal | #### `stableHash32` ```ts function stableHash32(text); ``` 32-bit FNV-1a hash. Used to derive a stable PRNG seed from a string. **Parameters** | Name | Type | Description | | ------ | -------- | ----------- | | `text` | `string` | — | **Returns:** `number` — Unsigned 32-bit integer. #### `createSeededRng` ```ts function createSeededRng(seed); ``` Create a deterministic PRNG returning floats in `[0, 1)`. Uses the xorshift32 algorithm — small, fast, good enough for Excalidraw seeds. **Parameters** | Name | Type | Description | | ------ | -------- | ----------------------------- | | `seed` | `number` | Unsigned 32-bit integer seed. | **Returns:** `() => number` --- ## `general/render/schema` _Source: [`src/general/render/schema.mjs`](src/general/render/schema.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------- | ----- | ---------- | | [`EXCALIDRAW_SCHEMA`](#excalidraw_schema-generalrenderschema) | const | public | | [`ROUNDNESS`](#roundness-generalrenderschema) | const | public | #### `EXCALIDRAW_SCHEMA` ```ts const EXCALIDRAW_SCHEMA; ``` Top-level metadata emitted on every `.excalidraw` document. #### `ROUNDNESS` ```ts const ROUNDNESS; ``` Roundness presets used by Excalidraw shapes. `proportional` is the default for rectangles when the user toggles "rounded corners" in the editor. --- ## `general/render/svg` _Source: [`src/general/render/svg.mjs`](src/general/render/svg.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------ | -------- | ----------- | | [`excalidrawToSvg`](#excalidrawtosvg-generalrendersvg) | function | unspecified | | [`escapeAttr`](#escapeattr-generalrendersvg) | function | unspecified | | [`escapeText`](#escapetext-generalrendersvg) | function | unspecified | #### `excalidrawToSvg` ```ts function excalidrawToSvg(doc, opts = {}); ``` Convert an Excalidraw JSON document to a stand-alone SVG string. **Parameters** | Name | Type | Description | | ------------------- | -------- | ----------------------------- | | `doc` | `any` | The Excalidraw JSON document. | | `opts` _(optional)_ | `object` | — | **Returns:** `string` — A complete `...` document. #### `escapeAttr` ```ts function escapeAttr(s); ``` Escape a string for safe interpolation into an SVG attribute value. Escapes `&`, `"`, `<` and `>` so attacker-controlled input cannot break out of the surrounding `"..."` and inject extra attributes or markup. **Parameters** | Name | Type | Description | | ---- | -------- | ----------- | | `s` | `string` | Raw string. | **Returns:** `string` — Escaped string. #### `escapeText` ```ts function escapeText(s); ``` Escape a string for safe interpolation into SVG text content. **Parameters** | Name | Type | Description | | ---- | -------- | ----------- | | `s` | `string` | Raw string. | **Returns:** `string` — Escaped string. --- ## `general/style/colors` _Source: [`src/general/style/colors.mjs`](src/general/style/colors.mjs)_ ### Exports | Name | Kind | Visibility | | ---------------------------------------------------- | -------- | ---------- | | [`planeColor`](#planecolor-generalstylecolors) | function | public | | [`subplaneColor`](#subplanecolor-generalstylecolors) | function | public | | [`boxColor`](#boxcolor-generalstylecolors) | function | public | #### `planeColor` ```ts function planeColor(id); ``` Deterministically derive a {@link ColorTriple} from a plane id. The same id always yields the same colours so re-rendering the same diagram is byte-stable. **Parameters** | Name | Type | Description | | ---- | -------- | ------------------------------------------- | | `id` | `string` | Plane identifier (alias or generated slug). | **Returns:** `ColorTriple` — Stroke / fill / title-fill colours for the plane. #### `subplaneColor` ```ts function subplaneColor(planeColor); ``` Derive a subplane's {@link ColorTriple} from its parent plane's triple by darkening the fills slightly. **Parameters** | Name | Type | Description | | ------------ | ------------- | ----------------------------- | | `planeColor` | `ColorTriple` | Parent plane's colour triple. | **Returns:** `ColorTriple` — Slightly darker triple for the nested subplane. #### `boxColor` ```ts function boxColor(planeColor); ``` Derive a box's {@link ColorTriple} from its plane's colour: the stroke matches the plane, the box body is white, and the title bar is a subtly darker variant of the plane fill. **Parameters** | Name | Type | Description | | ------------ | ------------- | ----------------------------- | | `planeColor` | `ColorTriple` | Owning plane's colour triple. | **Returns:** `ColorTriple` — Triple with white body and tinted title bar. ### Type definitions #### `ColorTriple` ```ts { stroke: string, fill: string, titleFill: string } ``` Hex-coded fill / stroke / title-fill colours used by one renderable. --- ## `general/style/font` _Source: [`src/general/style/font.mjs`](src/general/style/font.mjs)_ ### Exports | Name | Kind | Visibility | | ------------------------------------------------------------------------------ | -------- | ----------- | | [`EXCALIFONT_FAMILY`](#excalifont_family-generalstylefont) | const | unspecified | | [`EXCALIFONT_FONT_PATH`](#excalifont_font_path-generalstylefont) | const | unspecified | | [`EXCALIFONT_RASTER_FONT_PATH`](#excalifont_raster_font_path-generalstylefont) | const | unspecified | | [`getExcalifontWoff2`](#getexcalifontwoff2-generalstylefont) | function | public | | [`getExcalifontDataUrl`](#getexcalifontdataurl-generalstylefont) | function | public | | [`getExcalifontFontFace`](#getexcalifontfontface-generalstylefont) | function | public | | [`EXCALIFONT_FONT_STACK`](#excalifont_font_stack-generalstylefont) | const | unspecified | #### `EXCALIFONT_FAMILY` ```ts const EXCALIFONT_FAMILY; ``` Family name used inside the SVG `font-family` attribute. #### `EXCALIFONT_FONT_PATH` ```ts const EXCALIFONT_FONT_PATH; ``` Absolute filesystem path to the bundled woff2. #### `EXCALIFONT_RASTER_FONT_PATH` ```ts const EXCALIFONT_RASTER_FONT_PATH; ``` Absolute filesystem path to the bundled TrueType copy used by resvg. #### `getExcalifontWoff2` ```ts function getExcalifontWoff2(); ``` Returns the bundled Excalifont woff2 bytes. Cached after the first call so subsequent renders share one buffer. **Returns:** `Buffer` #### `getExcalifontDataUrl` ```ts function getExcalifontDataUrl(); ``` Returns a `data:font/woff2;base64,…` URL with the inlined font. **Returns:** `string` #### `getExcalifontFontFace` ```ts function getExcalifontFontFace(); ``` Returns a complete `@font-face { … }` rule ready to drop inside an SVG `