@sobree/core 0.1.20 → 0.1.22

package/dist/docx/import/anchoredFrames.d.ts

@@ -36,3 +36,24 @@ export interface AnchoredFramesContext {
  * stable across re-imports of the same source.
  */
 export declare function parseAnchoredFrames(xmlDoc: Document, ctx: AnchoredFramesContext, claim?: boolean): AnchoredFrame[];
+/**
+ * Parse FLOATING legacy-VML objects — `<w:pict>` / `<w:object>` whose
+ * `<v:shape style="position:absolute;…">` pins them to page/margin
+ * coordinates (watermarks, full-page decorative backgrounds, logos
+ * placed by absolute position). DrawingML anchors are handled by
+ * `parseAnchoredFrames`; this is the VML-era equivalent and returns the
+ * same `AnchoredFrame` model, so the renderer is oblivious to the
+ * source format.
+ *
+ * ONLY floating VML is claimed here — gated on `position:absolute`.
+ * An INLINE VML picture (an OLE logo sitting in the text flow) has no
+ * such style; it stays in flow and `runs.ts` reads it as a `DrawingRun`.
+ * That distinction is what stops a header watermark from inflating the
+ * header's flow height (and shoving the body off the page) while
+ * leaving ordinary inline VML images untouched.
+ *
+ * Behind-text when the shape's `z-index` is negative (Word's "behind
+ * text" wrap). Claims (removes) the container so the body / flow walker
+ * never double-renders it.
+ */
+export declare function parseVmlFloatingFrames(xmlDoc: Document, ctx: AnchoredFramesContext, claim?: boolean): AnchoredFrame[];