Returns all font styles for a family using a specific FontConnector. The connector needs to list detail
as a supported capability.
array of font styles
unique id of the Font connector
unique id of the Font family
context that will be available in the connector script.
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.
unique id of the Font connector
unique id of the Font style to download
context that will be available in the connector script.
This method returns what capabilities the selected connector has. It gives an indication what methods can be used successfully for a certain connector.
FontConnectorCapabilities
unique id of the Font connector
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.
connector mappings
unique id of the media connector
This method will parse the deprecatedFontType to the new Font type. This method will be removed once the deprecatedFontType is out of use
MediaType value
is 0 or 1
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.
unique id of the Font connector
unique id of the Font family to download
hint to the Font connector about desired format of the Font preview
dynamic map of additional options potentially used by the connector
Query a specific FontConnector for data using both standardized queryOptions and the dynamic context as parameters.
array of font families
unique id of the Font connector
query options
context that will be available in the connector script.
Generated using TypeDoc
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.