Google Apps Script API
    Preparing search index...

    Interface Range

    Access and modify spreadsheet ranges. A range can be a single cell in a sheet or a group of adjacent cells in a sheet.

    interface Range {
        activate(): GoogleAppsScript.Spreadsheet.Range;
        activateAsCurrentCell(): GoogleAppsScript.Spreadsheet.Range;
        addDeveloperMetadata(key: string): GoogleAppsScript.Spreadsheet.Range;
        addDeveloperMetadata(
            key: string,
            visibility: DeveloperMetadataVisibility,
        ): GoogleAppsScript.Spreadsheet.Range;
        addDeveloperMetadata(
            key: string,
            value: string,
        ): GoogleAppsScript.Spreadsheet.Range;
        addDeveloperMetadata(
            key: string,
            value: string,
            visibility: DeveloperMetadataVisibility,
        ): GoogleAppsScript.Spreadsheet.Range;
        applyColumnBanding(): Banding;
        applyColumnBanding(bandingTheme: BandingTheme): Banding;
        applyColumnBanding(
            bandingTheme: BandingTheme,
            showHeader: boolean,
            showFooter: boolean,
        ): Banding;
        applyRowBanding(): Banding;
        applyRowBanding(bandingTheme: BandingTheme): Banding;
        applyRowBanding(
            bandingTheme: BandingTheme,
            showHeader: boolean,
            showFooter: boolean,
        ): Banding;
        autoFill(
            destination: GoogleAppsScript.Spreadsheet.Range,
            series: AutoFillSeries,
        ): void;
        autoFillToNeighbor(series: AutoFillSeries): void;
        breakApart(): GoogleAppsScript.Spreadsheet.Range;
        canEdit(): boolean;
        check(): GoogleAppsScript.Spreadsheet.Range;
        clear(): GoogleAppsScript.Spreadsheet.Range;
        clear(
            options: {
                commentsOnly?: boolean;
                contentsOnly?: boolean;
                formatOnly?: boolean;
                skipFilteredRows?: boolean;
                validationsOnly?: boolean;
            },
        ): GoogleAppsScript.Spreadsheet.Range;
        clearContent(): GoogleAppsScript.Spreadsheet.Range;
        clearDataValidations(): GoogleAppsScript.Spreadsheet.Range;
        clearFormat(): GoogleAppsScript.Spreadsheet.Range;
        clearNote(): GoogleAppsScript.Spreadsheet.Range;
        collapseGroups(): GoogleAppsScript.Spreadsheet.Range;
        copyFormatToRange(
            gridId: number,
            column: number,
            columnEnd: number,
            row: number,
            rowEnd: number,
        ): void;
        copyFormatToRange(
            sheet: GoogleAppsScript.Spreadsheet.Sheet,
            column: number,
            columnEnd: number,
            row: number,
            rowEnd: number,
        ): void;
        copyTo(destination: GoogleAppsScript.Spreadsheet.Range): void;
        copyTo(
            destination: GoogleAppsScript.Spreadsheet.Range,
            copyPasteType: CopyPasteType,
            transposed: boolean,
        ): void;
        copyTo(
            destination: GoogleAppsScript.Spreadsheet.Range,
            options: { contentsOnly?: boolean; formatOnly?: boolean },
        ): void;
        copyValuesToRange(
            gridId: number,
            column: number,
            columnEnd: number,
            row: number,
            rowEnd: number,
        ): void;
        copyValuesToRange(
            sheet: GoogleAppsScript.Spreadsheet.Sheet,
            column: number,
            columnEnd: number,
            row: number,
            rowEnd: number,
        ): void;
        createDataSourcePivotTable(dataSource: DataSource): DataSourcePivotTable;
        createDataSourceTable(dataSource: DataSource): DataSourceTable;
        createDeveloperMetadataFinder(): DeveloperMetadataFinder;
        createFilter(): GoogleAppsScript.Spreadsheet.Filter;
        createPivotTable(
            sourceData: GoogleAppsScript.Spreadsheet.Range,
        ): GoogleAppsScript.Spreadsheet.PivotTable;
        createTextFinder(findText: string): TextFinder;
        deleteCells(shiftDimension: GoogleAppsScript.Spreadsheet.Dimension): void;
        expandGroups(): GoogleAppsScript.Spreadsheet.Range;
        getA1Notation(): string;
        getBackground(): string;
        getBackgroundObject(): GoogleAppsScript.Spreadsheet.Color;
        getBackgroundObjects(): GoogleAppsScript.Spreadsheet.Color[][];
        getBackgrounds(): string[][];
        getBandings(): Banding[];
        getCell(row: number, column: number): GoogleAppsScript.Spreadsheet.Range;
        getColumn(): number;
        getDataRegion(): GoogleAppsScript.Spreadsheet.Range;
        getDataRegion(
            dimension: GoogleAppsScript.Spreadsheet.Dimension,
        ): GoogleAppsScript.Spreadsheet.Range;
        getDataSourceFormula(): DataSourceFormula;
        getDataSourceFormulas(): DataSourceFormula[];
        getDataSourcePivotTables(): DataSourcePivotTable[];
        getDataSourceTables(): DataSourceTable[];
        getDataSourceUrl(): string;
        getDataTable(): DataTable;
        getDataTable(firstRowIsHeader: boolean): DataTable;
        getDataValidation(): DataValidation;
        getDataValidations(): DataValidation[][];
        getDeveloperMetadata(): GoogleAppsScript.Spreadsheet.DeveloperMetadata[];
        getDisplayValue(): string;
        getDisplayValues(): string[][];
        getFilter(): GoogleAppsScript.Spreadsheet.Filter;
        getFontColor(): string;
        getFontColorObject(): GoogleAppsScript.Spreadsheet.Color;
        getFontColorObjects(): GoogleAppsScript.Spreadsheet.Color[][];
        getFontColors(): string[][];
        getFontFamilies(): string[][];
        getFontFamily(): string;
        getFontLine(): FontLine;
        getFontLines(): FontLine[][];
        getFontSize(): number;
        getFontSizes(): number[][];
        getFontStyle(): FontStyle;
        getFontStyles(): FontStyle[][];
        getFontWeight(): FontWeight;
        getFontWeights(): FontWeight[][];
        getFormula(): string;
        getFormulaR1C1(): string;
        getFormulas(): string[][];
        getFormulasR1C1(): string[][];
        getGridId(): number;
        getHeight(): number;
        getHorizontalAlignment(): string;
        getHorizontalAlignments(): string[][];
        getLastColumn(): number;
        getLastRow(): number;
        getMergedRanges(): GoogleAppsScript.Spreadsheet.Range[];
        getNextDataCell(direction: Direction): GoogleAppsScript.Spreadsheet.Range;
        getNote(): string;
        getNotes(): string[][];
        getNumberFormat(): string;
        getNumberFormats(): string[][];
        getNumColumns(): number;
        getNumRows(): number;
        getRichTextValue(): RichTextValue;
        getRichTextValues(): RichTextValue[][];
        getRow(): number;
        getRowIndex(): number;
        getSheet(): GoogleAppsScript.Spreadsheet.Sheet;
        getTextDirection(): GoogleAppsScript.Spreadsheet.TextDirection;
        getTextDirections(): GoogleAppsScript.Spreadsheet.TextDirection[][];
        getTextRotation(): GoogleAppsScript.Spreadsheet.TextRotation;
        getTextRotations(): GoogleAppsScript.Spreadsheet.TextRotation[][];
        getTextStyle(): GoogleAppsScript.Spreadsheet.TextStyle;
        getTextStyles(): GoogleAppsScript.Spreadsheet.TextStyle[][];
        getValue(): any;
        getValues(): any[][];
        getVerticalAlignment(): string;
        getVerticalAlignments(): string[][];
        getWidth(): number;
        getWrap(): boolean;
        getWraps(): boolean[][];
        getWrapStrategies(): WrapStrategy[][];
        getWrapStrategy(): WrapStrategy;
        insertCells(
            shiftDimension: GoogleAppsScript.Spreadsheet.Dimension,
        ): GoogleAppsScript.Spreadsheet.Range;
        insertCheckboxes(): GoogleAppsScript.Spreadsheet.Range;
        insertCheckboxes(checkedValue: any): GoogleAppsScript.Spreadsheet.Range;
        insertCheckboxes(
            checkedValue: any,
            uncheckedValue: any,
        ): GoogleAppsScript.Spreadsheet.Range;
        isBlank(): boolean;
        isChecked(): boolean;
        isEndColumnBounded(): boolean;
        isEndRowBounded(): boolean;
        isPartOfMerge(): boolean;
        isStartColumnBounded(): boolean;
        isStartRowBounded(): boolean;
        merge(): GoogleAppsScript.Spreadsheet.Range;
        mergeAcross(): GoogleAppsScript.Spreadsheet.Range;
        mergeVertically(): GoogleAppsScript.Spreadsheet.Range;
        moveTo(target: GoogleAppsScript.Spreadsheet.Range): void;
        offset(
            rowOffset: number,
            columnOffset: number,
        ): GoogleAppsScript.Spreadsheet.Range;
        offset(
            rowOffset: number,
            columnOffset: number,
            numRows: number,
        ): GoogleAppsScript.Spreadsheet.Range;
        offset(
            rowOffset: number,
            columnOffset: number,
            numRows: number,
            numColumns: number,
        ): GoogleAppsScript.Spreadsheet.Range;
        protect(): Protection;
        randomize(): GoogleAppsScript.Spreadsheet.Range;
        removeCheckboxes(): GoogleAppsScript.Spreadsheet.Range;
        removeDuplicates(): GoogleAppsScript.Spreadsheet.Range;
        removeDuplicates(
            columnsToCompare: number[],
        ): GoogleAppsScript.Spreadsheet.Range;
        setBackground(color: string): GoogleAppsScript.Spreadsheet.Range;
        setBackgroundObject(
            color: GoogleAppsScript.Spreadsheet.Color,
        ): GoogleAppsScript.Spreadsheet.Range;
        setBackgroundObjects(
            color: GoogleAppsScript.Spreadsheet.Color[][],
        ): GoogleAppsScript.Spreadsheet.Range;
        setBackgroundRGB(
            red: number,
            green: number,
            blue: number,
        ): GoogleAppsScript.Spreadsheet.Range;
        setBackgrounds(color: string[][]): GoogleAppsScript.Spreadsheet.Range;
        setBorder(
            top: boolean,
            left: boolean,
            bottom: boolean,
            right: boolean,
            vertical: boolean,
            horizontal: boolean,
        ): GoogleAppsScript.Spreadsheet.Range;
        setBorder(
            top: boolean,
            left: boolean,
            bottom: boolean,
            right: boolean,
            vertical: boolean,
            horizontal: boolean,
            color: string,
            style: GoogleAppsScript.Spreadsheet.BorderStyle,
        ): GoogleAppsScript.Spreadsheet.Range;
        setDataValidation(rule: DataValidation): GoogleAppsScript.Spreadsheet.Range;
        setDataValidations(
            rules: DataValidation[][],
        ): GoogleAppsScript.Spreadsheet.Range;
        setFontColor(color: string): GoogleAppsScript.Spreadsheet.Range;
        setFontColorObject(
            color: GoogleAppsScript.Spreadsheet.Color,
        ): GoogleAppsScript.Spreadsheet.Range;
        setFontColorObjects(
            colors: GoogleAppsScript.Spreadsheet.Color[][],
        ): GoogleAppsScript.Spreadsheet.Range;
        setFontColors(colors: any[][]): GoogleAppsScript.Spreadsheet.Range;
        setFontFamilies(
            fontFamilies: string[][],
        ): GoogleAppsScript.Spreadsheet.Range;
        setFontFamily(fontFamily: string): GoogleAppsScript.Spreadsheet.Range;
        setFontLine(fontLine: FontLine): GoogleAppsScript.Spreadsheet.Range;
        setFontLines(fontLines: FontLine[][]): GoogleAppsScript.Spreadsheet.Range;
        setFontSize(size: number): GoogleAppsScript.Spreadsheet.Range;
        setFontSizes(sizes: number[][]): GoogleAppsScript.Spreadsheet.Range;
        setFontStyle(fontStyle: FontStyle): GoogleAppsScript.Spreadsheet.Range;
        setFontStyles(
            fontStyles: FontStyle[][],
        ): GoogleAppsScript.Spreadsheet.Range;
        setFontWeight(fontWeight: FontWeight): GoogleAppsScript.Spreadsheet.Range;
        setFontWeights(
            fontWeights: FontWeight[][],
        ): GoogleAppsScript.Spreadsheet.Range;
        setFormula(formula: string): GoogleAppsScript.Spreadsheet.Range;
        setFormulaR1C1(formula: string): GoogleAppsScript.Spreadsheet.Range;
        setFormulas(formulas: string[][]): GoogleAppsScript.Spreadsheet.Range;
        setFormulasR1C1(formulas: string[][]): GoogleAppsScript.Spreadsheet.Range;
        setHorizontalAlignment(
            alignment: "normal" | "left" | "center" | "right",
        ): GoogleAppsScript.Spreadsheet.Range;
        setHorizontalAlignments(
            alignments: ("normal" | "left" | "center" | "right")[][],
        ): GoogleAppsScript.Spreadsheet.Range;
        setNote(note: string): GoogleAppsScript.Spreadsheet.Range;
        setNotes(notes: string[][]): GoogleAppsScript.Spreadsheet.Range;
        setNumberFormat(numberFormat: string): GoogleAppsScript.Spreadsheet.Range;
        setNumberFormats(
            numberFormats: string[][],
        ): GoogleAppsScript.Spreadsheet.Range;
        setRichTextValue(value: RichTextValue): GoogleAppsScript.Spreadsheet.Range;
        setRichTextValues(
            values: RichTextValue[][],
        ): GoogleAppsScript.Spreadsheet.Range;
        setShowHyperlink(
            showHyperlink: boolean,
        ): GoogleAppsScript.Spreadsheet.Range;
        setTextDirection(
            direction: GoogleAppsScript.Spreadsheet.TextDirection,
        ): GoogleAppsScript.Spreadsheet.Range;
        setTextDirections(
            directions: GoogleAppsScript.Spreadsheet.TextDirection[][],
        ): GoogleAppsScript.Spreadsheet.Range;
        setTextRotation(degrees: number): GoogleAppsScript.Spreadsheet.Range;
        setTextRotation(
            rotation: GoogleAppsScript.Spreadsheet.TextRotation,
        ): GoogleAppsScript.Spreadsheet.Range;
        setTextRotations(
            rotations: GoogleAppsScript.Spreadsheet.TextRotation[][],
        ): GoogleAppsScript.Spreadsheet.Range;
        setTextStyle(
            style: GoogleAppsScript.Spreadsheet.TextStyle,
        ): GoogleAppsScript.Spreadsheet.Range;
        setTextStyles(
            styles: GoogleAppsScript.Spreadsheet.TextStyle[][],
        ): GoogleAppsScript.Spreadsheet.Range;
        setValue(value: any): GoogleAppsScript.Spreadsheet.Range;
        setValues(values: any[][]): GoogleAppsScript.Spreadsheet.Range;
        setVerticalAlignment(
            alignment: "top" | "middle" | "bottom",
        ): GoogleAppsScript.Spreadsheet.Range;
        setVerticalAlignments(
            alignments: ("top" | "middle" | "bottom")[][],
        ): GoogleAppsScript.Spreadsheet.Range;
        setVerticalText(isVertical: boolean): GoogleAppsScript.Spreadsheet.Range;
        setWrap(isWrapEnabled: boolean): GoogleAppsScript.Spreadsheet.Range;
        setWraps(isWrapEnabled: boolean[][]): GoogleAppsScript.Spreadsheet.Range;
        setWrapStrategies(
            strategies: WrapStrategy[][],
        ): GoogleAppsScript.Spreadsheet.Range;
        setWrapStrategy(strategy: WrapStrategy): GoogleAppsScript.Spreadsheet.Range;
        shiftColumnGroupDepth(delta: number): GoogleAppsScript.Spreadsheet.Range;
        shiftRowGroupDepth(delta: number): GoogleAppsScript.Spreadsheet.Range;
        sort(sortSpecObj: any): GoogleAppsScript.Spreadsheet.Range;
        splitTextToColumns(): void;
        splitTextToColumns(delimiter: string): void;
        splitTextToColumns(delimiter: TextToColumnsDelimiter): void;
        trimWhitespace(): GoogleAppsScript.Spreadsheet.Range;
        uncheck(): GoogleAppsScript.Spreadsheet.Range;
    }
    Index

    Methods

    activate activateAsCurrentCell addDeveloperMetadata applyColumnBanding applyRowBanding autoFill autoFillToNeighbor breakApart canEdit check clear clearContent clearDataValidations clearFormat clearNote collapseGroups copyFormatToRange copyTo copyValuesToRange createDataSourcePivotTable createDataSourceTable createDeveloperMetadataFinder createFilter createPivotTable createTextFinder deleteCells expandGroups getA1Notation getBackground getBackgroundObject getBackgroundObjects getBackgrounds getBandings getCell getColumn getDataRegion getDataSourceFormula getDataSourceFormulas getDataSourcePivotTables getDataSourceTables getDataSourceUrl getDataTable getDataValidation getDataValidations getDeveloperMetadata getDisplayValue getDisplayValues getFilter getFontColor getFontColorObject getFontColorObjects getFontColors getFontFamilies getFontFamily getFontLine getFontLines getFontSize getFontSizes getFontStyle getFontStyles getFontWeight getFontWeights getFormula getFormulaR1C1 getFormulas getFormulasR1C1 getGridId getHeight getHorizontalAlignment getHorizontalAlignments getLastColumn getLastRow getMergedRanges getNextDataCell getNote getNotes getNumberFormat getNumberFormats getNumColumns getNumRows getRichTextValue getRichTextValues getRow getRowIndex getSheet getTextDirection getTextDirections getTextRotation getTextRotations getTextStyle getTextStyles getValue getValues getVerticalAlignment getVerticalAlignments getWidth getWrap getWraps getWrapStrategies getWrapStrategy insertCells insertCheckboxes isBlank isChecked isEndColumnBounded isEndRowBounded isPartOfMerge isStartColumnBounded isStartRowBounded merge mergeAcross mergeVertically moveTo offset protect randomize removeCheckboxes removeDuplicates setBackground setBackgroundObject setBackgroundObjects setBackgroundRGB setBackgrounds setBorder setDataValidation setDataValidations setFontColor setFontColorObject setFontColorObjects setFontColors setFontFamilies setFontFamily setFontLine setFontLines setFontSize setFontSizes setFontStyle setFontStyles setFontWeight setFontWeights setFormula setFormulaR1C1 setFormulas setFormulasR1C1 setHorizontalAlignment setHorizontalAlignments setNote setNotes setNumberFormat setNumberFormats setRichTextValue setRichTextValues setShowHyperlink setTextDirection setTextDirections setTextRotation setTextRotations setTextStyle setTextStyles setValue setValues setVerticalAlignment setVerticalAlignments setVerticalText setWrap setWraps setWrapStrategies setWrapStrategy shiftColumnGroupDepth shiftRowGroupDepth sort splitTextToColumns trimWhitespace uncheck

    Methods

    Settings
    Member Visibility

    On This Page
    Methods
    activate activateAsCurrentCell addDeveloperMetadata applyColumnBanding applyRowBanding autoFill autoFillToNeighbor breakApart canEdit check clear clearContent clearDataValidations clearFormat clearNote collapseGroups copyFormatToRange copyTo copyValuesToRange createDataSourcePivotTable createDataSourceTable createDeveloperMetadataFinder createFilter createPivotTable createTextFinder deleteCells expandGroups getA1Notation getBackground getBackgroundObject getBackgroundObjects getBackgrounds getBandings getCell getColumn getDataRegion getDataSourceFormula getDataSourceFormulas getDataSourcePivotTables getDataSourceTables getDataSourceUrl getDataTable getDataValidation getDataValidations getDeveloperMetadata getDisplayValue getDisplayValues getFilter getFontColor getFontColorObject getFontColorObjects getFontColors getFontFamilies getFontFamily getFontLine getFontLines getFontSize getFontSizes getFontStyle getFontStyles getFontWeight getFontWeights getFormula getFormulaR1C1 getFormulas getFormulasR1C1 getGridId getHeight getHorizontalAlignment getHorizontalAlignments getLastColumn getLastRow getMergedRanges getNextDataCell getNote getNotes getNumberFormat getNumberFormats getNumColumns getNumRows getRichTextValue getRichTextValues getRow getRowIndex getSheet getTextDirection getTextDirections getTextRotation getTextRotations getTextStyle getTextStyles getValue getValues getVerticalAlignment getVerticalAlignments getWidth getWrap getWraps getWrapStrategies getWrapStrategy insertCells insertCheckboxes isBlank isChecked isEndColumnBounded isEndRowBounded isPartOfMerge isStartColumnBounded isStartRowBounded merge mergeAcross mergeVertically moveTo offset protect randomize removeCheckboxes removeDuplicates setBackground setBackgroundObject setBackgroundObjects setBackgroundRGB setBackgrounds setBorder setDataValidation setDataValidations setFontColor setFontColorObject setFontColorObjects setFontColors setFontFamilies setFontFamily setFontLine setFontLines setFontSize setFontSizes setFontStyle setFontStyles setFontWeight setFontWeights setFormula setFormulaR1C1 setFormulas setFormulasR1C1 setHorizontalAlignment setHorizontalAlignments setNote setNotes setNumberFormat setNumberFormats setRichTextValue setRichTextValues setShowHyperlink setTextDirection setTextDirections setTextRotation setTextRotations setTextStyle setTextStyles setValue setValues setVerticalAlignment setVerticalAlignments setVerticalText setWrap setWraps setWrapStrategies setWrapStrategy shiftColumnGroupDepth shiftRowGroupDepth sort splitTextToColumns trimWhitespace uncheck