Spreadsheet class - gsheets library

Properties

data → SpreadsheetData: Spreadsheet's additional data, see SpreadsheetData
no setter
hashCode → int: The hash code for this object.
no setterinherited
id → String: Spreadsheet's id
final
inputOption → String: Determines how input data should be interpreted. https://developers.google.com/sheets/api/reference/rest/v4/ValueInputOption
final
renderOption → String: Determines how values should be rendered in the output. https://developers.google.com/sheets/api/reference/rest/v4/ValueRenderOption
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
sheets → List<Worksheet>: List of Worksheets
final
url → String: Spreadsheet's url
final

Methods

addFromSpreadsheet(String spreadsheetId, int sheetId) → Future<Worksheet>: Copies Worksheet from another spreadsheet (the name of the copy will be "Copy of {title of copied sheet}").
addWorksheet(String title, {int rows = defaultRowsCount, int columns = defaultColumnCount}) → Future<Worksheet>: Adds new Worksheet with specified title, rows and columns.
batchUpdate(List<Map<String, dynamic>> requests) → Future<Response>: Applies one or more updates to the spreadsheet. About batchUpdate
copyWorksheet(Worksheet ws, String title, {int? index}) → Future<Worksheet?>: Copies ws with specified title and index.
deleteWorksheet(Worksheet ws) → Future<bool>: Deletes ws.
export(File file, ExportFormat format, {int? worksheetId}) → Future<File>: Exports spreadsheet in specified format and writes it to file
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
permissionByEmail(String email) → Future<Permission?>: Returns Future Permission by email.
permissions() → Future<List<Permission>>: Returns Future list of Permission.
refresh() → Future<bool>: Refreshes Spreadsheet.
revokePermissionByEmail(String email) → Future<bool>: Revokes permission by email.
revokePermissionById(String id) → Future<bool>: Revokes permission by id.
share(String user, {PermType type = PermType.user, PermRole role = PermRole.reader, bool withLink = false}) → Future<Permission>: Shares Spreadsheet.
toString() → String: A string representation of this object.
inherited
worksheetById(int id) → Worksheet?: Returns Worksheet with id.
worksheetByIndex(int index) → Worksheet?: Returns Worksheet with index.
worksheetByTitle(String title) → Worksheet?: Returns Worksheet with title.

Operators

operator ==(Object other) → bool: The equality operator.
inherited