API Reference › core-common› Annotation › TextStyleSettingsProps

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.  
fontName string | undefined The name of a 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.  
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.  
leader TextLeaderStyleProps | undefined Properties describing appearance of leaders in a TextAnnotation  
lineHeight number | undefined The height each line of text, in meters.  
lineSpacingFactor number | undefined Multiplier used to compute the vertical distance between two lines 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.  
widthFactor number | undefined A scale applied to the width of each glyph.  

Defined in

Last Updated: 29 July, 2025