Excel.JavaScriptCustomFunctionReferenceCellValue interface

Pacote:
excel

Representa uma referência a uma função personalizada do JavaScript.

Comentários

Conjunto de APIs: ExcelApi 1.19

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.
functionType

Representa o tipo de FunctionCellValuearquivo .
id

Representa a ID da função personalizada. Para obter mais informações, consulte Gerar metadados JSON automaticamente para funções personalizadas: ID.
namespace

Representa o namespace usado pela função personalizada. Para obter mais informações, consulte Referência do manifesto: Namespace.
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.19

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.19

functionType

Representa o tipo de FunctionCellValuearquivo .

functionType: FunctionCellValueType.javaScriptReference | "JavaScriptReference";

Valor da propriedade

javaScriptReference | "JavaScriptReference"

Comentários

Conjunto de APIs: ExcelApi 1.19

id

Representa a ID da função personalizada. Para obter mais informações, consulte Gerar metadados JSON automaticamente para funções personalizadas: ID.

id: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: ExcelApi 1.19

namespace

Representa o namespace usado pela função personalizada. Para obter mais informações, consulte Referência do manifesto: Namespace.

namespace: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: ExcelApi 1.19

type

Representa o tipo desse valor de célula.

type: CellValueType.function | "Function";

Valor da propriedade

function | "Function"

Comentários

Conjunto de APIs: ExcelApi 1.19