Options for font registration.

Hierarchy

  • FontRegistrationOptions

Properties

addToUI?: boolean

If true, the font will be added to the UI for selection. Default is true.

clientOnly?: boolean

If true, the font data will not be sent to the SupportApi server. This is useful if the font is already registered on the server.

displayName?: string

A user-friendly name for the font to be displayed in the UI.

embedMode?: FontEmbedMode

Specifies the font embedding mode for PDF generation.

  • NotEmbed: The font is not embedded.
  • EmbedSubset: A subset of the font is embedded.
  • EmbedFullFont: The whole font is embedded.
  • EmbedSubsetNoForms: A subset of the font is embedded for static content. If the font is used in the Acroform, a non-embedded PDF font will be associated with the form fields.
format?: FontFormat

The format of the font file ("truetype", "opentype", "woff", "woff2", or "ttc"). If not provided, the function will attempt to determine the format from the URL.

serverOnly?: boolean

If true, the font will not be registered on the client but will be sent to the SupportApi server.