Skip to content

Slides and progressive reveal ​

A diagram for a talk needs readable sizing and a controlled introduction. Layup supplies both through grouped viewport settings and authored presentation steps. The same features apply to graphs, decisions, states, and sequences.

Fit a slide ​

A request through the system{"languageVersion":1,"diagramId":"main","diagrams":["main"],"manifest":[{"id":"main","diagramType":"graph","status":"selected","reason":null,"annotations":[],"span":{"start":0,"end":323,"line":1,"column":1,"endLine":8,"endColumn":2}}],"targets":[],"diagnostics":[],"diagram":{"declaration":"diagram","attributes":{"flow-direction":{"value":{"type":"choice","value":"right"},"span":{"start":67,"end":87,"line":1,"column":68,"endLine":1,"endColumn":88},"valueSpan":{"start":82,"end":87,"line":1,"column":83,"endLine":1,"endColumn":88},"nameSpan":{"start":67,"end":81,"line":1,"column":68,"endLine":1,"endColumn":82}},"layout":{"value":{"type":"choice","value":"auto"},"span":{"start":55,"end":66,"line":1,"column":56,"endLine":1,"endColumn":67},"valueSpan":{"start":62,"end":66,"line":1,"column":63,"endLine":1,"endColumn":67},"nameSpan":{"start":55,"end":61,"line":1,"column":56,"endLine":1,"endColumn":62}},"type":{"value":{"type":"choice","value":"graph"},"span":{"start":44,"end":54,"line":1,"column":45,"endLine":1,"endColumn":55},"valueSpan":{"start":49,"end":54,"line":1,"column":50,"endLine":1,"endColumn":55},"nameSpan":{"start":44,"end":48,"line":1,"column":45,"endLine":1,"endColumn":49}},"width":{"value":{"type":"integer","value":"480"},"span":{"start":88,"end":97,"line":1,"column":89,"endLine":1,"endColumn":98},"valueSpan":{"start":94,"end":97,"line":1,"column":95,"endLine":1,"endColumn":98},"nameSpan":{"start":88,"end":93,"line":1,"column":89,"endLine":1,"endColumn":94}}},"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":{"palette":{"value":{"type":"choice","value":"green"},"span":{"start":199,"end":212,"line":4,"column":32,"endLine":4,"endColumn":45},"valueSpan":{"start":207,"end":212,"line":4,"column":40,"endLine":4,"endColumn":45},"nameSpan":{"start":199,"end":206,"line":4,"column":32,"endLine":4,"endColumn":39}},"style":{"value":{"type":"choice","value":"process"},"span":{"start":185,"end":198,"line":4,"column":18,"endLine":4,"endColumn":31},"valueSpan":{"start":191,"end":198,"line":4,"column":24,"endLine":4,"endColumn":31},"nameSpan":{"start":185,"end":190,"line":4,"column":18,"endLine":4,"endColumn":23}}},"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:[\"client\"]":{"declaration":"node","attributes":{"palette":{"value":{"type":"choice","value":"blue"},"span":{"start":155,"end":167,"line":3,"column":38,"endLine":3,"endColumn":50},"valueSpan":{"start":163,"end":167,"line":3,"column":46,"endLine":3,"endColumn":50},"nameSpan":{"start":155,"end":162,"line":3,"column":38,"endLine":3,"endColumn":45}},"style":{"value":{"type":"choice","value":"process"},"span":{"start":141,"end":154,"line":3,"column":24,"endLine":3,"endColumn":37},"valueSpan":{"start":147,"end":154,"line":3,"column":30,"endLine":3,"endColumn":37},"nameSpan":{"start":141,"end":146,"line":3,"column":24,"endLine":3,"endColumn":29}}},"path":["client"],"authoredId":"client","documentation":null,"sourceLocations":[],"metadata":{},"annotations":[],"paint":{"paletteOrigin":null,"fillColor":null,"strokeColor":null,"textColor":null,"backgroundColor":null,"strokeStyle":null,"strokeWidth":null}},"object:[\"store\"]":{"declaration":"node","attributes":{"palette":{"value":{"type":"choice","value":"purple"},"span":{"start":250,"end":264,"line":5,"column":38,"endLine":5,"endColumn":52},"valueSpan":{"start":258,"end":264,"line":5,"column":46,"endLine":5,"endColumn":52},"nameSpan":{"start":250,"end":257,"line":5,"column":38,"endLine":5,"endColumn":45}},"style":{"value":{"type":"choice","value":"process"},"span":{"start":236,"end":249,"line":5,"column":24,"endLine":5,"endColumn":37},"valueSpan":{"start":242,"end":249,"line":5,"column":30,"endLine":5,"endColumn":37},"nameSpan":{"start":236,"end":241,"line":5,"column":24,"endLine":5,"endColumn":29}}},"path":["store"],"authoredId":"store","documentation":null,"sourceLocations":[],"metadata":{},"annotations":[],"paint":{"paletteOrigin":null,"fillColor":null,"strokeColor":null,"textColor":null,"backgroundColor":null,"strokeStyle":null,"strokeWidth":null}}},"relationships":{"anonymous:0":{"declaration":"edge","attributes":{},"path":null,"authoredId":null,"documentation":null,"sourceLocations":[],"metadata":{},"annotations":[],"paint":{"paletteOrigin":null,"fillColor":null,"strokeColor":null,"textColor":null,"backgroundColor":null,"strokeStyle":null,"strokeWidth":null}},"anonymous:1":{"declaration":"edge","attributes":{},"path":null,"authoredId":null,"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.A request through the systemClientAPIStorageRequestQuery
text
diagram main "A request through the system" type=graph layout=auto flow-direction=right width=480 {
  slide size=wide
  node client "Client" style=process palette=blue
  node api "API" style=process palette=green
  node store "Storage" style=process palette=purple
  ::client -> ::api "Request"
  ::api -> ::store "Query"
}
AttributeBehavior
slide size=wide or slide size="16:9"1920 × 1080 viewport
slide size=standard or slide size="4:3"1440 × 1080 viewport
slide size={width: 1200, height: 1800}Explicit width and height
padding=NInterior padding, default 48
min-font-size=NMinimum post-fit font size, default 18

The size, padding and readability properties belong to a slide statement at the diagram or view level. The finished scene scales uniformly and centers in the viewport. Layout, routes, measured text, and aspect ratio remain intact. width=N controls the original layout canvas separately. For a short pipeline, a compact source width such as 480 avoids fitting a mostly empty 900-unit default canvas. The slide keeps its 16:9 viewport; change source width to balance the content inside it. Readability warnings include every text item, including captions, roles, and chips, after fitting. --strict fails on those warnings. The threshold is in slide units before display resizing.

Reveal the explanation in steps ​

Dispatch a job{"languageVersion":1,"diagramId":"main","diagrams":["main"],"manifest":[{"id":"main","diagramType":"graph","status":"selected","reason":null,"annotations":[],"span":{"start":0,"end":431,"line":1,"column":1,"endLine":14,"endColumn":2}}],"targets":[],"diagnostics":[],"diagram":{"declaration":"diagram","attributes":{"flow-direction":{"value":{"type":"choice","value":"right"},"span":{"start":53,"end":73,"line":1,"column":54,"endLine":1,"endColumn":74},"valueSpan":{"start":68,"end":73,"line":1,"column":69,"endLine":1,"endColumn":74},"nameSpan":{"start":53,"end":67,"line":1,"column":54,"endLine":1,"endColumn":68}},"layout":{"value":{"type":"choice","value":"auto"},"span":{"start":41,"end":52,"line":1,"column":42,"endLine":1,"endColumn":53},"valueSpan":{"start":48,"end":52,"line":1,"column":49,"endLine":1,"endColumn":53},"nameSpan":{"start":41,"end":47,"line":1,"column":42,"endLine":1,"endColumn":48}},"type":{"value":{"type":"choice","value":"graph"},"span":{"start":30,"end":40,"line":1,"column":31,"endLine":1,"endColumn":41},"valueSpan":{"start":35,"end":40,"line":1,"column":36,"endLine":1,"endColumn":41},"nameSpan":{"start":30,"end":34,"line":1,"column":31,"endLine":1,"endColumn":35}}},"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:[\"worker\"]":{"declaration":"node","attributes":{},"path":["worker"],"authoredId":"worker","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}}}}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.Dispatch a jobAPIWorkerdispatch
text
diagram main "Dispatch a job" type=graph layout=auto flow-direction=right {
  node api "API"
  node worker "Worker"
  edge dispatch ::api -> ::worker "dispatch"
  step overview "Meet the services" {
    show objects=[::api, ::worker]
    highlight objects=[::api]
    speaker-note "The API accepts work for the worker."
  }
  step request "Dispatch work" {
    show connections=[dispatch]
    highlight connections=[dispatch]
  }
}

show objects=[…] and show connections=[…] accumulate. Highlights apply only to the current step and require visible targets. Showing a container reveals its subtree; showing a descendant keeps ancestor frames visible.

Edges ordinarily appear when both endpoints are visible. If an edge is assigned to show connections=[…] anywhere, it waits for that explicit reveal and for both endpoints. Give important edges IDs to keep step references stable.

Static output starts with the complete diagram. Present starts the plan; Previous, Next, and Show all control it. Arrow Left/Right, Page Up/Down, Space, Home, and End navigate during presentation. Inline docs also support fullscreen. Notes are plain text; reduced-motion preferences are respected.

A combined request/retry walkthrough ​

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.

Choose the walkthrough view, then select Present under the diagram. Its four steps introduce the request, asynchronous dispatch, polling, and result. Expand it to see the slide at a useful presentation size.

Sequence notes and fragment frames remain context during reveal. Presentation steps do not execute state machines or automatically time a trace.

Drive an iframe ​

Use --html --embed for a page without the toolbar. ?step=request selects an initial step. A host can send:

js
frame.contentWindow.postMessage({ layup: 'step', id: 'request' }, '*');
frame.contentWindow.postMessage({ layup: 'step', action: 'next' }, '*');
frame.contentWindow.postMessage({ layup: 'step', action: 'all' }, '*');

The viewer reports { layup: 'step', index, id, count, title, note }. Indices are zero-based; the complete view has index -1 and ID null. Existing focus/select/theme/fit messages remain available. Verify the origin and source of incoming messages in your host.

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