Expand description
Collaborative yrs-backed PPTX deck model.
Modules§
- paragraph
- Font-independent paragraph semantics shared by rendering and export: the layout and master a slide inherits from, the paragraph-property cascade, and list markers.
- structured
- Read-only structured export of PPTX content: slides in deck order, each with its shape tree,
text stories, tables and placeholders for content the export cannot represent, every record
carrying the location it was read from, plus diagnostics for everything omitted.
render_pptx_markdownrenders the same content as Markdown.
Structs§
- Background
Guard - Refuses a step unless the slide’s effective background is exactly
background;nullis no background of its own. - Caret
Anchor - Color
Value - Comment
Receipt - Comment
Snapshot - Deck
Session - Deck
Snapshot - Deck
Undo Manager - Document
Version - An opaque, session-scoped optimistic-concurrency token. Compare for equality only.
- Edit
Application - EditCtx
- Edit
Failure - Edit
Preview - What one step would do at its resolved pre-batch target. It reserves nothing.
- Edit
Receipt - What one step did. Text targets describe the final state; a deletion reports its collapsed boundary.
- Edit
Refusal - A policy refusal; the deck is untouched at
version. - Edit
Request - Edit
Validation - Fill
Guard - Refuses a step unless the shape’s authored fill is exactly
fill;Noneis no fill of its own. - Find
Match - One search hit;
rangeis reusable as aTextTarget::Range. - Find
Request - Find
Response - Find
Scope - Where a search looks: a slide, one shape and its descendants, or one story.
- Gradient
Fill - Gradient
Stop - Inherited
Geometry - The transform a placeholder takes from its layout or master.
- Outline
Guard - Refuses a step unless the shape’s authored outline is exactly
outline. - Paragraph
Snapshot - Paragraph
Source - Paragraph
Text - One paragraph’s place in its story’s projected text.
- Pending
Media - Image data shared by editing peers.
- Picture
Draft - Preset
Shape Draft - Proposal
- Proposal
Acceptance - Proposal
Change - Proposal
Diff Preview - Proposal
Preview - Proposal
Request - Proposal
Slide Diff - Slide-scoped diff preview:
scopeis the render input,snapshotcarries that slide. - Proposal
Text Change - Read
Request - Read
Response - Rect
Guard - Refuses a step unless the shape’s rectangle is exactly
rect. - Shape
Adjust Receipt - Shape
Draft - Shape
Fill - Shape
Fill Receipt - Shape
Receipt - Shape
Rect - Shape
Snapshot - Shape
Stroke - Shape
Stroke Receipt - Shape
Target - A shape addressed through the slide that owns it.
- ShapeZ
Order Receipt - Slide
Background Receipt - Slide
Receipt - Slide
Scope - One slide’s snapshot plus deck geometry — the slide-scoped render input.
- Slide
Snapshot - Slide
Target - Story
Snapshot - Story
Target - A text story addressed through its slide and owning shape.
- Story
Text - One story’s projected text.
- Table
Receipt - Text
Field - The story offsets of one field result.
- Text
Guard - Refuses a step unless its target currently reads exactly
text. - Text
Paragraph Draft - Text
Range - A half-open range of story-local UTF-16 offsets.
- Text
Receipt - Text
RunDraft - Text
RunSnapshot - Text
Search Match - Story-local UTF-16 offsets.
- Text
Style - Text
Style Patch - Transform
Receipt - Update
Event
Enums§
- Comment
Flavor - Edit
Error - Edit
Failure Code - Edit
History - How an applied batch enters local undo history.
- Edit
Origin - Edit
Source - Who asked for a batch. Provenance only: it selects neither permissions nor history.
- Edit
Step - One batch step. Text steps stay inside one paragraph, except
formatTextandsetParagraphAlignment, which may span paragraphs of one story. - Edit
Target - What a failure, preview or receipt refers to.
- Proposal
Edit - Proposal
Error - Proposal
Text Change Kind - Shape
Kind - Table
Edit - Table
Insert Position - Target
Edge - Which end of a target an insertion goes to.
- Text
Caps a:rPr/@cap: how a run is cased when drawn. Display only — the stored text keeps the author’s casing.- Text
Target - The text a step addresses.
- Undo
Capture Mode - Policy for grouping tracked local transactions.
- Update
Origin
Constants§
- MAX_
REQUEST_ BYTES - Largest request a read, search or batch accepts, measured as JSON.
- MAX_
SAFE_ CLIENT_ ID - MAX_
UPDATE_ BYTES
Functions§
- outcome_
json - JSON of a policy outcome: the success body or the refusal, tagged with
ok. - oversized_
request - The refusal for a JSON request longer than
MAX_REQUEST_BYTES, before decoding it.