Skip to content

Shared models and named views ​

Define a system once, then choose how much detail to show. Named views keep IDs, relationships, source locations, and style declarations shared while allowing different layout and presentation choices.

System overview{"languageVersion":1,"diagramId":"main","diagrams":["main"],"manifest":[{"id":"main","diagramType":"graph","status":"selected","reason":null,"annotations":[],"span":{"start":0,"end":496,"line":1,"column":1,"endLine":17,"endColumn":2}}],"targets":[],"diagnostics":[],"diagram":{"declaration":"diagram","attributes":{"layout":{"value":{"type":"choice","value":"auto"},"span":{"start":37,"end":48,"line":1,"column":38,"endLine":1,"endColumn":49},"valueSpan":{"start":44,"end":48,"line":1,"column":45,"endLine":1,"endColumn":49},"nameSpan":{"start":37,"end":43,"line":1,"column":38,"endLine":1,"endColumn":44}},"type":{"value":{"type":"choice","value":"graph"},"span":{"start":26,"end":36,"line":1,"column":27,"endLine":1,"endColumn":37},"valueSpan":{"start":31,"end":36,"line":1,"column":32,"endLine":1,"endColumn":37},"nameSpan":{"start":26,"end":30,"line":1,"column":27,"endLine":1,"endColumn":31}}},"path":null,"authoredId":null,"documentation":null,"sourceLocations":[],"metadata":{},"annotations":[],"paint":{"paletteOrigin":null,"fillColor":null,"strokeColor":null,"textColor":null,"backgroundColor":null,"strokeStyle":null,"strokeWidth":null}},"objects":{"object:[\"api\"]":{"declaration":"node","attributes":{},"path":["api"],"authoredId":"api","documentation":null,"sourceLocations":[],"metadata":{},"annotations":[],"paint":{"paletteOrigin":null,"fillColor":null,"strokeColor":null,"textColor":null,"backgroundColor":null,"strokeStyle":null,"strokeWidth":null}},"object:[\"backend\",\"store\"]":{"declaration":"node","attributes":{},"path":["backend","store"],"authoredId":"store","documentation":null,"sourceLocations":[],"metadata":{},"annotations":[],"paint":{"paletteOrigin":null,"fillColor":null,"strokeColor":null,"textColor":null,"backgroundColor":null,"strokeStyle":null,"strokeWidth":null}},"object:[\"backend\",\"worker\"]":{"declaration":"node","attributes":{},"path":["backend","worker"],"authoredId":"worker","documentation":null,"sourceLocations":[],"metadata":{},"annotations":[],"paint":{"paletteOrigin":null,"fillColor":null,"strokeColor":null,"textColor":null,"backgroundColor":null,"strokeStyle":null,"strokeWidth":null}},"object:[\"backend\"]":{"declaration":"group","attributes":{},"path":["backend"],"authoredId":"backend","documentation":null,"sourceLocations":[],"metadata":{},"annotations":[],"paint":{"paletteOrigin":null,"fillColor":null,"strokeColor":null,"textColor":null,"backgroundColor":null,"strokeStyle":null,"strokeWidth":null}},"object:[\"client\"]":{"declaration":"node","attributes":{},"path":["client"],"authoredId":"client","documentation":null,"sourceLocations":[],"metadata":{},"annotations":[],"paint":{"paletteOrigin":null,"fillColor":null,"strokeColor":null,"textColor":null,"backgroundColor":null,"strokeStyle":null,"strokeWidth":null}}},"relationships":{"relationship:\"dispatch\"":{"declaration":"edge","attributes":{},"path":null,"authoredId":"dispatch","documentation":null,"sourceLocations":[],"metadata":{},"annotations":[],"paint":{"paletteOrigin":null,"fillColor":null,"strokeColor":null,"textColor":null,"backgroundColor":null,"strokeStyle":null,"strokeWidth":null}},"relationship:\"request\"":{"declaration":"edge","attributes":{},"path":null,"authoredId":"request","documentation":null,"sourceLocations":[],"metadata":{},"annotations":[],"paint":{"paletteOrigin":null,"fillColor":null,"strokeColor":null,"textColor":null,"backgroundColor":null,"strokeStyle":null,"strokeWidth":null}},"relationship:\"save\"":{"declaration":"edge","attributes":{},"path":null,"authoredId":"save","documentation":null,"sourceLocations":[],"metadata":{},"annotations":[],"paint":{"paletteOrigin":null,"fillColor":null,"strokeColor":null,"textColor":null,"backgroundColor":null,"strokeStyle":null,"strokeWidth":null}}}}Copyright © 2017 IBM Corp. with Reserved Font Name "Plex" This Font Software is licensed under the SIL Open Font License, Version 1.1. This license is copied below, and is also available with a FAQ at: http://scripts.sil.org/OFL ----------------------------------------------------------- SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 ----------------------------------------------------------- PREAMBLE The goals of the Open Font License (OFL) are to stimulate worldwide development of collaborative font projects, to support the font creation efforts of academic and linguistic communities, and to provide a free and open framework in which fonts may be shared and improved in partnership with others. The OFL allows the licensed fonts to be used, studied, modified and redistributed freely as long as they are not sold by themselves. The fonts, including any derivative works, can be bundled, embedded, redistributed and/or sold with any software provided that any reserved names are not used by derivative works. The fonts and derivatives, however, cannot be released under any other type of license. The requirement for fonts to remain under this license does not apply to any document created using the fonts or their derivatives. DEFINITIONS "Font Software" refers to the set of files released by the Copyright Holder(s) under this license and clearly marked as such. This may include source files, build scripts and documentation. "Reserved Font Name" refers to any names specified as such after the copyright statement(s). "Original Version" refers to the collection of Font Software components as distributed by the Copyright Holder(s). "Modified Version" refers to any derivative made by adding to, deleting, or substituting -- in part or in whole -- any of the components of the Original Version, by changing formats or by porting the Font Software to a new environment. "Author" refers to any designer, engineer, programmer, technical writer or other person who contributed to the Font Software. PERMISSION & CONDITIONS Permission is hereby granted, free of charge, to any person obtaining a copy of the Font Software, to use, study, copy, merge, embed, modify, redistribute, and sell modified and unmodified copies of the Font Software, subject to the following conditions: 1) Neither the Font Software nor any of its individual components, in Original or Modified Versions, may be sold by itself. 2) Original or Modified Versions of the Font Software may be bundled, redistributed and/or sold with any software, provided that each copy contains the above copyright notice and this license. These can be included either as stand-alone text files, human-readable headers or in the appropriate machine-readable metadata fields within text or binary files as long as those fields can be easily viewed by the user. 3) No Modified Version of the Font Software may use the Reserved Font Name(s) unless explicit written permission is granted by the corresponding Copyright Holder. This restriction only applies to the primary font name as presented to the users. 4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font Software shall not be used to promote, endorse or advertise any Modified Version, except to acknowledge the contribution(s) of the Copyright Holder(s) and the Author(s) or with their explicit written permission. 5) The Font Software, modified or unmodified, in part or in whole, must be distributed entirely under this license, and must not be distributed under any other license. The requirement for fonts to remain under this license does not apply to any document created using the Font Software. TERMINATION This license becomes null and void if any of the above conditions are not met. DISCLAIMER THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM OTHER DEALINGS IN THE FONT SOFTWARE.System overviewClientAPIBackendWorkerStore
text
diagram main "Job system" type=graph layout=auto {
  node client "Client"
  node api "API"
  group backend "Backend" {
    node worker "Worker"
    node store "Store"
  }
  edge request ::client -> ::api
  edge dispatch ::api -> ::backend.worker
  edge save ::backend.worker -> ::backend.store
  view overview "System overview" flow-direction=right {
    include ::client ::api ::backend
  }
  view storage "Storage detail" flow-direction=down {
    include ::backend.worker ::backend.store
  }
}

