Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Sheet

Hierarchy

Index

Properties

Methods

Properties

index

index: number
returns

The index of the sheet within the published tabs. Note that hidden tabs are still counted in the ordering, as long as they are published.

isActive

isActive: boolean
returns

A value indicating whether the sheet is the currently active sheet.

isHidden

isHidden: boolean
returns

A value indicating whether the sheet is hidden (true) or visible (false) in the UI. Note that if the entire tab control is hidden, it does not affect the state of this flag. This sheet may still report that it is visible even when the tabs control is hidden.

name

name: string
returns

The name of the sheet.

sheetType

sheetType: SheetType
returns

The type of the sheet.

size

size: SheetSize
returns

The size information that the author specified when publishing the workbook.

url

url: string
returns

the URL for this sheet.

workbook

workbook: Workbook
returns

The workbook containing this sheet

Methods

changeSizeAsync

  • Sets the size information of a sheet. Note that if the sheet is a Worksheet, only SheetSizeBehavior.Automatic is allowed since you can't actually set a Worksheet to a fixed size.

    Parameters

    Returns Promise<SheetSize>