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.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ActiveSheetBlockedError( sheetName, workbookName, operation): ActiveSheetBlockedError;Parameters
Section titled “Parameters”sheetName
Section titled “sheetName”string
workbookName
Section titled “workbookName”string
operation
Section titled “operation”"hide" | "remove"
Returns
Section titled “Returns”ActiveSheetBlockedError
Overrides
Section titled “Overrides”Properties
Section titled “Properties”cause?
Section titled “cause?”cause?: unknown;Inherited from
Section titled “Inherited from”message
Section titled “message”message: string;Inherited from
Section titled “Inherited from”name: string = 'ActiveSheetBlockedError';Overrides
Section titled “Overrides”sheetName
Section titled “sheetName”sheetName: string;Name of the sheet holding the protected region that blocked the operation.
Inherited from
Section titled “Inherited from”stack?
Section titled “stack?”stack?: string;Inherited from
Section titled “Inherited from”workbookName
Section titled “workbookName”workbookName: string;stackTraceLimit
Section titled “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
Section titled “Inherited from”EditBlockedError.stackTraceLimit
Methods
Section titled “Methods”captureStackTrace()
Section titled “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
Section titled “Parameters”targetObject
Section titled “targetObject”object
constructorOpt?
Section titled “constructorOpt?”Function
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”EditBlockedError.captureStackTrace
isError()
Section titled “isError()”static isError(error): error is Error;Indicates whether the argument provided is a built-in Error instance or not.
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”error is Error
Inherited from
Section titled “Inherited from”prepareStackTrace()
Section titled “prepareStackTrace()”static prepareStackTrace(err, stackTraces): any;Parameters
Section titled “Parameters”Error
stackTraces
Section titled “stackTraces”CallSite[]
Returns
Section titled “Returns”any
https://v8.dev/docs/stack-trace-api#customizing-stack-traces