CardLayoutTemplate Class

Serves as the base for classes that define a layout template for the CardItem.

Declaration

export abstract class CardLayoutTemplate extends SerializableModel

Remarks

The CardItem item allows you to specify a layout of individual cards from the CardDashboardItem.cards collection. The Card object exposes the Card.layoutTemplate property that allows you to set a predefined layout template or to create a custom layout.

To learn more about the available layouts, see the Web Dashboard - Cards - Layout topic.

Note

If you assign a null value to the Card.layoutTemplate property, the CardLayoutTemplate uses the legacy card layout used prior v17.1.

Inheritance

CardLayoutTemplate

CardEmptyLayoutTemplate

CardCustomLayoutTemplate

CardCenteredLayoutTemplate

CardStretchedLayoutTemplate

CardLightweightLayoutTemplate

CardCompactLayoutTemplate

constructor

For internal use.

Declaration

constructor(
    modelJson?: any,
    serializer?: DxDesigner.Analytics.Utils.ModelSerializer
)

Parameters

Name	Type	Description
modelJson	any	A JSON object used for a dashboard deserialization. Do not pass this parameter directly.
serializer	DxDesigner.Analytics.Utils.ModelSerializer	An object used for a dashboard deserialization. Do not pass this parameter directly.

Properties

maxWidth Property

Declaration

maxWidth: ko.Observable<number>

Property Value

Type
Observable<number>

minWidth Property

Declaration

minWidth: ko.Observable<number>

Property Value

Type
Observable<number>

title Property

Declaration

title: string

Property Value

Type
string

Methods

clone Method

Declaration

clone(): CardLayoutTemplate

Returns

Type
CardLayoutTemplate

getInfo Method

For internal use.

Declaration

getInfo(): DxDesigner.Analytics.Utils.ISerializationInfoArray

Returns

Type	Description
DxDesigner.Analytics.Utils.ISerializationInfoArray

getType Method

Declaration

abstract getType(): string

Returns

Type
string