Skip to main content

CardCompactLayoutTemplate Class

The Compact layout template used to arrange card elements so that they occupy the minimum area.

#Declaration

TypeScript
export class CardCompactLayoutTemplate extends CardLayoutTemplate

#Remarks

Use the Card.layoutTemplate property to specify a card’s layout template. To learn how to manage the layout of cards in the CardItem, refer to the CardLayoutTemplate class description.

The image below shows which card elements correspond to properties exposed by the CardCompactLayoutTemplate class:

Card_CompactLayoutTemplate_API

#Inherited Members

#Inheritance

SerializableModel
CardLayoutTemplate
CardCompactLayoutTemplate

#constructor

Initializes a new instance of the CardCompactLayoutTemplate class.

#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

#bottomSubValue1 Property

#Declaration

TypeScript
bottomSubValue1: DevExpress.Dashboard.Model.CardLayoutTemplateDataElement

#Property Value

Type
CardLayoutTemplateDataElement

#bottomSubValue2 Property

#Declaration

TypeScript
bottomSubValue2: DevExpress.Dashboard.Model.CardLayoutTemplateDataElement

#Property Value

Type
CardLayoutTemplateDataElement

#bottomValue Property

#Declaration

TypeScript
bottomValue: DevExpress.Dashboard.Model.CardLayoutTemplateDataElement

#Property Value

Type
CardLayoutTemplateDataElement

#deltaIndicator Property

#Declaration

TypeScript
deltaIndicator: DevExpress.Dashboard.Model.CardLayoutTemplateDeltaElement

#Property Value

Type
CardLayoutTemplateDeltaElement

#mainValue Property

#Declaration

TypeScript
mainValue: DevExpress.Dashboard.Model.CardLayoutTemplateDataElement

#Property Value

Type
CardLayoutTemplateDataElement

#sparkline Property

Provides access to the sparkline displayed within the card.

#Declaration

TypeScript
sparkline: DevExpress.Dashboard.Model.CardLayoutTemplateSparklineElement

#Property Value

Type Description
CardLayoutTemplateSparklineElement

A CardLayoutTemplateSparklineElement object that is the sparkline displayed within the card.

#subValue Property

#Declaration

TypeScript
subValue: DevExpress.Dashboard.Model.CardLayoutTemplateDataElement

#Property Value

Type
CardLayoutTemplateDataElement

#type Property

#Declaration

TypeScript
type: ko.Observable<string>

#Property Value

Type
Observable<string>

#Methods

#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
getType(): string

#Returns

Type
string