@jsfkit/types
    Preparing search index...

    Type Alias Style

    Style rules that specify the visual presentation of a cell.

    type Style = {
        bold?: boolean;
        borderBottomColor?: Color;
        borderBottomStyle?: BorderStyle;
        borderLeftColor?: Color;
        borderLeftStyle?: BorderStyle;
        borderRightColor?: Color;
        borderRightStyle?: BorderStyle;
        borderTopColor?: Color;
        borderTopStyle?: BorderStyle;
        color?: Color;
        extendsStyle?: string;
        fillColor?: Color;
        fontFamily?: string;
        fontScheme?: "major" | "minor";
        fontSize?: PixelValue;
        horizontalAlignment?: HAlign;
        italic?: boolean;
        numberFormat?: string;
        patternColor?: Color;
        patternStyle?: PatternStyle;
        pivotButton?: boolean;
        shrinkToFit?: boolean;
        textRotation?: integer;
        underline?: Underline;
        verticalAlignment?: VAlign;
        wrapText?: boolean;
    }
    Index

    Properties

    bold? borderBottomColor? borderBottomStyle? borderLeftColor? borderLeftStyle? borderRightColor? borderRightStyle? borderTopColor? borderTopStyle? color? extendsStyle? fillColor? fontFamily? fontScheme? fontSize? horizontalAlignment? italic? numberFormat? patternColor? patternStyle? pivotButton? shrinkToFit? textRotation? underline? verticalAlignment? wrapText?

    Properties

    bold?: boolean

    Indicates whether the text is bold.

    false // For cell styles only. No default for differential styles.
    borderBottomColor?: Color

    Bottom border color.

    borderBottomStyle?: BorderStyle

    Bottom border style.

    "none" // For cell styles only. No default for differential styles.
    borderLeftColor?: Color

    Left border color.

    borderLeftStyle?: BorderStyle

    Left border style.

    "none" // For cell styles only. No default for differential styles.
    borderRightColor?: Color

    Right border color.

    borderRightStyle?: BorderStyle

    Right border style.

    "none" // For cell styles only. No default for differential styles.
    borderTopColor?: Color

    Top border color.

    borderTopStyle?: BorderStyle

    Top border style.

    "none" // For cell styles only. No default for differential styles.
    color?: Color

    The color used to render text.

    "#000" // For cell styles only. No default for differential styles.
    extendsStyle?: string

    Name of the named style this style inherits from (e.g. "Percent", "Heading 1"). Refers to a key in Workbook.namedStyles. When absent, the style inherits from the default style (typically "Normal").

    fillColor?: Color

    The cell's background color.

    "#FFFFFF" // For cell styles only. No default for differential styles.
    fontFamily?: string

    The name of the font family used to render text, e.g. "Arial".

    "Calibri" // For cell styles only. No default for differential styles.
    fontScheme?: "major" | "minor"

    Identifies the font scheme, if any, to which this style's font belongs.

    When set, the Style.fontFamily property is ignored and the font is instead resolved by the workbook theme. "major" maps to the theme's heading font and "minor" to the body font. The actual typeface is determined by the theme's ThemeFontCollection at render time.

    When the theme changes, an application is expected to update the fonts associated with a scheme automatically.

    It is an error to set this when a workbook has no theme.

    fontSize?: PixelValue

    The font size in pixels.

    11 // For cell styles only. No default for differential styles.
    horizontalAlignment?: HAlign

    Horizontal alignment of the cells [text] content.

    "general" // For cell styles only. No default for differential styles.
    italic?: boolean

    Indicates whether the text is italic.

    false // For cell styles only. No default for differential styles.
    numberFormat?: string

    Formatting directions for rendering the cell's value to text.

    patternColor?: Color

    The color of a cell's background fill.

    "#000000" // For cell styles only. No default for differential styles.
    patternStyle?: PatternStyle

    The style of a cell's background fill.

    "none" // For cell styles only. No default for differential styles.
    pivotButton?: boolean

    Whether the a cell should appear as a pivot-table button header (typically shown with a dropdown-arrow filter UI, e.g. on "Row Labels" / "Column Labels").

    Should be set only on cell styles used in a pivot table's layout.

    shrinkToFit?: boolean

    Indicates whether the font-size should be automatically reduced in order to make the contents of the cell visible.

    textRotation?: integer

    The degrees to which the cell text should be rotated. Values range from 0 to 180, and 255 to indicate vertical text. The origin of the rotation is the first letter of the text.

    0 // For cell styles only. No default for differential styles.
    underline?: Underline

    Text underline decoration type.

    "none" // For cell styles only. No default for differential styles.
    verticalAlignment?: VAlign

    Vertical alignment of the cells [text] content.

    "bottom" // For cell styles only. No default for differential styles.
    wrapText?: boolean

    Indicates whether text should be wrapped when it exceeds the cell's width.

    false // For cell styles only. No default for differential styles.

    Settings

    Member Visibility

    On This Page

    Properties