Selection rules ​

  • Shared nodes require explicit IDs. Each view needs a unique name and an include list.
  • A container include selects its subtree. A descendant include preserves ancestor frames without including unselected siblings.
  • An edge survives when both endpoints survive. Rows preserve child order and the weights of selected cells.
  • Model attributes are inherited, then view attributes override them. The view's title becomes the diagram title.
  • The first authored view is the default. Explicit selection uses --view or an API option.

Opaque anonymous edge IDs are assigned before filtering the complete model, so a relationship retains its ID between views. Prefer explicit IDs for steps and external integrations that should survive source edits.

Try an overview and a detail view ​

Diagram Loading renderer…
Your diagram appears here. The renderer loads once and runs in your browser.

Ctrl+Enter renders now · Tab moves focus · Click a diagnostic to select its source · Expand for pan, zoom and presentation controls

Use your own fallback fonts

CJK uses your system fonts by default. Choose standalone .ttf/.otf faces for exact measurement and embedding. Files stay in this browser; share links do not include fonts.

Switch the View selector. Add an attribute such as flow-direction=left to one view, or change a shared node title and inspect both results.

sh
layup render model.layup --view storage --html
layup check model.layup --view overview --strict
layup check model.layup --view storage --strict
js
const scene = engine.compile(source, { view: 'storage' });
const rendered = engine.render(source, { view: 'storage' });

Per-view steps and validation ​

A view can declare step blocks; when present, its plan replaces the shared model's plan. Shared steps must still reference targets in the selected result. Models can inherit slide attributes and let individual views override the viewport or readability threshold.

All include references, duplicate identities, and shared edge references are validated before filtering. Styles, object references and every authored presentation plan are validated before selection. Layout and machine checks apply to the selected result. Unused declaration linting considers uses across the shared source. Validate each view in CI to cover all rendered variants.

State-machine views must retain valid initial scopes. Sequence notes tied to excluded participants disappear, but filtering must preserve nonempty fragments and complete alternative branches; empty branches are errors.

MIT OR Apache-2.0 · Bundled fonts: SIL OFL 1.1