Flow
Flow
概述
Flow 是 Aspose.PDF FOSS 中用于 TypeScript 的一个类。
一个流式布局容器。
此类在 TypeScript 程序中为 Flow 对象声明了 14 个方法。可用的方法包括:AddCodeBlock、AddColumnBreak、AddFloatBox、AddFloatingBox、AddHeading、AddImage、AddList、AddMarkdown、AddParagraph、AddQuote、AddRule、AddTable,以及另外 2 个方法。所有公共成员在安装 Aspose.PDF FOSS for TypeScript 包后,任何 TypeScript 应用程序均可访问。
方法
| 签名 | 描述 |
|---|---|
constructor(doc: Document, options: FlowOptions) | 在此 Flow 实例上调用构造函数 constructor(doc, options)。 |
AddParagraph(text: FlowText, options: FlowParagraphOptions) → this | 追加一个自动换行的段落。 |
AddHeading(level: number, text: FlowText, options: FlowHeadingOptions) → this | 追加一个自动换行的标题。 |
AddList(items: FlowListNode[], options: FlowListOptions) → this | 追加一个项目符号(默认)或编号({ ordered: true })列表。 |
AddImage(data: Uint8Array, options: FlowImageOptions) → this | 将光栅图像(JPEG/PNG)追加为其独立的流块。 |
AddRule(options: FlowRuleOptions) → this | 追加水平分隔线 — 一个章节分隔符,以及 Markdown 的主题分隔。 |
AddCodeBlock(text: string, options: FlowCodeOptions) → this | 追加预格式化代码块。 |
AddQuote(blocks: FlowElement[], options: FlowQuoteOptions) → this | 追加块引用:将给定的元素缩进显示在栏杆后面。 |
AddTable(t: TableBuilder, options: FlowTableOptions) → this | 在使用 createTable 构建的表格后追加,按行在列和页面之间分页。 |
| `AddMarkdown(src: string | MdDocument, options: MarkdownFlowOptions)→MarkdownResult` |
AddColumnBreak() → this | 强制以下内容在下一列开始(如果在最后一列则在下一页开始)。 |
| `AddFloatBox(box: FloatingBox, side: ’left' | ‘right’)→this` |
AddFloatingBox(box: FloatingBox, options: FlowBoxOptions) → this | 将 box 放置在正文流中——如摘录、提示框或公式卡。 |
Render() → Page[] | 布局排队的内容,将新页面追加到文档末尾,并按顺序返回这些页面。 |