EditBlockedError

Base class for the engine’s edit-guard refusals: operations the engine rejects to protect a structure Excel also protects --- pivot table output, what-if data table results, worksheet tables, merged cells and spill ranges under sort, and pivot refreshes that would produce an invalid or overlapping result. Excel refuses the same operations via a modal alert or a silent no-op; Apiary throws so the host application can decide how to react --- swallow the error to reproduce Excel’s no-op, or surface it to the user.

Every edit guard throws a subclass of this class, so a host can catch the whole family with a single instanceof EditBlockedError test and fall back to per-class handling only where it wants to distinguish refusals.

Extends

• Error

Extended by

• PivotEditBlockedError
• PivotCellWriteBlockedError
• MergedCellWriteBlockedError
• PivotOutputOverlapsDataError
• PivotDuplicateSourceHeadersError
• TableEditBlockedError
• SortCellsBlockedError
• ReorderMergeBlockedError
• SheetEdgeBlockedError
• DataTableEditBlockedError

Constructors

Constructor

new EditBlockedError(message, sheetName): EditBlockedError;

Parameters

message

string

sheetName

string

Returns

EditBlockedError

Overrides

Error.constructor

Properties

message

message: string;

Inherited from

Error.message

---

name

name: string;

Inherited from

Error.name

---

sheetName

sheetName: string;

Name of the sheet holding the protected region that blocked the operation.

---

stack?

optional stack?: string;

Inherited from

Error.stack

---

stackTraceLimit

static stackTraceLimit: number;

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace