The requested page is not available for the requested platform. You are viewing the content for Default platform.
All docs
V18.2
19.1 (preview)
18.2
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

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?: DxDesigner.Analytics.Utils.ModelSerializer)

Optional Parameters

Type Name Default Description
any modelJson null

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

DxDesigner.Analytics.Utils.ModelSerializer serializer null

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

Properties

maxWidth Property

Declaration

maxWidth: KnockoutObservable<number>

Property Value

Type Description
KnockoutObservable<number>

minWidth Property

Declaration

minWidth: KnockoutObservable<number>

Property Value

Type Description
KnockoutObservable<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(): DxDesigner.Analytics.Utils.ISerializationsInfo

Returns

Type Description
DxDesigner.Analytics.Utils.ISerializationsInfo

 

getType Method

Declaration

abstract getType(): string

Returns

Type Description
string