Interface FontManager

interface FontManager {
    fonts: {
        asset?: Asset;
        fallback: string;
        family: string;
        system: boolean;
    }[];
    restrictedFonts: Set<string>;
    runtime: Runtime;
    addCustomFont(family: string, fallback: string, asset: Asset): void;
    addSystemFont(family: string, fallback: string): void;
    changed(): void;
    clear(): void;
    deleteFont(index: number): void;
    deserialize(
        json: unknown,
        zip?: JSZip,
        keepExisting?: boolean,
    ): Promise<void>;
    emit<K extends "change">(
        event: K,
        ...args: EventEmitterArgs<FontManagerEvents, K>,
    ): void;
    getFonts(): {
        data: null
        | Uint8Array;
        family: string;
        format: null | string;
        name: string;
        system: boolean;
    }[];
    getUnusedCustomFont(family: string): string;
    getUnusedSystemFont(family: string): string;
    hasFont(family: string): boolean;
    isValidCustomFont(family: string): boolean;
    isValidFamily(family: string): boolean;
    isValidSystemFont(family: string): boolean;
    listeners<K extends "change">(
        event: K,
    ): EventEmitterCallback<FontManagerEvents, K>[];
    off<K extends "change">(
        event: K,
        callback: EventEmitterCallback<FontManagerEvents, K>,
    ): void;
    on<K extends "change">(
        event: K,
        callback: EventEmitterCallback<FontManagerEvents, K>,
    ): void;
    once<K extends "change">(
        event: K,
        callback: EventEmitterCallback<FontManagerEvents, K>,
    ): void;
    removeListener<K extends "change">(
        event: K,
        callback: EventEmitterCallback<FontManagerEvents, K>,
    ): void;
    restrictFont(font: string): void;
    serializeAssets(): Asset[];
    serializeJSON(): unknown;
    updateRenderer(): void;
}

Hierarchy (View Summary)

Properties

fonts restrictedFonts runtime

Methods

addCustomFont addSystemFont changed clear deleteFont deserialize emit getFonts getUnusedCustomFont getUnusedSystemFont hasFont isValidCustomFont isValidFamily isValidSystemFont listeners off on once removeListener restrictFont serializeAssets serializeJSON updateRenderer

Properties

fonts

fonts: { asset?: Asset; fallback: string; family: string; system: boolean }[]

restrictedFonts

restrictedFonts: Set<string>

runtime

runtime: Runtime

Methods

addCustomFont

addSystemFont

  • addSystemFont(family: string, fallback: string): void

  • Parameters

    • family: string
    • fallback: string

    Returns void

changed

clear

deleteFont

deserialize

  • deserialize(json: unknown, zip?: JSZip, keepExisting?: boolean): Promise<void>

  • Parameters

    • json: unknown
    • Optionalzip: JSZip
    • OptionalkeepExisting: boolean

    Returns Promise<void>

emit

getFonts

  • getFonts(): {
        data: null
        | Uint8Array;
        family: string;
        format: null | string;
        name: string;
        system: boolean;
    }[]

  • Returns {
        data: null | Uint8Array;
        family: string;
        format: null | string;
        name: string;
        system: boolean;
    }[]

getUnusedCustomFont

getUnusedSystemFont

hasFont

isValidCustomFont

isValidFamily

  • isValidFamily(family: string): boolean

  • Parameters

    • family: string

    Returns boolean

    Deprecated

    use isValidSystemFont or isValidCustomFont instead

isValidSystemFont

listeners

off

on

once

removeListener

restrictFont

serializeAssets

serializeJSON

updateRenderer

Settings

Member Visibility

On This Page

Properties
Methods