TabRun Class @beta

A TabRun is used to shift the next tab stop.

@note Only left-justified tabs are supported at this tab.

Extends

• TextBlockComponent

Methods

Name	Description
clone(): TabRun	Create a deep copy of this component.
equals(other: TextBlockComponent): boolean	Returns true if this is equivalent to other.
stringify(options?: TextBlockStringifyOptions): string	Converts a TabRun to its string representation.
toJSON(): TabRunProps	Convert this component to its JSON representation.
create(props: Omit<TabRunProps, "type">): TabRun Static

Inherited methods

Name	Inherited from	Description
applyStyle(styleName: string, options?: ApplyTextStyleOptions): void Inherited	TextBlockComponent	Apply the TextStyle specified by styleName to this component, optionally preserving styleOverrides and/or preventing propagation to sub-components.
clearStyleOverrides(): void Inherited	TextBlockComponent	Reset any styleOverrides applied to this component's TextStyle.

Properties

Name	Type	Description
type Readonly	"tab"	Discriminator field for the Run union.

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 this component's base TextStyle.
styleName Accessor Inherited	string	TextBlockComponent	The name of the TextStyle that provides the base formatting for the contents of this component.
styleOverrides Accessor Inherited	TextStyleSettingsProps	TextBlockComponent	Deviations in individual properties of the TextStyle specified by styleName. For example, if the style uses the "Arial" font, you can override that by settings styleOverrides.fontName to "Comic Sans".

Defined in

• core/common/src/annotation/TextBlock.ts Line 368