Edit

Share via

Excel.JavaScriptCustomFunctionReferenceCellValue interface

  • Reference
Package:
excel

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents a reference to a JavaScript custom function.

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Properties

basicType

Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue

Represents the value that would be returned by Range.values for a cell with this value. When accessed through a valuesAsJson property, this string value aligns with the en-US locale. When accessed through a valuesAsJsonLocal property, this string value aligns with the user's display locale.
functionType

Represents the type of FunctionCellValue.
id

Represents the ID of the custom function. For more information, see Autogenerate JSON metadata for custom functions: ID.
namespace

Represents the namespace used by the custom function. For more information, see Manifest reference: Namespace.
type

Represents the type of this cell value.

Property Details

basicType

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the value that would be returned by Range.valueTypes for a cell with this value.

basicType?: RangeValueType.error | "Error";

Property Value

error | "Error"

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

basicValue

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the value that would be returned by Range.values for a cell with this value. When accessed through a valuesAsJson property, this string value aligns with the en-US locale. When accessed through a valuesAsJsonLocal property, this string value aligns with the user's display locale.

basicValue?: "#VALUE!" | string;

Property Value

"#VALUE!" | string

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

functionType

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the type of FunctionCellValue.

functionType: FunctionCellValueType.javaScriptReference | "JavaScriptReference";

Property Value

javaScriptReference | "JavaScriptReference"

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

id

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the ID of the custom function. For more information, see Autogenerate JSON metadata for custom functions: ID.

id: string;

Property Value

string

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

namespace

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the namespace used by the custom function. For more information, see Manifest reference: Namespace.

namespace: string;

Property Value

string

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

type

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the type of this cell value.

type: CellValueType.function | "Function";

Property Value

function | "Function"

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]