The application GUID an extension card is associated with
The version of the application an extension card is created with
Controls auto restore behavior for the card. By default, or if this property is true, when a card is added to the review interface, the dock it is added to is automatically restored. If this property is false, the dock will not be restored. This can be useful when the card loading process is lengthy or costly, to prevent the card from loading until the user activates it.
Optional string representing the card group or category this card belongs to.
Optional number representing the rank or order of the card. Defines where this card is to be placed in the same category of cards
The default height for the card (as rem units)
The default width for the card (as rem units)
Optional string parameter that sets up a custom outsidein viewer. This overrides the ICardConfig.loader and ICardConfig.toolbarsConfig properties.
The icon to display in the card title bar
Unique card type ID
This should be globally unique, like a GUID or company identifier.
"mycompany.myplugin.mycard"Information for loading the card content
The default location for the card
The minimum height of the card (as rem units)
The minimum width of the card (as rem units)
An optional index to use when sorting the tabs for the cards in a dock. Defaults to 0.
If provided, indicates which viewer the custom viewer will replace
If true, only one instance of the card will be allowed.
Custom skeleton loader. If specified, this skeleton will replace the default skeleton loader.
Optional boolean indicating whether or not the card supports being popped out into a new window. Defaults to false. This flag is used by the experimental ICard.popout and ICard.popin APIs.
The human-readable card title
Indicates the toolbars to create within the card. The resulting toolbars may be accessed via the ICard.toolbars property. Toolbars may also be created via the ICard.createToolbar() method.
Indicates the configuration for the viewer toolbar to create within the card. The resulting toolbar may be accessed via the IViewerCard.viewerToolbar property. Viewer toolbars always appear at the top, so the edge property of this object will be ignored.
The viewer type identifier (i.e. "native" or "image")
This is used via the navigation API to specifiy which viewer type to load
This function will be called to create an IViewerCardInstance object to be bound to an IViewerCard.
Viewer card that the instance belongs to
Review Interface API
This function will be called to check whether the viewer type supports loading the provided IQueueItem
This function should return true or a Promise that resolves to true if the viewer type supports loading the provided queue item. Otherwise, this function should return false or a Promise that resolves to false. It is possible that this method will be called multiple times and it is advised to memoize the function if it is an expensive check.
Review Interface API
The queue item to check support for
The file type ID, if one is available
Whether or not the viewer type supports loading in the provided queue item
Configuration object for defining new viewer cards