PivotEditBlockedError

Thrown when a structural edit (row/column insert, delete or move, insertCells/deleteCells, moveCells, clearCells) or a range operation (fill, sortCells) targets a range that overlaps a pivot table’s protected footprint. Excel’s GUI refuses each of these (via a modal alert or silent no-op depending on the operation); Apiary surfaces the rejection so the host application can decide how to react.

Each operation has a default message; callers can pass an operationDescription when a more specific phrasing fits the refusal (e.g. 'delete cells whose shift would tear').

Extends

• EditBlockedError

Constructors

Constructor

new PivotEditBlockedError(
   pivotTableName,
   sheetName,
   operation,
   operationDescription?): PivotEditBlockedError;

Parameters

pivotTableName

string

sheetName

string

operation

PivotBlockedOperation

operationDescription?

string

Returns

PivotEditBlockedError

Overrides

EditBlockedError.constructor

Properties

message

message: string;

Inherited from

EditBlockedError.message

---

name

name: string;

Overrides

EditBlockedError.name

---

operation

operation: PivotBlockedOperation;

The kind of edit that was refused.

---

pivotTableName

pivotTableName: string;

---

sheetName

sheetName: string;

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

Inherited from

EditBlockedError.sheetName

---

stack?

optional stack?: string;

Inherited from

EditBlockedError.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

EditBlockedError.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

EditBlockedError.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

EditBlockedError.prepareStackTrace