This is a figure type used in Stencila Schema, analogous to figure containers in HTML, JATS, and scholarly publishing systems.

It extends CreativeWork so figures can carry rich metadata, authorship, captions, and provenance, while also adding document-oriented support for multi-panel layout and SVG overlays. This makes it suitable for executable and annotated figures, not just static media wrappers.

Key properties include content, caption, label, layout, padding, and overlay. Additional metadata and provenance features are inherited from CreativeWork.

Analogues

The following external types, elements, or nodes are similar to a Figure:

HTML <figure>: Closest HTML analogue for self-contained figure content with captions.

JATS <fig>: Closest JATS analogue for figures in scholarly publishing.

Pandoc Figure: Close Pandoc analogue for captioned figure content, though Stencila additionally supports panel layout and SVG overlay annotations.

MDAST Image: Only an approximate Markdown AST analogue; plain MDAST images do not model multi-block figure content, panels, or overlays.

Properties

The Figure type has these properties:

Name	Description	Type	Inherited from
`label`	A short label for the figure.	`String`	-
`labelAutomatically`	Whether the label should be automatically updated.	`Boolean`	-
`caption`	A caption for the figure.	`Block`*	-
`layout`	Layout for arranging content blocks in a multi-panel figure. When absent, content blocks stack vertically with no grid.	`String`	-
`padding`	Padding around the figure's content area in pixel units. Creates whitespace where overlay annotations can be placed outside the image bounds. Accepts 1, 2, or 4 space-separated values following CSS shorthand order (all, vertical/horizontal, or top/right/bottom/left).	`String`	-
`overlay`	An optional SVG overlay rendered on top of the figure's content. The SVG is positioned absolutely over the content area and scales proportionally using the SVG viewBox. Used for annotations such as arrows, callouts, bounding boxes, and labels.	`String`	-
`overlayCompiled`	The compiled SVG overlay with all custom elements expanded to standard SVG. Generated during compilation from the overlay source. When present, renderers use this instead of overlay.	`String`	-
`compilationDigest`	A digest of the `overlay` property.	`CompilationDigest`	-
`compilationMessages`	Messages generated while compiling the overlay.	`CompilationMessage`*	-
`content`	The content of the figure.	`Block`*	-
`workType`	The type of `CreativeWork` (e.g. article, book, software application).	`CreativeWorkType`	`CreativeWork`
`doi`	The work's Digital Object Identifier (https://doi.org/).	`String`	`CreativeWork`
`about`	The subject matter of the content.	`ThingVariant`*	`CreativeWork`
`abstract`	A short description that summarizes a `CreativeWork`.	`Block`*	`CreativeWork`
`authors`	The authors of the `CreativeWork`.	`Author`*	`CreativeWork`
`provenance`	A summary of the provenance of the content within the work.	`ProvenanceCount`*	`CreativeWork`
`contributors`	A secondary contributor to the `CreativeWork`.	`Author`*	`CreativeWork`
`editors`	People who edited the `CreativeWork`.	`Person`*	`CreativeWork`
`maintainers`	The maintainers of the `CreativeWork`.	(`Person` \| `Organization`)*	`CreativeWork`
`comments`	Comments about this creative work.	`Comment`*	`CreativeWork`
`dateCreated`	Date/time of creation.	`DateTime`	`CreativeWork`
`dateReceived`	Date/time that work was received.	`DateTime`	`CreativeWork`
`dateAccepted`	Date/time of acceptance.	`DateTime`	`CreativeWork`
`dateModified`	Date/time of most recent modification.	`DateTime`	`CreativeWork`
`datePublished`	Date of first publication.	`DateTime`	`CreativeWork`
`funders`	People or organizations that funded the `CreativeWork`.	(`Person` \| `Organization`)*	`CreativeWork`
`fundedBy`	Grants that funded the `CreativeWork`; reverse of `fundedItems`.	(`Grant` \| `MonetaryGrant`)*	`CreativeWork`
`genre`	Genre of the creative work, broadcast channel or group.	`String`*	`CreativeWork`
`keywords`	Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas.	`String`*	`CreativeWork`
`isPartOf`	An item or other CreativeWork that this CreativeWork is a part of.	`CreativeWorkVariant`	`CreativeWork`
`licenses`	License documents that applies to this content, typically indicated by URL, but may be a `CreativeWork` itself.	(`CreativeWorkVariant` \| `String`)*	`CreativeWork`
`parts`	Elements of the collection which can be a variety of different elements, such as Articles, Datatables, Tables and more.	`CreativeWorkVariant`*	`CreativeWork`
`publisher`	A publisher of the CreativeWork.	`Person` \| `Organization`	`CreativeWork`
`bibliography`	A bibliography of references which may be cited in the work.	`Bibliography`	`CreativeWork`
`references`	References to other creative works, such as another publication, web page, scholarly article, etc.	`Reference`*	`CreativeWork`
`text`	The textual content of this creative work.	`Text`	`CreativeWork`
`title`	The title of the creative work.	`Inline`*	`CreativeWork`
`repository`	URL of the repository where the un-compiled, human readable source of the work is located.	`String`	`CreativeWork`
`path`	The file system path of the source of the work.	`String`	`CreativeWork`
`commit`	The commit hash (or similar) of the source of the work.	`String`	`CreativeWork`
`version`	The version of the creative work.	`String` \| `Number`	`CreativeWork`
`alternateNames`	Alternate names (aliases) for the item.	`String`*	`Thing`
`description`	A description of the item.	`String`	`Thing`
`identifiers`	Any kind of identifier for any kind of Thing.	(`PropertyValue` \| `String`)*	`Thing`
`images`	Images of the item.	`ImageObject`*	`Thing`
`name`	The name of the item.	`String`	`Thing`
`url`	The URL of the item.	`String`	`Thing`
`id`	The identifier for this item.	`String`	`Entity`

The Figure type is related to these types:

Parents: CreativeWork

Children: none

Bindings

The Figure type is represented in:

JSON-LD

JSON Schema

Python class Figure

Rust struct Figure

TypeScript class Figure

Testing

During property-based (a.k.a generative) testing, the properties of the Figure type are generated using the following strategies.

Property	Complexity	Description	Strategy
`label`	Min+	No label	`None`
	Low+	Generate a simple label	`option::of(r"[a-zA-Z0-9]+")`
	Max	Generate an arbitrary string	`option::of(String::arbitrary())`
`caption`	Min+	No caption	`None`
	Low+	Generate up to two arbitrary paragraphs.	`option::of(vec_paragraphs(2))`
	Max	Generate up to three arbitrary, non-recursive, block nodes.	`option::of(vec_blocks_non_recursive(3))`
`content`	Min+	Generate a single arbitrary block image object.	`vec_blocks_image_object(1)`
	Low+	Generate up to two arbitrary, non-recursive, block nodes (excluding code chunks).	`vec_blocks_figure_content(2)`
	Max	Generate up to four arbitrary, non-recursive, block nodes.	`vec_blocks_non_recursive(4)`

This documentation was generated from Figure.yaml by docs_types.rs.

Analogues

Properties

Related

Bindings

Testing