FractionRun Class @beta
A Run containing a numeric ratio to be displayed as a numerator and denominator separated by a horizontal or diagonal bar.
@note The numerator and denominator are stored as strings. They are not technically required to contain a numeric representation.
Extends
Methods
Name | Description | |
---|---|---|
clone(): FractionRun | Create a deep copy of this component. | |
equals(other: TextBlockComponent): boolean | Returns true if this is equivalent to other . |
|
stringify(options?: TextBlockStringifyOptions): string | Formats the fraction as a string with the numerator and denominator separated by fractionSeparator. | |
toJSON(): FractionRunProps | Convert this component to its JSON representation. | |
create(props?: Omit<FractionRunProps, "type">): FractionRun Static |
Inherited methods
Name | Inherited from | Description |
---|---|---|
clearStyleOverrides(_options?: ClearTextStyleOptions): void Inherited | TextBlockComponent | Reset any styleOverrides applied to this component. |
Properties
Name | Type | Description | |
---|---|---|---|
denominator | string | The fraction's denominator. | |
numerator | string | The fraction's numerator. | |
type Readonly | "fraction" | 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 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.