@squareys/webdecks-sdk - v0.0.0
    Preparing search index...

    Class Run

    A run: the maximal span of uniform formatting within a paragraph, addressed by its starting byte offset. Reads reflect the current model; formatting mutators chain.

    Hierarchy (View Summary)

    Index
    • get isValid(): boolean

      Whether this wrapper still refers to a live engine object.

      Returns boolean

    • set _index(value: number): void

      Parameters

      • value: number

      Returns void

    • get paragraph(): number

      The run's paragraph index.

      Returns number

    • get start(): number

      The byte offset of the run's first character within its paragraph.

      Returns number

    • get end(): number

      The exclusive byte offset where the run ends.

      Returns number

    • get format(): number

      The run's character-format bitmask (see TextFormat).

      Returns number

    • get color(): number

      The run's color as packed 0xRRGGBBAA, or 0 for the default body color.

      Returns number

    • get fontFamilyId(): number

      The run's font-family registry id (0 = the base font).

      Returns number

    • get fontFamily(): string

      The run's font-family display name ("" for the base font, or in a headless host that has no renderer registry). Resolved live from Run.fontFamilyId.

      Returns string

    • get fontSizePixels(): number

      The run's effective em size in pixels at 96dpi.

      Returns number

    • Reference equality is the identity test — prefer a === b. This is retained only for the rare cross-realm case where two wrappers describe the same handle by value. Reads the raw index so comparing a stale wrapper never throws.

      Parameters

      • other: Handle<unknown> | null

      Returns boolean

    • A readable identity for logs and diagnostics, never [object Object].

      Returns string

    • Select this run's byte range, so a following selection-scoped edit targets it.

      Returns this

    • Set the run's color as packed 0xRRGGBBAA, preserving its format and size.

      Parameters

      • rgba: number

      Returns this

    • Set the run's font size in pixels at 96dpi, preserving its format and color.

      Parameters

      • fontSizePixels: number

      Returns this

    • Apply absolute character formatting over the run's range. Any field left out keeps the run's current value.

      Parameters

      • properties: { format?: number; color?: number; fontSizePixels?: number }

      Returns this

    • Adjust the run's micro-typography: letter tracking and vertical shift in pixels, horizontal scale as a percentage.

      Parameters

      • tracking: number
      • positionShift: number
      • scalePercent: number

      Returns this