Card Class

A card(s) displayed within the CardItem.

Declaration

export class Card extends KpiElement

Remarks

To create a card(s) within the CardItem, use the CardDashboardItem.Cards property that accepts Card class objects. An API exposed by the Card class includes the following main members:

• The KpiElement.actualValue and KpiElement.targetValue properties provide measure values for a card.
• The SeriesDashboardItem.seriesDimensions property provides dimension values that are used to create multiple cards for the predefined set of measures.
• The Card.layoutTemplate property allows you to customize card layouts.

Inherited Members

absoluteVariationNumericFormat

actualValue

deltaOptions

itemType

name

percentOfTargetNumericFormat

percentVariationNumericFormat

targetValue

Inheritance

KpiElement

Card

constructor(dataItemProvider)

Initializes a new instance of the Card class with specified settings.

Declaration

constructor(
    dataItemProvider: DataDashboardItem,
    modelJson?: any,
    serializer?: DxDesigner.Analytics.Utils.ModelSerializer
)

Parameters

Name	Type	Description
dataItemProvider	DataDashboardItem
modelJson	any	A JSON object used for a dashboard deserialization. Do not pass this parameter directly.
serializer	DxDesigner.Analytics.Utils.ModelSerializer	An object used for a dashboard deserialization. Do not pass this parameter directly.

Properties

cardDeltaOptions Property

Declaration

cardDeltaOptions: CardDeltaOptions

Property Value

Type
CardDeltaOptions

layoutTemplate Property

Declaration

layoutTemplate: KnockoutObservable<CardLayoutTemplate>

Property Value

Type
KnockoutObservable<CardLayoutTemplate>

showSparkline Property

Declaration

showSparkline: KnockoutObservable<boolean>

Property Value

Type
KnockoutObservable<boolean>

sparklineOptions Property

Declaration

sparklineOptions: SparklineOptions

Property Value

Type
SparklineOptions

type Property

Declaration

type: KnockoutObservable<string>

Property Value

Type
KnockoutObservable<string>

Methods

getInfo Method

For internal use.

Declaration

getInfo(): DxDesigner.Analytics.Utils.ISerializationsInfo

Returns

Type	Description
DxDesigner.Analytics.Utils.ISerializationsInfo