API Reference › core-common› Annotation › Paragraph

Paragraph Class @beta

A collection of Runs and Lists. Paragraphs can be appended to Lists and TextBlocks. Each paragraph is laid out on a separate line. If included in a List, the paragraph will be treated as a list item.

Extends

Methods

Name Description
clearStyleOverrides(options?: ClearTextStyleOptions): void Reset any styleOverrides applied to this component.  
clone(): Paragraph Create a deep copy of this component.  
equals(other: TextBlockComponent): boolean Returns true if this is equivalent to other.  
stringify(options?: TextBlockStringifyOptions, context?: TextBlockStringifyContext): string Compute a string representation of this paragraph by concatenating the string representations of all of its children.  
toJSON(): ParagraphProps Convert this component to its JSON representation.  
create(props?: Omit<ParagraphProps, "type">): Paragraph Static Create a paragraph from its JSON representation.  

Properties

Name Type Description
children Readonly List | Run[]    
isEmpty Accessor ReadOnly boolean Returns true if this component has no content or children.  
type Readonly "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.
For example, if the style uses the "Arial" font, you can override that by settings styleOverrides.font.name to "Comic Sans".

Defined in

Last Updated: 07 October, 2025