Skip to content

API reference / Common / Engine types / TextUnderlineStyle

Type Alias: TextUnderlineStyle ​

ts
type TextUnderlineStyle = 
  | "none"
  | "single"
  | "double"
  | "singleAccounting"
  | "doubleAccounting"
  | "heavy"
  | "dotted"
  | "dottedHeavy"
  | "dash"
  | "dashHeavy"
  | "dashLong"
  | "dashLongHeavy"
  | "dotDash"
  | "dotDashHeavy"
  | "dotDotDash"
  | "dotDotDashHeavy"
  | "wavy"
  | "wavyHeavy"
  | "wavyDouble"
  | "words";

The underline pattern (ST_TextUnderlineType / ST_Underline).

None is an explicit no-underline (distinct from an unspecified [TextCharacterProperties::underline], which is None on the Option) — it overrides an inherited underline.