Interface IStyle

ReadonlyisIStyle

createTemporaryStyle

• createTemporaryStyle(update: IStyle.Update): IStyle

  Allows for a non managed style. Useful for tooltips or other transient styles.

  Parameters

  • update: IStyle.Update

    Adjustments to the style.

  Returns IStyle

createTemporaryTextFrame

• createTemporaryTextFrame(text: string, allowWrap?: boolean): ITextFrame

  Creates a simple text frame that can be used for rendering and/or measuring.

  Parameters

  • text: string
  • OptionalallowWrap: boolean

    If true then will try to wrap on natural breaks.

  Returns ITextFrame

getAlignment

• getAlignment(): ITextBoxAlignment

  Returns the alignment for the style.

  Returns ITextBoxAlignment

getBestFit

• getBestFit(): Partial<Dimensions>

  Returns the best fit size assuming no content.

  Returns Partial<Dimensions>

getBorder

• getBorder(): IBorder

  Returns the border style.

  Returns IBorder

getFill

• getFill(): INone | ISolid | IGradient | IPattern

  Fill properties for the background.

  Returns INone | ISolid | IGradient | IPattern

getFont

• getFont(): IStyledFont

  Returns the font for the style.

  Returns IStyledFont

getInsets

• getInsets(): Rectangle

  Returns insets used for content. This does not taking into account indent because this is alignment and type specific.

  Returns Rectangle

getNamed

• getNamed(): IStyle.INamed

  Returns an instance of the named style that this is derived from.

  Returns IStyle.INamed

getNumberFormat

• getNumberFormat(): string

  Format used for Number formatting:

  • https://docs.microsoft.com/en-us/dotnet/api/documentformat.openxml.spreadsheet.numberingformats?view=openxml-2.8.1
  • https://customformats.com/

  Returns string

  Remarks

  • If a number provided the builtIn numFmtId as defined in OOXML will be used.

  • NumberFormat.Type

getQuotePrefix

• getQuotePrefix(): boolean

  A boolean value indicating whether the text string in a cell should be prefixed by a single quote mark (e.g., 'text). In these cases, the quote is not stored in the Shared Strings Part.

  Returns boolean

hasVisibleStyling

• hasVisibleStyling(): boolean

  This is used to determine if the style has rendering artifacts even if there is no content. (For example borders or background)

  Returns boolean

isNormal

• isNormal(): boolean

  Returns true if the CellStyle is the normal style

  Returns boolean

measureText

• measureText(
      text: string,
      size?: number,
      family?: string,
      options?: MetricOptions,
  ): ExtendedMetrics

  Measure the text using the styling properties

  Parameters

  • text: string

    The text to measure.
  • Optionalsize: number

    Size
  • Optionalfamily: string

    Family
  • Optionaloptions: MetricOptions

    Options for the measurement.

  Returns ExtendedMetrics

  Default Value

  'to the cell font.size'
  Copy

  Default Value

  'to the cell font.family'
  Copy