Skip to content
Apiary

ActiveSheetBlockedError

Thrown when Workbook.setSheetHidden is asked to hide, or very hide, a visible sheet that is the active sheet of a workbook view, or Workbook.removeSheet to remove a view’s active sheet. Make another sheet active with WorkbookView.setActiveSheetName in every view where this sheet is active.

A workbook with no views has its first sheet active: that sheet cannot be hidden, though it can be removed. Add a view with workbook.views.add() to make another sheet active.

Excel permits both edits: it hides or removes the sheet and makes a neighbouring sheet active itself. Apiary leaves the choice of that sheet to the host.

new ActiveSheetBlockedError(
sheetName,
workbookName,
operation
): ActiveSheetBlockedError;

string

string

"hide" | "remove"

ActiveSheetBlockedError

EditBlockedError.constructor

cause?: unknown;

EditBlockedError.cause


message: string;

EditBlockedError.message


name: string = 'ActiveSheetBlockedError';

EditBlockedError.name


sheetName: string;

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

EditBlockedError.sheetName


stack?: string;

EditBlockedError.stack


workbookName: string;

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.

EditBlockedError.stackTraceLimit

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();

object

Function

void

EditBlockedError.captureStackTrace


static isError(error): error is Error;

Indicates whether the argument provided is a built-in Error instance or not.

unknown

error is Error

EditBlockedError.isError


static prepareStackTrace(err, stackTraces): any;

Error

CallSite[]

any

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

EditBlockedError.prepareStackTrace