ReorderMergeBlockedError

Thrown when a row/column reorder (Workbook.reorderRows/reorderColumns) would cut through part of a merged cell --- a merge whose rows or columns cannot all travel together, because it straddles the moved block’s boundary or the cut falls inside its span. Excel never executes such a cut: its GUI snaps the selection outward to encompass the whole merge (even when the cut rows/columns lie strictly inside the merge’s span), and a scripted cut of the exact bisecting window errors out (GRID-is/excel-test, folder merge-straddling-row-cut). Merges that translate whole with their rows/columns still move.

Extends

• EditBlockedError

Constructors

Constructor

new ReorderMergeBlockedError(
   axis,
   mergeRef,
   sheetName): ReorderMergeBlockedError;

Parameters

axis

"col" | "row"

mergeRef

string

sheetName

string

Returns

ReorderMergeBlockedError

Overrides

EditBlockedError.constructor

Properties

axis

axis: "col" | "row";

The axis the refused reorder moved along.

---

mergeRef

mergeRef: string;

A1 range (no sheet prefix) of the merged cell the reorder would cut through.

---

message

message: string;

Inherited from

EditBlockedError.message

---

name

name: string;

Overrides

EditBlockedError.name

---

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