The FontConnectorController is responsible for all communication regarding Font connectors. Methods inside this controller can be called by window.SDK.FontConnector.{method-name}

The way GraFx Studio handles different sources of Font is called 'FontConnector'. A FontConnector is an implementation of a set of capabilities we need to interact with a certain Digital Asset Management system. In essence, a connector is the combination of a JavaScript snippet and some metadata. The JavaScript snippet is loaded in the studio engine using a sandboxed JavaScript execution engine (QuickJs). This allows us to execute the Font connector both on web using webassembly and on the server side during e.g. animation output generation. This controller is an interface to the running connector instance inside the studio engine.

Hierarchy

  • FontConnectorController

Methods

  • Returns all font styles for a family using a specific FontConnector. The connector needs to list detail as a supported capability.

    Returns

    array of font styles

    Parameters

    • connectorId: string

      unique id of the Font connector

    • fontFamilyId: string

      unique id of the Font family

    • context: MetaData = {}

      context that will be available in the connector script.

    Returns Promise<EditorResponse<FontStyle[]>>

  • The combination of a connectorId and fontId is typically enough for a Font connector to perform the download of this asset. The download endpoint is capable of relaying this information to the Font connector instance running in the editor engine.

    Returns

    Parameters

    • connectorId: string

      unique id of the Font connector

    • fontStyleId: string

      unique id of the Font style to download

    • context: MetaData = {}

      context that will be available in the connector script.

    Returns Promise<Uint8Array>

  • All connectors have a certain set of mappings they allow to be passed into the connector methods their context. This method allows you to discover which mappings are available for a given connector. If you want to use any of these mappings, they will be available in the context parameter of any connector method.

    Returns

    connector mappings

    Parameters

    • connectorId: string

      unique id of the media connector

    Returns Promise<EditorResponse<ConnectorConfigOptions>>

  • The combination of a connectorId and fontFamilyId is typically enough for a Font connector to perform the preview of this asset. The preview endpoint is capable of relaying this information to the Font connector instance running in the editor engine.

    Returns

    Parameters

    • connectorId: string

      unique id of the Font connector

    • fontFamilyId: string

      unique id of the Font family to download

    • previewFormat: FontPreviewFormat

      hint to the Font connector about desired format of the Font preview

    • context: MetaData = {}

      dynamic map of additional options potentially used by the connector

    Returns Promise<Uint8Array>

Generated using TypeDoc