kslides-core/com.kslides/DiagramDescription

DiagramDescription

class DiagramDescription : DiagramConfig

Receiver for diagram blocks. Extends DiagramConfig so you can override size, style, and output format in the same block that sets source.

Constructors

DiagramDescription

constructor()

Types

object Companion

Properties

var height: String

height attribute on the emitted <img>. Blank omits the attribute.

var options: Map<String, Any>

Per-diagram-type options forwarded to Kroki as diagram_options. See the Kroki docs for the keys each diagram type supports.

var outputType: DiagramOutputType

Image format requested from Kroki. Defaults to DiagramOutputType.SVG.

var source: String

diagram source text in the language matching the diagramType passed to diagram (e.g. PlantUML, Mermaid, Graphviz DOT).

var style: String

Inline CSS applied to the emitted <img>.

var title: String

Accessible title text (shown as tooltip and read by screen readers).

var width: String

width attribute on the emitted <img>. Blank omits the attribute.

Functions

open fun merge(other: AbstractConfig)

Merge other into this config in place: every entry from other's two maps is copied into this config's maps, with later puts overwriting earlier keys. This is how the global → presentation → slide cascade resolves (parent merged first, then child).

open fun revealjsOption(key: String, value: Any)

Set a raw reveal.js config option by key for options kslides does not expose as a typed property (e.g. the menu plugin's themes array). The value is emitted verbatim into the Reveal.initialize({...}) call and participates in the config cascade like any other option. Prefer the typed properties where they exist.