Excel.EntityCellValue interface

Representa um conjunto de propriedades sem um esquema ou estrutura definida.

Comentários

Conjunto de APIs: ExcelApi 1.16

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-function-references.yaml

// Attach a reference to a JavaScript custom function as a method on a math entity.
await Excel.run(async (context) => {
    const sheet: Excel.Worksheet = context.workbook.worksheets.getItem("Sample");
    const entityRange: Excel.Range = sheet.getRange("A2");
    const referenceType: Excel.FunctionCellValueType = Excel.FunctionCellValueType.javaScriptReference;
    const customFunctionReference: Excel.JavaScriptCustomFunctionReferenceCellValue = {
        type: Excel.CellValueType.function,
        functionType: referenceType,
        namespace: "CONTOSO",
        id: "GET27"
    };

    // The namespace and ID identify a function; this value doesn't register its implementation.
    const mathEntity: Excel.EntityCellValue = {
        type: Excel.CellValueType.entity,
        text: "Math value",
        properties: {
            Value: {
                type: Excel.CellValueType.double,
                basicValue: 10
            },
            Get27: customFunctionReference
        }
    };
    entityRange.valuesAsJson = [[mathEntity]];
    entityRange.format.autofitColumns();
    await context.sync();
    console.log("Created the Math value entity in Sample!A2. Read the reference to inspect its metadata.");
});

Propriedades

basicType

Representa o valor que seria retornado por Range.valueTypes uma célula com esse valor.

basicValue

Representa o valor que seria retornado por Range.values uma célula com esse valor. Quando acessado por meio de uma valuesAsJson propriedade, esse valor de cadeia de caracteres se alinha com a localidade en-US. Quando acessado por meio de uma valuesAsJsonLocal propriedade, esse valor de cadeia de caracteres se alinha com a localidade de exibição do usuário.

layouts

Representa informações de layout para exibições desta entidade.

properties

Representa as propriedades dessa entidade e seus metadados.

provider

Representa informações que descrevem o serviço que forneceu os dados neste EntityCellValuearquivo . Essas informações podem ser usadas para identidade visual em cartões de entidade.

referencedValues

Representa os valores de célula referenciados em EntityCellValue.properties.

text

Representa o texto mostrado quando uma célula com esse valor é renderizada.

type

Representa o tipo desse valor de célula.

Detalhes da propriedade

basicType

Representa o valor que seria retornado por Range.valueTypes uma célula com esse valor.

basicType?: RangeValueType.error | "Error";

Valor da propriedade

error | "Error"

Comentários

Conjunto de APIs: ExcelApi 1.16

basicValue

Representa o valor que seria retornado por Range.values uma célula com esse valor. Quando acessado por meio de uma valuesAsJson propriedade, esse valor de cadeia de caracteres se alinha com a localidade en-US. Quando acessado por meio de uma valuesAsJsonLocal propriedade, esse valor de cadeia de caracteres se alinha com a localidade de exibição do usuário.

basicValue?: "#VALUE!" | string;

Valor da propriedade

"#VALUE!" | string

Comentários

Conjunto de APIs: ExcelApi 1.16

layouts

Representa informações de layout para exibições desta entidade.

layouts?: EntityViewLayouts;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.16

properties

Representa as propriedades dessa entidade e seus metadados.

properties?: {
            [key: string]: EntityPropertyType;
        };

Valor da propriedade

{ [key: string]: Excel.EntityPropertyType; }

Comentários

Conjunto de APIs: ExcelApi 1.16

provider

Representa informações que descrevem o serviço que forneceu os dados neste EntityCellValuearquivo . Essas informações podem ser usadas para identidade visual em cartões de entidade.

provider?: CellValueProviderAttributes;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.16

referencedValues

Representa os valores de célula referenciados em EntityCellValue.properties.

referencedValues?: ReferencedValue[];

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.16

text

Representa o texto mostrado quando uma célula com esse valor é renderizada.

text?: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: ExcelApi 1.16

type

Representa o tipo desse valor de célula.

type: CellValueType.entity | ReferenceValueType.entity | "Entity";

Valor da propriedade

entity | entity | "Entity"

Comentários

Conjunto de APIs: ExcelApi 1.16