Paragraph Class @beta
A collection of Runs within a TextBlock. Each paragraph within a text block is laid out on a separate line.
Extends
Methods
| Name | Description | |
|---|---|---|
| clearStyleOverrides(options?: ClearTextStyleOptions): void | Clears any styleOverrides applied to this Paragraph. | |
| clone(): Paragraph | Create a deep copy of this component. | |
| equals(other: TextBlockComponent): boolean | Returns true if this is equivalent to other. |
|
| stringify(options?: TextBlockStringifyOptions): string | Compute a string representation of this paragraph by concatenating the string representations of all of its runs. | |
| toJSON(): ParagraphProps | Convert this component to its JSON representation. | |
| create(props?: ParagraphProps): Paragraph Static | Create a paragraph from its JSON representation. |
Properties
| Name | Type | Description | |
|---|---|---|---|
| runs Readonly | Run[] | The runs within the paragraph. |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| isWhitespace Accessor Inherited ReadOnly | boolean | TextBlockComponent | Returns true if the string representation of this component consists only of whitespace characters. Useful for checking if the component is visually empty (producing no graphics) or contains only spaces, tabs, or line breaks. |
| overridesStyle Accessor Inherited ReadOnly | boolean | TextBlockComponent | Returns true if styleOverrides specifies any deviations from the TextBlock's AnnotationTextStyle. |
| styleOverrides Accessor Inherited | TextStyleSettingsProps | TextBlockComponent | Deviations in individual properties of the TextStyleSettings in the AnnotationTextStyle specified by styleId on the TextBlock.For example, if the style uses the "Arial" font, you can override that by settings styleOverrides.fontName to "Comic Sans". |
Defined in
Last Updated: 29 July, 2025
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.