BaseLayout Lightning Web Component ReadMe (Managed Package)

Vlocity Insurance and Health Spring '20

All card layouts extend BaseLayout Lightning Web Component as a mixin.

Available baseLayout Attributes

Attribute	Value	Type	Required	Description
record-id		string		Specifies params id used for the card.
theme	slds, nds (Default: slds)	string		Specifes the theme to use.
records		string or array		Specifies the data to pass to the cards inside the layout.
parent		string		Sets parent if the layout is a flyout.
definition		string		Specifies the complete JSON obj, which defines the data and definition for the card.
isLoaded	true, false (Default: false)	boolean		To load the layout, set to true.
debug		boolean		Enables the debug mode.

Example baseLayout Component

export default class CardCanvas extends BaseLayout(LightningElement) {
        // component definition
    }

Available Methods

reloadLayout()

Fetches the updated data from the data source and reloads the layout.

manipulateData()

Manipulates records before passing to cards. Updates the records, passes them to the cards.

fetchUserProfile()

Call this method to fetch the userProfile data. By default, when the fetch User Info is checked, this fetches the value and stores it in the userProfile field. If the data is not present, you can call this method to fetch it again.

setDefinition(val)

The definition is auto-generated when a layout is created in the Card Designer, defining the layout. If it needs to be changed at runtime, you can call this method and pass val as the card definition.

evaluateMetatags()

By default, this method gets triggered when setting the definition value and sets the metatag from the definition. To set the metadata manually, use this method.

loadRecords()

Fetches the data again from the card data source and updates the records data.

Vlocity Insurance and Health Winter '20 and Vlocity CME Spring '20

All card layouts extend BaseLayout Lightning Web Component as a mixin.

Available baseLayout Attributes

Attribute	Value	Type	Required	Description
record-id		string		The params id used for the card.
theme	slds, nds (Default: slds)	string		Specifies the theme to use.
records		string or array		Data to pass to the cards inside the layout.
parent		string		Set parent if the layout is a flyout.
definition		string		The complete JSON obj which defines the data and definition for the card.
isLoaded		boolean		It is false until the layout is loaded.
debug		boolean		Enables the debug mode.

Example baseLayout Component

    export default class CardCanvas extends BaseLayout(LightningElement) {
        // component definition
    }