Skip to content

API reference / Common / Engine types / TextFloatingWrap

Type Alias: TextFloatingWrap ​

ts
type TextFloatingWrap = 
  | "none"
  | {
  square: {
     side: TextFloatingWrapSide;
  };
}
  | {
  tight: {
     side: TextFloatingWrapSide;
     polygon: TextFloatingWrapPolygon;
  };
}
  | {
  through: {
     side: TextFloatingWrapSide;
     polygon: TextFloatingWrapPolygon;
  };
}
  | "topAndBottom";

What the text does around a floating drawing — the file's five wrap elements, which are a choice of exactly one.

Each kind carries only what is its own: which sides text runs down, and the contour it follows. The clearance each kind may also restate — and the effect extent beside it — folds into the drawing's distance and effect_extent on import: they mean the same thing in both places, and an editor that had two copies would have to pick one to write.