Google Apps Script API
    Preparing search index...

    Interface Sheet

    Access and modify spreadsheet sheets. Common operations are renaming a sheet and accessing range objects from the sheet.

    interface Sheet {
        activate(): GoogleAppsScript.Spreadsheet.Sheet;
        addDeveloperMetadata(key: string): GoogleAppsScript.Spreadsheet.Sheet;
        addDeveloperMetadata(
            key: string,
            visibility: DeveloperMetadataVisibility,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        addDeveloperMetadata(
            key: string,
            value: string,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        addDeveloperMetadata(
            key: string,
            value: string,
            visibility: DeveloperMetadataVisibility,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        appendRow(rowContents: any[]): GoogleAppsScript.Spreadsheet.Sheet;
        asDataSourceSheet(): DataSourceSheet;
        autoResizeColumn(
            columnPosition: number,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        autoResizeColumns(
            startColumn: number,
            numColumns: number,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        autoResizeRows(
            startRow: number,
            numRows: number,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        clear(): GoogleAppsScript.Spreadsheet.Sheet;
        clear(
            options: { contentsOnly?: boolean; formatOnly?: boolean },
        ): GoogleAppsScript.Spreadsheet.Sheet;
        clearConditionalFormatRules(): void;
        clearContents(): GoogleAppsScript.Spreadsheet.Sheet;
        clearFormats(): GoogleAppsScript.Spreadsheet.Sheet;
        clearNotes(): GoogleAppsScript.Spreadsheet.Sheet;
        collapseAllColumnGroups(): GoogleAppsScript.Spreadsheet.Sheet;
        collapseAllRowGroups(): GoogleAppsScript.Spreadsheet.Sheet;
        copyTo(
            spreadsheet: GoogleAppsScript.Spreadsheet.Spreadsheet,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        createDeveloperMetadataFinder(): DeveloperMetadataFinder;
        createTextFinder(findText: string): TextFinder;
        deleteColumn(columnPosition: number): GoogleAppsScript.Spreadsheet.Sheet;
        deleteColumns(columnPosition: number, howMany: number): void;
        deleteRow(rowPosition: number): GoogleAppsScript.Spreadsheet.Sheet;
        deleteRows(rowPosition: number, howMany: number): void;
        expandAllColumnGroups(): GoogleAppsScript.Spreadsheet.Sheet;
        expandAllRowGroups(): GoogleAppsScript.Spreadsheet.Sheet;
        expandColumnGroupsUpToDepth(
            groupDepth: number,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        expandRowGroupsUpToDepth(
            groupDepth: number,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        getActiveCell(): GoogleAppsScript.Spreadsheet.Range;
        getActiveRange(): GoogleAppsScript.Spreadsheet.Range;
        getActiveRangeList(): RangeList;
        getBandings(): Banding[];
        getCharts(): GoogleAppsScript.Spreadsheet.EmbeddedChart[];
        getColumnGroup(
            columnIndex: number,
            groupDepth: number,
        ): GoogleAppsScript.Spreadsheet.Group;
        getColumnGroupControlPosition(): GroupControlTogglePosition;
        getColumnGroupDepth(columnIndex: number): number;
        getColumnWidth(columnPosition: number): number;
        getConditionalFormatRules(): GoogleAppsScript.Spreadsheet.ConditionalFormatRule[];
        getCurrentCell(): GoogleAppsScript.Spreadsheet.Range;
        getDataRange(): GoogleAppsScript.Spreadsheet.Range;
        getDataSourceTables(): DataSourceTable[];
        getDeveloperMetadata(): GoogleAppsScript.Spreadsheet.DeveloperMetadata[];
        getDrawings(): Drawing[];
        getFilter(): GoogleAppsScript.Spreadsheet.Filter;
        getFormUrl(): string;
        getFrozenColumns(): number;
        getFrozenRows(): number;
        getImages(): OverGridImage[];
        getIndex(): number;
        getLastColumn(): number;
        getLastRow(): number;
        getMaxColumns(): number;
        getMaxRows(): number;
        getName(): string;
        getNamedRanges(): GoogleAppsScript.Spreadsheet.NamedRange[];
        getParent(): GoogleAppsScript.Spreadsheet.Spreadsheet;
        getPivotTables(): GoogleAppsScript.Spreadsheet.PivotTable[];
        getProtections(type: ProtectionType): Protection[];
        getRange(row: number, column: number): GoogleAppsScript.Spreadsheet.Range;
        getRange(
            row: number,
            column: number,
            numRows: number,
        ): GoogleAppsScript.Spreadsheet.Range;
        getRange(
            row: number,
            column: number,
            numRows: number,
            numColumns: number,
        ): GoogleAppsScript.Spreadsheet.Range;
        getRange(a1Notation: string): GoogleAppsScript.Spreadsheet.Range;
        getRangeList(a1Notations: string[]): RangeList;
        getRowGroup(
            rowIndex: number,
            groupDepth: number,
        ): GoogleAppsScript.Spreadsheet.Group;
        getRowGroupControlPosition(): GroupControlTogglePosition;
        getRowGroupDepth(rowIndex: number): number;
        getRowHeight(rowPosition: number): number;
        getSelection(): GoogleAppsScript.Spreadsheet.Selection;
        getSheetId(): number;
        getSheetName(): string;
        getSheetProtection(): PageProtection;
        getSheetValues(
            startRow: number,
            startColumn: number,
            numRows: number,
            numColumns: number,
        ): any[][];
        getSlicers(): Slicer[];
        getTabColor(): string;
        getType(): SheetType;
        hasHiddenGridlines(): boolean;
        hideColumn(column: GoogleAppsScript.Spreadsheet.Range): void;
        hideColumns(columnIndex: number): void;
        hideColumns(columnIndex: number, numColumns: number): void;
        hideRow(row: GoogleAppsScript.Spreadsheet.Range): void;
        hideRows(rowIndex: number): void;
        hideRows(rowIndex: number, numRows: number): void;
        hideSheet(): GoogleAppsScript.Spreadsheet.Sheet;
        insertChart(chart: GoogleAppsScript.Spreadsheet.EmbeddedChart): void;
        insertColumnAfter(
            afterPosition: number,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        insertColumnBefore(
            beforePosition: number,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        insertColumns(columnIndex: number): void;
        insertColumns(columnIndex: number, numColumns: number): void;
        insertColumnsAfter(
            afterPosition: number,
            howMany: number,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        insertColumnsBefore(
            beforePosition: number,
            howMany: number,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        insertImage(
            blobSource: BlobSource,
            column: number,
            row: number,
        ): OverGridImage;
        insertImage(
            blobSource: BlobSource,
            column: number,
            row: number,
            offsetX: number,
            offsetY: number,
        ): OverGridImage;
        insertImage(url: string, column: number, row: number): OverGridImage;
        insertImage(
            url: string,
            column: number,
            row: number,
            offsetX: number,
            offsetY: number,
        ): OverGridImage;
        insertRowAfter(afterPosition: number): GoogleAppsScript.Spreadsheet.Sheet;
        insertRowBefore(beforePosition: number): GoogleAppsScript.Spreadsheet.Sheet;
        insertRows(rowIndex: number): void;
        insertRows(rowIndex: number, numRows: number): void;
        insertRowsAfter(
            afterPosition: number,
            howMany: number,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        insertRowsBefore(
            beforePosition: number,
            howMany: number,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        insertSlicer(
            range: GoogleAppsScript.Spreadsheet.Range,
            anchorRowPos: number,
            anchorColPos: number,
        ): Slicer;
        insertSlicer(
            range: GoogleAppsScript.Spreadsheet.Range,
            anchorRowPos: number,
            anchorColPos: number,
            offsetX: number,
            offsetY: number,
        ): Slicer;
        isColumnHiddenByUser(columnPosition: number): boolean;
        isRightToLeft(): boolean;
        isRowHiddenByFilter(rowPosition: number): boolean;
        isRowHiddenByUser(rowPosition: number): boolean;
        isSheetHidden(): boolean;
        moveColumns(
            columnSpec: GoogleAppsScript.Spreadsheet.Range,
            destinationIndex: number,
        ): void;
        moveRows(
            rowSpec: GoogleAppsScript.Spreadsheet.Range,
            destinationIndex: number,
        ): void;
        newChart(): EmbeddedChartBuilder;
        protect(): Protection;
        removeChart(chart: GoogleAppsScript.Spreadsheet.EmbeddedChart): void;
        setActiveRange(
            range: GoogleAppsScript.Spreadsheet.Range,
        ): GoogleAppsScript.Spreadsheet.Range;
        setActiveRangeList(rangeList: RangeList): RangeList;
        setActiveSelection(
            range: GoogleAppsScript.Spreadsheet.Range,
        ): GoogleAppsScript.Spreadsheet.Range;
        setActiveSelection(a1Notation: string): GoogleAppsScript.Spreadsheet.Range;
        setColumnGroupControlPosition(
            position: GroupControlTogglePosition,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        setColumnWidth(
            columnPosition: number,
            width: number,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        setColumnWidths(
            startColumn: number,
            numColumns: number,
            width: number,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        setConditionalFormatRules(
            rules: GoogleAppsScript.Spreadsheet.ConditionalFormatRule[],
        ): void;
        setCurrentCell(
            cell: GoogleAppsScript.Spreadsheet.Range,
        ): GoogleAppsScript.Spreadsheet.Range;
        setFrozenColumns(columns: number): void;
        setFrozenRows(rows: number): void;
        setHiddenGridlines(
            hideGridlines: boolean,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        setName(name: string): GoogleAppsScript.Spreadsheet.Sheet;
        setRightToLeft(rightToLeft: boolean): GoogleAppsScript.Spreadsheet.Sheet;
        setRowGroupControlPosition(
            position: GroupControlTogglePosition,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        setRowHeight(
            rowPosition: number,
            height: number,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        setRowHeights(
            startRow: number,
            numRows: number,
            height: number,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        setRowHeightsForced(
            startRow: number,
            numRows: number,
            height: number,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        setSheetProtection(permissions: PageProtection): void;
        setTabColor(color: string): GoogleAppsScript.Spreadsheet.Sheet;
        showColumns(columnIndex: number): void;
        showColumns(columnIndex: number, numColumns: number): void;
        showRows(rowIndex: number): void;
        showRows(rowIndex: number, numRows: number): void;
        showSheet(): GoogleAppsScript.Spreadsheet.Sheet;
        sort(columnPosition: number): GoogleAppsScript.Spreadsheet.Sheet;
        sort(
            columnPosition: number,
            ascending: boolean,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        unhideColumn(column: GoogleAppsScript.Spreadsheet.Range): void;
        unhideRow(row: GoogleAppsScript.Spreadsheet.Range): void;
        updateChart(chart: GoogleAppsScript.Spreadsheet.EmbeddedChart): void;
    }
    Index

    Methods

    activate addDeveloperMetadata appendRow asDataSourceSheet autoResizeColumn autoResizeColumns autoResizeRows clear clearConditionalFormatRules clearContents clearFormats clearNotes collapseAllColumnGroups collapseAllRowGroups copyTo createDeveloperMetadataFinder createTextFinder deleteColumn deleteColumns deleteRow deleteRows expandAllColumnGroups expandAllRowGroups expandColumnGroupsUpToDepth expandRowGroupsUpToDepth getActiveCell getActiveRange getActiveRangeList getBandings getCharts getColumnGroup getColumnGroupControlPosition getColumnGroupDepth getColumnWidth getConditionalFormatRules getCurrentCell getDataRange getDataSourceTables getDeveloperMetadata getDrawings getFilter getFormUrl getFrozenColumns getFrozenRows getImages getIndex getLastColumn getLastRow getMaxColumns getMaxRows getName getNamedRanges getParent getPivotTables getProtections getRange getRangeList getRowGroup getRowGroupControlPosition getRowGroupDepth getRowHeight getSelection getSheetId getSheetName getSheetProtection getSheetValues getSlicers getTabColor getType hasHiddenGridlines hideColumn hideColumns hideRow hideRows hideSheet insertChart insertColumnAfter insertColumnBefore insertColumns insertColumnsAfter insertColumnsBefore insertImage insertRowAfter insertRowBefore insertRows insertRowsAfter insertRowsBefore insertSlicer isColumnHiddenByUser isRightToLeft isRowHiddenByFilter isRowHiddenByUser isSheetHidden moveColumns moveRows newChart protect removeChart setActiveRange setActiveRangeList setActiveSelection setColumnGroupControlPosition setColumnWidth setColumnWidths setConditionalFormatRules setCurrentCell setFrozenColumns setFrozenRows setHiddenGridlines setName setRightToLeft setRowGroupControlPosition setRowHeight setRowHeights setRowHeightsForced setSheetProtection setTabColor showColumns showRows showSheet sort unhideColumn unhideRow updateChart

    Methods

    Settings
    Member Visibility

    On This Page
    Methods
    activate addDeveloperMetadata appendRow asDataSourceSheet autoResizeColumn autoResizeColumns autoResizeRows clear clearConditionalFormatRules clearContents clearFormats clearNotes collapseAllColumnGroups collapseAllRowGroups copyTo createDeveloperMetadataFinder createTextFinder deleteColumn deleteColumns deleteRow deleteRows expandAllColumnGroups expandAllRowGroups expandColumnGroupsUpToDepth expandRowGroupsUpToDepth getActiveCell getActiveRange getActiveRangeList getBandings getCharts getColumnGroup getColumnGroupControlPosition getColumnGroupDepth getColumnWidth getConditionalFormatRules getCurrentCell getDataRange getDataSourceTables getDeveloperMetadata getDrawings getFilter getFormUrl getFrozenColumns getFrozenRows getImages getIndex getLastColumn getLastRow getMaxColumns getMaxRows getName getNamedRanges getParent getPivotTables getProtections getRange getRangeList getRowGroup getRowGroupControlPosition getRowGroupDepth getRowHeight getSelection getSheetId getSheetName getSheetProtection getSheetValues getSlicers getTabColor getType hasHiddenGridlines hideColumn hideColumns hideRow hideRows hideSheet insertChart insertColumnAfter insertColumnBefore insertColumns insertColumnsAfter insertColumnsBefore insertImage insertRowAfter insertRowBefore insertRows insertRowsAfter insertRowsBefore insertSlicer isColumnHiddenByUser isRightToLeft isRowHiddenByFilter isRowHiddenByUser isSheetHidden moveColumns moveRows newChart protect removeChart setActiveRange setActiveRangeList setActiveSelection setColumnGroupControlPosition setColumnWidth setColumnWidths setConditionalFormatRules setCurrentCell setFrozenColumns setFrozenRows setHiddenGridlines setName setRightToLeft setRowGroupControlPosition setRowHeight setRowHeights setRowHeightsForced setSheetProtection setTabColor showColumns showRows showSheet sort unhideColumn unhideRow updateChart