SheetXL - v1.0.2
    Preparing search index...

    Interface Properties<C>

    The stored shape of a text style.

    One spelling per concept: bold is a weight, italic a style, a theme font a ThemeFamily in family. Updates accept the more forgiving Update, which is normalized to this before it is stored.

    interface Properties<C = Serializable> {
        baseline?: number;
        charset?: number;
        color?: C;
        fallbacks?: string[];
        family?: string;
        letterSpacing?: number;
        outline?: boolean;
        shadow?: boolean;
        size?: number;
        strike?: IFont.StrikeStyle;
        style?: IFont.Style;
        underline?: IFont.UnderlineStyle;
        weight?: number;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index
    baseline? charset? color? fallbacks? family? letterSpacing? outline? shadow? size? strike? style? underline? weight?
    baseline?: number

    Returns how far the text is raised, as a percentage of its size: positive for superscript, negative for subscript, 0 on the baseline.

    charset?: number

    The character set the font was authored against, a font-substitution hint.

    An opaque passthrough. The model carries the value so it survives a round trip and never interprets it.

    color?: C

    Returns the text color.

    fallbacks?: string[]

    Returns the families drawn when IFontStyle.getFamily cannot draw a character, in order.

    family?: string

    A family name, or a ThemeFamily.

    letterSpacing?: number

    Returns the space added between characters, in points; 0 for none, negative to condense.

    outline?: boolean

    An opaque passthrough, not drawn. The model carries the value so it survives a round trip.

    shadow?: boolean

    An opaque passthrough, not drawn. The model carries the value so it survives a round trip.

    size?: number

    Returns the size in points.

    strike?: IFont.StrikeStyle

    Returns how the text is struck through; 'none' when it is not.

    style?: IFont.Style

    italic or normal.

    underline?: IFont.UnderlineStyle

    Returns how the text is underlined; 'none' when it is not.

    weight?: number

    Returns the weight, 400 being regular and 700 bold.

    Settings
    Member Visibility

    On This Page
    Properties