Google Apps Script API
    Preparing search index...

    Interface RangeList

    A collection of one or more Range instances in the same sheet. You can use this class to apply operations on collections of non-adjacent ranges or cells.

    interface RangeList {
        activate(): RangeList;
        breakApart(): RangeList;
        check(): RangeList;
        clear(): RangeList;
        clear(
            options: {
                commentsOnly?: boolean;
                contentsOnly?: boolean;
                formatOnly?: boolean;
                skipFilteredRows?: boolean;
                validationsOnly?: boolean;
            },
        ): RangeList;
        clearContent(): RangeList;
        clearDataValidations(): RangeList;
        clearFormat(): RangeList;
        clearNote(): RangeList;
        getRanges(): GoogleAppsScript.Spreadsheet.Range[];
        insertCheckboxes(): RangeList;
        insertCheckboxes(checkedValue: any): RangeList;
        insertCheckboxes(checkedValue: any, uncheckedValue: any): RangeList;
        removeCheckboxes(): RangeList;
        setBackground(color: string): RangeList;
        setBackgroundRGB(red: number, green: number, blue: number): RangeList;
        setBorder(
            top: boolean,
            left: boolean,
            bottom: boolean,
            right: boolean,
            vertical: boolean,
            horizontal: boolean,
        ): RangeList;
        setBorder(
            top: boolean,
            left: boolean,
            bottom: boolean,
            right: boolean,
            vertical: boolean,
            horizontal: boolean,
            color: string,
            style: GoogleAppsScript.Spreadsheet.BorderStyle,
        ): RangeList;
        setFontColor(color: string): RangeList;
        setFontFamily(fontFamily: string): RangeList;
        setFontLine(fontLine: FontLine): RangeList;
        setFontSize(size: number): RangeList;
        setFontStyle(fontStyle: FontStyle): RangeList;
        setFontWeight(fontWeight: FontWeight): RangeList;
        setFormula(formula: string): RangeList;
        setFormulaR1C1(formula: string): RangeList;
        setHorizontalAlignment(
            alignment: "normal" | "left" | "center" | "right",
        ): RangeList;
        setNote(note: string): RangeList;
        setNumberFormat(numberFormat: string): RangeList;
        setShowHyperlink(showHyperlink: boolean): RangeList;
        setTextDirection(
            direction: GoogleAppsScript.Spreadsheet.TextDirection,
        ): RangeList;
        setTextRotation(degrees: number): RangeList;
        setValue(value: any): RangeList;
        setVerticalAlignment(alignment: "top" | "middle" | "bottom"): RangeList;
        setVerticalText(isVertical: boolean): RangeList;
        setWrap(isWrapEnabled: boolean): RangeList;
        setWrapStrategy(strategy: WrapStrategy): RangeList;
        trimWhitespace(): RangeList;
        uncheck(): RangeList;
    }
    Index

    Methods

    activate breakApart check clear clearContent clearDataValidations clearFormat clearNote getRanges insertCheckboxes removeCheckboxes setBackground setBackgroundRGB setBorder setFontColor setFontFamily setFontLine setFontSize setFontStyle setFontWeight setFormula setFormulaR1C1 setHorizontalAlignment setNote setNumberFormat setShowHyperlink setTextDirection setTextRotation setValue setVerticalAlignment setVerticalText setWrap setWrapStrategy trimWhitespace uncheck

    Methods

    Settings
    Member Visibility

    On This Page
    Methods