TextStyleSettingsProps Interface
Serves both as the JSON representation of a TextStyleSettings, and a way for a TextBlockComponent to selectively override aspects of a AnnotationTextStyle's properties.
Properties
Name | Type | Description | |
---|---|---|---|
color | TextStyleColor | undefined | The color of the text. | |
font | FontFamilySelector | undefined | The font stored in an iModel, used to draw the contents of a TextRun. | |
frame | TextFrameStyleProps | undefined | A description of the frame around the text annotation. | |
indentation | number | undefined | The offset (in meters) from the left edge of the text block to the start of the line of text. | |
isBold | boolean | undefined | Specifies whether the content of a TextRun should be rendered bold. | |
isItalic | boolean | undefined | Specifies whether the content of a TextRun should be rendered in italics. | |
isUnderlined | boolean | undefined | Specifies whether the content of a TextRun should be underlined. | |
justification | TextJustification | undefined | The alignment of the text content. | |
leader | TextLeaderStyleProps | undefined | Properties describing appearance of leaders in a TextAnnotation | |
lineSpacingFactor | number | undefined | Multiplier used to compute the vertical distance between two lines of text. | |
listMarker | ListMarker | undefined | The marker used to indicate the start of a list item. | |
margins | TextBlockMargins | undefined | The margins to surround the document content. | |
paragraphSpacingFactor | number | undefined | Multiplier used to compute the vertical distance between two paragraphs of text. | |
stackedFractionScale | number | undefined | Multiplier used to compute the height of both the numerator and denominator of a FractionRun. | |
stackedFractionType | StackedFractionType | undefined | Specifies how to separate the numerator and denominator of a FractionRun. | |
subScriptOffsetFactor | number | undefined | Multiplier used to compute the vertical offset from the baseline for a subscript TextRun. | |
subScriptScale | number | undefined | Multiplier used to compute the height of a subscript TextRun. | |
superScriptOffsetFactor | number | undefined | Multiplier used to compute the vertical offset from the baseline for a super TextRun. | |
superScriptScale | number | undefined | Multiplier used to compute the height of a superscript TextRun. | |
tabInterval | number | undefined | The size (in meters) used to calculate the tab stops in a run. | |
textHeight | number | undefined | The height of the text, in meters. | |
widthFactor | number | undefined | A scale applied to the width of each glyph. |
Defined in
Last Updated: 07 October, 2025
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.