Skip to main content

CardLayoutTemplate Class

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

#Declaration

TypeScript
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.

#Inherited Members

#constructor

For internal use.

#Declaration

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

#Parameters

Name Type Description
modelJson any

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

serializer ModelSerializer

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

#Properties

#maxWidth Property

#Declaration

TypeScript
maxWidth: ko.Observable<number>

#Property Value

Type
Observable<number>

#minWidth Property

#Declaration

TypeScript
minWidth: ko.Observable<number>

#Property Value

Type
Observable<number>

#title Property

#Declaration

TypeScript
title: string

#Property Value

Type
string

#Methods

#clone Method

#Declaration

TypeScript

#Returns

Type
CardLayoutTemplate

#getInfo Method

For internal use.

#Declaration

TypeScript
getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray

#Returns

Type Description
ISerializationInfoArray

An array of objects that provide serialization info.

#getType Method

#Declaration

TypeScript
abstract getType(): string

#Returns

Type
string