Interface: ICardConfig

Configuration object for defining new cards

Extended by

• IViewerCardConfig

Properties

appGuid?

optionalappGuid: string

The application GUID an extension card is associated with

appVersion?

optionalappVersion: string

The version of the application an extension card is created with

autoRestore?

optionalautoRestore: 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?

optionalcategory: string

Optional string representing the card group or category this card belongs to.

categoryOrder?

optionalcategoryOrder: 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()?

optionalcreateInstance: (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?

optionaldefaultHeight: number

The default height for the card (as rem units)

defaultWidth?

optionaldefaultWidth: number

The default width for the card (as rem units)

extends?

optionalextends: IExtendsConfig

Experimental

Optional property IExtendsConfig that sets up a custom outsidein viewer. This overrides the ICardConfig.loader and ICardConfig.toolbarsConfig properties.

icon?

optionalicon: 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.

"mycompany.myplugin.mycard"

loader

loader: ICardLoaderConfig

Information for loading the card content

location?

optionallocation: ICardLocation

The default location for the card

minHeight?

optionalminHeight: number

The minimum height of the card (as rem units)

minWidth?

optionalminWidth: number

The minimum width of the card (as rem units)

order?

optionalorder: number

An optional index to use when sorting the tabs for the cards in a dock. Defaults to 0.

singleton?

optionalsingleton: boolean

If true, only one instance of the card will be allowed.

skeleton?

optionalskeleton: ICardSkeleton

Custom skeleton loader. If specified, this skeleton will replace the default skeleton loader.

supportsPopout?

optionalsupportsPopout: 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

toolbarsConfig?

optionaltoolbarsConfig: 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.

toolTipConfig?

optionaltoolTipConfig: IToolTipConfig

Experimental

Optional configuration for adding custom tool tip to the card icon.