SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface Properties<C>

    The canonical, serializable shape of a font.

    This is the stored form and carries exactly one spelling per concept - there is no bold or italic property here, and no string/boolean shorthands. Update calls accept the more forgiving IStyledFont.Modifiers, which is normalized to this shape before it is stored.

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

    Type Parameters

    Hierarchy (View Summary)

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

    The character set the font was authored against, or null when the font does not name one.

    Purely a font-substitution hint - see IFont.Charset. Cell text is Unicode either way, so this does not change what a cell contains or, when the named family is installed, how it renders.

    color?: C

    The text color.

    extend?: boolean

    The effect extends or stretches out the text.

    Not rendered by Excel or SheetXL.

    fallbacks?: string[]

    A list of fonts and their fallbacks. These can also be provided in the fontFamily attribute but will be normalized to here.

    family?: string

    This can be set as a string using html values such as 'Arial 11pt' but will be resolved to a single font. Fallbacks and fontSize will be marshalled into their correct property.

    A font with a scheme of major or minor is a theme font and reports the theme's heading or body font; a font with no family of its own reports the theme body font.

    letterSpacing?: number

    Adds or removes additional spacing between the characters.

    outline?: boolean

    The effect draws the text as an outline.

    Not rendered by Excel or SheetXL.

    scheme?: IFont.Scheme

    The theme font this font refers to, if any. A major or minor scheme makes the font follow the theme's heading or body font, overriding family.

    shadow?: boolean

    The effect draws a shadow around the text.

    Not rendered by Excel or SheetXL.

    size?: number

    Font size is either a number in points or a string that can be converted such as '14px', '1.5em'.

    strike?: boolean

    The effect draws the text with a line through it.

    style?: IFont.Style
    underline?: IFont.UnderlineStyle

    Sets the underline style. If true defaults to single. If false or null defaults to none.

    verticalAlign?: IFont.VerticalAlignment

    Returns the vertical alignment of the text within a text line.

    If the IFont.VerticalAlignment is superscript or subscript then the font size should also render smaller.

    weight?: number

    The numeric weight of the characters, 400 being normal and 700 bold.

    IStyledFont.getWeight

    Settings
    Member Visibility

    On This Page
    Properties