CardStretchedLayoutTemplate Class

The Stretched layout template that arranges card elements so that they occupy an entire card area.

Declaration

export class CardStretchedLayoutTemplate 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 CardStretchedLayoutTemplate class:

Card_StretchedLayoutTemplate_API

Inherited Members

Inheritance

CardLayoutTemplate
CardStretchedLayoutTemplate

constructor

Initializes a new instance of the CardStretchedLayoutTemplate class.

Declaration

constructor(
    modelJson?: any,
    serializer?: 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

bottomValue1 Property

Declaration

bottomValue1: CardLayoutTemplateDataElement

Property Value

Type
CardLayoutTemplateDataElement

bottomValue2 Property

Declaration

bottomValue2: CardLayoutTemplateDataElement

Property Value

Type
CardLayoutTemplateDataElement

deltaIndicator Property

Declaration

deltaIndicator: CardLayoutTemplateDeltaElement

Property Value

Type
CardLayoutTemplateDeltaElement

mainValue Property

Declaration

mainValue: CardLayoutTemplateDataElement

Property Value

Type
CardLayoutTemplateDataElement

sparkline Property

Provides access to the sparkline displayed within the card.

Declaration

sparkline: CardLayoutTemplateSparklineElement

Property Value

Type Description
CardLayoutTemplateSparklineElement

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

subValue Property

Declaration

subValue: CardLayoutTemplateDataElement

Property Value

Type
CardLayoutTemplateDataElement

topValue Property

Declaration

topValue: CardLayoutTemplateDataElement

Property Value

Type
CardLayoutTemplateDataElement

type Property

Declaration

type: ko.Observable<string>

Property Value

Type
Observable<string>

Methods

getInfo Method

For internal use.

Declaration

getInfo(): ISerializationInfoArray

Returns

Type Description
ISerializationInfoArray

An array of objects that provide serialization info.

getType Method

Declaration

getType(): string

Returns

Type
string