Interface: ICardConfig
Configuration object for defining new cards
Extended by
Properties
appGuid?
optional
appGuid: string
The application GUID an extension card is associated with
appVersion?
optional
appVersion: string
The version of the application an extension card is created with
autoRestore?
optional
autoRestore: boolean
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.
category?
optional
category: string
Optional string representing the card group or category this card belongs to.
categoryOrder?
optional
categoryOrder: number
Optional number representing the rank or order of the card.
Defines where this card is to be placed in the same category of cards
createInstance()?
optional
createInstance: (card
, api
) => ICardInstance
If specified, this function will be called to create an ICardInstance object to be bound
to an ICard. Alternately, the ICard.bindInstance() method may be used.
Parameters
• card: ICard
• api: IReviewInterfaceApi
Returns
ICardInstance
defaultHeight?
optional
defaultHeight: number
The default height for the card (as rem units)
defaultWidth?
optional
defaultWidth: number
The default width for the card (as rem units)
extends?
optional
extends: IExtendsConfig
Experimental
Optional property IExtendsConfig that sets up a custom outsidein viewer.
This overrides the ICardConfig.loader and ICardConfig.toolbarsConfig properties.
icon?
optional
icon: ICardIcon
The icon to display in the card title bar
id
id: string
Unique card type ID
This should be globally unique, like a GUID or company identifier.
Copy
"mycompany.myplugin.mycard"
loader
loader: ICardLoaderConfig
Information for loading the card content
location?
optional
location: ICardLocation
The default location for the card
minHeight?
optional
minHeight: number
The minimum height of the card (as rem units)
minWidth?
optional
minWidth: number
The minimum width of the card (as rem units)
order?
optional
order: number
An optional index to use when sorting the tabs for the cards in a dock. Defaults to 0.
singleton?
optional
singleton: boolean
If true, only one instance of the card will be allowed.
skeleton?
optional
skeleton: ICardSkeleton
Custom skeleton loader. If specified, this skeleton will replace the default skeleton loader.
supportsPopout?
optional
supportsPopout: boolean
Experimental
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.
title
title: string
The human-readable card title
optional
toolbarsConfig: ICardToolbarConfig
| ICardToolbarConfig
[]
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.
optional
toolTipConfig: IToolTipConfig
Experimental
Optional configuration for adding custom tool tip to the card icon.