This method returns what capabilities the selected connector has. It gives an indication what methods can be used successfully for a certain connector.
unique id of the Data connector
DataConnectorCapabilities
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.
unique id of the data connector
connector mappings
Query a specific DataConnector for a data model using the dynamic context as parameter.
unique id of the data connector
context that will be available in the connector script.
DataModel or DataSourceVariableDataModel
Query a specific DataConnector for data using both specific PageConfig and the dynamic context as parameters.
unique id of the Data connector
bidirectional page configuration — provides previousPageToken / continuationToken navigation
Optionalcontext: Dictionarycontext that will be available in the connector script.
a BidirectionalDataPage with an array of data objects and bidirectional navigation tokens
Query a specific DataConnector for data using both specific PageConfig and the dynamic context as parameters.
unique id of the Data connector
one-directional page configuration — provides a continuationToken for forward navigation
Optionalcontext: Dictionarycontext that will be available in the connector script.
a DataPage with an array of data objects and a continuation token
ExperimentalThis method is still experimental and might change in future releases.
Retrieve a single data item by its identifier from a specific DataConnector.
Only available for connectors that set DataConnectorCapabilities.dataSourceVariable = true,
which implies support for both bidirectional page navigation and item-level lookup.
pageOptions (sorting, limit) are used by the connector to build navigation tokens.
unique id of the Data connector
identifier of the item to retrieve
sorting and limit used to build previousPageToken/continuationToken
context that will be available in the connector script.
a BidirectionalDataPageItem containing the data item and bidirectional navigation tokens
The DataConnectorController is responsible for all communication regarding Data connectors. Methods inside this controller can be called by
window.SDK.dataConnector.{method-name}The way GraFx Studio handles different sources of Data is called 'DataConnector'. A DataConnector is an implementation of a set of capabilities we need to interact with a certain Data 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 Data 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.