Class FontCollection

Represents a collection of fonts.

Hierarchy (View Summary)

ObjectBase
- FontCollection

Index

Constructors

constructor

new FontCollection(): FontCollection
Creates an empty FontCollection instance.

Returns FontCollection
Overrides ObjectBase.constructor
new FontCollection(om: ObjectManager): FontCollection
Creates an empty FontCollection instance.
Parameters
- om: ObjectManager
  An object manager that controls the lifetime of the FontCollection object.
Returns FontCollection
Overrides ObjectBase.constructor

Accessors

count

get count(): number
Gets the number of fonts in the FontCollection.

Returns number

defaultFont

get defaultFont(): Font | null
Gets or sets the default font for the current font collection.

Returns Font | null
set defaultFont(font: Font | null): void
Gets or sets the default font for the current font collection.
Parameters
- font: Font | null
Returns void

id

get id(): number
Gets the reference to the object.

Returns number
Inherited from ObjectBase.id

om

get om(): ObjectManager
Gets the owner ObjectManager instance.

Returns ObjectManager
Inherited from ObjectBase.om

Methods

`Static`getDefaultCollection

getDefaultCollection(): FontCollection
Gets the default FontCollection instance.

Returns FontCollection
The default FontCollection instance.
getDefaultCollection(om: ObjectManager): FontCollection
Gets the default FontCollection instance.
Parameters
- om: ObjectManager
  An object manager that controls the lifetime of the FontCollection object.
Returns FontCollection
The default FontCollection instance.

addFallbackFont

addFallbackFont(font: Font): void
Adds the specified font as fallback to the FontCollection.
Parameters
- font: Font
  The Font to be added as fallback font.
Returns void

addFont

addFont(font: Font, fallbackFont?: boolean, defaultFont?: boolean): void
Adds the specified font to the FontCollection.
Parameters
- font: Font
  The Font object to add, if the Font is not yet added.
- OptionalfallbackFont: boolean = false
  true if the font should also be added to the list of fallback fonts, false otherwise.
- OptionaldefaultFont: boolean = false
  true if the font should be set as default font, false otherwise.
Returns void

clear

clear(): void
Removes all fonts from the FontCollection.

Returns void

clearFallbackFonts

clearFallbackFonts(): void
Clears the list of fallback fonts in the FontCollection.

Returns void

clone

clone(): FontCollection
Creates a copy of the FontCollection.

Returns FontCollection

contains

contains(font: Font): boolean
Determines whether the font is in the FontCollection.
Parameters
- font: Font
  The Font to be searched.
Returns boolean

free

free(): void
Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns void
Inherited from ObjectBase.free

getAt

getAt(index: number): Font
Gets the font with the specified index from the FontCollection.
Parameters
- index: number
Returns Font

indexOf

indexOf(font: Font): number
Gets the index of the font in the FontCollection, or -1 if the font is not found.
Parameters
- font: Font
  The Font to be searched.
Returns number

loadFont

loadFont(
    fontBytes: Uint8Array,
    fallbackFont?: boolean,
    defaultFont?: boolean,
): void
Loads a font or font collection from the byte array.
Parameters
- fontBytes: Uint8Array
  The binary data of the font.
- OptionalfallbackFont: boolean = false
  true if the font should be added to the list of fallback fonts, false otherwise.
- OptionaldefaultFont: boolean = false
  true if the font should be set as default font, false otherwise.
Returns void

rebind

rebind(omTo: ObjectManager): void
Rebinds the object from the current ObjectManager to the specified one.
Parameters
- omTo: ObjectManager
  The new ObjectManager for the object.
Returns void
Inherited from ObjectBase.rebind

remove

remove(font: Font): boolean
Removes the specified font from the FontCollection.
Parameters
- font: Font
  The Font to be removed from the collection.
Returns boolean
true if the font was actually removed, false otherwise.

removeAt

removeAt(index: number): void
Removes a font at the specified index.
Parameters
- index: number
Returns void

removeFallbackFont

removeFallbackFont(font: Font): void
Removes the specified font from fallbacks of the FontCollection.
Parameters
- font: Font
  The Font to be removed from fallback fonts.
Returns void

searchFont

searchFont(searchFontOptions: SearchFontOptions): Font | null
Searches for a font with specified options in the FontCollection.
Parameters
- searchFontOptions: SearchFontOptions
Returns Font | null
The Font found, or null if not found.

Class FontCollection

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns FontCollection

Parameters

Returns FontCollection

Accessors

count

Returns number

defaultFont

Returns Font | null

Parameters

Returns void

id

Returns number

om

Returns ObjectManager

Methods

StaticgetDefaultCollection

Returns FontCollection

Parameters

Returns FontCollection

addFallbackFont

Parameters

Returns void

addFont

Parameters

Returns void

clear

Returns void

clearFallbackFonts

Returns void

clone

Returns FontCollection

contains

Parameters

Returns boolean

free

Returns void

getAt

Parameters

Returns Font

indexOf

Parameters

Returns number

loadFont

Parameters

Returns void

rebind

Parameters

Returns void

remove

Parameters

Returns boolean

removeAt

Parameters

Returns void

removeFallbackFont

Parameters

Returns void

searchFont

Parameters

Returns Font | null

Settings

On This Page

`Static`getDefaultCollection