Class FontSettings

Style class for describing a font.

Instances of FontSettings, like all LCJS style classes, are immutable, meaning that its setters don't modify the actual object, but instead return a completely new modified object.

Properties of FontSettings:

FontSettings usage:

Use FontSettings with:

 // Example 1, set chart title font with explicit font.
 ChartXY.setTitleFont(new FontSettings({
     size: 20,
     family: 'Arial, Helvetica, sans-serif',
     weight: 'bold',
     style: 'italic'
 }))

 // Example 2, override chart title font, specifying only a sub-set of properties.
 ChartXY.setTitleFont((font) => font
     .setSize(20)
 )

Hierarchy

  • FontSettingsRecord
    • FontSettings

Constructors

constructor

Properties

family size style type variant weight

Methods

getFamily getSize getStyle getVariant getWeight setFamily setSize setStyle setVariant setWeight

Constructors

constructor

  • Construct a FontSettings object, specifying any amount of its properties.

     // Example,
     const font = new FontSettings({
         size: 20,
         family: 'Arial, Helvetica, sans-serif',
         weight: 'bold',
         style: 'italic',
     })

    Parameters

    • Optional props: Partial<FontProperties>

      Object containing any amount of SolidFill properties.

    Returns FontSettings

Properties

Readonly family

family: string

CSS font family, or list of font families.

For example, 'Arial, Helvetica, sans-serif'.

Readonly size

size: number

CSS font size.

For example, 16.

Readonly style

style: FontStyle

CSS font style.

For example, 'italic'

Readonly type

type: "font"

Readonly variant

variant: boolean

CSS font variant.

true = 'small-caps', false = 'normal'.

Readonly weight

weight: FontWeight

CSS font weight.

For example, 'bold'.

Methods

getFamily

  • Get font family.

    CSS font family, or list of font families.

    For example, 'Arial, Helvetica, sans-serif'.

    Returns

    Font family.

    Returns string

getSize

  • Get font size.

    CSS font size.

    For example, 16.

    Returns

    Font size.

    Returns number

getStyle

getVariant

  • Get font variant.

    CSS font variant.

    true = 'small-caps', false = 'normal'.

    Returns

    Font variant.

    Returns boolean

getWeight

setFamily

  • Create new FontSettings object with different family.

    CSS font family, or list of font families.

    For example, 'Arial, Helvetica, sans-serif'.

    Returns

    New FontSettings object.

    Parameters

    • family: string

      Font family or list of families.

    Returns FontSettings

setSize

  • Create new FontSettings object with different size.

    CSS font size.

    For example, 16.

    Returns

    New FontSettings object.

    Parameters

    • size: number

      Font size.

    Returns FontSettings

setStyle

setVariant

  • Create new FontSettings object with different variant.

    CSS font variant.

    true = 'small-caps', false = 'normal'

    Returns

    New FontSettings object.

    Parameters

    • smallCaps: boolean

    Returns FontSettings

setWeight

Settings

Member Visibility

Theme