OLD | NEW |
1 // This is a generated file (see the discoveryapis_generator project). | 1 // This is a generated file (see the discoveryapis_generator project). |
2 | 2 |
3 library googleapis.sheets.v4; | 3 library googleapis.sheets.v4; |
4 | 4 |
5 import 'dart:core' as core; | 5 import 'dart:core' as core; |
6 import 'dart:async' as async; | 6 import 'dart:async' as async; |
7 import 'dart:convert' as convert; | 7 import 'dart:convert' as convert; |
8 | 8 |
9 import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons; | 9 import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons; |
10 import 'package:http/http.dart' as http; | 10 import 'package:http/http.dart' as http; |
11 | 11 |
12 export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' show | 12 export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' show |
13 ApiRequestError, DetailedApiRequestError; | 13 ApiRequestError, DetailedApiRequestError; |
14 | 14 |
15 const core.String USER_AGENT = 'dart-api-client sheets/v4'; | 15 const core.String USER_AGENT = 'dart-api-client sheets/v4'; |
16 | 16 |
17 /** An API for reading and modifying Google Sheets. */ | 17 /** Reads and writes Google Sheets. */ |
18 class SheetsApi { | 18 class SheetsApi { |
19 /** View and manage the files in your Google Drive */ | 19 /** View and manage the files in your Google Drive */ |
20 static const DriveScope = "https://www.googleapis.com/auth/drive"; | 20 static const DriveScope = "https://www.googleapis.com/auth/drive"; |
21 | 21 |
22 /** View the files in your Google Drive */ | 22 /** View the files in your Google Drive */ |
23 static const DriveReadonlyScope = "https://www.googleapis.com/auth/drive.reado
nly"; | 23 static const DriveReadonlyScope = "https://www.googleapis.com/auth/drive.reado
nly"; |
24 | 24 |
25 /** View and manage your spreadsheets in Google Drive */ | 25 /** View and manage your spreadsheets in Google Drive */ |
26 static const SpreadsheetsScope = "https://www.googleapis.com/auth/spreadsheets
"; | 26 static const SpreadsheetsScope = "https://www.googleapis.com/auth/spreadsheets
"; |
27 | 27 |
(...skipping 21 matching lines...) Expand all Loading... |
49 | 49 |
50 /** | 50 /** |
51 * Applies one or more updates to the spreadsheet. | 51 * Applies one or more updates to the spreadsheet. |
52 * | 52 * |
53 * Each request is validated before | 53 * Each request is validated before |
54 * being applied. If any request is not valid then the entire request will | 54 * being applied. If any request is not valid then the entire request will |
55 * fail and nothing will be applied. | 55 * fail and nothing will be applied. |
56 * | 56 * |
57 * Some requests have replies to | 57 * Some requests have replies to |
58 * give you some information about how | 58 * give you some information about how |
59 * they applied. The replies will mirror the requests. For example, | 59 * they are applied. The replies will mirror the requests. For example, |
60 * if you applied 4 updates and the 3rd one had a reply, then the | 60 * if you applied 4 updates and the 3rd one had a reply, then the |
61 * response will have 2 empty replies, the actual reply, and another empty | 61 * response will have 2 empty replies, the actual reply, and another empty |
62 * reply, in that order. | 62 * reply, in that order. |
63 * | 63 * |
64 * Due to the collaborative nature of spreadsheets, it is not guaranteed that | 64 * Due to the collaborative nature of spreadsheets, it is not guaranteed that |
65 * the spreadsheet will reflect exactly your changes after this completes, | 65 * the spreadsheet will reflect exactly your changes after this completes, |
66 * however it is guaranteed that all the updates in the request will be | 66 * however it is guaranteed that the updates in the request will be |
67 * applied atomically. Your changes may be altered with respect to | 67 * applied together atomically. Your changes may be altered with respect to |
68 * collaborator changes. If there are no collaborators, the spreadsheet | 68 * collaborator changes. If there are no collaborators, the spreadsheet |
69 * should reflect your changes. | 69 * should reflect your changes. |
70 * | 70 * |
71 * [request] - The metadata request object. | 71 * [request] - The metadata request object. |
72 * | 72 * |
73 * Request parameters: | 73 * Request parameters: |
74 * | 74 * |
75 * [spreadsheetId] - The spreadsheet to apply the updates to. | 75 * [spreadsheetId] - The spreadsheet to apply the updates to. |
76 * | 76 * |
77 * Completes with a [BatchUpdateSpreadsheetResponse]. | 77 * Completes with a [BatchUpdateSpreadsheetResponse]. |
(...skipping 64 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
142 "POST", | 142 "POST", |
143 body: _body, | 143 body: _body, |
144 queryParams: _queryParams, | 144 queryParams: _queryParams, |
145 uploadOptions: _uploadOptions, | 145 uploadOptions: _uploadOptions, |
146 uploadMedia: _uploadMedia, | 146 uploadMedia: _uploadMedia, |
147 downloadOptions: _downloadOptions); | 147 downloadOptions: _downloadOptions); |
148 return _response.then((data) => new Spreadsheet.fromJson(data)); | 148 return _response.then((data) => new Spreadsheet.fromJson(data)); |
149 } | 149 } |
150 | 150 |
151 /** | 151 /** |
152 * Returns the spreadsheet at the given id. | 152 * Returns the spreadsheet at the given ID. |
153 * The caller must specify the spreadsheet ID. | 153 * The caller must specify the spreadsheet ID. |
154 * | 154 * |
155 * By default, data within grids will not be returned. | 155 * By default, data within grids will not be returned. |
156 * You can include grid data one of two ways: specify a field mask listing | 156 * You can include grid data one of two ways: |
157 * your desired fields (using the `fields` URL parameter in HTTP, | 157 * |
158 * or `FieldMaskContext.response_mask` in the request extensions in an RPC), | 158 * * Specify a field mask listing your desired fields using the `fields` URL |
159 * or by setting the | 159 * parameter in HTTP |
160 * includeGridData URL parameter | 160 * |
161 * to true. If a field mask is set, the `includeGridData` parameter is | 161 * * Set the includeGridData |
162 * ignored. | 162 * URL parameter to true. If a field mask is set, the `includeGridData` |
| 163 * parameter is ignored |
163 * | 164 * |
164 * For large spreadsheets, it is recommended to retrieve only the specific | 165 * For large spreadsheets, it is recommended to retrieve only the specific |
165 * fields of the spreadsheet that you want. | 166 * fields of the spreadsheet that you want. |
166 * | 167 * |
167 * To retrieve only subsets of the spreadsheet, use the | 168 * To retrieve only subsets of the spreadsheet, use the |
168 * ranges URL parameter. | 169 * ranges URL parameter. |
169 * Multiple ranges can be specified. Limiting the range will | 170 * Multiple ranges can be specified. Limiting the range will |
170 * return only the portions of the spreadsheet that intersect the requested | 171 * return only the portions of the spreadsheet that intersect the requested |
171 * ranges. Ranges are specified using A1 notation. | 172 * ranges. Ranges are specified using A1 notation. |
172 * | 173 * |
(...skipping 54 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
227 _requester = client; | 228 _requester = client; |
228 | 229 |
229 /** | 230 /** |
230 * Copies a single sheet from a spreadsheet to another spreadsheet. | 231 * Copies a single sheet from a spreadsheet to another spreadsheet. |
231 * Returns the properties of the newly created sheet. | 232 * Returns the properties of the newly created sheet. |
232 * | 233 * |
233 * [request] - The metadata request object. | 234 * [request] - The metadata request object. |
234 * | 235 * |
235 * Request parameters: | 236 * Request parameters: |
236 * | 237 * |
237 * [spreadsheetId] - The id of the spreadsheet containing the sheet to copy. | 238 * [spreadsheetId] - The ID of the spreadsheet containing the sheet to copy. |
238 * | 239 * |
239 * [sheetId] - The ID of the sheet to copy. | 240 * [sheetId] - The ID of the sheet to copy. |
240 * | 241 * |
241 * Completes with a [SheetProperties]. | 242 * Completes with a [SheetProperties]. |
242 * | 243 * |
243 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 244 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
244 * error. | 245 * error. |
245 * | 246 * |
246 * If the used [http.Client] completes with an error when making a REST call, | 247 * If the used [http.Client] completes with an error when making a REST call, |
247 * this method will complete with the same error. | 248 * this method will complete with the same error. |
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
284 | 285 |
285 SpreadsheetsValuesResourceApi(commons.ApiRequester client) : | 286 SpreadsheetsValuesResourceApi(commons.ApiRequester client) : |
286 _requester = client; | 287 _requester = client; |
287 | 288 |
288 /** | 289 /** |
289 * Returns one or more ranges of values from a spreadsheet. | 290 * Returns one or more ranges of values from a spreadsheet. |
290 * The caller must specify the spreadsheet ID and one or more ranges. | 291 * The caller must specify the spreadsheet ID and one or more ranges. |
291 * | 292 * |
292 * Request parameters: | 293 * Request parameters: |
293 * | 294 * |
294 * [spreadsheetId] - The id of the spreadsheet to retrieve data from. | 295 * [spreadsheetId] - The ID of the spreadsheet to retrieve data from. |
295 * | 296 * |
296 * [ranges] - The A1 notation of the values to retrieve. | 297 * [ranges] - The A1 notation of the values to retrieve. |
297 * | 298 * |
298 * [valueRenderOption] - How values should be represented in the output. | 299 * [valueRenderOption] - How values should be represented in the output. |
299 * Possible string values are: | 300 * Possible string values are: |
300 * - "FORMATTED_VALUE" : A FORMATTED_VALUE. | 301 * - "FORMATTED_VALUE" : A FORMATTED_VALUE. |
301 * - "UNFORMATTED_VALUE" : A UNFORMATTED_VALUE. | 302 * - "UNFORMATTED_VALUE" : A UNFORMATTED_VALUE. |
302 * - "FORMULA" : A FORMULA. | 303 * - "FORMULA" : A FORMULA. |
303 * | 304 * |
304 * [dateTimeRenderOption] - How dates, times, and durations should be | 305 * [dateTimeRenderOption] - How dates, times, and durations should be |
305 * represented in the output. | 306 * represented in the output. |
306 * This is ignored if ValueRenderOption option is | 307 * This is ignored if value_render_option is |
307 * FORMATTED_VALUE. | 308 * FORMATTED_VALUE. |
308 * Possible string values are: | 309 * Possible string values are: |
309 * - "SERIAL_NUMBER" : A SERIAL_NUMBER. | 310 * - "SERIAL_NUMBER" : A SERIAL_NUMBER. |
310 * - "FORMATTED_STRING" : A FORMATTED_STRING. | 311 * - "FORMATTED_STRING" : A FORMATTED_STRING. |
311 * | 312 * |
312 * [majorDimension] - The major dimension that results should use. | 313 * [majorDimension] - The major dimension that results should use. |
313 * | 314 * |
314 * For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, | 315 * For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, |
315 * then requesting `range=A1:B2,majorDimension=ROWS` will return | 316 * then requesting `range=A1:B2,majorDimension=ROWS` will return |
316 * `[[1,2],[3,4]]`, | 317 * `[[1,2],[3,4]]`, |
(...skipping 42 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
359 "GET", | 360 "GET", |
360 body: _body, | 361 body: _body, |
361 queryParams: _queryParams, | 362 queryParams: _queryParams, |
362 uploadOptions: _uploadOptions, | 363 uploadOptions: _uploadOptions, |
363 uploadMedia: _uploadMedia, | 364 uploadMedia: _uploadMedia, |
364 downloadOptions: _downloadOptions); | 365 downloadOptions: _downloadOptions); |
365 return _response.then((data) => new BatchGetValuesResponse.fromJson(data)); | 366 return _response.then((data) => new BatchGetValuesResponse.fromJson(data)); |
366 } | 367 } |
367 | 368 |
368 /** | 369 /** |
369 * Sets values in a range of a spreadsheet. | 370 * Sets values in one or more ranges of a spreadsheet. |
370 * The caller must specify the spreadsheet ID, | 371 * The caller must specify the spreadsheet ID, |
371 * a valueInputOption, and one or more | 372 * a valueInputOption, and one or more |
372 * ValueRanges. | 373 * ValueRanges. |
373 * | 374 * |
374 * [request] - The metadata request object. | 375 * [request] - The metadata request object. |
375 * | 376 * |
376 * Request parameters: | 377 * Request parameters: |
377 * | 378 * |
378 * [spreadsheetId] - The id of the spreadsheet to update. | 379 * [spreadsheetId] - The ID of the spreadsheet to update. |
379 * | 380 * |
380 * Completes with a [BatchUpdateValuesResponse]. | 381 * Completes with a [BatchUpdateValuesResponse]. |
381 * | 382 * |
382 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 383 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
383 * error. | 384 * error. |
384 * | 385 * |
385 * If the used [http.Client] completes with an error when making a REST call, | 386 * If the used [http.Client] completes with an error when making a REST call, |
386 * this method will complete with the same error. | 387 * this method will complete with the same error. |
387 */ | 388 */ |
388 async.Future<BatchUpdateValuesResponse> batchUpdate(BatchUpdateValuesRequest r
equest, core.String spreadsheetId) { | 389 async.Future<BatchUpdateValuesResponse> batchUpdate(BatchUpdateValuesRequest r
equest, core.String spreadsheetId) { |
(...skipping 22 matching lines...) Expand all Loading... |
411 downloadOptions: _downloadOptions); | 412 downloadOptions: _downloadOptions); |
412 return _response.then((data) => new BatchUpdateValuesResponse.fromJson(data)
); | 413 return _response.then((data) => new BatchUpdateValuesResponse.fromJson(data)
); |
413 } | 414 } |
414 | 415 |
415 /** | 416 /** |
416 * Returns a range of values from a spreadsheet. | 417 * Returns a range of values from a spreadsheet. |
417 * The caller must specify the spreadsheet ID and a range. | 418 * The caller must specify the spreadsheet ID and a range. |
418 * | 419 * |
419 * Request parameters: | 420 * Request parameters: |
420 * | 421 * |
421 * [spreadsheetId] - The id of the spreadsheet to retrieve data from. | 422 * [spreadsheetId] - The ID of the spreadsheet to retrieve data from. |
422 * | 423 * |
423 * [range] - The A1 notation of the values to retrieve. | 424 * [range] - The A1 notation of the values to retrieve. |
424 * | 425 * |
425 * [valueRenderOption] - How values should be represented in the output. | 426 * [valueRenderOption] - How values should be represented in the output. |
426 * Possible string values are: | 427 * Possible string values are: |
427 * - "FORMATTED_VALUE" : A FORMATTED_VALUE. | 428 * - "FORMATTED_VALUE" : A FORMATTED_VALUE. |
428 * - "UNFORMATTED_VALUE" : A UNFORMATTED_VALUE. | 429 * - "UNFORMATTED_VALUE" : A UNFORMATTED_VALUE. |
429 * - "FORMULA" : A FORMULA. | 430 * - "FORMULA" : A FORMULA. |
430 * | 431 * |
431 * [dateTimeRenderOption] - How dates, times, and durations should be | 432 * [dateTimeRenderOption] - How dates, times, and durations should be |
432 * represented in the output. | 433 * represented in the output. |
433 * This is ignored if the ValueRenderOption option is | 434 * This is ignored if value_render_option is |
434 * FORMATTED_VALUE. | 435 * FORMATTED_VALUE. |
435 * Possible string values are: | 436 * Possible string values are: |
436 * - "SERIAL_NUMBER" : A SERIAL_NUMBER. | 437 * - "SERIAL_NUMBER" : A SERIAL_NUMBER. |
437 * - "FORMATTED_STRING" : A FORMATTED_STRING. | 438 * - "FORMATTED_STRING" : A FORMATTED_STRING. |
438 * | 439 * |
439 * [majorDimension] - The major dimension that results should use. | 440 * [majorDimension] - The major dimension that results should use. |
440 * | 441 * |
441 * For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, | 442 * For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, |
442 * then requesting `range=A1:B2,majorDimension=ROWS` will return | 443 * then requesting `range=A1:B2,majorDimension=ROWS` will return |
443 * `[[1,2],[3,4]]`, | 444 * `[[1,2],[3,4]]`, |
(...skipping 50 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
494 | 495 |
495 /** | 496 /** |
496 * Sets values in a range of a spreadsheet. | 497 * Sets values in a range of a spreadsheet. |
497 * The caller must specify the spreadsheet ID, range, and | 498 * The caller must specify the spreadsheet ID, range, and |
498 * a valueInputOption. | 499 * a valueInputOption. |
499 * | 500 * |
500 * [request] - The metadata request object. | 501 * [request] - The metadata request object. |
501 * | 502 * |
502 * Request parameters: | 503 * Request parameters: |
503 * | 504 * |
504 * [spreadsheetId] - The id of the spreadsheet to update. | 505 * [spreadsheetId] - The ID of the spreadsheet to update. |
505 * | 506 * |
506 * [range] - The A1 notation of the values to update. | 507 * [range] - The A1 notation of the values to update. |
507 * | 508 * |
508 * [valueInputOption] - How the input data should be interpreted. | 509 * [valueInputOption] - How the input data should be interpreted. |
509 * Possible string values are: | 510 * Possible string values are: |
510 * - "INPUT_VALUE_OPTION_UNSPECIFIED" : A INPUT_VALUE_OPTION_UNSPECIFIED. | 511 * - "INPUT_VALUE_OPTION_UNSPECIFIED" : A INPUT_VALUE_OPTION_UNSPECIFIED. |
511 * - "RAW" : A RAW. | 512 * - "RAW" : A RAW. |
512 * - "USER_ENTERED" : A USER_ENTERED. | 513 * - "USER_ENTERED" : A USER_ENTERED. |
513 * | 514 * |
514 * Completes with a [UpdateValuesResponse]. | 515 * Completes with a [UpdateValuesResponse]. |
(...skipping 255 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
770 _json["protectedRange"] = (protectedRange).toJson(); | 771 _json["protectedRange"] = (protectedRange).toJson(); |
771 } | 772 } |
772 return _json; | 773 return _json; |
773 } | 774 } |
774 } | 775 } |
775 | 776 |
776 /** | 777 /** |
777 * Adds a new sheet. | 778 * Adds a new sheet. |
778 * When a sheet is added at a given index, | 779 * When a sheet is added at a given index, |
779 * all subsequent sheets' indexes are incremented. | 780 * all subsequent sheets' indexes are incremented. |
780 * To add an object sheet, use AddChartRequest instead. | 781 * To add an object sheet, use AddChartRequest instead and specify |
| 782 * EmbeddedObjectPosition.sheetId or |
| 783 * EmbeddedObjectPosition.newSheet. |
781 */ | 784 */ |
782 class AddSheetRequest { | 785 class AddSheetRequest { |
783 /** | 786 /** |
784 * The properties the new sheet should have. | 787 * The properties the new sheet should have. |
785 * All properties are optional. | 788 * All properties are optional. |
786 * If a sheetId | 789 * If a sheetId |
787 * is specified, the sheet will use that ID. | 790 * is specified, the sheet will use that ID. |
788 * (It is an error to specify the ID of a sheet that already exists.) | 791 * (It is an error to specify the ID of a sheet that already exists.) |
789 */ | 792 */ |
790 SheetProperties properties; | 793 SheetProperties properties; |
(...skipping 31 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
822 core.Map toJson() { | 825 core.Map toJson() { |
823 var _json = new core.Map(); | 826 var _json = new core.Map(); |
824 if (properties != null) { | 827 if (properties != null) { |
825 _json["properties"] = (properties).toJson(); | 828 _json["properties"] = (properties).toJson(); |
826 } | 829 } |
827 return _json; | 830 return _json; |
828 } | 831 } |
829 } | 832 } |
830 | 833 |
831 /** | 834 /** |
832 * Adds new cells to the last row with data in a sheet, | 835 * Adds new cells after the last row with data in a sheet, |
833 * inserting new rows into the sheet if necessary. | 836 * inserting new rows into the sheet if necessary. |
834 */ | 837 */ |
835 class AppendCellsRequest { | 838 class AppendCellsRequest { |
836 /** | 839 /** |
837 * The fields of CellData that should be updated. | 840 * The fields of CellData that should be updated. |
838 * At least one field must be specified. | 841 * At least one field must be specified. |
839 * The root is the CellData; 'row.values.' should not be specified. | 842 * The root is the CellData; 'row.values.' should not be specified. |
840 * A single `"*"` can be used as short-hand for listing every field. | 843 * A single `"*"` can be used as short-hand for listing every field. |
841 */ | 844 */ |
842 core.String fields; | 845 core.String fields; |
(...skipping 213 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1056 } | 1059 } |
1057 } | 1060 } |
1058 | 1061 |
1059 /** | 1062 /** |
1060 * The domain of a chart. | 1063 * The domain of a chart. |
1061 * For example, if charting stock prices over time, this would be the date. | 1064 * For example, if charting stock prices over time, this would be the date. |
1062 */ | 1065 */ |
1063 class BasicChartDomain { | 1066 class BasicChartDomain { |
1064 /** | 1067 /** |
1065 * The data of the domain. For example, if charting stock prices over time, | 1068 * The data of the domain. For example, if charting stock prices over time, |
1066 * this be the data representing the dates. | 1069 * this is the data representing the dates. |
1067 */ | 1070 */ |
1068 ChartData domain; | 1071 ChartData domain; |
1069 | 1072 |
1070 BasicChartDomain(); | 1073 BasicChartDomain(); |
1071 | 1074 |
1072 BasicChartDomain.fromJson(core.Map _json) { | 1075 BasicChartDomain.fromJson(core.Map _json) { |
1073 if (_json.containsKey("domain")) { | 1076 if (_json.containsKey("domain")) { |
1074 domain = new ChartData.fromJson(_json["domain"]); | 1077 domain = new ChartData.fromJson(_json["domain"]); |
1075 } | 1078 } |
1076 } | 1079 } |
(...skipping 231 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1308 _json["sortSpecs"] = sortSpecs.map((value) => (value).toJson()).toList(); | 1311 _json["sortSpecs"] = sortSpecs.map((value) => (value).toJson()).toList(); |
1309 } | 1312 } |
1310 return _json; | 1313 return _json; |
1311 } | 1314 } |
1312 } | 1315 } |
1313 | 1316 |
1314 /** | 1317 /** |
1315 * The response when retrieving more than one range of values in a spreadsheet. | 1318 * The response when retrieving more than one range of values in a spreadsheet. |
1316 */ | 1319 */ |
1317 class BatchGetValuesResponse { | 1320 class BatchGetValuesResponse { |
1318 /** The id of the spreadsheet to retrieve data from. */ | 1321 /** The ID of the spreadsheet the data was retrieved from. */ |
1319 core.String spreadsheetId; | 1322 core.String spreadsheetId; |
1320 /** | 1323 /** |
1321 * The requested values. The order of the ValueRanges is the same as the | 1324 * The requested values. The order of the ValueRanges is the same as the |
1322 * order of the requested ranges. | 1325 * order of the requested ranges. |
1323 */ | 1326 */ |
1324 core.List<ValueRange> valueRanges; | 1327 core.List<ValueRange> valueRanges; |
1325 | 1328 |
1326 BatchGetValuesResponse(); | 1329 BatchGetValuesResponse(); |
1327 | 1330 |
1328 BatchGetValuesResponse.fromJson(core.Map _json) { | 1331 BatchGetValuesResponse.fromJson(core.Map _json) { |
(...skipping 74 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1403 | 1406 |
1404 /** The request for updating more than one range of values in a spreadsheet. */ | 1407 /** The request for updating more than one range of values in a spreadsheet. */ |
1405 class BatchUpdateValuesRequest { | 1408 class BatchUpdateValuesRequest { |
1406 /** The new values to apply to the spreadsheet. */ | 1409 /** The new values to apply to the spreadsheet. */ |
1407 core.List<ValueRange> data; | 1410 core.List<ValueRange> data; |
1408 /** | 1411 /** |
1409 * How the input data should be interpreted. | 1412 * How the input data should be interpreted. |
1410 * Possible string values are: | 1413 * Possible string values are: |
1411 * - "INPUT_VALUE_OPTION_UNSPECIFIED" : Default input value. This value must | 1414 * - "INPUT_VALUE_OPTION_UNSPECIFIED" : Default input value. This value must |
1412 * not be used. | 1415 * not be used. |
1413 * - "RAW" : The values the user is entered will not be parsed and will be | 1416 * - "RAW" : The values the user has entered will not be parsed and will be |
1414 * stored | 1417 * stored |
1415 * as-is. | 1418 * as-is. |
1416 * - "USER_ENTERED" : The values will be parsed as if the user typed them into | 1419 * - "USER_ENTERED" : The values will be parsed as if the user typed them into |
1417 * the UI. | 1420 * the UI. |
1418 * Numbers will stay as numbers, but strings may be converted to numbers, | 1421 * Numbers will stay as numbers, but strings may be converted to numbers, |
1419 * dates, etc.. following the same rules that are applied when entering | 1422 * dates, etc. following the same rules that are applied when entering |
1420 * text into a cell via the Google Sheets UI. | 1423 * text into a cell via the Google Sheets UI. |
1421 */ | 1424 */ |
1422 core.String valueInputOption; | 1425 core.String valueInputOption; |
1423 | 1426 |
1424 BatchUpdateValuesRequest(); | 1427 BatchUpdateValuesRequest(); |
1425 | 1428 |
1426 BatchUpdateValuesRequest.fromJson(core.Map _json) { | 1429 BatchUpdateValuesRequest.fromJson(core.Map _json) { |
1427 if (_json.containsKey("data")) { | 1430 if (_json.containsKey("data")) { |
1428 data = _json["data"].map((value) => new ValueRange.fromJson(value)).toList
(); | 1431 data = _json["data"].map((value) => new ValueRange.fromJson(value)).toList
(); |
1429 } | 1432 } |
(...skipping 282 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1712 /** The color of the border. */ | 1715 /** The color of the border. */ |
1713 Color color; | 1716 Color color; |
1714 /** | 1717 /** |
1715 * The style of the border. | 1718 * The style of the border. |
1716 * Possible string values are: | 1719 * Possible string values are: |
1717 * - "STYLE_UNSPECIFIED" : The style is not specified. Do not use this. | 1720 * - "STYLE_UNSPECIFIED" : The style is not specified. Do not use this. |
1718 * - "DOTTED" : The border is dotted. | 1721 * - "DOTTED" : The border is dotted. |
1719 * - "DASHED" : The border is dashed. | 1722 * - "DASHED" : The border is dashed. |
1720 * - "SOLID" : The border is a solid line. | 1723 * - "SOLID" : The border is a solid line. |
1721 * - "NONE" : No border. | 1724 * - "NONE" : No border. |
1722 * Used only when updating a border in order erase it. | 1725 * Used only when updating a border in order to erase it. |
1723 * - "DOUBLE" : The border is double (two solid lines). | 1726 * - "DOUBLE" : The border is two solid lines. |
1724 */ | 1727 */ |
1725 core.String style; | 1728 core.String style; |
1726 /** | 1729 /** |
1727 * The width of the border, in pixels. | 1730 * The width of the border, in pixels. |
1728 * Border widths must be between 0 and 3 pixels. | 1731 * Border widths must be between 0 and 3 pixels, inclusive. |
1729 */ | 1732 */ |
1730 core.int width; | 1733 core.int width; |
1731 | 1734 |
1732 Border(); | 1735 Border(); |
1733 | 1736 |
1734 Border.fromJson(core.Map _json) { | 1737 Border.fromJson(core.Map _json) { |
1735 if (_json.containsKey("color")) { | 1738 if (_json.containsKey("color")) { |
1736 color = new Color.fromJson(_json["color"]); | 1739 color = new Color.fromJson(_json["color"]); |
1737 } | 1740 } |
1738 if (_json.containsKey("style")) { | 1741 if (_json.containsKey("style")) { |
(...skipping 98 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1837 /** | 1840 /** |
1838 * A hyperlink this cell points to, if any. | 1841 * A hyperlink this cell points to, if any. |
1839 * This field is read-only. (To set it, use a `=HYPERLINK` formula.) | 1842 * This field is read-only. (To set it, use a `=HYPERLINK` formula.) |
1840 */ | 1843 */ |
1841 core.String hyperlink; | 1844 core.String hyperlink; |
1842 /** Any note on the cell. */ | 1845 /** Any note on the cell. */ |
1843 core.String note; | 1846 core.String note; |
1844 /** | 1847 /** |
1845 * A pivot table anchored at this cell. The size of pivot table itself | 1848 * A pivot table anchored at this cell. The size of pivot table itself |
1846 * is computed dynamically based on its data, grouping, filters, values, | 1849 * is computed dynamically based on its data, grouping, filters, values, |
1847 * etc... Only the top-left cell of the pivot table contains the pivot table | 1850 * etc. Only the top-left cell of the pivot table contains the pivot table |
1848 * definition. The other cells will contain the calculated values of the | 1851 * definition. The other cells will contain the calculated values of the |
1849 * results of the pivot in their effectiveValue fields. | 1852 * results of the pivot in their effective_value fields. |
1850 */ | 1853 */ |
1851 PivotTable pivotTable; | 1854 PivotTable pivotTable; |
1852 /** | 1855 /** |
1853 * Runs of rich text applied to subsections of the cell. | 1856 * Runs of rich text applied to subsections of the cell. Runs are only valid |
| 1857 * on user entered strings, not formulas, bools, or numbers. |
1854 * Runs start at specific indexes in the text and continue until the next | 1858 * Runs start at specific indexes in the text and continue until the next |
1855 * run. Properties of a run will continue unless explicitly changed | 1859 * run. Properties of a run will continue unless explicitly changed |
1856 * in a subsequent run (and properties of the first run will continue | 1860 * in a subsequent run (and properties of the first run will continue |
1857 * the properties of the cell unless explicitly changed). | 1861 * the properties of the cell unless explicitly changed). |
1858 * | 1862 * |
1859 * When writing, the new runs will overwrite any prior runs. | 1863 * When writing, the new runs will overwrite any prior runs. When writing a |
| 1864 * new user_entered_value, previous runs will be erased. |
1860 */ | 1865 */ |
1861 core.List<TextFormatRun> textFormatRuns; | 1866 core.List<TextFormatRun> textFormatRuns; |
1862 /** | 1867 /** |
1863 * The format the user entered for the cell. | 1868 * The format the user entered for the cell. |
1864 * | 1869 * |
1865 * When writing, the new format will be merged with the existing format. | 1870 * When writing, the new format will be merged with the existing format. |
1866 */ | 1871 */ |
1867 CellFormat userEnteredFormat; | 1872 CellFormat userEnteredFormat; |
1868 /** | 1873 /** |
1869 * The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()` | 1874 * The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()` |
(...skipping 73 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1943 } | 1948 } |
1944 } | 1949 } |
1945 | 1950 |
1946 /** The format of a cell. */ | 1951 /** The format of a cell. */ |
1947 class CellFormat { | 1952 class CellFormat { |
1948 /** The background color of the cell. */ | 1953 /** The background color of the cell. */ |
1949 Color backgroundColor; | 1954 Color backgroundColor; |
1950 /** The borders of the cell. */ | 1955 /** The borders of the cell. */ |
1951 Borders borders; | 1956 Borders borders; |
1952 /** | 1957 /** |
1953 * The horizontal alignment of the value in cell. | 1958 * The horizontal alignment of the value in the cell. |
1954 * Possible string values are: | 1959 * Possible string values are: |
1955 * - "HORIZONTAL_ALIGN_UNSPECIFIED" : The horizontal alignment is not | 1960 * - "HORIZONTAL_ALIGN_UNSPECIFIED" : The horizontal alignment is not |
1956 * specified. Do not use this. | 1961 * specified. Do not use this. |
1957 * - "LEFT" : The text is explicitly aligned to the left of the cell. | 1962 * - "LEFT" : The text is explicitly aligned to the left of the cell. |
1958 * - "CENTER" : The text is explicitly aligned to the center of the cell. | 1963 * - "CENTER" : The text is explicitly aligned to the center of the cell. |
1959 * - "RIGHT" : The text is explicitly aligned to the right of the cell. | 1964 * - "RIGHT" : The text is explicitly aligned to the right of the cell. |
1960 */ | 1965 */ |
1961 core.String horizontalAlignment; | 1966 core.String horizontalAlignment; |
1962 /** | 1967 /** |
1963 * How a hyperlink, if it exists, should be displayed in the cell. | 1968 * How a hyperlink, if it exists, should be displayed in the cell. |
1964 * Possible string values are: | 1969 * Possible string values are: |
1965 * - "HYPERLINK_DISPLAY_TYPE_UNSPECIFIED" : The default value: the hyperlink | 1970 * - "HYPERLINK_DISPLAY_TYPE_UNSPECIFIED" : The default value: the hyperlink |
1966 * is clickable. Do not use this. | 1971 * is rendered. Do not use this. |
1967 * - "LINKED" : A hyperlink should be explicitly rendered. | 1972 * - "LINKED" : A hyperlink should be explicitly rendered. |
1968 * - "PLAIN_TEXT" : A hyperlink should not be rendered. | 1973 * - "PLAIN_TEXT" : A hyperlink should not be rendered. |
1969 */ | 1974 */ |
1970 core.String hyperlinkDisplayType; | 1975 core.String hyperlinkDisplayType; |
1971 /** | 1976 /** |
1972 * A format describing how number values should be represented to the user. | 1977 * A format describing how number values should be represented to the user. |
1973 */ | 1978 */ |
1974 NumberFormat numberFormat; | 1979 NumberFormat numberFormat; |
1975 /** The padding of the cell. */ | 1980 /** The padding of the cell. */ |
1976 Padding padding; | 1981 Padding padding; |
1977 /** | 1982 /** |
1978 * The direction of the text in the cell. | 1983 * The direction of the text in the cell. |
1979 * Possible string values are: | 1984 * Possible string values are: |
1980 * - "TEXT_DIRECTION_UNSPECIFIED" : The text direction is not specified. Do | 1985 * - "TEXT_DIRECTION_UNSPECIFIED" : The text direction is not specified. Do |
1981 * not use this. | 1986 * not use this. |
1982 * - "LEFT_TO_RIGHT" : The text direction of left-to-right was set by the | 1987 * - "LEFT_TO_RIGHT" : The text direction of left-to-right was set by the |
1983 * user. | 1988 * user. |
1984 * - "RIGHT_TO_LEFT" : The text direction of right-to-left was set by the | 1989 * - "RIGHT_TO_LEFT" : The text direction of right-to-left was set by the |
1985 * user. | 1990 * user. |
1986 */ | 1991 */ |
1987 core.String textDirection; | 1992 core.String textDirection; |
1988 /** | 1993 /** |
1989 * The format of the text in the cell (unless overridden by a format run). | 1994 * The format of the text in the cell (unless overridden by a format run). |
1990 */ | 1995 */ |
1991 TextFormat textFormat; | 1996 TextFormat textFormat; |
1992 /** | 1997 /** |
1993 * The vertical alignment of the value in cell. | 1998 * The vertical alignment of the value in the cell. |
1994 * Possible string values are: | 1999 * Possible string values are: |
1995 * - "VERTICAL_ALIGN_UNSPECIFIED" : The vertical alignment is not specified. | 2000 * - "VERTICAL_ALIGN_UNSPECIFIED" : The vertical alignment is not specified. |
1996 * Do not use this. | 2001 * Do not use this. |
1997 * - "TOP" : The text is explicitly aligned to the top of the cell. | 2002 * - "TOP" : The text is explicitly aligned to the top of the cell. |
1998 * - "MIDDLE" : The text is explicitly aligned to the middle of the cell. | 2003 * - "MIDDLE" : The text is explicitly aligned to the middle of the cell. |
1999 * - "BOTTOM" : The text is explicitly aligned to the bottom of the cell. | 2004 * - "BOTTOM" : The text is explicitly aligned to the bottom of the cell. |
2000 */ | 2005 */ |
2001 core.String verticalAlignment; | 2006 core.String verticalAlignment; |
2002 /** | 2007 /** |
2003 * The wrap strategy for the value in the cell. | 2008 * The wrap strategy for the value in the cell. |
2004 * Possible string values are: | 2009 * Possible string values are: |
2005 * - "WRAP_STRATEGY_UNSPECIFIED" : The default value, do not use. | 2010 * - "WRAP_STRATEGY_UNSPECIFIED" : The default value, do not use. |
2006 * - "OVERFLOW_CELL" : Lines that are longer than the cell width will be | 2011 * - "OVERFLOW_CELL" : Lines that are longer than the cell width will be |
2007 * written in the next | 2012 * written in the next |
2008 * cell over, so long as that cell is empty. If the next cell over is | 2013 * cell over, so long as that cell is empty. If the next cell over is |
2009 * non-empty, this behaves the same as CLIP. The text will never wrap | 2014 * non-empty, this behaves the same as CLIP. The text will never wrap |
2010 * to the next line unless the user manually inserts a new line. | 2015 * to the next line unless the user manually inserts a new line. |
2011 * Example: | 2016 * Example: |
2012 * | 2017 * |
2013 * | First sentence. | | 2018 * | First sentence. | |
2014 * | Manual newline that is very long. <- Text continues into next cell | 2019 * | Manual newline that is very long. <- Text continues into next cell |
2015 * | Next newline. | | 2020 * | Next newline. | |
2016 * - "LEGACY_WRAP" : This wrap strategy represents the old Google Sheets wrap | 2021 * - "LEGACY_WRAP" : This wrap strategy represents the old Google Sheets wrap |
2017 * strategy where | 2022 * strategy where |
2018 * words that are longer than a line are clipped rather than broken. This | 2023 * words that are longer than a line are clipped rather than broken. This |
2019 * strategy is not supported on all platforms and is being phased out. | 2024 * strategy is not supported on all platforms and is being phased out. |
2020 * Example: | 2025 * Example: |
2021 * | 2026 * |
2022 * | Cell has a | | 2027 * | Cell has a | |
2023 * | loooooooooo|ong <- Word is clipped. | 2028 * | loooooooooo| <- Word is clipped. |
2024 * | word. | | 2029 * | word. | |
2025 * - "CLIP" : Lines that are longer than the cell width will be clipped. | 2030 * - "CLIP" : Lines that are longer than the cell width will be clipped. |
2026 * The text will never wrap to the next line unless the user manually | 2031 * The text will never wrap to the next line unless the user manually |
2027 * inserts a new line. | 2032 * inserts a new line. |
2028 * Example: | 2033 * Example: |
2029 * | 2034 * |
2030 * | First sentence. | | 2035 * | First sentence. | |
2031 * | Manual newline t| <- Text is clipped | 2036 * | Manual newline t| <- Text is clipped |
2032 * | Next newline. | | 2037 * | Next newline. | |
2033 * - "WRAP" : Words that are longer than a line are wrapped at the character | 2038 * - "WRAP" : Words that are longer than a line are wrapped at the character |
(...skipping 137 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2171 _json["sources"] = sources.map((value) => (value).toJson()).toList(); | 2176 _json["sources"] = sources.map((value) => (value).toJson()).toList(); |
2172 } | 2177 } |
2173 return _json; | 2178 return _json; |
2174 } | 2179 } |
2175 } | 2180 } |
2176 | 2181 |
2177 /** The specifications of a chart. */ | 2182 /** The specifications of a chart. */ |
2178 class ChartSpec { | 2183 class ChartSpec { |
2179 /** | 2184 /** |
2180 * A basic chart specification, can be one of many kinds of charts. | 2185 * A basic chart specification, can be one of many kinds of charts. |
2181 * See BasicChartType for the list of all charts this supports. | 2186 * See BasicChartType for the list of all |
| 2187 * charts this supports. |
2182 */ | 2188 */ |
2183 BasicChartSpec basicChart; | 2189 BasicChartSpec basicChart; |
2184 /** | 2190 /** |
2185 * Determines how the charts will use hidden rows or columns. | 2191 * Determines how the charts will use hidden rows or columns. |
2186 * This value is only meaningful if the | |
2187 * ChartData.sourceRange | |
2188 * is used for a domain or series. | |
2189 * Possible string values are: | 2192 * Possible string values are: |
2190 * - "CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED" : Default value, do not | 2193 * - "CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED" : Default value, do not |
2191 * use. | 2194 * use. |
2192 * - "SKIP_HIDDEN_ROWS_AND_COLUMNS" : Charts will skip hidden rows and | 2195 * - "SKIP_HIDDEN_ROWS_AND_COLUMNS" : Charts will skip hidden rows and |
2193 * columns. | 2196 * columns. |
2194 * - "SKIP_HIDDEN_ROWS" : Charts will skip hidden rows only. | 2197 * - "SKIP_HIDDEN_ROWS" : Charts will skip hidden rows only. |
2195 * - "SKIP_HIDDEN_COLUMNS" : Charts will skip hidden columns only. | 2198 * - "SKIP_HIDDEN_COLUMNS" : Charts will skip hidden columns only. |
2196 * - "SHOW_ALL" : Charts will not skip any hidden rows or columns. | 2199 * - "SHOW_ALL" : Charts will not skip any hidden rows or columns. |
2197 */ | 2200 */ |
2198 core.String hiddenDimensionStrategy; | 2201 core.String hiddenDimensionStrategy; |
(...skipping 240 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2439 * DATE_BEFORE, | 2442 * DATE_BEFORE, |
2440 * DATE_AFTER, | 2443 * DATE_AFTER, |
2441 * DATE_ON_OR_BEFORE or | 2444 * DATE_ON_OR_BEFORE or |
2442 * DATE_ON_OR_AFTER. | 2445 * DATE_ON_OR_AFTER. |
2443 * | 2446 * |
2444 * Relative dates are not supported in data validation. | 2447 * Relative dates are not supported in data validation. |
2445 * They are supported only in conditional formatting and | 2448 * They are supported only in conditional formatting and |
2446 * conditional filters. | 2449 * conditional filters. |
2447 * Possible string values are: | 2450 * Possible string values are: |
2448 * - "RELATIVE_DATE_UNSPECIFIED" : Default value, do not use. | 2451 * - "RELATIVE_DATE_UNSPECIFIED" : Default value, do not use. |
2449 * - "PAST_YEAR" : The value is the year before today. | 2452 * - "PAST_YEAR" : The value is one year before today. |
2450 * - "PAST_MONTH" : The value is the month before today. | 2453 * - "PAST_MONTH" : The value is one month before today. |
2451 * - "PAST_WEEK" : The value is the week before today. | 2454 * - "PAST_WEEK" : The value is one week before today. |
2452 * - "YESTERDAY" : The value is yesterday. | 2455 * - "YESTERDAY" : The value is yesterday. |
2453 * - "TODAY" : The value is today. | 2456 * - "TODAY" : The value is today. |
2454 * - "TOMORROW" : The value is tomorrow. | 2457 * - "TOMORROW" : The value is tomorrow. |
2455 */ | 2458 */ |
2456 core.String relativeDate; | 2459 core.String relativeDate; |
2457 /** | 2460 /** |
2458 * A value the condition is based on. | 2461 * A value the condition is based on. |
2459 * The value will be parsed as if the user typed into a cell. | 2462 * The value will be parsed as if the user typed into a cell. |
2460 * Formulas are supported (and must begin with an `=`). | 2463 * Formulas are supported (and must begin with an `=`). |
2461 */ | 2464 */ |
(...skipping 84 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2546 /** | 2549 /** |
2547 * What kind of data to paste. | 2550 * What kind of data to paste. |
2548 * Possible string values are: | 2551 * Possible string values are: |
2549 * - "PASTE_NORMAL" : Paste values, formulas, formats, and merges. | 2552 * - "PASTE_NORMAL" : Paste values, formulas, formats, and merges. |
2550 * - "PASTE_VALUES" : Paste the values ONLY without formats, formulas, or | 2553 * - "PASTE_VALUES" : Paste the values ONLY without formats, formulas, or |
2551 * merges. | 2554 * merges. |
2552 * - "PASTE_FORMAT" : Paste the format and data validation only. | 2555 * - "PASTE_FORMAT" : Paste the format and data validation only. |
2553 * - "PASTE_NO_BORDERS" : Like PASTE_NORMAL but without borders. | 2556 * - "PASTE_NO_BORDERS" : Like PASTE_NORMAL but without borders. |
2554 * - "PASTE_FORMULA" : Paste the formulas only. | 2557 * - "PASTE_FORMULA" : Paste the formulas only. |
2555 * - "PASTE_DATA_VALIDATION" : Paste the data validation only. | 2558 * - "PASTE_DATA_VALIDATION" : Paste the data validation only. |
2556 * - "PASTE_CONDITIONAL_FORMATTING" : Paste the color rules only. | 2559 * - "PASTE_CONDITIONAL_FORMATTING" : Paste the conditional formatting rules |
| 2560 * only. |
2557 */ | 2561 */ |
2558 core.String pasteType; | 2562 core.String pasteType; |
2559 /** The source range to copy. */ | 2563 /** The source range to copy. */ |
2560 GridRange source; | 2564 GridRange source; |
2561 | 2565 |
2562 CopyPasteRequest(); | 2566 CopyPasteRequest(); |
2563 | 2567 |
2564 CopyPasteRequest.fromJson(core.Map _json) { | 2568 CopyPasteRequest.fromJson(core.Map _json) { |
2565 if (_json.containsKey("destination")) { | 2569 if (_json.containsKey("destination")) { |
2566 destination = new GridRange.fromJson(_json["destination"]); | 2570 destination = new GridRange.fromJson(_json["destination"]); |
(...skipping 57 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2624 * What kind of data to paste. All the source data will be cut, regardless | 2628 * What kind of data to paste. All the source data will be cut, regardless |
2625 * of what is pasted. | 2629 * of what is pasted. |
2626 * Possible string values are: | 2630 * Possible string values are: |
2627 * - "PASTE_NORMAL" : Paste values, formulas, formats, and merges. | 2631 * - "PASTE_NORMAL" : Paste values, formulas, formats, and merges. |
2628 * - "PASTE_VALUES" : Paste the values ONLY without formats, formulas, or | 2632 * - "PASTE_VALUES" : Paste the values ONLY without formats, formulas, or |
2629 * merges. | 2633 * merges. |
2630 * - "PASTE_FORMAT" : Paste the format and data validation only. | 2634 * - "PASTE_FORMAT" : Paste the format and data validation only. |
2631 * - "PASTE_NO_BORDERS" : Like PASTE_NORMAL but without borders. | 2635 * - "PASTE_NO_BORDERS" : Like PASTE_NORMAL but without borders. |
2632 * - "PASTE_FORMULA" : Paste the formulas only. | 2636 * - "PASTE_FORMULA" : Paste the formulas only. |
2633 * - "PASTE_DATA_VALIDATION" : Paste the data validation only. | 2637 * - "PASTE_DATA_VALIDATION" : Paste the data validation only. |
2634 * - "PASTE_CONDITIONAL_FORMATTING" : Paste the color rules only. | 2638 * - "PASTE_CONDITIONAL_FORMATTING" : Paste the conditional formatting rules |
| 2639 * only. |
2635 */ | 2640 */ |
2636 core.String pasteType; | 2641 core.String pasteType; |
2637 /** The source data to cut. */ | 2642 /** The source data to cut. */ |
2638 GridRange source; | 2643 GridRange source; |
2639 | 2644 |
2640 CutPasteRequest(); | 2645 CutPasteRequest(); |
2641 | 2646 |
2642 CutPasteRequest.fromJson(core.Map _json) { | 2647 CutPasteRequest.fromJson(core.Map _json) { |
2643 if (_json.containsKey("destination")) { | 2648 if (_json.containsKey("destination")) { |
2644 destination = new GridCoordinate.fromJson(_json["destination"]); | 2649 destination = new GridCoordinate.fromJson(_json["destination"]); |
(...skipping 206 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2851 | 2856 |
2852 core.Map toJson() { | 2857 core.Map toJson() { |
2853 var _json = new core.Map(); | 2858 var _json = new core.Map(); |
2854 if (namedRangeId != null) { | 2859 if (namedRangeId != null) { |
2855 _json["namedRangeId"] = namedRangeId; | 2860 _json["namedRangeId"] = namedRangeId; |
2856 } | 2861 } |
2857 return _json; | 2862 return _json; |
2858 } | 2863 } |
2859 } | 2864 } |
2860 | 2865 |
2861 /** Deletes the protected range with the given id. */ | 2866 /** Deletes the protected range with the given ID. */ |
2862 class DeleteProtectedRangeRequest { | 2867 class DeleteProtectedRangeRequest { |
2863 /** The ID of the protected range to delete. */ | 2868 /** The ID of the protected range to delete. */ |
2864 core.int protectedRangeId; | 2869 core.int protectedRangeId; |
2865 | 2870 |
2866 DeleteProtectedRangeRequest(); | 2871 DeleteProtectedRangeRequest(); |
2867 | 2872 |
2868 DeleteProtectedRangeRequest.fromJson(core.Map _json) { | 2873 DeleteProtectedRangeRequest.fromJson(core.Map _json) { |
2869 if (_json.containsKey("protectedRangeId")) { | 2874 if (_json.containsKey("protectedRangeId")) { |
2870 protectedRangeId = _json["protectedRangeId"]; | 2875 protectedRangeId = _json["protectedRangeId"]; |
2871 } | 2876 } |
(...skipping 329 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3201 } | 3206 } |
3202 } | 3207 } |
3203 | 3208 |
3204 /** The position of an embedded object such as a chart. */ | 3209 /** The position of an embedded object such as a chart. */ |
3205 class EmbeddedObjectPosition { | 3210 class EmbeddedObjectPosition { |
3206 /** | 3211 /** |
3207 * If true, the embedded object will be put on a new sheet whose ID | 3212 * If true, the embedded object will be put on a new sheet whose ID |
3208 * is chosen for you. Used only when writing. | 3213 * is chosen for you. Used only when writing. |
3209 */ | 3214 */ |
3210 core.bool newSheet; | 3215 core.bool newSheet; |
3211 /** The position the object is overlaid on top of a grid. */ | 3216 /** The position at which the object is overlaid on top of a grid. */ |
3212 OverlayPosition overlayPosition; | 3217 OverlayPosition overlayPosition; |
3213 /** | 3218 /** |
3214 * The sheet this is on. Set only if the embedded object | 3219 * The sheet this is on. Set only if the embedded object |
3215 * is on its own sheet. Must be non-negative. | 3220 * is on its own sheet. Must be non-negative. |
3216 */ | 3221 */ |
3217 core.int sheetId; | 3222 core.int sheetId; |
3218 | 3223 |
3219 EmbeddedObjectPosition(); | 3224 EmbeddedObjectPosition(); |
3220 | 3225 |
3221 EmbeddedObjectPosition.fromJson(core.Map _json) { | 3226 EmbeddedObjectPosition.fromJson(core.Map _json) { |
(...skipping 128 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3350 if (numberValue != null) { | 3355 if (numberValue != null) { |
3351 _json["numberValue"] = numberValue; | 3356 _json["numberValue"] = numberValue; |
3352 } | 3357 } |
3353 if (stringValue != null) { | 3358 if (stringValue != null) { |
3354 _json["stringValue"] = stringValue; | 3359 _json["stringValue"] = stringValue; |
3355 } | 3360 } |
3356 return _json; | 3361 return _json; |
3357 } | 3362 } |
3358 } | 3363 } |
3359 | 3364 |
3360 /** Criteria for showing/hiding rows in a filter, filter view. */ | 3365 /** Criteria for showing/hiding rows in a filter or filter view. */ |
3361 class FilterCriteria { | 3366 class FilterCriteria { |
3362 /** | 3367 /** |
3363 * A condition that must be true for values to be shown. | 3368 * A condition that must be true for values to be shown. |
3364 * (This does not override hiddenValues -- if a value is listed there, | 3369 * (This does not override hiddenValues -- if a value is listed there, |
3365 * it will still be hidden.) | 3370 * it will still be hidden.) |
3366 */ | 3371 */ |
3367 BooleanCondition condition; | 3372 BooleanCondition condition; |
3368 /** Values that should be hidden. */ | 3373 /** Values that should be hidden. */ |
3369 core.List<core.String> hiddenValues; | 3374 core.List<core.String> hiddenValues; |
3370 | 3375 |
(...skipping 26 matching lines...) Expand all Loading... |
3397 * The criteria for showing/hiding values per column. | 3402 * The criteria for showing/hiding values per column. |
3398 * The map's key is the column index, and the value is the criteria for | 3403 * The map's key is the column index, and the value is the criteria for |
3399 * that column. | 3404 * that column. |
3400 */ | 3405 */ |
3401 core.Map<core.String, FilterCriteria> criteria; | 3406 core.Map<core.String, FilterCriteria> criteria; |
3402 /** The ID of the filter view. */ | 3407 /** The ID of the filter view. */ |
3403 core.int filterViewId; | 3408 core.int filterViewId; |
3404 /** | 3409 /** |
3405 * The named range this filter view is backed by, if any. | 3410 * The named range this filter view is backed by, if any. |
3406 * | 3411 * |
3407 * When writing, only one of range or namedRangeId | 3412 * When writing, only one of range or named_range_id |
3408 * may be set. | 3413 * may be set. |
3409 */ | 3414 */ |
3410 core.String namedRangeId; | 3415 core.String namedRangeId; |
3411 /** | 3416 /** |
3412 * The range this filter view covers. | 3417 * The range this filter view covers. |
3413 * | 3418 * |
3414 * When writing, only one of range or namedRangeId | 3419 * When writing, only one of range or named_range_id |
3415 * may be set. | 3420 * may be set. |
3416 */ | 3421 */ |
3417 GridRange range; | 3422 GridRange range; |
3418 /** | 3423 /** |
3419 * The sort order per column. Later specifications are used when values | 3424 * The sort order per column. Later specifications are used when values |
3420 * are equal in the earlier specifications. | 3425 * are equal in the earlier specifications. |
3421 */ | 3426 */ |
3422 core.List<SortSpec> sortSpecs; | 3427 core.List<SortSpec> sortSpecs; |
3423 /** The name of the filter view. */ | 3428 /** The name of the filter view. */ |
3424 core.String title; | 3429 core.String title; |
(...skipping 62 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3487 core.bool matchEntireCell; | 3492 core.bool matchEntireCell; |
3488 /** The range to find/replace over. */ | 3493 /** The range to find/replace over. */ |
3489 GridRange range; | 3494 GridRange range; |
3490 /** The value to use as the replacement. */ | 3495 /** The value to use as the replacement. */ |
3491 core.String replacement; | 3496 core.String replacement; |
3492 /** | 3497 /** |
3493 * True if the find value is a regex. | 3498 * True if the find value is a regex. |
3494 * The regular expression and replacement should follow Java regex rules | 3499 * The regular expression and replacement should follow Java regex rules |
3495 * at https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html. | 3500 * at https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html. |
3496 * The replacement string is allowed to refer to capturing groups. | 3501 * The replacement string is allowed to refer to capturing groups. |
3497 * For example, if one cell has the contents "`Google Sheets`" and another | 3502 * For example, if one cell has the contents `"Google Sheets"` and another |
3498 * has "`Google Docs`", then searching for `"o.* (.*)"` with a replacement of | 3503 * has `"Google Docs"`, then searching for `"o.* (.*)"` with a replacement of |
3499 * `"$1 Rocks`"` would change the contents of the cells to | 3504 * `"$1 Rocks"` would change the contents of the cells to |
3500 * "`GSheets Rocks`" and "`GDocs Rocks`" respectively. | 3505 * `"GSheets Rocks"` and `"GDocs Rocks"` respectively. |
3501 */ | 3506 */ |
3502 core.bool searchByRegex; | 3507 core.bool searchByRegex; |
3503 /** The sheet to find/replace over. */ | 3508 /** The sheet to find/replace over. */ |
3504 core.int sheetId; | 3509 core.int sheetId; |
3505 | 3510 |
3506 FindReplaceRequest(); | 3511 FindReplaceRequest(); |
3507 | 3512 |
3508 FindReplaceRequest.fromJson(core.Map _json) { | 3513 FindReplaceRequest.fromJson(core.Map _json) { |
3509 if (_json.containsKey("allSheets")) { | 3514 if (_json.containsKey("allSheets")) { |
3510 allSheets = _json["allSheets"]; | 3515 allSheets = _json["allSheets"]; |
(...skipping 56 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3567 return _json; | 3572 return _json; |
3568 } | 3573 } |
3569 } | 3574 } |
3570 | 3575 |
3571 /** The result of the find/replace. */ | 3576 /** The result of the find/replace. */ |
3572 class FindReplaceResponse { | 3577 class FindReplaceResponse { |
3573 /** The number of formula cells changed. */ | 3578 /** The number of formula cells changed. */ |
3574 core.int formulasChanged; | 3579 core.int formulasChanged; |
3575 /** | 3580 /** |
3576 * The number of occurrences (possibly multiple within a cell) changed. | 3581 * The number of occurrences (possibly multiple within a cell) changed. |
3577 * For example, if replacing "`e`" with "`o`" in "`Google Sheets`", this would | 3582 * For example, if replacing `"e"` with `"o"` in `"Google Sheets"`, this would |
3578 * be "`3`" because "`Google Sheets`" -> "`Googlo Shoots`". | 3583 * be `"3"` because `"Google Sheets"` -> `"Googlo Shoots"`. |
3579 */ | 3584 */ |
3580 core.int occurrencesChanged; | 3585 core.int occurrencesChanged; |
3581 /** The number of rows changed. */ | 3586 /** The number of rows changed. */ |
3582 core.int rowsChanged; | 3587 core.int rowsChanged; |
3583 /** The number of sheets changed. */ | 3588 /** The number of sheets changed. */ |
3584 core.int sheetsChanged; | 3589 core.int sheetsChanged; |
3585 /** The number of non-formula cells changed. */ | 3590 /** The number of non-formula cells changed. */ |
3586 core.int valuesChanged; | 3591 core.int valuesChanged; |
3587 | 3592 |
3588 FindReplaceResponse(); | 3593 FindReplaceResponse(); |
(...skipping 118 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3707 _json["sheetId"] = sheetId; | 3712 _json["sheetId"] = sheetId; |
3708 } | 3713 } |
3709 return _json; | 3714 return _json; |
3710 } | 3715 } |
3711 } | 3716 } |
3712 | 3717 |
3713 /** Data in the grid, as well as metadata about the dimensions. */ | 3718 /** Data in the grid, as well as metadata about the dimensions. */ |
3714 class GridData { | 3719 class GridData { |
3715 /** | 3720 /** |
3716 * Metadata about the requested columns in the grid, starting with the column | 3721 * Metadata about the requested columns in the grid, starting with the column |
3717 * in startColumn. | 3722 * in start_column. |
3718 */ | 3723 */ |
3719 core.List<DimensionProperties> columnMetadata; | 3724 core.List<DimensionProperties> columnMetadata; |
3720 /** | 3725 /** |
3721 * The data in the grid, one entry per row, | 3726 * The data in the grid, one entry per row, |
3722 * starting with the row in startRow. | 3727 * starting with the row in startRow. |
3723 * The values in RowData will correspond to columns starting | 3728 * The values in RowData will correspond to columns starting |
3724 * at startColumn. | 3729 * at start_column. |
3725 */ | 3730 */ |
3726 core.List<RowData> rowData; | 3731 core.List<RowData> rowData; |
3727 /** | 3732 /** |
3728 * Metadata about the requested rows in the grid, starting with the row | 3733 * Metadata about the requested rows in the grid, starting with the row |
3729 * in startRow. | 3734 * in start_row. |
3730 */ | 3735 */ |
3731 core.List<DimensionProperties> rowMetadata; | 3736 core.List<DimensionProperties> rowMetadata; |
3732 /** The first column this GridData refers to, zero-based. */ | 3737 /** The first column this GridData refers to, zero-based. */ |
3733 core.int startColumn; | 3738 core.int startColumn; |
3734 /** The first row this GridData refers to, zero-based. */ | 3739 /** The first row this GridData refers to, zero-based. */ |
3735 core.int startRow; | 3740 core.int startRow; |
3736 | 3741 |
3737 GridData(); | 3742 GridData(); |
3738 | 3743 |
3739 GridData.fromJson(core.Map _json) { | 3744 GridData.fromJson(core.Map _json) { |
(...skipping 89 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3829 } | 3834 } |
3830 } | 3835 } |
3831 | 3836 |
3832 /** | 3837 /** |
3833 * A range on a sheet. | 3838 * A range on a sheet. |
3834 * All indexes are zero-based. | 3839 * All indexes are zero-based. |
3835 * Indexes are half open, e.g the start index is inclusive | 3840 * Indexes are half open, e.g the start index is inclusive |
3836 * and the end index is exclusive -- [start_index, end_index). | 3841 * and the end index is exclusive -- [start_index, end_index). |
3837 * Missing indexes indicate the range is unbounded on that side. | 3842 * Missing indexes indicate the range is unbounded on that side. |
3838 * | 3843 * |
3839 * For example, if "Sheet1" is grid ID 0, then: | 3844 * For example, if `"Sheet1"` is sheet ID 0, then: |
3840 * | 3845 * |
3841 * Sheet1!A1:A1 == sheet_id: 0, | 3846 * `Sheet1!A1:A1 == sheet_id: 0, |
3842 * start_row_index: 0, end_row_index: 1, | 3847 * start_row_index: 0, end_row_index: 1, |
3843 * start_column_index: 0, end_column_index: 1 | 3848 * start_column_index: 0, end_column_index: 1` |
3844 * | 3849 * |
3845 * Sheet1!A3:B4 == sheet_id: 0, | 3850 * `Sheet1!A3:B4 == sheet_id: 0, |
3846 * start_row_index: 2, end_row_index: 4, | 3851 * start_row_index: 2, end_row_index: 4, |
3847 * start_column_index: 0, end_column_index: 2 | 3852 * start_column_index: 0, end_column_index: 2` |
3848 * | 3853 * |
3849 * Sheet1!A:B == sheet_id: 0, | 3854 * `Sheet1!A:B == sheet_id: 0, |
3850 * start_column_index: 0, end_column_index: 2 | 3855 * start_column_index: 0, end_column_index: 2` |
3851 * | 3856 * |
3852 * Sheet1!A5:B == sheet_id: 0, | 3857 * `Sheet1!A5:B == sheet_id: 0, |
3853 * start_row_index: 4, | 3858 * start_row_index: 4, |
3854 * start_column_index: 0, end_column_index: 2 | 3859 * start_column_index: 0, end_column_index: 2` |
3855 * | 3860 * |
3856 * Sheet1 == sheet_id:0 | 3861 * `Sheet1 == sheet_id:0` |
3857 * | 3862 * |
3858 * The start index must always be less than or equal to the end index. | 3863 * The start index must always be less than or equal to the end index. |
3859 * If the start index equals the end index, then the range is empty. | 3864 * If the start index equals the end index, then the range is empty. |
3860 * Empty ranges are typically not meaningful and are usually rendered in the | 3865 * Empty ranges are typically not meaningful and are usually rendered in the |
3861 * UI as `#REF!`. | 3866 * UI as `#REF!`. |
3862 */ | 3867 */ |
3863 class GridRange { | 3868 class GridRange { |
3864 /** The end column (exclusive) of the range, or not set if unbounded. */ | 3869 /** The end column (exclusive) of the range, or not set if unbounded. */ |
3865 core.int endColumnIndex; | 3870 core.int endColumnIndex; |
3866 /** The end row (exclusive) of the range, or not set if unbounded. */ | 3871 /** The end row (exclusive) of the range, or not set if unbounded. */ |
(...skipping 53 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3920 * before or after the newly inserted dimensions. | 3925 * before or after the newly inserted dimensions. |
3921 * True to inherit from the dimensions before (in which case the start | 3926 * True to inherit from the dimensions before (in which case the start |
3922 * index must be greater than 0), and false to inherit from the dimensions | 3927 * index must be greater than 0), and false to inherit from the dimensions |
3923 * after. | 3928 * after. |
3924 * | 3929 * |
3925 * For example, if row index 0 has red background and row index 1 | 3930 * For example, if row index 0 has red background and row index 1 |
3926 * has a green background, then inserting 2 rows at index 1 can inherit | 3931 * has a green background, then inserting 2 rows at index 1 can inherit |
3927 * either the green or red background. If `inheritFromBefore` is true, | 3932 * either the green or red background. If `inheritFromBefore` is true, |
3928 * the two new rows will be red (because the row before the insertion point | 3933 * the two new rows will be red (because the row before the insertion point |
3929 * was red), whereas if `inheritFromBefore` is false, the two new rows will | 3934 * was red), whereas if `inheritFromBefore` is false, the two new rows will |
3930 * be green (because the rows after the insertion point were green). | 3935 * be green (because the row after the insertion point was green). |
3931 */ | 3936 */ |
3932 core.bool inheritFromBefore; | 3937 core.bool inheritFromBefore; |
3933 /** | 3938 /** |
3934 * The dimensions to insert. Both the start and end indexes must be bounded. | 3939 * The dimensions to insert. Both the start and end indexes must be bounded. |
3935 */ | 3940 */ |
3936 DimensionRange range; | 3941 DimensionRange range; |
3937 | 3942 |
3938 InsertDimensionRequest(); | 3943 InsertDimensionRequest(); |
3939 | 3944 |
3940 InsertDimensionRequest.fromJson(core.Map _json) { | 3945 InsertDimensionRequest.fromJson(core.Map _json) { |
(...skipping 11 matching lines...) Expand all Loading... |
3952 _json["inheritFromBefore"] = inheritFromBefore; | 3957 _json["inheritFromBefore"] = inheritFromBefore; |
3953 } | 3958 } |
3954 if (range != null) { | 3959 if (range != null) { |
3955 _json["range"] = (range).toJson(); | 3960 _json["range"] = (range).toJson(); |
3956 } | 3961 } |
3957 return _json; | 3962 return _json; |
3958 } | 3963 } |
3959 } | 3964 } |
3960 | 3965 |
3961 /** | 3966 /** |
3962 * A single interpolation point a gradient conditional format. | 3967 * A single interpolation point on a gradient conditional format. |
3963 * These pin the gradient color scale according to the color, | 3968 * These pin the gradient color scale according to the color, |
3964 * type and value chosen. | 3969 * type and value chosen. |
3965 */ | 3970 */ |
3966 class InterpolationPoint { | 3971 class InterpolationPoint { |
3967 /** The color this interpolation point should use. */ | 3972 /** The color this interpolation point should use. */ |
3968 Color color; | 3973 Color color; |
3969 /** | 3974 /** |
3970 * How the value should be interpreted. | 3975 * How the value should be interpreted. |
3971 * Possible string values are: | 3976 * Possible string values are: |
3972 * - "INTERPOLATION_POINT_TYPE_UNSPECIFIED" : The default value, do not use. | 3977 * - "INTERPOLATION_POINT_TYPE_UNSPECIFIED" : The default value, do not use. |
(...skipping 92 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
4065 class MoveDimensionRequest { | 4070 class MoveDimensionRequest { |
4066 /** | 4071 /** |
4067 * The zero-based start index of where to move the source data to, | 4072 * The zero-based start index of where to move the source data to, |
4068 * based on the coordinates *before* the source data is removed | 4073 * based on the coordinates *before* the source data is removed |
4069 * from the grid. Existing data will be shifted down or right | 4074 * from the grid. Existing data will be shifted down or right |
4070 * (depending on the dimension) to make room for the moved dimensions. | 4075 * (depending on the dimension) to make room for the moved dimensions. |
4071 * The source dimensions are removed from the grid, so the | 4076 * The source dimensions are removed from the grid, so the |
4072 * the data may end up in a different index than specified. | 4077 * the data may end up in a different index than specified. |
4073 * | 4078 * |
4074 * For example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move | 4079 * For example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move |
4075 * "`1`" and "`2`" to between "`3`" and "`4`", the source would be | 4080 * `"1"` and `"2"` to between `"3"` and `"4"`, the source would be |
4076 * `ROWS [1..3)`,and the destination index would be "`4`" | 4081 * `ROWS [1..3)`,and the destination index would be `"4"` |
4077 * (the zero-based index of row 5). | 4082 * (the zero-based index of row 5). |
4078 * The end result would be `A1..A5` of `0, 3, 1, 2, 4`. | 4083 * The end result would be `A1..A5` of `0, 3, 1, 2, 4`. |
4079 */ | 4084 */ |
4080 core.int destinationIndex; | 4085 core.int destinationIndex; |
4081 /** The source dimensions to move. */ | 4086 /** The source dimensions to move. */ |
4082 DimensionRange source; | 4087 DimensionRange source; |
4083 | 4088 |
4084 MoveDimensionRequest(); | 4089 MoveDimensionRequest(); |
4085 | 4090 |
4086 MoveDimensionRequest.fromJson(core.Map _json) { | 4091 MoveDimensionRequest.fromJson(core.Map _json) { |
(...skipping 48 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
4135 if (namedRangeId != null) { | 4140 if (namedRangeId != null) { |
4136 _json["namedRangeId"] = namedRangeId; | 4141 _json["namedRangeId"] = namedRangeId; |
4137 } | 4142 } |
4138 if (range != null) { | 4143 if (range != null) { |
4139 _json["range"] = (range).toJson(); | 4144 _json["range"] = (range).toJson(); |
4140 } | 4145 } |
4141 return _json; | 4146 return _json; |
4142 } | 4147 } |
4143 } | 4148 } |
4144 | 4149 |
4145 /** | 4150 /** The number format of a cell. */ |
4146 * The number format of a cell. | |
4147 * When updating, all fields must be set. | |
4148 */ | |
4149 class NumberFormat { | 4151 class NumberFormat { |
4150 /** Pattern string used for formatting. */ | 4152 /** |
| 4153 * Pattern string used for formatting. If not set, a default pattern based on |
| 4154 * the user's locale will be used if necessary for the given type. |
| 4155 */ |
4151 core.String pattern; | 4156 core.String pattern; |
4152 /** | 4157 /** |
4153 * The type of the number format. | 4158 * The type of the number format. |
| 4159 * When writing, this field must be set. |
4154 * Possible string values are: | 4160 * Possible string values are: |
4155 * - "NUMBER_FORMAT_TYPE_UNSPECIFIED" : The number format is not specified | 4161 * - "NUMBER_FORMAT_TYPE_UNSPECIFIED" : The number format is not specified |
4156 * and is based on the contents of the cell. | 4162 * and is based on the contents of the cell. |
4157 * Do not explicitly use this. | 4163 * Do not explicitly use this. |
4158 * - "TEXT" : Text formatting, e.g `1000.12` | 4164 * - "TEXT" : Text formatting, e.g `1000.12` |
4159 * - "NUMBER" : Number formatting, e.g, `1,000.12` | 4165 * - "NUMBER" : Number formatting, e.g, `1,000.12` |
4160 * - "PERCENT" : Percent formatting, e.g `10.12%` | 4166 * - "PERCENT" : Percent formatting, e.g `10.12%` |
4161 * - "CURRENCY" : Currency formatting, e.g `$1,000.12` | 4167 * - "CURRENCY" : Currency formatting, e.g `$1,000.12` |
4162 * - "DATE" : Date formatting, e.g `9/26/2008` | 4168 * - "DATE" : Date formatting, e.g `9/26/2008` |
4163 * - "TIME" : Time formatting, e.g `3:59:00 PM` | 4169 * - "TIME" : Time formatting, e.g `3:59:00 PM` |
(...skipping 147 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
4311 /** | 4317 /** |
4312 * How the data should be pasted. | 4318 * How the data should be pasted. |
4313 * Possible string values are: | 4319 * Possible string values are: |
4314 * - "PASTE_NORMAL" : Paste values, formulas, formats, and merges. | 4320 * - "PASTE_NORMAL" : Paste values, formulas, formats, and merges. |
4315 * - "PASTE_VALUES" : Paste the values ONLY without formats, formulas, or | 4321 * - "PASTE_VALUES" : Paste the values ONLY without formats, formulas, or |
4316 * merges. | 4322 * merges. |
4317 * - "PASTE_FORMAT" : Paste the format and data validation only. | 4323 * - "PASTE_FORMAT" : Paste the format and data validation only. |
4318 * - "PASTE_NO_BORDERS" : Like PASTE_NORMAL but without borders. | 4324 * - "PASTE_NO_BORDERS" : Like PASTE_NORMAL but without borders. |
4319 * - "PASTE_FORMULA" : Paste the formulas only. | 4325 * - "PASTE_FORMULA" : Paste the formulas only. |
4320 * - "PASTE_DATA_VALIDATION" : Paste the data validation only. | 4326 * - "PASTE_DATA_VALIDATION" : Paste the data validation only. |
4321 * - "PASTE_CONDITIONAL_FORMATTING" : Paste the color rules only. | 4327 * - "PASTE_CONDITIONAL_FORMATTING" : Paste the conditional formatting rules |
| 4328 * only. |
4322 */ | 4329 */ |
4323 core.String type; | 4330 core.String type; |
4324 | 4331 |
4325 PasteDataRequest(); | 4332 PasteDataRequest(); |
4326 | 4333 |
4327 PasteDataRequest.fromJson(core.Map _json) { | 4334 PasteDataRequest.fromJson(core.Map _json) { |
4328 if (_json.containsKey("coordinate")) { | 4335 if (_json.containsKey("coordinate")) { |
4329 coordinate = new GridCoordinate.fromJson(_json["coordinate"]); | 4336 coordinate = new GridCoordinate.fromJson(_json["coordinate"]); |
4330 } | 4337 } |
4331 if (_json.containsKey("data")) { | 4338 if (_json.containsKey("data")) { |
(...skipping 125 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
4457 * The order the values in this group should be sorted. | 4464 * The order the values in this group should be sorted. |
4458 * Possible string values are: | 4465 * Possible string values are: |
4459 * - "SORT_ORDER_UNSPECIFIED" : Default value, do not use this. | 4466 * - "SORT_ORDER_UNSPECIFIED" : Default value, do not use this. |
4460 * - "ASCENDING" : Sort ascending. | 4467 * - "ASCENDING" : Sort ascending. |
4461 * - "DESCENDING" : Sort descending. | 4468 * - "DESCENDING" : Sort descending. |
4462 */ | 4469 */ |
4463 core.String sortOrder; | 4470 core.String sortOrder; |
4464 /** | 4471 /** |
4465 * The column offset of the source range that this grouping is based on. | 4472 * The column offset of the source range that this grouping is based on. |
4466 * | 4473 * |
4467 * For example, if the source was `C10:E15', a `sourceColumnOffset` of `0` | 4474 * For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` |
4468 * means this group refers to column `C`, whereas the offset `1` would refer | 4475 * means this group refers to column `C`, whereas the offset `1` would refer |
4469 * to column `D`. | 4476 * to column `D`. |
4470 */ | 4477 */ |
4471 core.int sourceColumnOffset; | 4478 core.int sourceColumnOffset; |
4472 /** | 4479 /** |
4473 * The bucket of the opposite pivot group to sort by. | 4480 * The bucket of the opposite pivot group to sort by. |
4474 * If not specified, sorting is alphabetical by this group's values. | 4481 * If not specified, sorting is alphabetical by this group's values. |
4475 */ | 4482 */ |
4476 PivotGroupSortValueBucket valueBucket; | 4483 PivotGroupSortValueBucket valueBucket; |
4477 /** Metadata about values in the grouping. */ | 4484 /** Metadata about values in the grouping. */ |
(...skipping 50 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
4528 * For example, in a pivot table with one row group & two column groups, | 4535 * For example, in a pivot table with one row group & two column groups, |
4529 * the row group can list up to two values. The first value corresponds | 4536 * the row group can list up to two values. The first value corresponds |
4530 * to a value within the first column group, and the second value | 4537 * to a value within the first column group, and the second value |
4531 * corresponds to a value in the second column group. If no values | 4538 * corresponds to a value in the second column group. If no values |
4532 * are listed, this would indicate that the row should be sorted according | 4539 * are listed, this would indicate that the row should be sorted according |
4533 * to the "Grand Total" over the column groups. If a single value is listed, | 4540 * to the "Grand Total" over the column groups. If a single value is listed, |
4534 * this would correspond to using the "Total" of that bucket. | 4541 * this would correspond to using the "Total" of that bucket. |
4535 */ | 4542 */ |
4536 core.List<ExtendedValue> buckets; | 4543 core.List<ExtendedValue> buckets; |
4537 /** | 4544 /** |
4538 * The offset in the [PivotTable.values] list which the values in this | 4545 * The offset in the PivotTable.values list which the values in this |
4539 * grouping should be sorted by. | 4546 * grouping should be sorted by. |
4540 */ | 4547 */ |
4541 core.int valuesIndex; | 4548 core.int valuesIndex; |
4542 | 4549 |
4543 PivotGroupSortValueBucket(); | 4550 PivotGroupSortValueBucket(); |
4544 | 4551 |
4545 PivotGroupSortValueBucket.fromJson(core.Map _json) { | 4552 PivotGroupSortValueBucket.fromJson(core.Map _json) { |
4546 if (_json.containsKey("buckets")) { | 4553 if (_json.containsKey("buckets")) { |
4547 buckets = _json["buckets"].map((value) => new ExtendedValue.fromJson(value
)).toList(); | 4554 buckets = _json["buckets"].map((value) => new ExtendedValue.fromJson(value
)).toList(); |
4548 } | 4555 } |
(...skipping 52 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
4601 class PivotTable { | 4608 class PivotTable { |
4602 /** Each column grouping in the pivot table. */ | 4609 /** Each column grouping in the pivot table. */ |
4603 core.List<PivotGroup> columns; | 4610 core.List<PivotGroup> columns; |
4604 /** | 4611 /** |
4605 * An optional mapping of filters per source column offset. | 4612 * An optional mapping of filters per source column offset. |
4606 * | 4613 * |
4607 * The filters will be applied before aggregating data into the pivot table. | 4614 * The filters will be applied before aggregating data into the pivot table. |
4608 * The map's key is the column offset of the source range that you want to | 4615 * The map's key is the column offset of the source range that you want to |
4609 * filter, and the value is the criteria for that column. | 4616 * filter, and the value is the criteria for that column. |
4610 * | 4617 * |
4611 * For example, if the source was `C10:E15', a key of `0` will have the filter | 4618 * For example, if the source was `C10:E15`, a key of `0` will have the filter |
4612 * for column `C`, whereas the key `1` is for column `D`. | 4619 * for column `C`, whereas the key `1` is for column `D`. |
4613 */ | 4620 */ |
4614 core.Map<core.String, PivotFilterCriteria> criteria; | 4621 core.Map<core.String, PivotFilterCriteria> criteria; |
4615 /** Each row grouping in the pivot table. */ | 4622 /** Each row grouping in the pivot table. */ |
4616 core.List<PivotGroup> rows; | 4623 core.List<PivotGroup> rows; |
4617 /** The range the pivot table is reading data from. */ | 4624 /** The range the pivot table is reading data from. */ |
4618 GridRange source; | 4625 GridRange source; |
4619 /** | 4626 /** |
4620 * Whether values should be listed horizontally (as columns) | 4627 * Whether values should be listed horizontally (as columns) |
4621 * or vertically (as rows). | 4628 * or vertically (as rows). |
(...skipping 60 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
4682 */ | 4689 */ |
4683 core.String formula; | 4690 core.String formula; |
4684 /** | 4691 /** |
4685 * A name to use for the value. This is only used if formula was set. | 4692 * A name to use for the value. This is only used if formula was set. |
4686 * Otherwise, the column name is used. | 4693 * Otherwise, the column name is used. |
4687 */ | 4694 */ |
4688 core.String name; | 4695 core.String name; |
4689 /** | 4696 /** |
4690 * The column offset of the source range that this value reads from. | 4697 * The column offset of the source range that this value reads from. |
4691 * | 4698 * |
4692 * For example, if the source was `C10:E15', a `sourceColumnOffset` of `0` | 4699 * For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` |
4693 * means this value refers to column `C`, whereas the offset `1` would | 4700 * means this value refers to column `C`, whereas the offset `1` would |
4694 * refer to column `D`. | 4701 * refer to column `D`. |
4695 */ | 4702 */ |
4696 core.int sourceColumnOffset; | 4703 core.int sourceColumnOffset; |
4697 /** | 4704 /** |
4698 * A function to summarize the value. | 4705 * A function to summarize the value. |
4699 * If formula is set, the only supported values are | 4706 * If formula is set, the only supported values are |
4700 * SUM and | 4707 * SUM and |
4701 * CUSTOM. | 4708 * CUSTOM. |
4702 * If sourceColumnOffset is set, then `CUSTOM` | 4709 * If sourceColumnOffset is set, then `CUSTOM` |
4703 * is not supported. | 4710 * is not supported. |
4704 * Possible string values are: | 4711 * Possible string values are: |
4705 * - "PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED" : The default, do not use. | 4712 * - "PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED" : The default, do not use. |
4706 * - "SUM" : Corresponds to the `SUM` function. | 4713 * - "SUM" : Corresponds to the `SUM` function. |
4707 * - "COUNTA" : Corresponds to the `COUNTA` function. | 4714 * - "COUNTA" : Corresponds to the `COUNTA` function. |
4708 * - "COUNT" : Corresponds to the `COUNT` function. | 4715 * - "COUNT" : Corresponds to the `COUNT` function. |
4709 * - "COUNTUNIQUE" : Corresponds to the `COUNTUNIQUE` function. | 4716 * - "COUNTUNIQUE" : Corresponds to the `COUNTUNIQUE` function. |
4710 * - "AVERAGE" : Corresponds to the `AVERAGE` function. | 4717 * - "AVERAGE" : Corresponds to the `AVERAGE` function. |
4711 * - "MAX" : Corresponds to the `MAX` function. | 4718 * - "MAX" : Corresponds to the `MAX` function. |
4712 * - "MIN" : Corresponds to the `MIN` function. | 4719 * - "MIN" : Corresponds to the `MIN` function. |
4713 * - "MEDIAN" : Corresponds to the `MEDIAN` function. | 4720 * - "MEDIAN" : Corresponds to the `MEDIAN` function. |
4714 * - "PRODUCT" : Corresponds to the `PRODUCT` function. | 4721 * - "PRODUCT" : Corresponds to the `PRODUCT` function. |
4715 * - "STDEV" : Corresponds to the `STDEV` function. | 4722 * - "STDEV" : Corresponds to the `STDEV` function. |
4716 * - "STDEVP" : Corresponds to the `STDEVP` function. | 4723 * - "STDEVP" : Corresponds to the `STDEVP` function. |
4717 * - "VAR" : Corresponds to the `VAR` function. | 4724 * - "VAR" : Corresponds to the `VAR` function. |
4718 * - "VARP" : Corresponds to the `VARP` function. | 4725 * - "VARP" : Corresponds to the `VARP` function. |
4719 * - "CUSTOM" : Indicates the formula should be used as-is. | 4726 * - "CUSTOM" : Indicates the formula should be used as-is. |
4720 * Only valid if [PivotValue.formula] was set. | 4727 * Only valid if PivotValue.formula was set. |
4721 */ | 4728 */ |
4722 core.String summarizeFunction; | 4729 core.String summarizeFunction; |
4723 | 4730 |
4724 PivotValue(); | 4731 PivotValue(); |
4725 | 4732 |
4726 PivotValue.fromJson(core.Map _json) { | 4733 PivotValue.fromJson(core.Map _json) { |
4727 if (_json.containsKey("formula")) { | 4734 if (_json.containsKey("formula")) { |
4728 formula = _json["formula"]; | 4735 formula = _json["formula"]; |
4729 } | 4736 } |
4730 if (_json.containsKey("name")) { | 4737 if (_json.containsKey("name")) { |
(...skipping 26 matching lines...) Expand all Loading... |
4757 } | 4764 } |
4758 | 4765 |
4759 /** A protected range. */ | 4766 /** A protected range. */ |
4760 class ProtectedRange { | 4767 class ProtectedRange { |
4761 /** The description of this protected range. */ | 4768 /** The description of this protected range. */ |
4762 core.String description; | 4769 core.String description; |
4763 /** | 4770 /** |
4764 * The users and groups with edit access to the protected range. | 4771 * The users and groups with edit access to the protected range. |
4765 * This field is only visible to users with edit access to the protected | 4772 * This field is only visible to users with edit access to the protected |
4766 * range and the document. | 4773 * range and the document. |
4767 * Editors are not supported with warningOnly protection. | 4774 * Editors are not supported with warning_only protection. |
4768 */ | 4775 */ |
4769 Editors editors; | 4776 Editors editors; |
4770 /** | 4777 /** |
4771 * The named range this protected range is backed by, if any. | 4778 * The named range this protected range is backed by, if any. |
4772 * | 4779 * |
4773 * When writing, only one of range or namedRangeId | 4780 * When writing, only one of range or named_range_id |
4774 * may be set. | 4781 * may be set. |
4775 */ | 4782 */ |
4776 core.String namedRangeId; | 4783 core.String namedRangeId; |
4777 /** | 4784 /** |
4778 * The ID of the protected range. | 4785 * The ID of the protected range. |
4779 * This field is read-only. | 4786 * This field is read-only. |
4780 */ | 4787 */ |
4781 core.int protectedRangeId; | 4788 core.int protectedRangeId; |
4782 /** | 4789 /** |
4783 * The range that is being protected. | 4790 * The range that is being protected. |
4784 * The range may be fully unbounded, in which case this is considered | 4791 * The range may be fully unbounded, in which case this is considered |
4785 * a protected sheet. | 4792 * a protected sheet. |
4786 * | 4793 * |
4787 * When writing, only one of range or namedRangeId | 4794 * When writing, only one of range or named_range_id |
4788 * may be set. | 4795 * may be set. |
4789 */ | 4796 */ |
4790 GridRange range; | 4797 GridRange range; |
4791 /** | 4798 /** |
4792 * True if the user who requested this protected range can edit the | 4799 * True if the user who requested this protected range can edit the |
4793 * protected area. | 4800 * protected area. |
4794 * This field is read-only. | 4801 * This field is read-only. |
4795 */ | 4802 */ |
4796 core.bool requestingUserCanEdit; | 4803 core.bool requestingUserCanEdit; |
4797 /** | 4804 /** |
4798 * The list of unprotected ranges within a protected sheet. | 4805 * The list of unprotected ranges within a protected sheet. |
4799 * Unprotected ranges are only supported on protected sheets. | 4806 * Unprotected ranges are only supported on protected sheets. |
4800 */ | 4807 */ |
4801 core.List<GridRange> unprotectedRanges; | 4808 core.List<GridRange> unprotectedRanges; |
4802 /** | 4809 /** |
4803 * True if this this protected range will show a warning when editing. | 4810 * True if this protected range will show a warning when editing. |
4804 * Warning-based protection means that every user can edit data in the | 4811 * Warning-based protection means that every user can edit data in the |
4805 * protected range, except editing will prompt a warning asking the user | 4812 * protected range, except editing will prompt a warning asking the user |
4806 * to confirm the edit. | 4813 * to confirm the edit. |
4807 * | 4814 * |
4808 * When warning: if this field is true, then editors is ignored. | 4815 * When writing: if this field is true, then editors is ignored. |
4809 * Additionally, if this field is changed from true to false and the | 4816 * Additionally, if this field is changed from true to false and the |
4810 * `editors` field is not set (nor included in the field mask), then | 4817 * `editors` field is not set (nor included in the field mask), then |
4811 * the editors will be set to all the editors in the document. | 4818 * the editors will be set to all the editors in the document. |
4812 */ | 4819 */ |
4813 core.bool warningOnly; | 4820 core.bool warningOnly; |
4814 | 4821 |
4815 ProtectedRange(); | 4822 ProtectedRange(); |
4816 | 4823 |
4817 ProtectedRange.fromJson(core.Map _json) { | 4824 ProtectedRange.fromJson(core.Map _json) { |
4818 if (_json.containsKey("description")) { | 4825 if (_json.containsKey("description")) { |
(...skipping 57 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
4876 * Only the fields listed in the fields field are updated; others are | 4883 * Only the fields listed in the fields field are updated; others are |
4877 * unchanged. | 4884 * unchanged. |
4878 * | 4885 * |
4879 * If writing a cell with a formula, the formula's ranges will automatically | 4886 * If writing a cell with a formula, the formula's ranges will automatically |
4880 * increment for each field in the range. | 4887 * increment for each field in the range. |
4881 * For example, if writing a cell with formula `=A1` into range B2:C4, | 4888 * For example, if writing a cell with formula `=A1` into range B2:C4, |
4882 * B2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`, | 4889 * B2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`, |
4883 * C2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`. | 4890 * C2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`. |
4884 * | 4891 * |
4885 * To keep the formula's ranges static, use the `$` indicator. | 4892 * To keep the formula's ranges static, use the `$` indicator. |
4886 * For example, using the formula was `=$A$1`, neither | 4893 * For example, use the formula `=$A$1` to prevent both the row and the |
4887 * the row nor column would increment. | 4894 * column from incrementing. |
4888 */ | 4895 */ |
4889 class RepeatCellRequest { | 4896 class RepeatCellRequest { |
4890 /** The data to write. */ | 4897 /** The data to write. */ |
4891 CellData cell; | 4898 CellData cell; |
4892 /** | 4899 /** |
4893 * The fields that should be updated. At least one field must be specified. | 4900 * The fields that should be updated. At least one field must be specified. |
4894 * The root `cell` is implied and should not be specified. | 4901 * The root `cell` is implied and should not be specified. |
4895 * A single `"*"` can be used as short-hand for listing every field. | 4902 * A single `"*"` can be used as short-hand for listing every field. |
4896 */ | 4903 */ |
4897 core.String fields; | 4904 core.String fields; |
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
4934 /** Adds a new conditional format rule. */ | 4941 /** Adds a new conditional format rule. */ |
4935 AddConditionalFormatRuleRequest addConditionalFormatRule; | 4942 AddConditionalFormatRuleRequest addConditionalFormatRule; |
4936 /** Adds a filter view. */ | 4943 /** Adds a filter view. */ |
4937 AddFilterViewRequest addFilterView; | 4944 AddFilterViewRequest addFilterView; |
4938 /** Adds a named range. */ | 4945 /** Adds a named range. */ |
4939 AddNamedRangeRequest addNamedRange; | 4946 AddNamedRangeRequest addNamedRange; |
4940 /** Adds a protected range. */ | 4947 /** Adds a protected range. */ |
4941 AddProtectedRangeRequest addProtectedRange; | 4948 AddProtectedRangeRequest addProtectedRange; |
4942 /** Adds a sheet. */ | 4949 /** Adds a sheet. */ |
4943 AddSheetRequest addSheet; | 4950 AddSheetRequest addSheet; |
4944 /** Appends cells to the last row with data in a sheet. */ | 4951 /** Appends cells after the last row with data in a sheet. */ |
4945 AppendCellsRequest appendCells; | 4952 AppendCellsRequest appendCells; |
4946 /** Appends dimensions to the end of a sheet. */ | 4953 /** Appends dimensions to the end of a sheet. */ |
4947 AppendDimensionRequest appendDimension; | 4954 AppendDimensionRequest appendDimension; |
4948 /** Automatically fills in more data based on existing data. */ | 4955 /** Automatically fills in more data based on existing data. */ |
4949 AutoFillRequest autoFill; | 4956 AutoFillRequest autoFill; |
4950 /** | 4957 /** |
4951 * Automatically resizes one or more dimensions based on the contents | 4958 * Automatically resizes one or more dimensions based on the contents |
4952 * of the cells in that dimension. | 4959 * of the cells in that dimension. |
4953 */ | 4960 */ |
4954 AutoResizeDimensionsRequest autoResizeDimensions; | 4961 AutoResizeDimensionsRequest autoResizeDimensions; |
(...skipping 14 matching lines...) Expand all Loading... |
4969 /** Deletes a named range. */ | 4976 /** Deletes a named range. */ |
4970 DeleteNamedRangeRequest deleteNamedRange; | 4977 DeleteNamedRangeRequest deleteNamedRange; |
4971 /** Deletes a protected range. */ | 4978 /** Deletes a protected range. */ |
4972 DeleteProtectedRangeRequest deleteProtectedRange; | 4979 DeleteProtectedRangeRequest deleteProtectedRange; |
4973 /** Deletes a sheet. */ | 4980 /** Deletes a sheet. */ |
4974 DeleteSheetRequest deleteSheet; | 4981 DeleteSheetRequest deleteSheet; |
4975 /** Duplicates a filter view. */ | 4982 /** Duplicates a filter view. */ |
4976 DuplicateFilterViewRequest duplicateFilterView; | 4983 DuplicateFilterViewRequest duplicateFilterView; |
4977 /** Duplicates a sheet. */ | 4984 /** Duplicates a sheet. */ |
4978 DuplicateSheetRequest duplicateSheet; | 4985 DuplicateSheetRequest duplicateSheet; |
4979 /** Finds and replace occurrences of some text with other text. */ | 4986 /** Finds and replaces occurrences of some text with other text. */ |
4980 FindReplaceRequest findReplace; | 4987 FindReplaceRequest findReplace; |
4981 /** Inserts new rows or columns in a sheet. */ | 4988 /** Inserts new rows or columns in a sheet. */ |
4982 InsertDimensionRequest insertDimension; | 4989 InsertDimensionRequest insertDimension; |
4983 /** Merges cells together. */ | 4990 /** Merges cells together. */ |
4984 MergeCellsRequest mergeCells; | 4991 MergeCellsRequest mergeCells; |
4985 /** Moves rows or columns to another location in a sheet. */ | 4992 /** Moves rows or columns to another location in a sheet. */ |
4986 MoveDimensionRequest moveDimension; | 4993 MoveDimensionRequest moveDimension; |
4987 /** Pastes data (HTML or delimited) into a sheet. */ | 4994 /** Pastes data (HTML or delimited) into a sheet. */ |
4988 PasteDataRequest pasteData; | 4995 PasteDataRequest pasteData; |
4989 /** Repeats a single cell across a range. */ | 4996 /** Repeats a single cell across a range. */ |
(...skipping 849 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
5839 * - "RECALCULATION_INTERVAL_UNSPECIFIED" : Default value. This value must not | 5846 * - "RECALCULATION_INTERVAL_UNSPECIFIED" : Default value. This value must not |
5840 * be used. | 5847 * be used. |
5841 * - "ON_CHANGE" : Volatile functions are updated on every change. | 5848 * - "ON_CHANGE" : Volatile functions are updated on every change. |
5842 * - "MINUTE" : Volatile functions are updated on every change and every | 5849 * - "MINUTE" : Volatile functions are updated on every change and every |
5843 * minute. | 5850 * minute. |
5844 * - "HOUR" : Volatile functions are updated on every change and hourly. | 5851 * - "HOUR" : Volatile functions are updated on every change and hourly. |
5845 */ | 5852 */ |
5846 core.String autoRecalc; | 5853 core.String autoRecalc; |
5847 /** | 5854 /** |
5848 * The default format of all cells in the spreadsheet. | 5855 * The default format of all cells in the spreadsheet. |
5849 * CellData.effectiveFormat will not be set if the cell's format is equal | 5856 * CellData.effectiveFormat will not be set if the |
5850 * to this default format. | 5857 * cell's format is equal to this default format. |
5851 * This field is read-only. | 5858 * This field is read-only. |
5852 */ | 5859 */ |
5853 CellFormat defaultFormat; | 5860 CellFormat defaultFormat; |
5854 /** | 5861 /** |
5855 * The locale of the spreadsheet in one of the following formats: | 5862 * The locale of the spreadsheet in one of the following formats: |
| 5863 * |
5856 * * an ISO 639-1 language code such as `en` | 5864 * * an ISO 639-1 language code such as `en` |
| 5865 * |
5857 * * an ISO 639-2 language code such as `fil`, if no 639-1 code exists | 5866 * * an ISO 639-2 language code such as `fil`, if no 639-1 code exists |
| 5867 * |
5858 * * a combination of the ISO language code and country code, such as `en_US` | 5868 * * a combination of the ISO language code and country code, such as `en_US` |
| 5869 * |
5859 * Note: when updating this field, not all locales/languages are supported. | 5870 * Note: when updating this field, not all locales/languages are supported. |
5860 */ | 5871 */ |
5861 core.String locale; | 5872 core.String locale; |
5862 /** | 5873 /** |
5863 * The time zone of the spreadsheet, in CLDR format such as | 5874 * The time zone of the spreadsheet, in CLDR format such as |
5864 * `America/New_York`. If the time zone isn't recognized, this may | 5875 * `America/New_York`. If the time zone isn't recognized, this may |
5865 * be a custom time zone such as `GMT-07:00`. | 5876 * be a custom time zone such as `GMT-07:00`. |
5866 */ | 5877 */ |
5867 core.String timeZone; | 5878 core.String timeZone; |
5868 /** The title of the spreadsheet. */ | 5879 /** The title of the spreadsheet. */ |
(...skipping 107 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
5976 _json["strikethrough"] = strikethrough; | 5987 _json["strikethrough"] = strikethrough; |
5977 } | 5988 } |
5978 if (underline != null) { | 5989 if (underline != null) { |
5979 _json["underline"] = underline; | 5990 _json["underline"] = underline; |
5980 } | 5991 } |
5981 return _json; | 5992 return _json; |
5982 } | 5993 } |
5983 } | 5994 } |
5984 | 5995 |
5985 /** | 5996 /** |
5986 * A run of a text format. The format of this run continues until explicitly | 5997 * A run of a text format. The format of this run continues until the start |
5987 * overridden in the next run. | 5998 * index of the next run. |
5988 * When updating, all fields must be set. | 5999 * When updating, all fields must be set. |
5989 */ | 6000 */ |
5990 class TextFormatRun { | 6001 class TextFormatRun { |
5991 /** The format of this run. Absent values inherit the cell's format. */ | 6002 /** The format of this run. Absent values inherit the cell's format. */ |
5992 TextFormat format; | 6003 TextFormat format; |
5993 /** The character index where this run starts. */ | 6004 /** The character index where this run starts. */ |
5994 core.int startIndex; | 6005 core.int startIndex; |
5995 | 6006 |
5996 TextFormatRun(); | 6007 TextFormatRun(); |
5997 | 6008 |
(...skipping 279 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
6277 * or moves a conditional format rule to another index. | 6288 * or moves a conditional format rule to another index. |
6278 */ | 6289 */ |
6279 class UpdateConditionalFormatRuleRequest { | 6290 class UpdateConditionalFormatRuleRequest { |
6280 /** The zero-based index of the rule that should be replaced or moved. */ | 6291 /** The zero-based index of the rule that should be replaced or moved. */ |
6281 core.int index; | 6292 core.int index; |
6282 /** The zero-based new index the rule should end up at. */ | 6293 /** The zero-based new index the rule should end up at. */ |
6283 core.int newIndex; | 6294 core.int newIndex; |
6284 /** The rule that should replace the rule at the given index. */ | 6295 /** The rule that should replace the rule at the given index. */ |
6285 ConditionalFormatRule rule; | 6296 ConditionalFormatRule rule; |
6286 /** | 6297 /** |
6287 * The sheet of the rule to move. Required if newIndex is set, | 6298 * The sheet of the rule to move. Required if new_index is set, |
6288 * unused otherwise. | 6299 * unused otherwise. |
6289 */ | 6300 */ |
6290 core.int sheetId; | 6301 core.int sheetId; |
6291 | 6302 |
6292 UpdateConditionalFormatRuleRequest(); | 6303 UpdateConditionalFormatRuleRequest(); |
6293 | 6304 |
6294 UpdateConditionalFormatRuleRequest.fromJson(core.Map _json) { | 6305 UpdateConditionalFormatRuleRequest.fromJson(core.Map _json) { |
6295 if (_json.containsKey("index")) { | 6306 if (_json.containsKey("index")) { |
6296 index = _json["index"]; | 6307 index = _json["index"]; |
6297 } | 6308 } |
(...skipping 30 matching lines...) Expand all Loading... |
6328 class UpdateConditionalFormatRuleResponse { | 6339 class UpdateConditionalFormatRuleResponse { |
6329 /** The index of the new rule. */ | 6340 /** The index of the new rule. */ |
6330 core.int newIndex; | 6341 core.int newIndex; |
6331 /** | 6342 /** |
6332 * The new rule that replaced the old rule (if replacing), | 6343 * The new rule that replaced the old rule (if replacing), |
6333 * or the rule that was moved (if moved) | 6344 * or the rule that was moved (if moved) |
6334 */ | 6345 */ |
6335 ConditionalFormatRule newRule; | 6346 ConditionalFormatRule newRule; |
6336 /** | 6347 /** |
6337 * The old index of the rule. Not set if a rule was replaced | 6348 * The old index of the rule. Not set if a rule was replaced |
6338 * (because it is the same as newIndex). | 6349 * (because it is the same as new_index). |
6339 */ | 6350 */ |
6340 core.int oldIndex; | 6351 core.int oldIndex; |
6341 /** | 6352 /** |
6342 * The old (deleted) rule. Not set if a rule was moved | 6353 * The old (deleted) rule. Not set if a rule was moved |
6343 * (because it is the same as newRule). | 6354 * (because it is the same as new_rule). |
6344 */ | 6355 */ |
6345 ConditionalFormatRule oldRule; | 6356 ConditionalFormatRule oldRule; |
6346 | 6357 |
6347 UpdateConditionalFormatRuleResponse(); | 6358 UpdateConditionalFormatRuleResponse(); |
6348 | 6359 |
6349 UpdateConditionalFormatRuleResponse.fromJson(core.Map _json) { | 6360 UpdateConditionalFormatRuleResponse.fromJson(core.Map _json) { |
6350 if (_json.containsKey("newIndex")) { | 6361 if (_json.containsKey("newIndex")) { |
6351 newIndex = _json["newIndex"]; | 6362 newIndex = _json["newIndex"]; |
6352 } | 6363 } |
6353 if (_json.containsKey("newRule")) { | 6364 if (_json.containsKey("newRule")) { |
(...skipping 18 matching lines...) Expand all Loading... |
6372 if (oldIndex != null) { | 6383 if (oldIndex != null) { |
6373 _json["oldIndex"] = oldIndex; | 6384 _json["oldIndex"] = oldIndex; |
6374 } | 6385 } |
6375 if (oldRule != null) { | 6386 if (oldRule != null) { |
6376 _json["oldRule"] = (oldRule).toJson(); | 6387 _json["oldRule"] = (oldRule).toJson(); |
6377 } | 6388 } |
6378 return _json; | 6389 return _json; |
6379 } | 6390 } |
6380 } | 6391 } |
6381 | 6392 |
6382 /** | 6393 /** Updates properties of dimensions within the specified range. */ |
6383 * Updates properties of dimensions within the specified range. | |
6384 * It is an error to specify read only fields in the field mask. | |
6385 */ | |
6386 class UpdateDimensionPropertiesRequest { | 6394 class UpdateDimensionPropertiesRequest { |
6387 /** | 6395 /** |
6388 * The fields that should be updated. At least one field must be specified. | 6396 * The fields that should be updated. At least one field must be specified. |
6389 * The root `properties` is implied and should not be specified. | 6397 * The root `properties` is implied and should not be specified. |
6390 * A single `"*"` can be used as short-hand for listing every field. | 6398 * A single `"*"` can be used as short-hand for listing every field. |
6391 */ | 6399 */ |
6392 core.String fields; | 6400 core.String fields; |
6393 /** Properties to update. */ | 6401 /** Properties to update. */ |
6394 DimensionProperties properties; | 6402 DimensionProperties properties; |
6395 /** The rows or columns to update. */ | 6403 /** The rows or columns to update. */ |
(...skipping 27 matching lines...) Expand all Loading... |
6423 return _json; | 6431 return _json; |
6424 } | 6432 } |
6425 } | 6433 } |
6426 | 6434 |
6427 /** | 6435 /** |
6428 * Update an embedded object's position (such as a moving or resizing a | 6436 * Update an embedded object's position (such as a moving or resizing a |
6429 * chart or image). | 6437 * chart or image). |
6430 */ | 6438 */ |
6431 class UpdateEmbeddedObjectPositionRequest { | 6439 class UpdateEmbeddedObjectPositionRequest { |
6432 /** | 6440 /** |
6433 * The fields of OverlayPosition that should be updated when | 6441 * The fields of OverlayPosition |
6434 * setting a new position. Used only if | 6442 * that should be updated when setting a new position. Used only if |
6435 * newPosition.overlayPosition | 6443 * newPosition.overlayPosition |
6436 * is set, in which case at least one field must | 6444 * is set, in which case at least one field must |
6437 * be specified. The root `newPosition.overlayPosition` is implied and | 6445 * be specified. The root `newPosition.overlayPosition` is implied and |
6438 * should not be specified. | 6446 * should not be specified. |
6439 * A single `"*"` can be used as short-hand for listing every field. | 6447 * A single `"*"` can be used as short-hand for listing every field. |
6440 */ | 6448 */ |
6441 core.String fields; | 6449 core.String fields; |
6442 /** | 6450 /** |
6443 * An explicit position to move the embedded object to. | 6451 * An explicit position to move the embedded object to. |
6444 * If newPosition.sheetId is set, | 6452 * If newPosition.sheetId is set, |
6445 * a new sheet with that ID will be created. | 6453 * a new sheet with that ID will be created. |
6446 * If newPosition.newSheet is set to true, | 6454 * If newPosition.newSheet is set to true, |
6447 * a new sheet will be created with an ID that will be chosen for you. | 6455 * a new sheet will be created with an ID that will be chosen for you. |
6448 */ | 6456 */ |
6449 EmbeddedObjectPosition newPosition; | 6457 EmbeddedObjectPosition newPosition; |
6450 /** The id of the object to moved. */ | 6458 /** The ID of the object to moved. */ |
6451 core.int objectId; | 6459 core.int objectId; |
6452 | 6460 |
6453 UpdateEmbeddedObjectPositionRequest(); | 6461 UpdateEmbeddedObjectPositionRequest(); |
6454 | 6462 |
6455 UpdateEmbeddedObjectPositionRequest.fromJson(core.Map _json) { | 6463 UpdateEmbeddedObjectPositionRequest.fromJson(core.Map _json) { |
6456 if (_json.containsKey("fields")) { | 6464 if (_json.containsKey("fields")) { |
6457 fields = _json["fields"]; | 6465 fields = _json["fields"]; |
6458 } | 6466 } |
6459 if (_json.containsKey("newPosition")) { | 6467 if (_json.containsKey("newPosition")) { |
6460 newPosition = new EmbeddedObjectPosition.fromJson(_json["newPosition"]); | 6468 newPosition = new EmbeddedObjectPosition.fromJson(_json["newPosition"]); |
(...skipping 70 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
6531 if (filter != null) { | 6539 if (filter != null) { |
6532 _json["filter"] = (filter).toJson(); | 6540 _json["filter"] = (filter).toJson(); |
6533 } | 6541 } |
6534 return _json; | 6542 return _json; |
6535 } | 6543 } |
6536 } | 6544 } |
6537 | 6545 |
6538 /** | 6546 /** |
6539 * Updates properties of the named range with the specified | 6547 * Updates properties of the named range with the specified |
6540 * namedRangeId. | 6548 * namedRangeId. |
6541 * It is an error to specify read only fields in the field mask. | |
6542 */ | 6549 */ |
6543 class UpdateNamedRangeRequest { | 6550 class UpdateNamedRangeRequest { |
6544 /** | 6551 /** |
6545 * The fields that should be updated. At least one field must be specified. | 6552 * The fields that should be updated. At least one field must be specified. |
6546 * The root `namedRange` is implied and should not be specified. | 6553 * The root `namedRange` is implied and should not be specified. |
6547 * A single `"*"` can be used as short-hand for listing every field. | 6554 * A single `"*"` can be used as short-hand for listing every field. |
6548 */ | 6555 */ |
6549 core.String fields; | 6556 core.String fields; |
6550 /** The named range to update with the new properties. */ | 6557 /** The named range to update with the new properties. */ |
6551 NamedRange namedRange; | 6558 NamedRange namedRange; |
(...skipping 59 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
6611 if (protectedRange != null) { | 6618 if (protectedRange != null) { |
6612 _json["protectedRange"] = (protectedRange).toJson(); | 6619 _json["protectedRange"] = (protectedRange).toJson(); |
6613 } | 6620 } |
6614 return _json; | 6621 return _json; |
6615 } | 6622 } |
6616 } | 6623 } |
6617 | 6624 |
6618 /** | 6625 /** |
6619 * Updates properties of the sheet with the specified | 6626 * Updates properties of the sheet with the specified |
6620 * sheetId. | 6627 * sheetId. |
6621 * It is an error to specify read only fields in the field mask. | |
6622 */ | 6628 */ |
6623 class UpdateSheetPropertiesRequest { | 6629 class UpdateSheetPropertiesRequest { |
6624 /** | 6630 /** |
6625 * The fields that should be updated. At least one field must be specified. | 6631 * The fields that should be updated. At least one field must be specified. |
6626 * The root `properties` is implied and should not be specified. | 6632 * The root `properties` is implied and should not be specified. |
6627 * A single `"*"` can be used as short-hand for listing every field. | 6633 * A single `"*"` can be used as short-hand for listing every field. |
6628 */ | 6634 */ |
6629 core.String fields; | 6635 core.String fields; |
6630 /** The properties to update. */ | 6636 /** The properties to update. */ |
6631 SheetProperties properties; | 6637 SheetProperties properties; |
(...skipping 14 matching lines...) Expand all Loading... |
6646 if (fields != null) { | 6652 if (fields != null) { |
6647 _json["fields"] = fields; | 6653 _json["fields"] = fields; |
6648 } | 6654 } |
6649 if (properties != null) { | 6655 if (properties != null) { |
6650 _json["properties"] = (properties).toJson(); | 6656 _json["properties"] = (properties).toJson(); |
6651 } | 6657 } |
6652 return _json; | 6658 return _json; |
6653 } | 6659 } |
6654 } | 6660 } |
6655 | 6661 |
6656 /** | 6662 /** Updates properties of a spreadsheet. */ |
6657 * Updates properties of a spreadsheet. | |
6658 * It is an error to specify read only fields in the field mask. | |
6659 */ | |
6660 class UpdateSpreadsheetPropertiesRequest { | 6663 class UpdateSpreadsheetPropertiesRequest { |
6661 /** | 6664 /** |
6662 * The fields that should be updated. At least one field must be specified. | 6665 * The fields that should be updated. At least one field must be specified. |
6663 * The root 'properties' is implied and should not be specified. | 6666 * The root 'properties' is implied and should not be specified. |
6664 * A single `"*"` can be used as short-hand for listing every field. | 6667 * A single `"*"` can be used as short-hand for listing every field. |
6665 */ | 6668 */ |
6666 core.String fields; | 6669 core.String fields; |
6667 /** The properties to update. */ | 6670 /** The properties to update. */ |
6668 SpreadsheetProperties properties; | 6671 SpreadsheetProperties properties; |
6669 | 6672 |
(...skipping 74 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
6744 } | 6747 } |
6745 return _json; | 6748 return _json; |
6746 } | 6749 } |
6747 } | 6750 } |
6748 | 6751 |
6749 /** Data within a range of the spreadsheet. */ | 6752 /** Data within a range of the spreadsheet. */ |
6750 class ValueRange { | 6753 class ValueRange { |
6751 /** | 6754 /** |
6752 * The major dimension of the values. | 6755 * The major dimension of the values. |
6753 * | 6756 * |
6754 * For output, if the spreadsheet data is: A1=1,B1=2,A2=3,B2=4, | 6757 * For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, |
6755 * then requesting range=A1:B2,majorDimension=ROWS will return [[1,2],[3,4]], | 6758 * then requesting `range=A1:B2,majorDimension=ROWS` will return |
6756 * whereas requesting range=A1:B2,majorDimension=COLUMNS will return | 6759 * `[[1,2],[3,4]]`, |
6757 * [[1,3],[2,4]]. | 6760 * whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return |
| 6761 * `[[1,3],[2,4]]`. |
6758 * | 6762 * |
6759 * For input, with range=A1:B2,majorDimension=ROWS then [[1,2],[3,4]] | 6763 * For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` |
6760 * will set A1=1,B1=2,A2=3,B2=4. With range=A1:B2,majorDimension=COLUMNS | 6764 * will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` |
6761 * then [[1,2],[3,4]] will set A1=1,B1=3,A2=2,B2=4. | 6765 * then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. |
6762 * | 6766 * |
6763 * When writing, if this field is not set, it defaults to ROWS. | 6767 * When writing, if this field is not set, it defaults to ROWS. |
6764 * Possible string values are: | 6768 * Possible string values are: |
6765 * - "DIMENSION_UNSPECIFIED" : The default value, do not use. | 6769 * - "DIMENSION_UNSPECIFIED" : The default value, do not use. |
6766 * - "ROWS" : Operates on the rows of a sheet. | 6770 * - "ROWS" : Operates on the rows of a sheet. |
6767 * - "COLUMNS" : Operates on the columns of a sheet. | 6771 * - "COLUMNS" : Operates on the columns of a sheet. |
6768 */ | 6772 */ |
6769 core.String majorDimension; | 6773 core.String majorDimension; |
6770 /** | 6774 /** |
6771 * The range the values cover, in A1 notation. | 6775 * The range the values cover, in A1 notation. |
6772 * For output, this range indicates the entire requested range, | 6776 * For output, this range indicates the entire requested range, |
6773 * even though the values will exclude trailing rows and columns. | 6777 * even though the values will exclude trailing rows and columns. |
6774 */ | 6778 */ |
6775 core.String range; | 6779 core.String range; |
6776 /** | 6780 /** |
6777 * The data that was read or to be written. This is an array of arrays, | 6781 * The data that was read or to be written. This is an array of arrays, |
6778 * the outer array representing all the data and each inner array | 6782 * the outer array representing all the data and each inner array |
6779 * representing a major dimension. Each item in the inner array | 6783 * representing a major dimension. Each item in the inner array |
6780 * corresponds with one cell. | 6784 * corresponds with one cell. |
6781 * | 6785 * |
6782 * For output, empty trailing rows and columns will not be included. | 6786 * For output, empty trailing rows and columns will not be included. |
6783 * | 6787 * |
6784 * For input, supported value types are: bool, string, and double. | 6788 * For input, supported value types are: bool, string, and double. |
6785 * Null and empty values will be skipped. | 6789 * Null values will be skipped. |
6786 * To set a cell to an empty value, set the string value to an empty string. | 6790 * To set a cell to an empty value, set the string value to an empty string. |
6787 * | 6791 * |
6788 * The values for Object must be JSON objects. It can consist of `num`, | 6792 * The values for Object must be JSON objects. It can consist of `num`, |
6789 * `String`, `bool` and `null` as well as `Map` and `List` values. | 6793 * `String`, `bool` and `null` as well as `Map` and `List` values. |
6790 */ | 6794 */ |
6791 core.List<core.List<core.Object>> values; | 6795 core.List<core.List<core.Object>> values; |
6792 | 6796 |
6793 ValueRange(); | 6797 ValueRange(); |
6794 | 6798 |
6795 ValueRange.fromJson(core.Map _json) { | 6799 ValueRange.fromJson(core.Map _json) { |
(...skipping 15 matching lines...) Expand all Loading... |
6811 } | 6815 } |
6812 if (range != null) { | 6816 if (range != null) { |
6813 _json["range"] = range; | 6817 _json["range"] = range; |
6814 } | 6818 } |
6815 if (values != null) { | 6819 if (values != null) { |
6816 _json["values"] = values; | 6820 _json["values"] = values; |
6817 } | 6821 } |
6818 return _json; | 6822 return _json; |
6819 } | 6823 } |
6820 } | 6824 } |
OLD | NEW |