API methods available in the CatalogIQ default UI.
You can store the API object in a variable and call the methods directly.
Most methods have a snake_case and camelCase version of their name available.
snake_case
camelCase
import { useDsr } from '@pitcher/js-api'const dsrApi = useDsr() Copy
import { useDsr } from '@pitcher/js-api'const dsrApi = useDsr()
Closes the already open file that was opened via api or by the user.
dsrApi.close() Copy
dsrApi.close()
Signal to DSR that the app is ready to be shown.
useDsr().embeddableReady() Copy
useDsr().embeddableReady()
Fetches the necessary info for the app to know where it is embedded.
Check out usePitcherApi().getEnv() for more information.
useDsr().getEnv() Copy
useDsr().getEnv()
Fetches a file by ID.
dsrApi.getFile({ id: 'my-file-id' }) Copy
dsrApi.getFile({ id: 'my-file-id' })
API methods available in the CatalogIQ default UI.
You can store the API object in a variable and call the methods directly.
Most methods have a
snake_case
andcamelCase
version of their name available.