Excel.ArrayCellValue interface

Paquet:
excel

Représente un tableau 2D de valeurs de cellule.

Remarques

Ensemble d’API : ExcelApi 1.16

Exemples

const sheet = context.workbook.worksheets.getActiveWorksheet();

// This `EntityCellValue` contains an `ArrayCellValue` with two products and their prices.
const myEntity: Excel.EntityCellValue = {
    type: Excel.CellValueType.entity,
    text: "Product Catalog",
    properties: {
        items: {
            type: Excel.CellValueType.array, /* ArrayCellValue */
            elements: [[
                {
                    type: Excel.CellValueType.string,
                    basicValue: "Bicycle"
                },
                {
                    type: Excel.CellValueType.double,
                    basicValue: 300,
                    numberFormat: "$* #,##0.00",
                }
            ],
            [
                {
                    type: Excel.CellValueType.string,
                    basicValue: "Helmet"
                },
                {
                    type: Excel.CellValueType.double,
                    basicValue: 25,
                    numberFormat: "$* #,##0.00",
                }           
            ]],
            basicType: Excel.RangeValueType.error,
            basicValue: "#VALUE!"
        }
    },
    basicType: Excel.RangeValueType.error, // A read-only property. Used as a fallback in incompatible scenarios.
    basicValue: "#VALUE!" // A read-only property. Used as a fallback in incompatible scenarios.
};

sheet.getCell(0,0).valuesAsJson = [[myEntity]];

Propriétés

basicType

Représente la valeur qui serait retournée par Range.valueTypes pour une cellule avec cette valeur.
basicValue

Représente la valeur qui serait retournée par Range.values pour une cellule avec cette valeur. Lorsqu’elle est accessible via une valuesAsJson propriété, cette valeur de chaîne s’aligne sur les paramètres régionaux en-US. Lorsqu’elle est accessible via une valuesAsJsonLocal propriété, cette valeur de chaîne s’aligne sur les paramètres régionaux d’affichage de l’utilisateur.
elements

Représente les éléments du tableau. Peut ne pas contenir directement un ArrayCellValue.
referencedValues

Représente les valeurs de cellule référencées dans ArrayCellValue.elements.
type

Représente le type de cette valeur de cellule.

Détails de la propriété

basicType

Représente la valeur qui serait retournée par Range.valueTypes pour une cellule avec cette valeur.

basicType?: RangeValueType.error | "Error";

Valeur de propriété

error | "Error"

Remarques

Ensemble d’API : ExcelApi 1.16

basicValue

Représente la valeur qui serait retournée par Range.values pour une cellule avec cette valeur. Lorsqu’elle est accessible via une valuesAsJson propriété, cette valeur de chaîne s’aligne sur les paramètres régionaux en-US. Lorsqu’elle est accessible via une valuesAsJsonLocal propriété, cette valeur de chaîne s’aligne sur les paramètres régionaux d’affichage de l’utilisateur.

basicValue?: "#VALUE!" | string;

Valeur de propriété

"#VALUE!" | string

Remarques

Ensemble d’API : ExcelApi 1.16

elements

Représente les éléments du tableau. Peut ne pas contenir directement un ArrayCellValue.

elements: CellValue[][];

Valeur de propriété

Excel.CellValue[][]

Remarques

Ensemble d’API : ExcelApi 1.16

referencedValues

Représente les valeurs de cellule référencées dans ArrayCellValue.elements.

referencedValues?: ReferencedValue[];

Valeur de propriété

Excel.ReferencedValue[]

Remarques

Ensemble d’API : ExcelApi 1.16

type

Représente le type de cette valeur de cellule.

type: CellValueType.array | ReferenceValueType.array | "Array";

Valeur de propriété

array | array | "Array"

Remarques

Ensemble d’API : ExcelApi 1.16