CardLayout Class

Contains settings related to the layout of cards for the CardItem.

Declaration

export class CardLayout extends SerializableModel

Remarks

To learn how to manage the layout of cards in the CardItem, refer to the CardLayoutTemplate class description.

constructor

Declaration

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

Parameters

Name	Type	Description
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

maxWidth Property

Declaration

maxWidth: ko.Observable<number>

Property Value

Type
Observable<number>

minWidth Property

Declaration

minWidth: ko.Observable<number>

Property Value

Type
Observable<number>

rows Property

Declaration

rows: ko.ObservableArray<CardRowBase>

Property Value

Type
ObservableArray<CardRowBase>

rowTypes Property

Declaration

static rowTypes: {
    "CardRow": {
        constructor: typeof CardRow;
    };
    "CardSparklineRow": {
        constructor: typeof CardSparklineRow;
    };
}

Property Value

Name	Type
CardRow	{constructor: typeof CardRow}
CardSparklineRow	{constructor: typeof CardSparklineRow}

templateID Property

Declaration

templateID: ko.Observable<number>

Property Value

Type
Observable<number>

Methods

createRow(elementJSON, serializer) Method

Declaration

createRow(
    elementJSON: any,
    serializer: DxDesigner.Analytics.Utils.ModelSerializer
): CardRowBase

Parameters

Name	Type	Description
elementJSON	any
serializer	DxDesigner.Analytics.Utils.ModelSerializer	An object used for a dashboard deserialization. Do not pass this parameter directly.

Returns

Type
CardRowBase

getInfo Method

For internal use.

Declaration

getInfo(): DxDesigner.Analytics.Utils.ISerializationInfoArray

Returns

Type	Description
DxDesigner.Analytics.Utils.ISerializationInfoArray

grabFrom(newLayout) Method

Declaration

grabFrom(
    newLayout: CardLayout
): void

Parameters

Name	Type
newLayout	CardLayout