Excel.JavaScriptCustomFunctionReferenceCellValue interface

Paket:
excel

Stellt einen Verweis auf eine benutzerdefinierte JavaScript-Funktion dar.

Hinweise

API-Satz: ExcelApi 1.19

Beispiele

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

Eigenschaften

basicType

Stellt den Wert dar, der für eine Zelle mit diesem Wert zurückgegeben Range.valueTypes würde.
basicValue

Stellt den Wert dar, der für eine Zelle mit diesem Wert zurückgegeben Range.values würde. Wenn über eine valuesAsJson Eigenschaft auf diesen Zeichenfolgenwert zugegriffen wird, entspricht er dem Gebietsschema en-US. Wenn über eine valuesAsJsonLocal Eigenschaft auf diesen Zeichenfolgenwert zugegriffen wird, richtet er sich nach dem Anzeigegebietsschema des Benutzers.
functionType

Stellt den Typ von FunctionCellValuedar.
id

Stellt die ID der benutzerdefinierten Funktion dar. Weitere Informationen finden Sie unter Automatisches Generieren von JSON-Metadaten für benutzerdefinierte Funktionen: ID.
namespace

Stellt den Namespace dar, der von der benutzerdefinierten Funktion verwendet wird. Weitere Informationen finden Sie unter Manifestreferenz: Namespace.
type

Stellt den Typ dieses Zellwerts dar.

Details zur Eigenschaft

basicType

Stellt den Wert dar, der für eine Zelle mit diesem Wert zurückgegeben Range.valueTypes würde.

basicType?: RangeValueType.error | "Error";

Eigenschaftswert

error | "Error"

Hinweise

API-Satz: ExcelApi 1.19

basicValue

Stellt den Wert dar, der für eine Zelle mit diesem Wert zurückgegeben Range.values würde. Wenn über eine valuesAsJson Eigenschaft auf diesen Zeichenfolgenwert zugegriffen wird, entspricht er dem Gebietsschema en-US. Wenn über eine valuesAsJsonLocal Eigenschaft auf diesen Zeichenfolgenwert zugegriffen wird, richtet er sich nach dem Anzeigegebietsschema des Benutzers.

basicValue?: "#VALUE!" | string;

Eigenschaftswert

"#VALUE!" | string

Hinweise

API-Satz: ExcelApi 1.19

functionType

Stellt den Typ von FunctionCellValuedar.

functionType: FunctionCellValueType.javaScriptReference | "JavaScriptReference";

Eigenschaftswert

javaScriptReference | "JavaScriptReference"

Hinweise

API-Satz: ExcelApi 1.19

id

Stellt die ID der benutzerdefinierten Funktion dar. Weitere Informationen finden Sie unter Automatisches Generieren von JSON-Metadaten für benutzerdefinierte Funktionen: ID.

id: string;

Eigenschaftswert

string

Hinweise

API-Satz: ExcelApi 1.19

namespace

Stellt den Namespace dar, der von der benutzerdefinierten Funktion verwendet wird. Weitere Informationen finden Sie unter Manifestreferenz: Namespace.

namespace: string;

Eigenschaftswert

string

Hinweise

API-Satz: ExcelApi 1.19

type

Stellt den Typ dieses Zellwerts dar.

type: CellValueType.function | "Function";

Eigenschaftswert

function | "Function"

Hinweise

API-Satz: ExcelApi 1.19