VMPrint API Reference - v1.0.0
    Preparing search index...

    Interface Element

    interface Element {
        balance?: boolean;
        children?: Element[];
        columns?: number;
        columnSpan?: number | "all";
        content: string;
        dropCap?: DropCapSpec;
        gutter?: number;
        image?: EmbeddedImagePayload;
        name?: string;
        placement?: StoryLayoutDirective;
        properties?: ElementProperties;
        slots?: StripSlot[];
        stripLayout?: StripLayoutOptions;
        table?: TableLayoutOptions;
        type: string;
        zoneLayout?: ZoneLayoutOptions;
        zones?: ZoneDefinition[];
    }
    Index

    Properties

    balance? children? columns? columnSpan? content dropCap? gutter? image? name? placement? properties? slots? stripLayout? table? type zoneLayout? zones?

    Properties

    balance?: boolean

    When true, column height is set to ceil(totalContentHeight / columns) so content distributes evenly across all columns instead of packing into the first column (CSS column-fill: balance semantics). Only meaningful for type: "story" with columns > 1.

    children?: Element[]
    columns?: number

    Story-level multi-column count (only meaningful for type: "story").

    columnSpan?: number | "all"

    Story-local full-width span directive.

    content

    content: string
    dropCap?: DropCapSpec

    Drop-cap configuration.

    gutter?: number

    Story-level inter-column gap in points (only for type: "story").

    image?: EmbeddedImagePayload

    Embedded image payload. Required on type: "image" elements.

    name?: string
    placement?: StoryLayoutDirective

    Story-local placement directive. Declares how this element participates in a story's spatial layout — as a float anchored to the text cursor, or as an absolutely positioned element pinned within the story area. Only meaningful for direct children of a story element.

    properties?: ElementProperties
    slots?: StripSlot[]

    Strip slots. Each entry is an independent compact region in a one-row horizontal composition band. Only meaningful for type: "strip".

    stripLayout?: StripLayoutOptions

    Strip track model. Preferred on AST 1.1+.

    table?: TableLayoutOptions

    Table layout model. Required on type: "table" elements.

    type: string
    zoneLayout?: ZoneLayoutOptions

    Zone-map layout model. Preferred on AST 1.1+.

    zones?: ZoneDefinition[]

    Zone-map spatial regions. Each entry is an independent layout context (a room on the map). Only meaningful for type: "zone-map". Column widths and gap are declared in zoneLayout.

    Settings

    Member Visibility

    On This Page

    Properties