Interface DrawingText

The text a drawing carries, and how it is set. The text tool is this box; a shape (rectangle, channel, callout) carries one as its label.

Kept apart from DrawingStyle because the two answer different questions: style is how the outline is stroked, text is what the label says and how it is typeset. A purple rectangle with white bold text is one shape with two colours, and a settings panel wants them on different tabs.

interface DrawingText {
    align?: "center" | "left" | "right";
    background?: boolean;
    backgroundColor?: string;
    backgroundOpacity?: number;
    bold?: boolean;
    border?: boolean;
    borderColor?: string;
    color?: string;
    fontFamily?: string;
    fontSize?: number;
    italic?: boolean;
    position?: "inside" | "outside";
    valign?: "bottom" | "middle" | "top";
    value: string;
    wrap?: boolean;
    wrapWidth?: number;
}

Properties

align? background? backgroundColor? backgroundOpacity? bold? border? borderColor? color? fontFamily? fontSize? italic? position? valign? value wrap? wrapWidth?

Properties

Optionalalign

align?: "center" | "left" | "right"

Horizontal alignment within the box. Default 'left'.

Optionalbackground

background?: boolean

Draw a filled plate behind the text.

OptionalbackgroundColor

backgroundColor?: string

OptionalbackgroundOpacity

backgroundOpacity?: number

Plate opacity, 0..1. Default 1: a text background is usually opaque.

Optionalbold

bold?: boolean

Optionalborder

border?: boolean

Stroke a border around the plate.

OptionalborderColor

borderColor?: string

Optionalcolor

color?: string

Falls back to style.color.

OptionalfontFamily

fontFamily?: string

CSS font stack. Defaults to the UI sans-serif stack.

OptionalfontSize

fontSize?: number

Media px. Default 12.

Optionalitalic

italic?: boolean

Optionalposition

position?: "inside" | "outside"

Where a shape's label sits relative to the shape: inside the outline, or outside just above it. Shapes only; the text tool is its own box.

Optionalvalign

valign?: "bottom" | "middle" | "top"

Vertical placement within the box. Default 'top'.

value

value: string

Body text. \n starts a new line; see wrap for soft wrapping.

Optionalwrap

wrap?: boolean

Soft-wrap at wrapWidth instead of running off the pane.

OptionalwrapWidth

wrapWidth?: number

Wrap width in media px. Default 220.

Settings

Member Visibility

On This Page

Properties