Interface: TextStyle
Styles specific to box annotations.
Extends
Extended by
Properties
authorStyle?
optional authorStyle: Partial<AuthorLineStyle>;Per-annotation override for the author line's appearance. Overrides the global ControllerOptions.authorStyle for this annotation only - same precedence pattern as placeholder vs ControllerOptions.textPlaceholder. Falls back to a small built-in default (DEFAULT_AUTHOR_STYLE in renderer/shapes/text.ts) for any field neither this nor the global option sets.
background?
optional background: string;background color: empty for transparent #f00, yellow...
borderRadius?
optional borderRadius: number;Text box border radius
boxShadow?
optional boxShadow: string;box shadow in CSS format, e.g. "0px 4px 6px rgba(0, 0, 0, 0.1)"
color?
optional color: string;text color: #f00, yellow...
fixedSize?
optional fixedSize: boolean;When true, text maintains constant size regardless of zoom level
font?
optional font: string;Helvetica, sans-serif...
fontScale?
optional fontScale: number;Accumulated multiplier applied to fontSize at render time: effectiveFontSize = fontSize * (fontScale ?? 1). Updated incrementally by TextHandler's corner/edge drag when scaleFontOnResize is true; absent (≡ 1) for every annotation that doesn't opt in.
fontSize?
optional fontSize: string | number;Font size, in pixels
fontWeight?
optional fontWeight: "normal" | "bold";Bold the rendered/edited text. Absent (≡ "normal") for every annotation that doesn't opt in - no italic, no other weights for v1.
padding?
optional padding: number;padding around the text
placeholder?
optional placeholder: string;Ghost text shown (via the textarea's native placeholder attribute) while content is empty - disappears the instant the user types, no selection/focus tricks needed. Overrides the global ControllerOptions.textPlaceholder for this annotation.
scaled?
optional scaled: boolean;if true, the box scales with zoom. Default is true
scaleFontOnResize?
optional scaleFontOnResize: boolean;Opt-in: when true, corner/edge-drag resize also updates fontScale, so the rendered font size scales with the box instead of the text rewrapping/truncating. Only set by defaultStickyNoteStyle.
showAuthor?
optional showAuthor: boolean;Whether to render properties.author as a one-line, ellipsis-truncated signature at the bottom of the box. Toggled by TextStyleToolbar's author-visibility cell. No-op when properties.author is unset or blank. Hidden (≡ false) by default.
strokeColor?
optional strokeColor: string;Stroke color: #f00, yellow...
strokeType?
optional strokeType: StrokeType;Type of stroke: plain, dashed, or none
strokeWidth?
optional strokeWidth: number;Stroke width