Excel.JavaScriptCustomFunctionReferenceCellValue interface

Représente une référence à une fonction personnalisée JavaScript.

Remarques

Jeu d’API : ExcelApi 1.19

Exemples

// 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.");
});

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. Lorsque vous y accédez via une valuesAsJson propriété, cette valeur de chaîne s’aligne sur les paramètres régionaux fr-FR. Lorsque vous y accédez via une valuesAsJsonLocal propriété, cette valeur de chaîne s’aligne sur les paramètres régionaux d’affichage de l’utilisateur.

functionType

Représente le type de FunctionCellValue.

id

Représente l’ID de la fonction personnalisée. Pour plus d’informations, consultez Autogénérer les métadonnées JSON pour les fonctions personnalisées : ID.

namespace

Représente l’espace de noms utilisé par la fonction personnalisée. Pour plus d’informations, consultez Référence du manifeste : Espace de noms.

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

Jeu d’API : ExcelApi 1.19

basicValue

Représente la valeur qui serait retournée par Range.values pour une cellule avec cette valeur. Lorsque vous y accédez via une valuesAsJson propriété, cette valeur de chaîne s’aligne sur les paramètres régionaux fr-FR. Lorsque vous y accédez 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

Jeu d’API : ExcelApi 1.19

functionType

Représente le type de FunctionCellValue.

functionType: FunctionCellValueType.javaScriptReference | "JavaScriptReference";

Valeur de propriété

javaScriptReference | "JavaScriptReference"

Remarques

Jeu d’API : ExcelApi 1.19

id

Représente l’ID de la fonction personnalisée. Pour plus d’informations, consultez Autogénérer les métadonnées JSON pour les fonctions personnalisées : ID.

id: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.19

namespace

Représente l’espace de noms utilisé par la fonction personnalisée. Pour plus d’informations, consultez Référence du manifeste : Espace de noms.

namespace: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.19

type

Représente le type de cette valeur de cellule.

type: CellValueType.function | "Function";

Valeur de propriété

function | "Function"

Remarques

Jeu d’API : ExcelApi 1.19