Excel.JavaScriptCustomFunctionReferenceCellValue interface

Пакет:

excel

Представляет ссылку на пользовательскую функцию JavaScript.

Комментарии

Набор API: ExcelApi 1.19

Примеры

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

Свойства

basicType	Представляет значение, которое будет возвращено для ячейки Range.valueTypes с этим значением.
basicValue	Представляет значение, которое будет возвращено для ячейки Range.values с этим значением. При доступе через свойство valuesAsJson это строковое значение соответствует языковому стандарту en-US. При доступе через valuesAsJsonLocal свойство это строковое значение соответствует языковому стандарту отображения, выбранному пользователем.
functionType	Представляет тип FunctionCellValue.
id	Представляет идентификатор настраиваемой функции. Дополнительные сведения см. в статье Автоматическое создание метаданных JSON для пользовательских функций: ID.
namespace	Представляет пространство имен, используемое настраиваемой функцией. Дополнительные сведения см. в справочнике по манифесту: пространство имен.
type	Представляет тип значения ячейки.

Сведения о свойстве

basicType

Представляет значение, которое будет возвращено для ячейки Range.valueTypes с этим значением.

basicType?: RangeValueType.error | "Error";

Значение свойства

error | "Error"

Комментарии

Набор API: ExcelApi 1.19

basicValue

Представляет значение, которое будет возвращено для ячейки Range.values с этим значением. При доступе через свойство valuesAsJson это строковое значение соответствует языковому стандарту en-US. При доступе через valuesAsJsonLocal свойство это строковое значение соответствует языковому стандарту отображения, выбранному пользователем.

basicValue?: "#VALUE!" | string;

Значение свойства

"#VALUE!" | string

Комментарии

Набор API: ExcelApi 1.19

functionType

Представляет тип FunctionCellValue.

functionType: FunctionCellValueType.javaScriptReference | "JavaScriptReference";

Значение свойства

javaScriptReference | "JavaScriptReference"

Комментарии

Набор API: ExcelApi 1.19

id

Представляет идентификатор настраиваемой функции. Дополнительные сведения см. в статье Автоматическое создание метаданных JSON для пользовательских функций: ID.

id: string;

Значение свойства

string

Комментарии

Набор API: ExcelApi 1.19

namespace

Представляет пространство имен, используемое настраиваемой функцией. Дополнительные сведения см. в справочнике по манифесту: пространство имен.

namespace: string;

Значение свойства

string

Комментарии

Набор API: ExcelApi 1.19

type

Представляет тип значения ячейки.

type: CellValueType.function | "Function";

Значение свойства

function | "Function"

Комментарии

Набор API: ExcelApi 1.19