Trait/Object

com.google.appsscript.spreadsheet

SpreadsheetApp

Related Docs: object SpreadsheetApp | package spreadsheet

Permalink

trait SpreadsheetApp extends Object

SpreadsheetApp This class allows users to open Google Sheets files and to create new ones. This class is the parent class for the Spreadsheet service.

Annotations
@RawJSType()
Linear Supertypes
Object, Any, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SpreadsheetApp
  2. Object
  3. Any
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def create(name: String, rows: Int, columns: Int): Spreadsheet

    Permalink

    Creates a new spreadsheet with the given name and the specified number of rows and columns.

  7. def create(name: String): Spreadsheet

    Permalink

    Creates a new spreadsheet with the given name.

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def flush(): Unit

    Permalink

    Applies all pending Spreadsheet changes.

    Applies all pending Spreadsheet changes. Spreadsheet operations are sometimes bundled together to improve performance, such as when doing multiple calls to Range.getValue(). However, sometimes you may want to make sure that all pending changes are made right away, for instance to show users data as a script is executing.

  12. def getActive(): Spreadsheet

    Permalink

    Returns the currently active spreadsheet, or null if there is none.

    Returns the currently active spreadsheet, or null if there is none. Functions that are run in the context of a spreadsheet can get a reference to the corresponding Spreadsheet object by calling this function.

  13. def getActiveRange(): Range

    Permalink

    Returns the range of cells that is currently considered active.

    Returns the range of cells that is currently considered active. This generally means the range that a user has selected in the active sheet, but in a custom function it refers to the cell being actively recalculated.

  14. def getActiveSheet(): Sheet

    Permalink

    Gets the active sheet in a spreadsheet.

    Gets the active sheet in a spreadsheet. The active sheet in a spreadsheet is the sheet that is being displayed in the spreadsheet UI.

  15. def getActiveSpreadsheet(): Spreadsheet

    Permalink

    Returns the currently active spreadsheet, or null if there is none.

    Returns the currently active spreadsheet, or null if there is none. Functions that are run in the context of a spreadsheet can get a reference to the corresponding Spreadsheet object by calling this function.

  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. def getUi(): Ui

    Permalink

    Returns an instance of the spreadsheet's user-interface environment that allows the script to add features like menus, dialogs, and sidebars.

    Returns an instance of the spreadsheet's user-interface environment that allows the script to add features like menus, dialogs, and sidebars. A script can only interact with the UI for the current instance of an open spreadsheet, and only if the script is bound to the spreadsheet. For more information, see the guides to menus and dialogs and sidebars.

  18. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  19. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  21. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  22. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  23. def newDataValidation(): DataValidationBuilder

    Permalink

    Creates a builder for a data-validation rule.

  24. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. def open(file: File): Spreadsheet

    Permalink

    Opens the spreadsheet that corresponds to the given File object.

  27. def openById(id: String): Spreadsheet

    Permalink

    Opens the spreadsheet with the given ID.

    Opens the spreadsheet with the given ID. A spreadsheet ID can be extracted from its URL. For example, the spreadsheet ID in the URL https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0 is "abc1234567".

  28. def openByUrl(url: String): Spreadsheet

    Permalink

    Opens the spreadsheet with the given url.

  29. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  30. def setActiveRange(range: Range): Range

    Permalink

    Sets the active range for the application.

    Sets the active range for the application. The spreadsheet UI will display the sheet that contains the chosen range and will select the cells defined in the chosen range.

  31. def setActiveSheet(sheet: Sheet): Sheet

    Permalink

    Sets the active sheet in a spreadsheet.

    Sets the active sheet in a spreadsheet. The spreadsheet UI will display the chosen sheet unless the sheet belongs to a different spreadsheet.

  32. def setActiveSpreadsheet(newActiveSpreadsheet: Spreadsheet): Unit

    Permalink

    Sets the active spreadsheet.

  33. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  34. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  35. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  36. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  37. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped