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.

constructor

For internal use.

Declaration

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

Optional Parameters

Name Type Default Description
modelJson any null

A JSON object used for dashboard deserialization. Do not pass this parameter directly.

serializer ModelSerializer null

An object used for dashboard deserialization. Do not pass this parameter directly.

Properties

maxWidth Property

Declaration

maxWidth: ko.Observable<number>

Property Value

Type Description
ko.Observable<number>

minWidth Property

Declaration

minWidth: ko.Observable<number>

Property Value

Type Description
ko.Observable<number>

title Property

Declaration

title: string

Property Value

Type Description
string

Methods

clone Method

Declaration

clone(): CardLayoutTemplate

Returns

Type Description
CardLayoutTemplate

getInfo Method

For internal use.

Declaration

getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray

Returns

Type Description
ISerializationInfoArray

An array of objects that provide serialization info.

getType Method

Declaration

abstract getType(): string

Returns

Type Description
string