- Preparing search index...
- The search index is not available
GoogleSheet Class
Heirarchy
- GoogleSheet
Constructors
Properties
Methods
Events
Constructors
constructor
-
Initializes a new instance of the GoogleSheet class.
Parameters
-
sheetId: string
Parameter used to identify which GoogleSheet is to be accessed. This ID is the value between the "/d/" and the "/edit" in the URL of your GoogleSheet.
-
apiKey: string
Identifier used to authenticate requests associated with the app. To generate API keys, please go to https://console.cloud.google.com/.
-
Optional options: any
JavaScript object containing initialization data (property values and event handlers) for this GoogleSheet.
Returns GoogleSheet
-
Properties
accessToken
Gets or sets the OAuth 2.0 access token used to gain write access to the sheet.
You can use the OAuth2 class to provide user authentication. The OAuth2 class has methods that allow users to log in and provides accessToken strings that can be used to access the sheet.
apiKey
Gets the API key that this GoogleSheet is associated with.
columnDataTypes
Gets or sets an array containing IColumnDataType objects that determine the data types for the sheet columns.
Column data types are determined automatically based on the sheet data. In some cases, however, you may want to override that and set the column data types explicitly. This may be useful for sheets that contain empty cells or columns with cells of mixed types.
The code below causes the GoogleSheet to parse columns named "PostalCode", "Phone", and "Fax" as strings and any columns with names ending in "Date" as dates:
import { DataType } from '@grapecity/wijmo';
import { GoogleSheet } from '@grapecity/google';
let ssNWind = new GoogleSheet(SHEET_ID_NW, {
apiKey: API_KEY,
columnDataTypes: [
{ pattern: /^(PostalCode|Phone|Fax)$/, dataType: DataType.String },
{ pattern: /Date$/, dataType: DataType.Date },
]
});isLoading
Gets a value that indicates the GoogleSheet is currently loading data.
This property can be used to provide progress indicators.
sheetId
Gets the ID of this GoogleSheet.
sheets
Gets the list of Sheet objects in this GoogleSheet.
Methods
getSheet
-
Gets a Sheet by its Sheet.title.
Parameters
-
title: string
Sheet title to look for.
Returns Sheet
-
onAccessTokenChanged
-
Raises the accessTokenChanged event.
Parameters
-
Optional e: EventArgs
Returns void
-
onError
-
Raises the error event.
By default, errors throw exceptions and trigger a data refresh. If you want to prevent this behavior, set the RequestErrorEventArgs.cancel parameter to true in the event handler.
Parameters
-
e: RequestErrorEventArgs
RequestErrorEventArgs that contains information about the error.
Returns boolean
-
onLoaded
onLoading
Events
accessTokenChanged
Occurs when the value of the accessToken property changes.
error
Occurs when there is an error reading or writing data.
loaded
Occurs when the GoogleSheet finishes loading data.
loading
Occurs when the GoogleSheet starts loading data.
Represents a Google Sheets spreadsheet with one or more sheets.
Each sheet is represented by a Sheet object that exposes the data on the sheet as a CollectionView object which can be used as a data source for any Wijmo control.
In addition to full CRUD support you get all the CollectionView features including sorting, filtering, paging, and grouping. The sorting, filtering, and paging functions are performed on the on the client.