custom-functions-runtime package

Классы

CustomFunctions.Error

Используйте этот класс для обработки ошибок и написания пользовательских сообщений об ошибках.

Интерфейсы

CustomFunctions.CancelableInvocation	Предоставляет сведения о вызове настраиваемой функции, которую можно отменить. Настраиваемая функция, поддерживающая отмену, может предоставлять обработчик для события onCanceled. Чтобы указать, что функция может быть отменена, в JSON-файле метаданных в параметрах функции должны быть указаны: { "cancelable": true } Если JSON-файл метаданных генерируется из комментариев JSDoc, добавьте тег @cancelable.
CustomFunctions.Invocation	Предоставляет сведения о вызове пользовательской функции.
CustomFunctions.StreamingInvocation	Предоставляет сведения о вызове пользовательской функции потоковой передачи. Настраиваемая функция потоковой передачи может предоставлять результаты, которые могут меняться со временем. Вызовите setResult() один или несколько раз, чтобы предоставить результат вместо возврата результата из функции.

Перечисления

CustomFunctions.ErrorCode

Коды ошибок для пользовательских функций. В ячейке, вызвавшей функцию, отобразятся коды ошибок. В дополнение к этим кодам ошибок отображаются настраиваемые сообщения об ошибках. Пользовательские сообщения отображаются в меню индикатора ошибки, которое можно открыть, наведя курсор на флаг ошибки в каждой ячейке с ошибкой.

Функции

CustomFunctions.associate(id, functionObject)	Связывает функцию JavaScript с именем, указанным свойством "id" в JSON-файле метаданных.
CustomFunctions.associate(mappings)	Связывает функции JavaScript с именами, указанными свойствами "id" в JSON-файле метаданных.

Сведения о функции

CustomFunctions.associate(id, functionObject)

Связывает функцию JavaScript с именем, указанным свойством "id" в JSON-файле метаданных.

export function associate(id: string, functionObject: Function): void;

Параметры

id

string

functionObject

Function

Возвращаемое значение

void

Примеры

/**
* Adds two numbers together.
* @customfunction
* @param {number} first First number.
* @param {number} second Second number.
* @returns {number} The sum of the two numbers.
*/
// Define your custom function.
function add(first, second) {
  return first + second;
}

// Associate the "add" function with its ID from the JSON metadata. In this sample, the JSON metadata ID is "ADD".
CustomFunctions.associate("ADD", add);

CustomFunctions.associate(mappings)

Связывает функции JavaScript с именами, указанными свойствами "id" в JSON-файле метаданных.

export function associate(mappings: { [key: string]: Function }): void;

Параметры

mappings

{ [key: string]: Function }

Возвращаемое значение

void

Примеры

/**
* Calculates the area of a rectangle.
* @customfunction
* @param {number} width The width of the rectangle.
* @param {number} height The height of the rectangle.
* @returns {number} The area of the rectangle.
*/
function calculateArea(width, height) {
  return width * height;
}

/**
* Calculates the perimeter of a rectangle.
* @customfunction
* @param {number} width The width of the rectangle.
* @param {number} height The height of the rectangle.
* @returns {number} The perimeter of the rectangle.
*/
function calculatePerimeter(width, height) {
  return 2 * (width + height);
}

// Associate multiple functions at once using an object that maps JSON metadata IDs to function names.
// In this sample, the "calculateArea" and "calculatePerimeter" functions have the JSON metadata IDs "CALCULATEAREA" and "CALCULATEPERIMETER".
CustomFunctions.associate({
  "CALCULATEAREA": calculateArea,
  "CALCULATEPERIMETER": calculatePerimeter
});