Type Alias Modifiers<C>

Modifiers: Omit<IStyledFont.Properties<C>, "weight" | "underline"> & {
    bold?: boolean | null;
    italic?: boolean | null;
    underline?: boolean | IFont.UnderlineStyle | null;
    weight?: number | string;
}

The shape accepted by font updates - IStyledFont.Properties widened with shorthands and with convenience aliases for the properties that have a boolean spelling.

Type Parameters

C = Serializable

Type Declaration

Optionalbold?: boolean | null

Alias for IStyledFont.Properties.weight. true sets bold (700), false normal (400), null clears it. Ignored when weight is also supplied.

See
IStyledFont.setBold
Optionalitalic?: boolean | null

Alias for IStyledFont.Properties.style. true sets IFont.Style.Italic, false IFont.Style.Normal, null clears it. Ignored when style is also supplied.

See
IStyledFont.setItalic
Optionalunderline?: boolean | IFont.UnderlineStyle | null

The underline style. true is shorthand for IFont.UnderlineStyle.Single; false and null for IFont.UnderlineStyle.None.

See
IStyledFont.getUnderline
Optionalweight?: number | string

The weight of the characters, either numeric (400, 700) or a css keyword such as 'bold' or 'lighter'.

See
IStyledFont.getWeight

Remarks

Every key here is normalized onto a IStyledFont.Properties key before it is stored, so none of the widened forms survive into IStyledFont.JSON. An explicit canonical key wins when both it and its alias are supplied.

Type Alias Modifiers<C>

Type Parameters

Type Declaration

`Optional`bold?: boolean | null

See

`Optional`italic?: boolean | null

See

`Optional`underline?: boolean | IFont.UnderlineStyle | null

See

`Optional`weight?: number | string

See

Remarks

Settings

Type Alias Modifiers<C>

Type Parameters

Type Declaration

Optionalbold?: boolean | null

See

Optionalitalic?: boolean | null

See

Optionalunderline?: boolean | IFont.UnderlineStyle | null

See

Optionalweight?: number | string

See

Remarks

Settings

`Optional`bold?: boolean | null

`Optional`italic?: boolean | null

`Optional`underline?: boolean | IFont.UnderlineStyle | null

`Optional`weight?: number | string