Edit

Excel.EntityArrayCardLayout interface

  • Reference
Package:
excel

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents a card layout that is best used for an array.

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Properties

arrayProperty

Represents name of the property that contains the array shown in the card.
columnsToReport

Represents the count of columns which the card claims are in the array. A card may report a different number of columns than it actually has to display smaller amounts of preview data.
displayName

Represents name of the property that contains the array shown in the card. Default value is "Array".
firstRowIsHeader

Represents whether the first row of the array is treated as a header.
layout

Represents the type of this layout.
rowsToReport

Represents the count of rows which the card claims are in the array. A card may report a different number of rows than it actually has to display smaller amounts of preview data.

Property Details

arrayProperty

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents name of the property that contains the array shown in the card.

arrayProperty: string;

Property Value

string

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

columnsToReport

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the count of columns which the card claims are in the array. A card may report a different number of columns than it actually has to display smaller amounts of preview data.

columnsToReport?: number;

Property Value

number

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

displayName

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents name of the property that contains the array shown in the card. Default value is "Array".

displayName?: string;

Property Value

string

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

firstRowIsHeader

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents whether the first row of the array is treated as a header.

firstRowIsHeader?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

layout

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the type of this layout.

layout: EntityCardLayoutType.array | "Array";

Property Value

array | "Array"

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

rowsToReport

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the count of rows which the card claims are in the array. A card may report a different number of rows than it actually has to display smaller amounts of preview data.

rowsToReport?: number;

Property Value

number

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]