Skip to main content
All docs
V24.2

AvailableFontFamiliesExtension Class

A Web Dashboard extension that stores a font family list. This list defines typeface options available for custom styles in format rules.

#Declaration

TypeScript
export class AvailableFontFamiliesExtension extends DisposableObject implements IExtension

#Implements

IExtension

#Inherited Members

#Inheritance

DisposableObject
AvailableFontFamiliesExtension

#constructor(dashboardControl)

Initializes a new instance of the AvailableFontFamiliesExtension class with specified settings.

#Declaration

TypeScript
constructor(
    dashboardControl: DevExpress.Dashboard.DashboardControl
)

#Parameters

Name Type Description
dashboardControl DashboardControl

A Web Dashboard control that owns the extension.

#Properties

#fontFamilies Property

Gets or sets the list of font family names. This list defines typeface options available for custom styles in format rules.

#Declaration

TypeScript
fontFamilies: ko.ObservableArray<string>

#Property Value

Type Description
ObservableArray<string>

An array of strings that are the names of font families.

#Remarks

A Web Dashboard control obtains available font families from the server.

#name Property

Specifies the extension’s unique name.

#Declaration

TypeScript
name: string

#Property Value

Type Description
string

The unique extension name.

#Remarks

Warning

Do not change the unique name of the extension registered in the Web Dashboard to avoid exceptions.

#Methods

#start Method

Contains code that is executed when you register the dashboard extension.

#Declaration

TypeScript
start(): void

#stop Method

Contains code that is executed when you unregister the dashboard extension.

#Declaration

TypeScript
stop(): void