Indicates whether the card is currently active. Cards in a dock will be active when the associated tab is active. Cards in a frame are always active.
Reference to the application window the card is currently in
Cards can be moved to layouts in various different browser windows, but the code defined in the card callback methods will often be executing in the context of the IWindowService.main window. This property should be used to determine which window the card is currently in. This is especially important when performing actions such as querying the DOM. Note that when a card has not been placed in a layout, the card framework cannot know which window it will be added to. In these situations, this property will be undefined.
The card's bottom toolbar, if it has one.
The card error of any error that occurred while handling the card
The viewer card configuration
The default height for the card (as rem units)
The default width for the card (as rem units)
Class name to be used to apply to the skeleton to the cards in this dock.
The root HTML element of the card
Indicates whether the card is enabled.
A description of any error that occurred while handling the card
The HTML element containing the IFrame of the card
true if an error has occurred while handling the card
The current height for the card (as pixels)
The unique identifier from ICardConfig.id
The instance data associated with the viewer card
A unique id for this card instance (combination of ICard.id and ICard.instance)
The instance number of the card (generally 0 unless there are multiple instances of the same card)
The card's left toolbar, if it has one.
Current location of the card. If the card has not been placed in a location yet, or has been removed from its location, this is undefined.
Indicates whether the card is currently maximized.
The minimum height of the card (as rem units)
The minimum width of the card (as rem units)
The index to use when sorting the tabs for the cards in a dock.
The overlay card if showOverlay() was called, or undefined if no overlay is set.
Additional parameters attached to the card during creation. The interpretation of these parameters is dependent on the card type.
Indicates whether the card is currently popped out.
This flag is used by the experimental popout feature.
The card's right toolbar, if it has one.
True if the skeleton for this is currently visible
The state (CardStatus) the card is in
The human-readable card title
The card toolbar controls
The card's top toolbar, if it has one.
The viewer collection the viewer belongs to
The card's viewer toolbar, if it has one.
The viewer type identifier (i.e. "native" or "image")
This is used via the navigation API to specifiy which viewer type to load
Controls whether the card is visible. Setting this property to false will hide the card, setting it to true will show the card. Hiding a card can result in other panes being hidden as well, e.g. hiding a card when it is the only card in the dock will result in the dock being hidden as well. Cards are visible by default.
The current width for the card (as pixels)
Reference to the browser window the card is currently in
This property is the same as ICard.applicationWindow.window.
Activate the card if it is in a dock. This results in the card content being displayed in the dock body. If the card is still in the process of loading, a skeleton will be displayed until the load completes. If the card is not in a dock, this method has no effect.
Binds an ICardInstance to the card. Alternately, the ICardConfig.createInstance() function may be specified to have an ICardInstance created automatically for each card instance.
The ICardInstance to bind to the card
Reserved for internal use
Manually resolves the loading of the card for an IFrame or view model card loader.
Creates a banner that will display within the card
Creates a toolbar in the card. Toolbars may also be created via the ICardConfig.toolbarsConfig property.
Deactivate the card if it is in a dock. This results in the card content being hidden. If the card is not in a dock, this method has no effect.
Disables the card. When cards are disabled, they are automatically deactivated and the associated dock toolbar button (if any) is disabled, preventing activation.
Dismisses a banner and removes it from the card. Equivalent to calling ICardBanner.dismiss().
Enables the card if it has been disabled by a call to ICard.disable().
Manually fails the loading of the card for an IFrame or view model card loader.
Error to pass to reject
Hides any overlay that was shown via a call to showOverlay()
Hides card skeleton without delay.
Loads the card if it is not already loaded. Note that it is normally not necessary to call this method because cards are loaded automatically when they activated in the UI. Manual loads may be useful in certain circumstances, for instance if the loading process is lengthy.
Moves the card to cover the whole viewport.
Moves the card to the specified location.
This is an experimental API. The application may not function properly when invoking this API.
Location to move the card to
Optional boolean indicating whether or not the card should be forecefully moved,
bypassing the standard cardCanDeactivate() checks. Defaults to false.
Promise that resolves to a boolean indicating if the card was successfully moved
Docks the card and returns it to its original location after being popped out.
This is an experimental API. The application may not function properly when invoking this API.
Optional boolean indicating whether or not the card should be forcefully popped in,
bypassing the standard cardCanDeactivate() checks. Defaults to false.
Promise that resolves to a boolean indicating whether or not the card could be popped out.
Undocks the card and moves it to a new popout window.
This is an experimental API. The application may not function properly when invoking this API.
Promise that resolves to a boolean indicating whether or not the card could be popped out.
Report that the card is in error state. This will display the passed in error message on the card if ICardError.isFatal is true and log it.
Message to be displayed on the card.
The ICardError instance containing information about the error.
Any other additional data related to the error.
Un-maximizes the card so that it shows in its location instead over the whole viewport.
Set the card's status to one of the CardStatus values.
Temporarily replaces the card contents with another card, for instance to display an error message. Only the overlay contents are used - other properties from the overlay card, such as the title and minimum size are ignored.
Shows card skeleton without delay.
Called to notify the card system that the card's internal state (the data returned by ICardInstance.cardSaveState) has changed.
Unloads the card. Normally it is not necessary to call this method but it may be useful if the card is no longer needed.
Card that is used for displaying queue items