| Index: generated/googleapis/lib/sheets/v4.dart
|
| diff --git a/generated/googleapis/lib/sheets/v4.dart b/generated/googleapis/lib/sheets/v4.dart
|
| index d3aca568cb55d98f9b448bfb6a9f33b7f866569e..48177d3658d5c5c51b878688c87c237c666b02e6 100644
|
| --- a/generated/googleapis/lib/sheets/v4.dart
|
| +++ b/generated/googleapis/lib/sheets/v4.dart
|
| @@ -9,86 +9,90 @@ import 'dart:convert' as convert;
|
| import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
|
| import 'package:http/http.dart' as http;
|
|
|
| -export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' show
|
| - ApiRequestError, DetailedApiRequestError;
|
| +export 'package:_discoveryapis_commons/_discoveryapis_commons.dart'
|
| + show ApiRequestError, DetailedApiRequestError;
|
|
|
| const core.String USER_AGENT = 'dart-api-client sheets/v4';
|
|
|
| -/** Reads and writes Google Sheets. */
|
| +/// Reads and writes Google Sheets.
|
| class SheetsApi {
|
| - /** View and manage the files in your Google Drive */
|
| + /// View and manage the files in your Google Drive
|
| static const DriveScope = "https://www.googleapis.com/auth/drive";
|
|
|
| - /**
|
| - * View and manage Google Drive files and folders that you have opened or
|
| - * created with this app
|
| - */
|
| + /// View and manage Google Drive files and folders that you have opened or
|
| + /// created with this app
|
| static const DriveFileScope = "https://www.googleapis.com/auth/drive.file";
|
|
|
| - /** View the files in your Google Drive */
|
| - static const DriveReadonlyScope = "https://www.googleapis.com/auth/drive.readonly";
|
| + /// View the files in your Google Drive
|
| + static const DriveReadonlyScope =
|
| + "https://www.googleapis.com/auth/drive.readonly";
|
|
|
| - /** View and manage your spreadsheets in Google Drive */
|
| - static const SpreadsheetsScope = "https://www.googleapis.com/auth/spreadsheets";
|
| -
|
| - /** View your Google Spreadsheets */
|
| - static const SpreadsheetsReadonlyScope = "https://www.googleapis.com/auth/spreadsheets.readonly";
|
| + /// View and manage your spreadsheets in Google Drive
|
| + static const SpreadsheetsScope =
|
| + "https://www.googleapis.com/auth/spreadsheets";
|
|
|
| + /// View your Google Spreadsheets
|
| + static const SpreadsheetsReadonlyScope =
|
| + "https://www.googleapis.com/auth/spreadsheets.readonly";
|
|
|
| final commons.ApiRequester _requester;
|
|
|
| - SpreadsheetsResourceApi get spreadsheets => new SpreadsheetsResourceApi(_requester);
|
| + SpreadsheetsResourceApi get spreadsheets =>
|
| + new SpreadsheetsResourceApi(_requester);
|
|
|
| - SheetsApi(http.Client client, {core.String rootUrl: "https://sheets.googleapis.com/", core.String servicePath: ""}) :
|
| - _requester = new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
|
| + SheetsApi(http.Client client,
|
| + {core.String rootUrl: "https://sheets.googleapis.com/",
|
| + core.String servicePath: ""})
|
| + : _requester =
|
| + new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
|
| }
|
|
|
| -
|
| class SpreadsheetsResourceApi {
|
| final commons.ApiRequester _requester;
|
|
|
| - SpreadsheetsSheetsResourceApi get sheets => new SpreadsheetsSheetsResourceApi(_requester);
|
| - SpreadsheetsValuesResourceApi get values => new SpreadsheetsValuesResourceApi(_requester);
|
| -
|
| - SpreadsheetsResourceApi(commons.ApiRequester client) :
|
| - _requester = client;
|
| -
|
| - /**
|
| - * Applies one or more updates to the spreadsheet.
|
| - *
|
| - * Each request is validated before
|
| - * being applied. If any request is not valid then the entire request will
|
| - * fail and nothing will be applied.
|
| - *
|
| - * Some requests have replies to
|
| - * give you some information about how
|
| - * they are applied. The replies will mirror the requests. For example,
|
| - * if you applied 4 updates and the 3rd one had a reply, then the
|
| - * response will have 2 empty replies, the actual reply, and another empty
|
| - * reply, in that order.
|
| - *
|
| - * Due to the collaborative nature of spreadsheets, it is not guaranteed that
|
| - * the spreadsheet will reflect exactly your changes after this completes,
|
| - * however it is guaranteed that the updates in the request will be
|
| - * applied together atomically. Your changes may be altered with respect to
|
| - * collaborator changes. If there are no collaborators, the spreadsheet
|
| - * should reflect your changes.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [spreadsheetId] - The spreadsheet to apply the updates to.
|
| - *
|
| - * Completes with a [BatchUpdateSpreadsheetResponse].
|
| - *
|
| - * Completes with a [commons.ApiRequestError] if the API endpoint returned an
|
| - * error.
|
| - *
|
| - * If the used [http.Client] completes with an error when making a REST call,
|
| - * this method will complete with the same error.
|
| - */
|
| - async.Future<BatchUpdateSpreadsheetResponse> batchUpdate(BatchUpdateSpreadsheetRequest request, core.String spreadsheetId) {
|
| + SpreadsheetsSheetsResourceApi get sheets =>
|
| + new SpreadsheetsSheetsResourceApi(_requester);
|
| + SpreadsheetsValuesResourceApi get values =>
|
| + new SpreadsheetsValuesResourceApi(_requester);
|
| +
|
| + SpreadsheetsResourceApi(commons.ApiRequester client) : _requester = client;
|
| +
|
| + /// Applies one or more updates to the spreadsheet.
|
| + ///
|
| + /// Each request is validated before
|
| + /// being applied. If any request is not valid then the entire request will
|
| + /// fail and nothing will be applied.
|
| + ///
|
| + /// Some requests have replies to
|
| + /// give you some information about how
|
| + /// they are applied. The replies will mirror the requests. For example,
|
| + /// if you applied 4 updates and the 3rd one had a reply, then the
|
| + /// response will have 2 empty replies, the actual reply, and another empty
|
| + /// reply, in that order.
|
| + ///
|
| + /// Due to the collaborative nature of spreadsheets, it is not guaranteed
|
| + /// that
|
| + /// the spreadsheet will reflect exactly your changes after this completes,
|
| + /// however it is guaranteed that the updates in the request will be
|
| + /// applied together atomically. Your changes may be altered with respect to
|
| + /// collaborator changes. If there are no collaborators, the spreadsheet
|
| + /// should reflect your changes.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [spreadsheetId] - The spreadsheet to apply the updates to.
|
| + ///
|
| + /// Completes with a [BatchUpdateSpreadsheetResponse].
|
| + ///
|
| + /// Completes with a [commons.ApiRequestError] if the API endpoint returned
|
| + /// an error.
|
| + ///
|
| + /// If the used [http.Client] completes with an error when making a REST
|
| + /// call, this method will complete with the same error.
|
| + async.Future<BatchUpdateSpreadsheetResponse> batchUpdate(
|
| + BatchUpdateSpreadsheetRequest request, core.String spreadsheetId) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -103,33 +107,33 @@ class SpreadsheetsResourceApi {
|
| throw new core.ArgumentError("Parameter spreadsheetId is required.");
|
| }
|
|
|
| - _url = 'v4/spreadsheets/' + commons.Escaper.ecapeVariable('$spreadsheetId') + ':batchUpdate';
|
| -
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| - return _response.then((data) => new BatchUpdateSpreadsheetResponse.fromJson(data));
|
| - }
|
| -
|
| - /**
|
| - * Creates a spreadsheet, returning the newly created spreadsheet.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * Completes with a [Spreadsheet].
|
| - *
|
| - * Completes with a [commons.ApiRequestError] if the API endpoint returned an
|
| - * error.
|
| - *
|
| - * If the used [http.Client] completes with an error when making a REST call,
|
| - * this method will complete with the same error.
|
| - */
|
| + _url = 'v4/spreadsheets/' +
|
| + commons.Escaper.ecapeVariable('$spreadsheetId') +
|
| + ':batchUpdate';
|
| +
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response
|
| + .then((data) => new BatchUpdateSpreadsheetResponse.fromJson(data));
|
| + }
|
| +
|
| + /// Creates a spreadsheet, returning the newly created spreadsheet.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// Completes with a [Spreadsheet].
|
| + ///
|
| + /// Completes with a [commons.ApiRequestError] if the API endpoint returned
|
| + /// an error.
|
| + ///
|
| + /// If the used [http.Client] completes with an error when making a REST
|
| + /// call, this method will complete with the same error.
|
| async.Future<Spreadsheet> create(Spreadsheet request) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| @@ -144,57 +148,55 @@ class SpreadsheetsResourceApi {
|
|
|
| _url = 'v4/spreadsheets';
|
|
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Spreadsheet.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Returns the spreadsheet at the given ID.
|
| - * The caller must specify the spreadsheet ID.
|
| - *
|
| - * By default, data within grids will not be returned.
|
| - * You can include grid data one of two ways:
|
| - *
|
| - * * Specify a field mask listing your desired fields using the `fields` URL
|
| - * parameter in HTTP
|
| - *
|
| - * * Set the includeGridData
|
| - * URL parameter to true. If a field mask is set, the `includeGridData`
|
| - * parameter is ignored
|
| - *
|
| - * For large spreadsheets, it is recommended to retrieve only the specific
|
| - * fields of the spreadsheet that you want.
|
| - *
|
| - * To retrieve only subsets of the spreadsheet, use the
|
| - * ranges URL parameter.
|
| - * Multiple ranges can be specified. Limiting the range will
|
| - * return only the portions of the spreadsheet that intersect the requested
|
| - * ranges. Ranges are specified using A1 notation.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [spreadsheetId] - The spreadsheet to request.
|
| - *
|
| - * [includeGridData] - True if grid data should be returned.
|
| - * This parameter is ignored if a field mask was set in the request.
|
| - *
|
| - * [ranges] - The ranges to retrieve from the spreadsheet.
|
| - *
|
| - * Completes with a [Spreadsheet].
|
| - *
|
| - * Completes with a [commons.ApiRequestError] if the API endpoint returned an
|
| - * error.
|
| - *
|
| - * If the used [http.Client] completes with an error when making a REST call,
|
| - * this method will complete with the same error.
|
| - */
|
| - async.Future<Spreadsheet> get(core.String spreadsheetId, {core.bool includeGridData, core.List<core.String> ranges}) {
|
| + /// Returns the spreadsheet at the given ID.
|
| + /// The caller must specify the spreadsheet ID.
|
| + ///
|
| + /// By default, data within grids will not be returned.
|
| + /// You can include grid data one of two ways:
|
| + ///
|
| + /// * Specify a field mask listing your desired fields using the `fields` URL
|
| + /// parameter in HTTP
|
| + ///
|
| + /// * Set the includeGridData
|
| + /// URL parameter to true. If a field mask is set, the `includeGridData`
|
| + /// parameter is ignored
|
| + ///
|
| + /// For large spreadsheets, it is recommended to retrieve only the specific
|
| + /// fields of the spreadsheet that you want.
|
| + ///
|
| + /// To retrieve only subsets of the spreadsheet, use the
|
| + /// ranges URL parameter.
|
| + /// Multiple ranges can be specified. Limiting the range will
|
| + /// return only the portions of the spreadsheet that intersect the requested
|
| + /// ranges. Ranges are specified using A1 notation.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [spreadsheetId] - The spreadsheet to request.
|
| + ///
|
| + /// [includeGridData] - True if grid data should be returned.
|
| + /// This parameter is ignored if a field mask was set in the request.
|
| + ///
|
| + /// [ranges] - The ranges to retrieve from the spreadsheet.
|
| + ///
|
| + /// Completes with a [Spreadsheet].
|
| + ///
|
| + /// Completes with a [commons.ApiRequestError] if the API endpoint returned
|
| + /// an error.
|
| + ///
|
| + /// If the used [http.Client] completes with an error when making a REST
|
| + /// call, this method will complete with the same error.
|
| + async.Future<Spreadsheet> get(core.String spreadsheetId,
|
| + {core.bool includeGridData, core.List<core.String> ranges}) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -214,46 +216,44 @@ class SpreadsheetsResourceApi {
|
|
|
| _url = 'v4/spreadsheets/' + commons.Escaper.ecapeVariable('$spreadsheetId');
|
|
|
| - var _response = _requester.request(_url,
|
| - "GET",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Spreadsheet.fromJson(data));
|
| }
|
| -
|
| }
|
|
|
| -
|
| class SpreadsheetsSheetsResourceApi {
|
| final commons.ApiRequester _requester;
|
|
|
| - SpreadsheetsSheetsResourceApi(commons.ApiRequester client) :
|
| - _requester = client;
|
| -
|
| - /**
|
| - * Copies a single sheet from a spreadsheet to another spreadsheet.
|
| - * Returns the properties of the newly created sheet.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [spreadsheetId] - The ID of the spreadsheet containing the sheet to copy.
|
| - *
|
| - * [sheetId] - The ID of the sheet to copy.
|
| - *
|
| - * Completes with a [SheetProperties].
|
| - *
|
| - * Completes with a [commons.ApiRequestError] if the API endpoint returned an
|
| - * error.
|
| - *
|
| - * If the used [http.Client] completes with an error when making a REST call,
|
| - * this method will complete with the same error.
|
| - */
|
| - async.Future<SheetProperties> copyTo(CopySheetToAnotherSpreadsheetRequest request, core.String spreadsheetId, core.int sheetId) {
|
| + SpreadsheetsSheetsResourceApi(commons.ApiRequester client)
|
| + : _requester = client;
|
| +
|
| + /// Copies a single sheet from a spreadsheet to another spreadsheet.
|
| + /// Returns the properties of the newly created sheet.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [spreadsheetId] - The ID of the spreadsheet containing the sheet to copy.
|
| + ///
|
| + /// [sheetId] - The ID of the sheet to copy.
|
| + ///
|
| + /// Completes with a [SheetProperties].
|
| + ///
|
| + /// Completes with a [commons.ApiRequestError] if the API endpoint returned
|
| + /// an error.
|
| + ///
|
| + /// If the used [http.Client] completes with an error when making a REST
|
| + /// call, this method will complete with the same error.
|
| + async.Future<SheetProperties> copyTo(
|
| + CopySheetToAnotherSpreadsheetRequest request,
|
| + core.String spreadsheetId,
|
| + core.int sheetId) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -271,94 +271,101 @@ class SpreadsheetsSheetsResourceApi {
|
| throw new core.ArgumentError("Parameter sheetId is required.");
|
| }
|
|
|
| - _url = 'v4/spreadsheets/' + commons.Escaper.ecapeVariable('$spreadsheetId') + '/sheets/' + commons.Escaper.ecapeVariable('$sheetId') + ':copyTo';
|
| + _url = 'v4/spreadsheets/' +
|
| + commons.Escaper.ecapeVariable('$spreadsheetId') +
|
| + '/sheets/' +
|
| + commons.Escaper.ecapeVariable('$sheetId') +
|
| + ':copyTo';
|
|
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new SheetProperties.fromJson(data));
|
| }
|
| -
|
| }
|
|
|
| -
|
| class SpreadsheetsValuesResourceApi {
|
| final commons.ApiRequester _requester;
|
|
|
| - SpreadsheetsValuesResourceApi(commons.ApiRequester client) :
|
| - _requester = client;
|
| -
|
| - /**
|
| - * Appends values to a spreadsheet. The input range is used to search for
|
| - * existing data and find a "table" within that range. Values will be
|
| - * appended to the next row of the table, starting with the first column of
|
| - * the table. See the
|
| - * [guide](/sheets/api/guides/values#appending_values)
|
| - * and
|
| - * [sample code](/sheets/api/samples/writing#append_values)
|
| - * for specific details of how tables are detected and data is appended.
|
| - *
|
| - * The caller must specify the spreadsheet ID, range, and
|
| - * a valueInputOption. The `valueInputOption` only
|
| - * controls how the input data will be added to the sheet (column-wise or
|
| - * row-wise), it does not influence what cell the data starts being written
|
| - * to.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [spreadsheetId] - The ID of the spreadsheet to update.
|
| - *
|
| - * [range] - The A1 notation of a range to search for a logical table of data.
|
| - * Values will be appended after the last row of the table.
|
| - *
|
| - * [includeValuesInResponse] - Determines if the update response should
|
| - * include the values
|
| - * of the cells that were appended. By default, responses
|
| - * do not include the updated values.
|
| - *
|
| - * [responseValueRenderOption] - Determines how values in the response should
|
| - * be rendered.
|
| - * The default render option is ValueRenderOption.FORMATTED_VALUE.
|
| - * Possible string values are:
|
| - * - "FORMATTED_VALUE" : A FORMATTED_VALUE.
|
| - * - "UNFORMATTED_VALUE" : A UNFORMATTED_VALUE.
|
| - * - "FORMULA" : A FORMULA.
|
| - *
|
| - * [insertDataOption] - How the input data should be inserted.
|
| - * Possible string values are:
|
| - * - "OVERWRITE" : A OVERWRITE.
|
| - * - "INSERT_ROWS" : A INSERT_ROWS.
|
| - *
|
| - * [valueInputOption] - How the input data should be interpreted.
|
| - * Possible string values are:
|
| - * - "INPUT_VALUE_OPTION_UNSPECIFIED" : A INPUT_VALUE_OPTION_UNSPECIFIED.
|
| - * - "RAW" : A RAW.
|
| - * - "USER_ENTERED" : A USER_ENTERED.
|
| - *
|
| - * [responseDateTimeRenderOption] - Determines how dates, times, and durations
|
| - * in the response should be
|
| - * rendered. This is ignored if response_value_render_option is
|
| - * FORMATTED_VALUE.
|
| - * The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
|
| - * Possible string values are:
|
| - * - "SERIAL_NUMBER" : A SERIAL_NUMBER.
|
| - * - "FORMATTED_STRING" : A FORMATTED_STRING.
|
| - *
|
| - * Completes with a [AppendValuesResponse].
|
| - *
|
| - * Completes with a [commons.ApiRequestError] if the API endpoint returned an
|
| - * error.
|
| - *
|
| - * If the used [http.Client] completes with an error when making a REST call,
|
| - * this method will complete with the same error.
|
| - */
|
| - async.Future<AppendValuesResponse> append(ValueRange request, core.String spreadsheetId, core.String range, {core.bool includeValuesInResponse, core.String responseValueRenderOption, core.String insertDataOption, core.String valueInputOption, core.String responseDateTimeRenderOption}) {
|
| + SpreadsheetsValuesResourceApi(commons.ApiRequester client)
|
| + : _requester = client;
|
| +
|
| + /// Appends values to a spreadsheet. The input range is used to search for
|
| + /// existing data and find a "table" within that range. Values will be
|
| + /// appended to the next row of the table, starting with the first column of
|
| + /// the table. See the
|
| + /// [guide](/sheets/api/guides/values#appending_values)
|
| + /// and
|
| + /// [sample code](/sheets/api/samples/writing#append_values)
|
| + /// for specific details of how tables are detected and data is appended.
|
| + ///
|
| + /// The caller must specify the spreadsheet ID, range, and
|
| + /// a valueInputOption. The `valueInputOption` only
|
| + /// controls how the input data will be added to the sheet (column-wise or
|
| + /// row-wise), it does not influence what cell the data starts being written
|
| + /// to.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [spreadsheetId] - The ID of the spreadsheet to update.
|
| + ///
|
| + /// [range] - The A1 notation of a range to search for a logical table of
|
| + /// data.
|
| + /// Values will be appended after the last row of the table.
|
| + ///
|
| + /// [includeValuesInResponse] - Determines if the update response should
|
| + /// include the values
|
| + /// of the cells that were appended. By default, responses
|
| + /// do not include the updated values.
|
| + ///
|
| + /// [responseValueRenderOption] - Determines how values in the response
|
| + /// should be rendered.
|
| + /// The default render option is ValueRenderOption.FORMATTED_VALUE.
|
| + /// Possible string values are:
|
| + /// - "FORMATTED_VALUE" : A FORMATTED_VALUE.
|
| + /// - "UNFORMATTED_VALUE" : A UNFORMATTED_VALUE.
|
| + /// - "FORMULA" : A FORMULA.
|
| + ///
|
| + /// [insertDataOption] - How the input data should be inserted.
|
| + /// Possible string values are:
|
| + /// - "OVERWRITE" : A OVERWRITE.
|
| + /// - "INSERT_ROWS" : A INSERT_ROWS.
|
| + ///
|
| + /// [valueInputOption] - How the input data should be interpreted.
|
| + /// Possible string values are:
|
| + /// - "INPUT_VALUE_OPTION_UNSPECIFIED" : A INPUT_VALUE_OPTION_UNSPECIFIED.
|
| + /// - "RAW" : A RAW.
|
| + /// - "USER_ENTERED" : A USER_ENTERED.
|
| + ///
|
| + /// [responseDateTimeRenderOption] - Determines how dates, times, and
|
| + /// durations in the response should be
|
| + /// rendered. This is ignored if response_value_render_option is
|
| + /// FORMATTED_VALUE.
|
| + /// The default dateTime render option is
|
| + /// [DateTimeRenderOption.SERIAL_NUMBER].
|
| + /// Possible string values are:
|
| + /// - "SERIAL_NUMBER" : A SERIAL_NUMBER.
|
| + /// - "FORMATTED_STRING" : A FORMATTED_STRING.
|
| + ///
|
| + /// Completes with a [AppendValuesResponse].
|
| + ///
|
| + /// Completes with a [commons.ApiRequestError] if the API endpoint returned
|
| + /// an error.
|
| + ///
|
| + /// If the used [http.Client] completes with an error when making a REST
|
| + /// call, this method will complete with the same error.
|
| + async.Future<AppendValuesResponse> append(
|
| + ValueRange request, core.String spreadsheetId, core.String range,
|
| + {core.bool includeValuesInResponse,
|
| + core.String responseValueRenderOption,
|
| + core.String insertDataOption,
|
| + core.String valueInputOption,
|
| + core.String responseDateTimeRenderOption}) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -388,42 +395,46 @@ class SpreadsheetsValuesResourceApi {
|
| _queryParams["valueInputOption"] = [valueInputOption];
|
| }
|
| if (responseDateTimeRenderOption != null) {
|
| - _queryParams["responseDateTimeRenderOption"] = [responseDateTimeRenderOption];
|
| - }
|
| -
|
| - _url = 'v4/spreadsheets/' + commons.Escaper.ecapeVariable('$spreadsheetId') + '/values/' + commons.Escaper.ecapeVariable('$range') + ':append';
|
| -
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + _queryParams["responseDateTimeRenderOption"] = [
|
| + responseDateTimeRenderOption
|
| + ];
|
| + }
|
| +
|
| + _url = 'v4/spreadsheets/' +
|
| + commons.Escaper.ecapeVariable('$spreadsheetId') +
|
| + '/values/' +
|
| + commons.Escaper.ecapeVariable('$range') +
|
| + ':append';
|
| +
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new AppendValuesResponse.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Clears one or more ranges of values from a spreadsheet.
|
| - * The caller must specify the spreadsheet ID and one or more ranges.
|
| - * Only values are cleared -- all other properties of the cell (such as
|
| - * formatting, data validation, etc..) are kept.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [spreadsheetId] - The ID of the spreadsheet to update.
|
| - *
|
| - * Completes with a [BatchClearValuesResponse].
|
| - *
|
| - * Completes with a [commons.ApiRequestError] if the API endpoint returned an
|
| - * error.
|
| - *
|
| - * If the used [http.Client] completes with an error when making a REST call,
|
| - * this method will complete with the same error.
|
| - */
|
| - async.Future<BatchClearValuesResponse> batchClear(BatchClearValuesRequest request, core.String spreadsheetId) {
|
| + /// Clears one or more ranges of values from a spreadsheet.
|
| + /// The caller must specify the spreadsheet ID and one or more ranges.
|
| + /// Only values are cleared -- all other properties of the cell (such as
|
| + /// formatting, data validation, etc..) are kept.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [spreadsheetId] - The ID of the spreadsheet to update.
|
| + ///
|
| + /// Completes with a [BatchClearValuesResponse].
|
| + ///
|
| + /// Completes with a [commons.ApiRequestError] if the API endpoint returned
|
| + /// an error.
|
| + ///
|
| + /// If the used [http.Client] completes with an error when making a REST
|
| + /// call, this method will complete with the same error.
|
| + async.Future<BatchClearValuesResponse> batchClear(
|
| + BatchClearValuesRequest request, core.String spreadsheetId) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -438,65 +449,70 @@ class SpreadsheetsValuesResourceApi {
|
| throw new core.ArgumentError("Parameter spreadsheetId is required.");
|
| }
|
|
|
| - _url = 'v4/spreadsheets/' + commons.Escaper.ecapeVariable('$spreadsheetId') + '/values:batchClear';
|
| -
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| - return _response.then((data) => new BatchClearValuesResponse.fromJson(data));
|
| - }
|
| -
|
| - /**
|
| - * Returns one or more ranges of values from a spreadsheet.
|
| - * The caller must specify the spreadsheet ID and one or more ranges.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [spreadsheetId] - The ID of the spreadsheet to retrieve data from.
|
| - *
|
| - * [majorDimension] - The major dimension that results should use.
|
| - *
|
| - * For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
|
| - * then requesting `range=A1:B2,majorDimension=ROWS` will return
|
| - * `[[1,2],[3,4]]`,
|
| - * whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
|
| - * `[[1,3],[2,4]]`.
|
| - * Possible string values are:
|
| - * - "DIMENSION_UNSPECIFIED" : A DIMENSION_UNSPECIFIED.
|
| - * - "ROWS" : A ROWS.
|
| - * - "COLUMNS" : A COLUMNS.
|
| - *
|
| - * [ranges] - The A1 notation of the values to retrieve.
|
| - *
|
| - * [dateTimeRenderOption] - How dates, times, and durations should be
|
| - * represented in the output.
|
| - * This is ignored if value_render_option is
|
| - * FORMATTED_VALUE.
|
| - * The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
|
| - * Possible string values are:
|
| - * - "SERIAL_NUMBER" : A SERIAL_NUMBER.
|
| - * - "FORMATTED_STRING" : A FORMATTED_STRING.
|
| - *
|
| - * [valueRenderOption] - How values should be represented in the output.
|
| - * The default render option is ValueRenderOption.FORMATTED_VALUE.
|
| - * Possible string values are:
|
| - * - "FORMATTED_VALUE" : A FORMATTED_VALUE.
|
| - * - "UNFORMATTED_VALUE" : A UNFORMATTED_VALUE.
|
| - * - "FORMULA" : A FORMULA.
|
| - *
|
| - * Completes with a [BatchGetValuesResponse].
|
| - *
|
| - * Completes with a [commons.ApiRequestError] if the API endpoint returned an
|
| - * error.
|
| - *
|
| - * If the used [http.Client] completes with an error when making a REST call,
|
| - * this method will complete with the same error.
|
| - */
|
| - async.Future<BatchGetValuesResponse> batchGet(core.String spreadsheetId, {core.String majorDimension, core.List<core.String> ranges, core.String dateTimeRenderOption, core.String valueRenderOption}) {
|
| + _url = 'v4/spreadsheets/' +
|
| + commons.Escaper.ecapeVariable('$spreadsheetId') +
|
| + '/values:batchClear';
|
| +
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response
|
| + .then((data) => new BatchClearValuesResponse.fromJson(data));
|
| + }
|
| +
|
| + /// Returns one or more ranges of values from a spreadsheet.
|
| + /// The caller must specify the spreadsheet ID and one or more ranges.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [spreadsheetId] - The ID of the spreadsheet to retrieve data from.
|
| + ///
|
| + /// [majorDimension] - The major dimension that results should use.
|
| + ///
|
| + /// For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
|
| + /// then requesting `range=A1:B2,majorDimension=ROWS` will return
|
| + /// `[[1,2],[3,4]]`,
|
| + /// whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
|
| + /// `[[1,3],[2,4]]`.
|
| + /// Possible string values are:
|
| + /// - "DIMENSION_UNSPECIFIED" : A DIMENSION_UNSPECIFIED.
|
| + /// - "ROWS" : A ROWS.
|
| + /// - "COLUMNS" : A COLUMNS.
|
| + ///
|
| + /// [ranges] - The A1 notation of the values to retrieve.
|
| + ///
|
| + /// [dateTimeRenderOption] - How dates, times, and durations should be
|
| + /// represented in the output.
|
| + /// This is ignored if value_render_option is
|
| + /// FORMATTED_VALUE.
|
| + /// The default dateTime render option is
|
| + /// [DateTimeRenderOption.SERIAL_NUMBER].
|
| + /// Possible string values are:
|
| + /// - "SERIAL_NUMBER" : A SERIAL_NUMBER.
|
| + /// - "FORMATTED_STRING" : A FORMATTED_STRING.
|
| + ///
|
| + /// [valueRenderOption] - How values should be represented in the output.
|
| + /// The default render option is ValueRenderOption.FORMATTED_VALUE.
|
| + /// Possible string values are:
|
| + /// - "FORMATTED_VALUE" : A FORMATTED_VALUE.
|
| + /// - "UNFORMATTED_VALUE" : A UNFORMATTED_VALUE.
|
| + /// - "FORMULA" : A FORMULA.
|
| + ///
|
| + /// Completes with a [BatchGetValuesResponse].
|
| + ///
|
| + /// Completes with a [commons.ApiRequestError] if the API endpoint returned
|
| + /// an error.
|
| + ///
|
| + /// If the used [http.Client] completes with an error when making a REST
|
| + /// call, this method will complete with the same error.
|
| + async.Future<BatchGetValuesResponse> batchGet(core.String spreadsheetId,
|
| + {core.String majorDimension,
|
| + core.List<core.String> ranges,
|
| + core.String dateTimeRenderOption,
|
| + core.String valueRenderOption}) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -520,39 +536,39 @@ class SpreadsheetsValuesResourceApi {
|
| _queryParams["valueRenderOption"] = [valueRenderOption];
|
| }
|
|
|
| - _url = 'v4/spreadsheets/' + commons.Escaper.ecapeVariable('$spreadsheetId') + '/values:batchGet';
|
| + _url = 'v4/spreadsheets/' +
|
| + commons.Escaper.ecapeVariable('$spreadsheetId') +
|
| + '/values:batchGet';
|
|
|
| - var _response = _requester.request(_url,
|
| - "GET",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new BatchGetValuesResponse.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Sets values in one or more ranges of a spreadsheet.
|
| - * The caller must specify the spreadsheet ID,
|
| - * a valueInputOption, and one or more
|
| - * ValueRanges.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [spreadsheetId] - The ID of the spreadsheet to update.
|
| - *
|
| - * Completes with a [BatchUpdateValuesResponse].
|
| - *
|
| - * Completes with a [commons.ApiRequestError] if the API endpoint returned an
|
| - * error.
|
| - *
|
| - * If the used [http.Client] completes with an error when making a REST call,
|
| - * this method will complete with the same error.
|
| - */
|
| - async.Future<BatchUpdateValuesResponse> batchUpdate(BatchUpdateValuesRequest request, core.String spreadsheetId) {
|
| + /// Sets values in one or more ranges of a spreadsheet.
|
| + /// The caller must specify the spreadsheet ID,
|
| + /// a valueInputOption, and one or more
|
| + /// ValueRanges.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [spreadsheetId] - The ID of the spreadsheet to update.
|
| + ///
|
| + /// Completes with a [BatchUpdateValuesResponse].
|
| + ///
|
| + /// Completes with a [commons.ApiRequestError] if the API endpoint returned
|
| + /// an error.
|
| + ///
|
| + /// If the used [http.Client] completes with an error when making a REST
|
| + /// call, this method will complete with the same error.
|
| + async.Future<BatchUpdateValuesResponse> batchUpdate(
|
| + BatchUpdateValuesRequest request, core.String spreadsheetId) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -567,41 +583,42 @@ class SpreadsheetsValuesResourceApi {
|
| throw new core.ArgumentError("Parameter spreadsheetId is required.");
|
| }
|
|
|
| - _url = 'v4/spreadsheets/' + commons.Escaper.ecapeVariable('$spreadsheetId') + '/values:batchUpdate';
|
| -
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| - return _response.then((data) => new BatchUpdateValuesResponse.fromJson(data));
|
| - }
|
| -
|
| - /**
|
| - * Clears values from a spreadsheet.
|
| - * The caller must specify the spreadsheet ID and range.
|
| - * Only values are cleared -- all other properties of the cell (such as
|
| - * formatting, data validation, etc..) are kept.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [spreadsheetId] - The ID of the spreadsheet to update.
|
| - *
|
| - * [range] - The A1 notation of the values to clear.
|
| - *
|
| - * Completes with a [ClearValuesResponse].
|
| - *
|
| - * Completes with a [commons.ApiRequestError] if the API endpoint returned an
|
| - * error.
|
| - *
|
| - * If the used [http.Client] completes with an error when making a REST call,
|
| - * this method will complete with the same error.
|
| - */
|
| - async.Future<ClearValuesResponse> clear(ClearValuesRequest request, core.String spreadsheetId, core.String range) {
|
| + _url = 'v4/spreadsheets/' +
|
| + commons.Escaper.ecapeVariable('$spreadsheetId') +
|
| + '/values:batchUpdate';
|
| +
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response
|
| + .then((data) => new BatchUpdateValuesResponse.fromJson(data));
|
| + }
|
| +
|
| + /// Clears values from a spreadsheet.
|
| + /// The caller must specify the spreadsheet ID and range.
|
| + /// Only values are cleared -- all other properties of the cell (such as
|
| + /// formatting, data validation, etc..) are kept.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [spreadsheetId] - The ID of the spreadsheet to update.
|
| + ///
|
| + /// [range] - The A1 notation of the values to clear.
|
| + ///
|
| + /// Completes with a [ClearValuesResponse].
|
| + ///
|
| + /// Completes with a [commons.ApiRequestError] if the API endpoint returned
|
| + /// an error.
|
| + ///
|
| + /// If the used [http.Client] completes with an error when making a REST
|
| + /// call, this method will complete with the same error.
|
| + async.Future<ClearValuesResponse> clear(ClearValuesRequest request,
|
| + core.String spreadsheetId, core.String range) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -619,65 +636,70 @@ class SpreadsheetsValuesResourceApi {
|
| throw new core.ArgumentError("Parameter range is required.");
|
| }
|
|
|
| - _url = 'v4/spreadsheets/' + commons.Escaper.ecapeVariable('$spreadsheetId') + '/values/' + commons.Escaper.ecapeVariable('$range') + ':clear';
|
| + _url = 'v4/spreadsheets/' +
|
| + commons.Escaper.ecapeVariable('$spreadsheetId') +
|
| + '/values/' +
|
| + commons.Escaper.ecapeVariable('$range') +
|
| + ':clear';
|
|
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new ClearValuesResponse.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Returns a range of values from a spreadsheet.
|
| - * The caller must specify the spreadsheet ID and a range.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [spreadsheetId] - The ID of the spreadsheet to retrieve data from.
|
| - *
|
| - * [range] - The A1 notation of the values to retrieve.
|
| - *
|
| - * [dateTimeRenderOption] - How dates, times, and durations should be
|
| - * represented in the output.
|
| - * This is ignored if value_render_option is
|
| - * FORMATTED_VALUE.
|
| - * The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
|
| - * Possible string values are:
|
| - * - "SERIAL_NUMBER" : A SERIAL_NUMBER.
|
| - * - "FORMATTED_STRING" : A FORMATTED_STRING.
|
| - *
|
| - * [valueRenderOption] - How values should be represented in the output.
|
| - * The default render option is ValueRenderOption.FORMATTED_VALUE.
|
| - * Possible string values are:
|
| - * - "FORMATTED_VALUE" : A FORMATTED_VALUE.
|
| - * - "UNFORMATTED_VALUE" : A UNFORMATTED_VALUE.
|
| - * - "FORMULA" : A FORMULA.
|
| - *
|
| - * [majorDimension] - The major dimension that results should use.
|
| - *
|
| - * For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
|
| - * then requesting `range=A1:B2,majorDimension=ROWS` will return
|
| - * `[[1,2],[3,4]]`,
|
| - * whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
|
| - * `[[1,3],[2,4]]`.
|
| - * Possible string values are:
|
| - * - "DIMENSION_UNSPECIFIED" : A DIMENSION_UNSPECIFIED.
|
| - * - "ROWS" : A ROWS.
|
| - * - "COLUMNS" : A COLUMNS.
|
| - *
|
| - * Completes with a [ValueRange].
|
| - *
|
| - * Completes with a [commons.ApiRequestError] if the API endpoint returned an
|
| - * error.
|
| - *
|
| - * If the used [http.Client] completes with an error when making a REST call,
|
| - * this method will complete with the same error.
|
| - */
|
| - async.Future<ValueRange> get(core.String spreadsheetId, core.String range, {core.String dateTimeRenderOption, core.String valueRenderOption, core.String majorDimension}) {
|
| + /// Returns a range of values from a spreadsheet.
|
| + /// The caller must specify the spreadsheet ID and a range.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [spreadsheetId] - The ID of the spreadsheet to retrieve data from.
|
| + ///
|
| + /// [range] - The A1 notation of the values to retrieve.
|
| + ///
|
| + /// [dateTimeRenderOption] - How dates, times, and durations should be
|
| + /// represented in the output.
|
| + /// This is ignored if value_render_option is
|
| + /// FORMATTED_VALUE.
|
| + /// The default dateTime render option is
|
| + /// [DateTimeRenderOption.SERIAL_NUMBER].
|
| + /// Possible string values are:
|
| + /// - "SERIAL_NUMBER" : A SERIAL_NUMBER.
|
| + /// - "FORMATTED_STRING" : A FORMATTED_STRING.
|
| + ///
|
| + /// [valueRenderOption] - How values should be represented in the output.
|
| + /// The default render option is ValueRenderOption.FORMATTED_VALUE.
|
| + /// Possible string values are:
|
| + /// - "FORMATTED_VALUE" : A FORMATTED_VALUE.
|
| + /// - "UNFORMATTED_VALUE" : A UNFORMATTED_VALUE.
|
| + /// - "FORMULA" : A FORMULA.
|
| + ///
|
| + /// [majorDimension] - The major dimension that results should use.
|
| + ///
|
| + /// For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
|
| + /// then requesting `range=A1:B2,majorDimension=ROWS` will return
|
| + /// `[[1,2],[3,4]]`,
|
| + /// whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
|
| + /// `[[1,3],[2,4]]`.
|
| + /// Possible string values are:
|
| + /// - "DIMENSION_UNSPECIFIED" : A DIMENSION_UNSPECIFIED.
|
| + /// - "ROWS" : A ROWS.
|
| + /// - "COLUMNS" : A COLUMNS.
|
| + ///
|
| + /// Completes with a [ValueRange].
|
| + ///
|
| + /// Completes with a [commons.ApiRequestError] if the API endpoint returned
|
| + /// an error.
|
| + ///
|
| + /// If the used [http.Client] completes with an error when making a REST
|
| + /// call, this method will complete with the same error.
|
| + async.Future<ValueRange> get(core.String spreadsheetId, core.String range,
|
| + {core.String dateTimeRenderOption,
|
| + core.String valueRenderOption,
|
| + core.String majorDimension}) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -701,71 +723,77 @@ class SpreadsheetsValuesResourceApi {
|
| _queryParams["majorDimension"] = [majorDimension];
|
| }
|
|
|
| - _url = 'v4/spreadsheets/' + commons.Escaper.ecapeVariable('$spreadsheetId') + '/values/' + commons.Escaper.ecapeVariable('$range');
|
| + _url = 'v4/spreadsheets/' +
|
| + commons.Escaper.ecapeVariable('$spreadsheetId') +
|
| + '/values/' +
|
| + commons.Escaper.ecapeVariable('$range');
|
|
|
| - var _response = _requester.request(_url,
|
| - "GET",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new ValueRange.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Sets values in a range of a spreadsheet.
|
| - * The caller must specify the spreadsheet ID, range, and
|
| - * a valueInputOption.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [spreadsheetId] - The ID of the spreadsheet to update.
|
| - *
|
| - * [range] - The A1 notation of the values to update.
|
| - *
|
| - * [responseValueRenderOption] - Determines how values in the response should
|
| - * be rendered.
|
| - * The default render option is ValueRenderOption.FORMATTED_VALUE.
|
| - * Possible string values are:
|
| - * - "FORMATTED_VALUE" : A FORMATTED_VALUE.
|
| - * - "UNFORMATTED_VALUE" : A UNFORMATTED_VALUE.
|
| - * - "FORMULA" : A FORMULA.
|
| - *
|
| - * [valueInputOption] - How the input data should be interpreted.
|
| - * Possible string values are:
|
| - * - "INPUT_VALUE_OPTION_UNSPECIFIED" : A INPUT_VALUE_OPTION_UNSPECIFIED.
|
| - * - "RAW" : A RAW.
|
| - * - "USER_ENTERED" : A USER_ENTERED.
|
| - *
|
| - * [responseDateTimeRenderOption] - Determines how dates, times, and durations
|
| - * in the response should be
|
| - * rendered. This is ignored if response_value_render_option is
|
| - * FORMATTED_VALUE.
|
| - * The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
|
| - * Possible string values are:
|
| - * - "SERIAL_NUMBER" : A SERIAL_NUMBER.
|
| - * - "FORMATTED_STRING" : A FORMATTED_STRING.
|
| - *
|
| - * [includeValuesInResponse] - Determines if the update response should
|
| - * include the values
|
| - * of the cells that were updated. By default, responses
|
| - * do not include the updated values.
|
| - * If the range to write was larger than than the range actually written,
|
| - * the response will include all values in the requested range (excluding
|
| - * trailing empty rows and columns).
|
| - *
|
| - * Completes with a [UpdateValuesResponse].
|
| - *
|
| - * Completes with a [commons.ApiRequestError] if the API endpoint returned an
|
| - * error.
|
| - *
|
| - * If the used [http.Client] completes with an error when making a REST call,
|
| - * this method will complete with the same error.
|
| - */
|
| - async.Future<UpdateValuesResponse> update(ValueRange request, core.String spreadsheetId, core.String range, {core.String responseValueRenderOption, core.String valueInputOption, core.String responseDateTimeRenderOption, core.bool includeValuesInResponse}) {
|
| + /// Sets values in a range of a spreadsheet.
|
| + /// The caller must specify the spreadsheet ID, range, and
|
| + /// a valueInputOption.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [spreadsheetId] - The ID of the spreadsheet to update.
|
| + ///
|
| + /// [range] - The A1 notation of the values to update.
|
| + ///
|
| + /// [responseValueRenderOption] - Determines how values in the response
|
| + /// should be rendered.
|
| + /// The default render option is ValueRenderOption.FORMATTED_VALUE.
|
| + /// Possible string values are:
|
| + /// - "FORMATTED_VALUE" : A FORMATTED_VALUE.
|
| + /// - "UNFORMATTED_VALUE" : A UNFORMATTED_VALUE.
|
| + /// - "FORMULA" : A FORMULA.
|
| + ///
|
| + /// [valueInputOption] - How the input data should be interpreted.
|
| + /// Possible string values are:
|
| + /// - "INPUT_VALUE_OPTION_UNSPECIFIED" : A INPUT_VALUE_OPTION_UNSPECIFIED.
|
| + /// - "RAW" : A RAW.
|
| + /// - "USER_ENTERED" : A USER_ENTERED.
|
| + ///
|
| + /// [responseDateTimeRenderOption] - Determines how dates, times, and
|
| + /// durations in the response should be
|
| + /// rendered. This is ignored if response_value_render_option is
|
| + /// FORMATTED_VALUE.
|
| + /// The default dateTime render option is
|
| + /// [DateTimeRenderOption.SERIAL_NUMBER].
|
| + /// Possible string values are:
|
| + /// - "SERIAL_NUMBER" : A SERIAL_NUMBER.
|
| + /// - "FORMATTED_STRING" : A FORMATTED_STRING.
|
| + ///
|
| + /// [includeValuesInResponse] - Determines if the update response should
|
| + /// include the values
|
| + /// of the cells that were updated. By default, responses
|
| + /// do not include the updated values.
|
| + /// If the range to write was larger than than the range actually written,
|
| + /// the response will include all values in the requested range (excluding
|
| + /// trailing empty rows and columns).
|
| + ///
|
| + /// Completes with a [UpdateValuesResponse].
|
| + ///
|
| + /// Completes with a [commons.ApiRequestError] if the API endpoint returned
|
| + /// an error.
|
| + ///
|
| + /// If the used [http.Client] completes with an error when making a REST
|
| + /// call, this method will complete with the same error.
|
| + async.Future<UpdateValuesResponse> update(
|
| + ValueRange request, core.String spreadsheetId, core.String range,
|
| + {core.String responseValueRenderOption,
|
| + core.String valueInputOption,
|
| + core.String responseDateTimeRenderOption,
|
| + core.bool includeValuesInResponse}) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -789,35 +817,35 @@ class SpreadsheetsValuesResourceApi {
|
| _queryParams["valueInputOption"] = [valueInputOption];
|
| }
|
| if (responseDateTimeRenderOption != null) {
|
| - _queryParams["responseDateTimeRenderOption"] = [responseDateTimeRenderOption];
|
| + _queryParams["responseDateTimeRenderOption"] = [
|
| + responseDateTimeRenderOption
|
| + ];
|
| }
|
| if (includeValuesInResponse != null) {
|
| _queryParams["includeValuesInResponse"] = ["${includeValuesInResponse}"];
|
| }
|
|
|
| - _url = 'v4/spreadsheets/' + commons.Escaper.ecapeVariable('$spreadsheetId') + '/values/' + commons.Escaper.ecapeVariable('$range');
|
| + _url = 'v4/spreadsheets/' +
|
| + commons.Escaper.ecapeVariable('$spreadsheetId') +
|
| + '/values/' +
|
| + commons.Escaper.ecapeVariable('$range');
|
|
|
| - var _response = _requester.request(_url,
|
| - "PUT",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "PUT",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new UpdateValuesResponse.fromJson(data));
|
| }
|
| -
|
| }
|
|
|
| -
|
| -
|
| -/** Adds a new banded range to the spreadsheet. */
|
| +/// Adds a new banded range to the spreadsheet.
|
| class AddBandingRequest {
|
| - /**
|
| - * The banded range to add. The bandedRangeId
|
| - * field is optional; if one is not set, an id will be randomly generated. (It
|
| - * is an error to specify the ID of a range that already exists.)
|
| - */
|
| + /// The banded range to add. The bandedRangeId
|
| + /// field is optional; if one is not set, an id will be randomly generated.
|
| + /// (It
|
| + /// is an error to specify the ID of a range that already exists.)
|
| BandedRange bandedRange;
|
|
|
| AddBandingRequest();
|
| @@ -829,7 +857,8 @@ class AddBandingRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (bandedRange != null) {
|
| _json["bandedRange"] = (bandedRange).toJson();
|
| }
|
| @@ -837,9 +866,9 @@ class AddBandingRequest {
|
| }
|
| }
|
|
|
| -/** The result of adding a banded range. */
|
| +/// The result of adding a banded range.
|
| class AddBandingResponse {
|
| - /** The banded range that was added. */
|
| + /// The banded range that was added.
|
| BandedRange bandedRange;
|
|
|
| AddBandingResponse();
|
| @@ -851,7 +880,8 @@ class AddBandingResponse {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (bandedRange != null) {
|
| _json["bandedRange"] = (bandedRange).toJson();
|
| }
|
| @@ -859,14 +889,13 @@ class AddBandingResponse {
|
| }
|
| }
|
|
|
| -/** Adds a chart to a sheet in the spreadsheet. */
|
| +/// Adds a chart to a sheet in the spreadsheet.
|
| class AddChartRequest {
|
| - /**
|
| - * The chart that should be added to the spreadsheet, including the position
|
| - * where it should be placed. The chartId
|
| - * field is optional; if one is not set, an id will be randomly generated. (It
|
| - * is an error to specify the ID of a chart that already exists.)
|
| - */
|
| + /// The chart that should be added to the spreadsheet, including the position
|
| + /// where it should be placed. The chartId
|
| + /// field is optional; if one is not set, an id will be randomly generated.
|
| + /// (It
|
| + /// is an error to specify the ID of a chart that already exists.)
|
| EmbeddedChart chart;
|
|
|
| AddChartRequest();
|
| @@ -878,7 +907,8 @@ class AddChartRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (chart != null) {
|
| _json["chart"] = (chart).toJson();
|
| }
|
| @@ -886,9 +916,9 @@ class AddChartRequest {
|
| }
|
| }
|
|
|
| -/** The result of adding a chart to a spreadsheet. */
|
| +/// The result of adding a chart to a spreadsheet.
|
| class AddChartResponse {
|
| - /** The newly added chart. */
|
| + /// The newly added chart.
|
| EmbeddedChart chart;
|
|
|
| AddChartResponse();
|
| @@ -900,7 +930,8 @@ class AddChartResponse {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (chart != null) {
|
| _json["chart"] = (chart).toJson();
|
| }
|
| @@ -908,14 +939,13 @@ class AddChartResponse {
|
| }
|
| }
|
|
|
| -/**
|
| - * Adds a new conditional format rule at the given index.
|
| - * All subsequent rules' indexes are incremented.
|
| - */
|
| +/// Adds a new conditional format rule at the given index.
|
| +/// All subsequent rules' indexes are incremented.
|
| class AddConditionalFormatRuleRequest {
|
| - /** The zero-based index where the rule should be inserted. */
|
| + /// The zero-based index where the rule should be inserted.
|
| core.int index;
|
| - /** The rule to add. */
|
| +
|
| + /// The rule to add.
|
| ConditionalFormatRule rule;
|
|
|
| AddConditionalFormatRuleRequest();
|
| @@ -930,7 +960,8 @@ class AddConditionalFormatRuleRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (index != null) {
|
| _json["index"] = index;
|
| }
|
| @@ -941,13 +972,12 @@ class AddConditionalFormatRuleRequest {
|
| }
|
| }
|
|
|
| -/** Adds a filter view. */
|
| +/// Adds a filter view.
|
| class AddFilterViewRequest {
|
| - /**
|
| - * The filter to add. The filterViewId
|
| - * field is optional; if one is not set, an id will be randomly generated. (It
|
| - * is an error to specify the ID of a filter that already exists.)
|
| - */
|
| + /// The filter to add. The filterViewId
|
| + /// field is optional; if one is not set, an id will be randomly generated.
|
| + /// (It
|
| + /// is an error to specify the ID of a filter that already exists.)
|
| FilterView filter;
|
|
|
| AddFilterViewRequest();
|
| @@ -959,7 +989,8 @@ class AddFilterViewRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (filter != null) {
|
| _json["filter"] = (filter).toJson();
|
| }
|
| @@ -967,9 +998,9 @@ class AddFilterViewRequest {
|
| }
|
| }
|
|
|
| -/** The result of adding a filter view. */
|
| +/// The result of adding a filter view.
|
| class AddFilterViewResponse {
|
| - /** The newly added filter view. */
|
| + /// The newly added filter view.
|
| FilterView filter;
|
|
|
| AddFilterViewResponse();
|
| @@ -981,7 +1012,8 @@ class AddFilterViewResponse {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (filter != null) {
|
| _json["filter"] = (filter).toJson();
|
| }
|
| @@ -989,13 +1021,12 @@ class AddFilterViewResponse {
|
| }
|
| }
|
|
|
| -/** Adds a named range to the spreadsheet. */
|
| +/// Adds a named range to the spreadsheet.
|
| class AddNamedRangeRequest {
|
| - /**
|
| - * The named range to add. The namedRangeId
|
| - * field is optional; if one is not set, an id will be randomly generated. (It
|
| - * is an error to specify the ID of a range that already exists.)
|
| - */
|
| + /// The named range to add. The namedRangeId
|
| + /// field is optional; if one is not set, an id will be randomly generated.
|
| + /// (It
|
| + /// is an error to specify the ID of a range that already exists.)
|
| NamedRange namedRange;
|
|
|
| AddNamedRangeRequest();
|
| @@ -1007,7 +1038,8 @@ class AddNamedRangeRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (namedRange != null) {
|
| _json["namedRange"] = (namedRange).toJson();
|
| }
|
| @@ -1015,9 +1047,9 @@ class AddNamedRangeRequest {
|
| }
|
| }
|
|
|
| -/** The result of adding a named range. */
|
| +/// The result of adding a named range.
|
| class AddNamedRangeResponse {
|
| - /** The named range to add. */
|
| + /// The named range to add.
|
| NamedRange namedRange;
|
|
|
| AddNamedRangeResponse();
|
| @@ -1029,7 +1061,8 @@ class AddNamedRangeResponse {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (namedRange != null) {
|
| _json["namedRange"] = (namedRange).toJson();
|
| }
|
| @@ -1037,14 +1070,12 @@ class AddNamedRangeResponse {
|
| }
|
| }
|
|
|
| -/** Adds a new protected range. */
|
| +/// Adds a new protected range.
|
| class AddProtectedRangeRequest {
|
| - /**
|
| - * The protected range to be added. The
|
| - * protectedRangeId field is optional; if
|
| - * one is not set, an id will be randomly generated. (It is an error to
|
| - * specify the ID of a range that already exists.)
|
| - */
|
| + /// The protected range to be added. The
|
| + /// protectedRangeId field is optional; if
|
| + /// one is not set, an id will be randomly generated. (It is an error to
|
| + /// specify the ID of a range that already exists.)
|
| ProtectedRange protectedRange;
|
|
|
| AddProtectedRangeRequest();
|
| @@ -1056,7 +1087,8 @@ class AddProtectedRangeRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (protectedRange != null) {
|
| _json["protectedRange"] = (protectedRange).toJson();
|
| }
|
| @@ -1064,9 +1096,9 @@ class AddProtectedRangeRequest {
|
| }
|
| }
|
|
|
| -/** The result of adding a new protected range. */
|
| +/// The result of adding a new protected range.
|
| class AddProtectedRangeResponse {
|
| - /** The newly added protected range. */
|
| + /// The newly added protected range.
|
| ProtectedRange protectedRange;
|
|
|
| AddProtectedRangeResponse();
|
| @@ -1078,7 +1110,8 @@ class AddProtectedRangeResponse {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (protectedRange != null) {
|
| _json["protectedRange"] = (protectedRange).toJson();
|
| }
|
| @@ -1086,22 +1119,18 @@ class AddProtectedRangeResponse {
|
| }
|
| }
|
|
|
| -/**
|
| - * Adds a new sheet.
|
| - * When a sheet is added at a given index,
|
| - * all subsequent sheets' indexes are incremented.
|
| - * To add an object sheet, use AddChartRequest instead and specify
|
| - * EmbeddedObjectPosition.sheetId or
|
| - * EmbeddedObjectPosition.newSheet.
|
| - */
|
| +/// Adds a new sheet.
|
| +/// When a sheet is added at a given index,
|
| +/// all subsequent sheets' indexes are incremented.
|
| +/// To add an object sheet, use AddChartRequest instead and specify
|
| +/// EmbeddedObjectPosition.sheetId or
|
| +/// EmbeddedObjectPosition.newSheet.
|
| class AddSheetRequest {
|
| - /**
|
| - * The properties the new sheet should have.
|
| - * All properties are optional.
|
| - * The sheetId field is optional; if one is not
|
| - * set, an id will be randomly generated. (It is an error to specify the ID
|
| - * of a sheet that already exists.)
|
| - */
|
| + /// The properties the new sheet should have.
|
| + /// All properties are optional.
|
| + /// The sheetId field is optional; if one is not
|
| + /// set, an id will be randomly generated. (It is an error to specify the ID
|
| + /// of a sheet that already exists.)
|
| SheetProperties properties;
|
|
|
| AddSheetRequest();
|
| @@ -1113,7 +1142,8 @@ class AddSheetRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (properties != null) {
|
| _json["properties"] = (properties).toJson();
|
| }
|
| @@ -1121,9 +1151,9 @@ class AddSheetRequest {
|
| }
|
| }
|
|
|
| -/** The result of adding a sheet. */
|
| +/// The result of adding a sheet.
|
| class AddSheetResponse {
|
| - /** The properties of the newly added sheet. */
|
| + /// The properties of the newly added sheet.
|
| SheetProperties properties;
|
|
|
| AddSheetResponse();
|
| @@ -1135,7 +1165,8 @@ class AddSheetResponse {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (properties != null) {
|
| _json["properties"] = (properties).toJson();
|
| }
|
| @@ -1143,21 +1174,19 @@ class AddSheetResponse {
|
| }
|
| }
|
|
|
| -/**
|
| - * Adds new cells after the last row with data in a sheet,
|
| - * inserting new rows into the sheet if necessary.
|
| - */
|
| +/// Adds new cells after the last row with data in a sheet,
|
| +/// inserting new rows into the sheet if necessary.
|
| class AppendCellsRequest {
|
| - /**
|
| - * The fields of CellData that should be updated.
|
| - * At least one field must be specified.
|
| - * The root is the CellData; 'row.values.' should not be specified.
|
| - * A single `"*"` can be used as short-hand for listing every field.
|
| - */
|
| + /// The fields of CellData that should be updated.
|
| + /// At least one field must be specified.
|
| + /// The root is the CellData; 'row.values.' should not be specified.
|
| + /// A single `"*"` can be used as short-hand for listing every field.
|
| core.String fields;
|
| - /** The data to append. */
|
| +
|
| + /// The data to append.
|
| core.List<RowData> rows;
|
| - /** The sheet ID to append the data to. */
|
| +
|
| + /// The sheet ID to append the data to.
|
| core.int sheetId;
|
|
|
| AppendCellsRequest();
|
| @@ -1175,7 +1204,8 @@ class AppendCellsRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (fields != null) {
|
| _json["fields"] = fields;
|
| }
|
| @@ -1189,19 +1219,19 @@ class AppendCellsRequest {
|
| }
|
| }
|
|
|
| -/** Appends rows or columns to the end of a sheet. */
|
| +/// Appends rows or columns to the end of a sheet.
|
| class AppendDimensionRequest {
|
| - /**
|
| - * Whether rows or columns should be appended.
|
| - * Possible string values are:
|
| - * - "DIMENSION_UNSPECIFIED" : The default value, do not use.
|
| - * - "ROWS" : Operates on the rows of a sheet.
|
| - * - "COLUMNS" : Operates on the columns of a sheet.
|
| - */
|
| + /// Whether rows or columns should be appended.
|
| + /// Possible string values are:
|
| + /// - "DIMENSION_UNSPECIFIED" : The default value, do not use.
|
| + /// - "ROWS" : Operates on the rows of a sheet.
|
| + /// - "COLUMNS" : Operates on the columns of a sheet.
|
| core.String dimension;
|
| - /** The number of rows or columns to append. */
|
| +
|
| + /// The number of rows or columns to append.
|
| core.int length;
|
| - /** The sheet to append rows or columns to. */
|
| +
|
| + /// The sheet to append rows or columns to.
|
| core.int sheetId;
|
|
|
| AppendDimensionRequest();
|
| @@ -1219,7 +1249,8 @@ class AppendDimensionRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (dimension != null) {
|
| _json["dimension"] = dimension;
|
| }
|
| @@ -1233,17 +1264,17 @@ class AppendDimensionRequest {
|
| }
|
| }
|
|
|
| -/** The response when updating a range of values in a spreadsheet. */
|
| +/// The response when updating a range of values in a spreadsheet.
|
| class AppendValuesResponse {
|
| - /** The spreadsheet the updates were applied to. */
|
| + /// The spreadsheet the updates were applied to.
|
| core.String spreadsheetId;
|
| - /**
|
| - * The range (in A1 notation) of the table that values are being appended to
|
| - * (before the values were appended).
|
| - * Empty if no table was found.
|
| - */
|
| +
|
| + /// The range (in A1 notation) of the table that values are being appended to
|
| + /// (before the values were appended).
|
| + /// Empty if no table was found.
|
| core.String tableRange;
|
| - /** Information about the updates that were applied. */
|
| +
|
| + /// Information about the updates that were applied.
|
| UpdateValuesResponse updates;
|
|
|
| AppendValuesResponse();
|
| @@ -1261,7 +1292,8 @@ class AppendValuesResponse {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (spreadsheetId != null) {
|
| _json["spreadsheetId"] = spreadsheetId;
|
| }
|
| @@ -1275,24 +1307,20 @@ class AppendValuesResponse {
|
| }
|
| }
|
|
|
| -/** Fills in more data based on existing data. */
|
| +/// Fills in more data based on existing data.
|
| class AutoFillRequest {
|
| - /**
|
| - * The range to autofill. This will examine the range and detect
|
| - * the location that has data and automatically fill that data
|
| - * in to the rest of the range.
|
| - */
|
| + /// The range to autofill. This will examine the range and detect
|
| + /// the location that has data and automatically fill that data
|
| + /// in to the rest of the range.
|
| GridRange range;
|
| - /**
|
| - * The source and destination areas to autofill.
|
| - * This explicitly lists the source of the autofill and where to
|
| - * extend that data.
|
| - */
|
| +
|
| + /// The source and destination areas to autofill.
|
| + /// This explicitly lists the source of the autofill and where to
|
| + /// extend that data.
|
| SourceAndDestination sourceAndDestination;
|
| - /**
|
| - * True if we should generate data with the "alternate" series.
|
| - * This differs based on the type and amount of source data.
|
| - */
|
| +
|
| + /// True if we should generate data with the "alternate" series.
|
| + /// This differs based on the type and amount of source data.
|
| core.bool useAlternateSeries;
|
|
|
| AutoFillRequest();
|
| @@ -1302,7 +1330,8 @@ class AutoFillRequest {
|
| range = new GridRange.fromJson(_json["range"]);
|
| }
|
| if (_json.containsKey("sourceAndDestination")) {
|
| - sourceAndDestination = new SourceAndDestination.fromJson(_json["sourceAndDestination"]);
|
| + sourceAndDestination =
|
| + new SourceAndDestination.fromJson(_json["sourceAndDestination"]);
|
| }
|
| if (_json.containsKey("useAlternateSeries")) {
|
| useAlternateSeries = _json["useAlternateSeries"];
|
| @@ -1310,7 +1339,8 @@ class AutoFillRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (range != null) {
|
| _json["range"] = (range).toJson();
|
| }
|
| @@ -1324,15 +1354,10 @@ class AutoFillRequest {
|
| }
|
| }
|
|
|
| -/**
|
| - * Automatically resizes one or more dimensions based on the contents
|
| - * of the cells in that dimension.
|
| - */
|
| +/// Automatically resizes one or more dimensions based on the contents
|
| +/// of the cells in that dimension.
|
| class AutoResizeDimensionsRequest {
|
| - /**
|
| - * The dimensions to automatically resize.
|
| - * Only COLUMNS are supported.
|
| - */
|
| + /// The dimensions to automatically resize.
|
| DimensionRange dimensions;
|
|
|
| AutoResizeDimensionsRequest();
|
| @@ -1344,7 +1369,8 @@ class AutoResizeDimensionsRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (dimensions != null) {
|
| _json["dimensions"] = (dimensions).toJson();
|
| }
|
| @@ -1352,23 +1378,24 @@ class AutoResizeDimensionsRequest {
|
| }
|
| }
|
|
|
| -/** A banded (alternating colors) range in a sheet. */
|
| +/// A banded (alternating colors) range in a sheet.
|
| class BandedRange {
|
| - /** The id of the banded range. */
|
| + /// The id of the banded range.
|
| core.int bandedRangeId;
|
| - /**
|
| - * Properties for column bands. These properties will be applied on a column-
|
| - * by-column basis throughout all the columns in the range. At least one of
|
| - * row_properties or column_properties must be specified.
|
| - */
|
| +
|
| + /// Properties for column bands. These properties will be applied on a
|
| + /// column-
|
| + /// by-column basis throughout all the columns in the range. At least one of
|
| + /// row_properties or column_properties must be specified.
|
| BandingProperties columnProperties;
|
| - /** The range over which these properties are applied. */
|
| +
|
| + /// The range over which these properties are applied.
|
| GridRange range;
|
| - /**
|
| - * Properties for row bands. These properties will be applied on a row-by-row
|
| - * basis throughout all the rows in the range. At least one of
|
| - * row_properties or column_properties must be specified.
|
| - */
|
| +
|
| + /// Properties for row bands. These properties will be applied on a
|
| + /// row-by-row
|
| + /// basis throughout all the rows in the range. At least one of
|
| + /// row_properties or column_properties must be specified.
|
| BandingProperties rowProperties;
|
|
|
| BandedRange();
|
| @@ -1378,7 +1405,8 @@ class BandedRange {
|
| bandedRangeId = _json["bandedRangeId"];
|
| }
|
| if (_json.containsKey("columnProperties")) {
|
| - columnProperties = new BandingProperties.fromJson(_json["columnProperties"]);
|
| + columnProperties =
|
| + new BandingProperties.fromJson(_json["columnProperties"]);
|
| }
|
| if (_json.containsKey("range")) {
|
| range = new GridRange.fromJson(_json["range"]);
|
| @@ -1389,7 +1417,8 @@ class BandedRange {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (bandedRangeId != null) {
|
| _json["bandedRangeId"] = bandedRangeId;
|
| }
|
| @@ -1406,41 +1435,38 @@ class BandedRange {
|
| }
|
| }
|
|
|
| -/**
|
| - * Properties referring a single dimension (either row or column). If both
|
| - * BandedRange.row_properties and BandedRange.column_properties are
|
| - * set, the fill colors are applied to cells according to the following rules:
|
| - *
|
| - * * header_color and footer_color take priority over band colors.
|
| - * * first_band_color takes priority over second_band_color.
|
| - * * row_properties takes priority over column_properties.
|
| - *
|
| - * For example, the first row color takes priority over the first column
|
| - * color, but the first column color takes priority over the second row color.
|
| - * Similarly, the row header takes priority over the column header in the
|
| - * top left cell, but the column header takes priority over the first row
|
| - * color if the row header is not set.
|
| - */
|
| +/// Properties referring a single dimension (either row or column). If both
|
| +/// BandedRange.row_properties and BandedRange.column_properties are
|
| +/// set, the fill colors are applied to cells according to the following rules:
|
| +///
|
| +/// * header_color and footer_color take priority over band colors.
|
| +/// * first_band_color takes priority over second_band_color.
|
| +/// * row_properties takes priority over column_properties.
|
| +///
|
| +/// For example, the first row color takes priority over the first column
|
| +/// color, but the first column color takes priority over the second row color.
|
| +/// Similarly, the row header takes priority over the column header in the
|
| +/// top left cell, but the column header takes priority over the first row
|
| +/// color if the row header is not set.
|
| class BandingProperties {
|
| - /** The first color that is alternating. (Required) */
|
| + /// The first color that is alternating. (Required)
|
| Color firstBandColor;
|
| - /**
|
| - * The color of the last row or column. If this field is not set, the last
|
| - * row or column will be filled with either first_band_color or
|
| - * second_band_color, depending on the color of the previous row or
|
| - * column.
|
| - */
|
| +
|
| + /// The color of the last row or column. If this field is not set, the last
|
| + /// row or column will be filled with either first_band_color or
|
| + /// second_band_color, depending on the color of the previous row or
|
| + /// column.
|
| Color footerColor;
|
| - /**
|
| - * The color of the first row or column. If this field is set, the first
|
| - * row or column will be filled with this color and the colors will
|
| - * alternate between first_band_color and second_band_color starting
|
| - * from the second row or column. Otherwise, the first row or column will be
|
| - * filled with first_band_color and the colors will proceed to alternate
|
| - * as they normally would.
|
| - */
|
| +
|
| + /// The color of the first row or column. If this field is set, the first
|
| + /// row or column will be filled with this color and the colors will
|
| + /// alternate between first_band_color and second_band_color starting
|
| + /// from the second row or column. Otherwise, the first row or column will be
|
| + /// filled with first_band_color and the colors will proceed to alternate
|
| + /// as they normally would.
|
| Color headerColor;
|
| - /** The second color that is alternating. (Required) */
|
| +
|
| + /// The second color that is alternating. (Required)
|
| Color secondBandColor;
|
|
|
| BandingProperties();
|
| @@ -1461,7 +1487,8 @@ class BandingProperties {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (firstBandColor != null) {
|
| _json["firstBandColor"] = (firstBandColor).toJson();
|
| }
|
| @@ -1478,36 +1505,30 @@ class BandingProperties {
|
| }
|
| }
|
|
|
| -/**
|
| - * An axis of the chart.
|
| - * A chart may not have more than one axis per
|
| - * axis position.
|
| - */
|
| +/// An axis of the chart.
|
| +/// A chart may not have more than one axis per
|
| +/// axis position.
|
| class BasicChartAxis {
|
| - /**
|
| - * The format of the title.
|
| - * Only valid if the axis is not associated with the domain.
|
| - */
|
| + /// The format of the title.
|
| + /// Only valid if the axis is not associated with the domain.
|
| TextFormat format;
|
| - /**
|
| - * The position of this axis.
|
| - * Possible string values are:
|
| - * - "BASIC_CHART_AXIS_POSITION_UNSPECIFIED" : Default value, do not use.
|
| - * - "BOTTOM_AXIS" : The axis rendered at the bottom of a chart.
|
| - * For most charts, this is the standard major axis.
|
| - * For bar charts, this is a minor axis.
|
| - * - "LEFT_AXIS" : The axis rendered at the left of a chart.
|
| - * For most charts, this is a minor axis.
|
| - * For bar charts, this is the standard major axis.
|
| - * - "RIGHT_AXIS" : The axis rendered at the right of a chart.
|
| - * For most charts, this is a minor axis.
|
| - * For bar charts, this is an unusual major axis.
|
| - */
|
| +
|
| + /// The position of this axis.
|
| + /// Possible string values are:
|
| + /// - "BASIC_CHART_AXIS_POSITION_UNSPECIFIED" : Default value, do not use.
|
| + /// - "BOTTOM_AXIS" : The axis rendered at the bottom of a chart.
|
| + /// For most charts, this is the standard major axis.
|
| + /// For bar charts, this is a minor axis.
|
| + /// - "LEFT_AXIS" : The axis rendered at the left of a chart.
|
| + /// For most charts, this is a minor axis.
|
| + /// For bar charts, this is the standard major axis.
|
| + /// - "RIGHT_AXIS" : The axis rendered at the right of a chart.
|
| + /// For most charts, this is a minor axis.
|
| + /// For bar charts, this is an unusual major axis.
|
| core.String position;
|
| - /**
|
| - * The title of this axis. If set, this overrides any title inferred
|
| - * from headers of the data.
|
| - */
|
| +
|
| + /// The title of this axis. If set, this overrides any title inferred
|
| + /// from headers of the data.
|
| core.String title;
|
|
|
| BasicChartAxis();
|
| @@ -1525,7 +1546,8 @@ class BasicChartAxis {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (format != null) {
|
| _json["format"] = (format).toJson();
|
| }
|
| @@ -1539,17 +1561,14 @@ class BasicChartAxis {
|
| }
|
| }
|
|
|
| -/**
|
| - * The domain of a chart.
|
| - * For example, if charting stock prices over time, this would be the date.
|
| - */
|
| +/// The domain of a chart.
|
| +/// For example, if charting stock prices over time, this would be the date.
|
| class BasicChartDomain {
|
| - /**
|
| - * The data of the domain. For example, if charting stock prices over time,
|
| - * this is the data representing the dates.
|
| - */
|
| + /// The data of the domain. For example, if charting stock prices over time,
|
| + /// this is the data representing the dates.
|
| ChartData domain;
|
| - /** True to reverse the order of the domain values (horizontal axis). */
|
| +
|
| + /// True to reverse the order of the domain values (horizontal axis).
|
| core.bool reversed;
|
|
|
| BasicChartDomain();
|
| @@ -1564,7 +1583,8 @@ class BasicChartDomain {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (domain != null) {
|
| _json["domain"] = (domain).toJson();
|
| }
|
| @@ -1575,60 +1595,56 @@ class BasicChartDomain {
|
| }
|
| }
|
|
|
| -/**
|
| - * A single series of data in a chart.
|
| - * For example, if charting stock prices over time, multiple series may exist,
|
| - * one for the "Open Price", "High Price", "Low Price" and "Close Price".
|
| - */
|
| +/// A single series of data in a chart.
|
| +/// For example, if charting stock prices over time, multiple series may exist,
|
| +/// one for the "Open Price", "High Price", "Low Price" and "Close Price".
|
| class BasicChartSeries {
|
| - /** The data being visualized in this chart series. */
|
| + /// The data being visualized in this chart series.
|
| ChartData series;
|
| - /**
|
| - * The minor axis that will specify the range of values for this series.
|
| - * For example, if charting stocks over time, the "Volume" series
|
| - * may want to be pinned to the right with the prices pinned to the left,
|
| - * because the scale of trading volume is different than the scale of
|
| - * prices.
|
| - * It is an error to specify an axis that isn't a valid minor axis
|
| - * for the chart's type.
|
| - * Possible string values are:
|
| - * - "BASIC_CHART_AXIS_POSITION_UNSPECIFIED" : Default value, do not use.
|
| - * - "BOTTOM_AXIS" : The axis rendered at the bottom of a chart.
|
| - * For most charts, this is the standard major axis.
|
| - * For bar charts, this is a minor axis.
|
| - * - "LEFT_AXIS" : The axis rendered at the left of a chart.
|
| - * For most charts, this is a minor axis.
|
| - * For bar charts, this is the standard major axis.
|
| - * - "RIGHT_AXIS" : The axis rendered at the right of a chart.
|
| - * For most charts, this is a minor axis.
|
| - * For bar charts, this is an unusual major axis.
|
| - */
|
| +
|
| + /// The minor axis that will specify the range of values for this series.
|
| + /// For example, if charting stocks over time, the "Volume" series
|
| + /// may want to be pinned to the right with the prices pinned to the left,
|
| + /// because the scale of trading volume is different than the scale of
|
| + /// prices.
|
| + /// It is an error to specify an axis that isn't a valid minor axis
|
| + /// for the chart's type.
|
| + /// Possible string values are:
|
| + /// - "BASIC_CHART_AXIS_POSITION_UNSPECIFIED" : Default value, do not use.
|
| + /// - "BOTTOM_AXIS" : The axis rendered at the bottom of a chart.
|
| + /// For most charts, this is the standard major axis.
|
| + /// For bar charts, this is a minor axis.
|
| + /// - "LEFT_AXIS" : The axis rendered at the left of a chart.
|
| + /// For most charts, this is a minor axis.
|
| + /// For bar charts, this is the standard major axis.
|
| + /// - "RIGHT_AXIS" : The axis rendered at the right of a chart.
|
| + /// For most charts, this is a minor axis.
|
| + /// For bar charts, this is an unusual major axis.
|
| core.String targetAxis;
|
| - /**
|
| - * The type of this series. Valid only if the
|
| - * chartType is
|
| - * COMBO.
|
| - * Different types will change the way the series is visualized.
|
| - * Only LINE, AREA,
|
| - * and COLUMN are supported.
|
| - * Possible string values are:
|
| - * - "BASIC_CHART_TYPE_UNSPECIFIED" : Default value, do not use.
|
| - * - "BAR" : A <a href="/chart/interactive/docs/gallery/barchart">bar
|
| - * chart</a>.
|
| - * - "LINE" : A <a href="/chart/interactive/docs/gallery/linechart">line
|
| - * chart</a>.
|
| - * - "AREA" : An <a href="/chart/interactive/docs/gallery/areachart">area
|
| - * chart</a>.
|
| - * - "COLUMN" : A <a href="/chart/interactive/docs/gallery/columnchart">column
|
| - * chart</a>.
|
| - * - "SCATTER" : A <a
|
| - * href="/chart/interactive/docs/gallery/scatterchart">scatter chart</a>.
|
| - * - "COMBO" : A <a href="/chart/interactive/docs/gallery/combochart">combo
|
| - * chart</a>.
|
| - * - "STEPPED_AREA" : A <a
|
| - * href="/chart/interactive/docs/gallery/steppedareachart">stepped area
|
| - * chart</a>.
|
| - */
|
| +
|
| + /// The type of this series. Valid only if the
|
| + /// chartType is
|
| + /// COMBO.
|
| + /// Different types will change the way the series is visualized.
|
| + /// Only LINE, AREA,
|
| + /// and COLUMN are supported.
|
| + /// Possible string values are:
|
| + /// - "BASIC_CHART_TYPE_UNSPECIFIED" : Default value, do not use.
|
| + /// - "BAR" : A <a href="/chart/interactive/docs/gallery/barchart">bar
|
| + /// chart</a>.
|
| + /// - "LINE" : A <a href="/chart/interactive/docs/gallery/linechart">line
|
| + /// chart</a>.
|
| + /// - "AREA" : An <a href="/chart/interactive/docs/gallery/areachart">area
|
| + /// chart</a>.
|
| + /// - "COLUMN" : A <a
|
| + /// href="/chart/interactive/docs/gallery/columnchart">column chart</a>.
|
| + /// - "SCATTER" : A <a
|
| + /// href="/chart/interactive/docs/gallery/scatterchart">scatter chart</a>.
|
| + /// - "COMBO" : A <a href="/chart/interactive/docs/gallery/combochart">combo
|
| + /// chart</a>.
|
| + /// - "STEPPED_AREA" : A <a
|
| + /// href="/chart/interactive/docs/gallery/steppedareachart">stepped area
|
| + /// chart</a>.
|
| core.String type;
|
|
|
| BasicChartSeries();
|
| @@ -1646,7 +1662,8 @@ class BasicChartSeries {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (series != null) {
|
| _json["series"] = (series).toJson();
|
| }
|
| @@ -1660,104 +1677,100 @@ class BasicChartSeries {
|
| }
|
| }
|
|
|
| -/**
|
| - * The specification for a basic chart. See BasicChartType for the list
|
| - * of charts this supports.
|
| - */
|
| +/// The specification for a basic chart. See BasicChartType for the list
|
| +/// of charts this supports.
|
| class BasicChartSpec {
|
| - /** The axis on the chart. */
|
| + /// The axis on the chart.
|
| core.List<BasicChartAxis> axis;
|
| - /**
|
| - * The type of the chart.
|
| - * Possible string values are:
|
| - * - "BASIC_CHART_TYPE_UNSPECIFIED" : Default value, do not use.
|
| - * - "BAR" : A <a href="/chart/interactive/docs/gallery/barchart">bar
|
| - * chart</a>.
|
| - * - "LINE" : A <a href="/chart/interactive/docs/gallery/linechart">line
|
| - * chart</a>.
|
| - * - "AREA" : An <a href="/chart/interactive/docs/gallery/areachart">area
|
| - * chart</a>.
|
| - * - "COLUMN" : A <a href="/chart/interactive/docs/gallery/columnchart">column
|
| - * chart</a>.
|
| - * - "SCATTER" : A <a
|
| - * href="/chart/interactive/docs/gallery/scatterchart">scatter chart</a>.
|
| - * - "COMBO" : A <a href="/chart/interactive/docs/gallery/combochart">combo
|
| - * chart</a>.
|
| - * - "STEPPED_AREA" : A <a
|
| - * href="/chart/interactive/docs/gallery/steppedareachart">stepped area
|
| - * chart</a>.
|
| - */
|
| +
|
| + /// The type of the chart.
|
| + /// Possible string values are:
|
| + /// - "BASIC_CHART_TYPE_UNSPECIFIED" : Default value, do not use.
|
| + /// - "BAR" : A <a href="/chart/interactive/docs/gallery/barchart">bar
|
| + /// chart</a>.
|
| + /// - "LINE" : A <a href="/chart/interactive/docs/gallery/linechart">line
|
| + /// chart</a>.
|
| + /// - "AREA" : An <a href="/chart/interactive/docs/gallery/areachart">area
|
| + /// chart</a>.
|
| + /// - "COLUMN" : A <a
|
| + /// href="/chart/interactive/docs/gallery/columnchart">column chart</a>.
|
| + /// - "SCATTER" : A <a
|
| + /// href="/chart/interactive/docs/gallery/scatterchart">scatter chart</a>.
|
| + /// - "COMBO" : A <a href="/chart/interactive/docs/gallery/combochart">combo
|
| + /// chart</a>.
|
| + /// - "STEPPED_AREA" : A <a
|
| + /// href="/chart/interactive/docs/gallery/steppedareachart">stepped area
|
| + /// chart</a>.
|
| core.String chartType;
|
| - /**
|
| - * The domain of data this is charting.
|
| - * Only a single domain is supported.
|
| - */
|
| +
|
| + /// The domain of data this is charting.
|
| + /// Only a single domain is supported.
|
| core.List<BasicChartDomain> domains;
|
| - /**
|
| - * The number of rows or columns in the data that are "headers".
|
| - * If not set, Google Sheets will guess how many rows are headers based
|
| - * on the data.
|
| - *
|
| - * (Note that BasicChartAxis.title may override the axis title
|
| - * inferred from the header values.)
|
| - */
|
| +
|
| + /// The number of rows or columns in the data that are "headers".
|
| + /// If not set, Google Sheets will guess how many rows are headers based
|
| + /// on the data.
|
| + ///
|
| + /// (Note that BasicChartAxis.title may override the axis title
|
| + /// inferred from the header values.)
|
| core.int headerCount;
|
| - /**
|
| - * If some values in a series are missing, gaps may appear in the chart (e.g,
|
| - * segments of lines in a line chart will be missing). To eliminate these
|
| - * gaps set this to true.
|
| - * Applies to Line, Area, and Combo charts.
|
| - */
|
| +
|
| + /// If some values in a series are missing, gaps may appear in the chart
|
| + /// (e.g,
|
| + /// segments of lines in a line chart will be missing). To eliminate these
|
| + /// gaps set this to true.
|
| + /// Applies to Line, Area, and Combo charts.
|
| core.bool interpolateNulls;
|
| - /**
|
| - * The position of the chart legend.
|
| - * Possible string values are:
|
| - * - "BASIC_CHART_LEGEND_POSITION_UNSPECIFIED" : Default value, do not use.
|
| - * - "BOTTOM_LEGEND" : The legend is rendered on the bottom of the chart.
|
| - * - "LEFT_LEGEND" : The legend is rendered on the left of the chart.
|
| - * - "RIGHT_LEGEND" : The legend is rendered on the right of the chart.
|
| - * - "TOP_LEGEND" : The legend is rendered on the top of the chart.
|
| - * - "NO_LEGEND" : No legend is rendered.
|
| - */
|
| +
|
| + /// The position of the chart legend.
|
| + /// Possible string values are:
|
| + /// - "BASIC_CHART_LEGEND_POSITION_UNSPECIFIED" : Default value, do not use.
|
| + /// - "BOTTOM_LEGEND" : The legend is rendered on the bottom of the chart.
|
| + /// - "LEFT_LEGEND" : The legend is rendered on the left of the chart.
|
| + /// - "RIGHT_LEGEND" : The legend is rendered on the right of the chart.
|
| + /// - "TOP_LEGEND" : The legend is rendered on the top of the chart.
|
| + /// - "NO_LEGEND" : No legend is rendered.
|
| core.String legendPosition;
|
| - /**
|
| - * Gets whether all lines should be rendered smooth or straight by default.
|
| - * Applies to Line charts.
|
| - */
|
| +
|
| + /// Gets whether all lines should be rendered smooth or straight by default.
|
| + /// Applies to Line charts.
|
| core.bool lineSmoothing;
|
| - /** The data this chart is visualizing. */
|
| +
|
| + /// The data this chart is visualizing.
|
| core.List<BasicChartSeries> series;
|
| - /**
|
| - * The stacked type for charts that support vertical stacking.
|
| - * Applies to Area, Bar, Column, and Stepped Area charts.
|
| - * Possible string values are:
|
| - * - "BASIC_CHART_STACKED_TYPE_UNSPECIFIED" : Default value, do not use.
|
| - * - "NOT_STACKED" : Series are not stacked.
|
| - * - "STACKED" : Series values are stacked, each value is rendered vertically
|
| - * beginning
|
| - * from the top of the value below it.
|
| - * - "PERCENT_STACKED" : Vertical stacks are stretched to reach the top of the
|
| - * chart, with
|
| - * values laid out as percentages of each other.
|
| - */
|
| +
|
| + /// The stacked type for charts that support vertical stacking.
|
| + /// Applies to Area, Bar, Column, and Stepped Area charts.
|
| + /// Possible string values are:
|
| + /// - "BASIC_CHART_STACKED_TYPE_UNSPECIFIED" : Default value, do not use.
|
| + /// - "NOT_STACKED" : Series are not stacked.
|
| + /// - "STACKED" : Series values are stacked, each value is rendered
|
| + /// vertically beginning
|
| + /// from the top of the value below it.
|
| + /// - "PERCENT_STACKED" : Vertical stacks are stretched to reach the top of
|
| + /// the chart, with
|
| + /// values laid out as percentages of each other.
|
| core.String stackedType;
|
| - /**
|
| - * True to make the chart 3D.
|
| - * Applies to Bar and Column charts.
|
| - */
|
| +
|
| + /// True to make the chart 3D.
|
| + /// Applies to Bar and Column charts.
|
| core.bool threeDimensional;
|
|
|
| BasicChartSpec();
|
|
|
| BasicChartSpec.fromJson(core.Map _json) {
|
| if (_json.containsKey("axis")) {
|
| - axis = _json["axis"].map((value) => new BasicChartAxis.fromJson(value)).toList();
|
| + axis = _json["axis"]
|
| + .map((value) => new BasicChartAxis.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("chartType")) {
|
| chartType = _json["chartType"];
|
| }
|
| if (_json.containsKey("domains")) {
|
| - domains = _json["domains"].map((value) => new BasicChartDomain.fromJson(value)).toList();
|
| + domains = _json["domains"]
|
| + .map((value) => new BasicChartDomain.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("headerCount")) {
|
| headerCount = _json["headerCount"];
|
| @@ -1772,7 +1785,9 @@ class BasicChartSpec {
|
| lineSmoothing = _json["lineSmoothing"];
|
| }
|
| if (_json.containsKey("series")) {
|
| - series = _json["series"].map((value) => new BasicChartSeries.fromJson(value)).toList();
|
| + series = _json["series"]
|
| + .map((value) => new BasicChartSeries.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("stackedType")) {
|
| stackedType = _json["stackedType"];
|
| @@ -1783,7 +1798,8 @@ class BasicChartSpec {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (axis != null) {
|
| _json["axis"] = axis.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -1818,40 +1834,47 @@ class BasicChartSpec {
|
| }
|
| }
|
|
|
| -/** The default filter associated with a sheet. */
|
| +/// The default filter associated with a sheet.
|
| class BasicFilter {
|
| - /**
|
| - * The criteria for showing/hiding values per column.
|
| - * The map's key is the column index, and the value is the criteria for
|
| - * that column.
|
| - */
|
| + /// The criteria for showing/hiding values per column.
|
| + /// The map's key is the column index, and the value is the criteria for
|
| + /// that column.
|
| core.Map<core.String, FilterCriteria> criteria;
|
| - /** The range the filter covers. */
|
| +
|
| + /// The range the filter covers.
|
| GridRange range;
|
| - /**
|
| - * The sort order per column. Later specifications are used when values
|
| - * are equal in the earlier specifications.
|
| - */
|
| +
|
| + /// The sort order per column. Later specifications are used when values
|
| + /// are equal in the earlier specifications.
|
| core.List<SortSpec> sortSpecs;
|
|
|
| BasicFilter();
|
|
|
| BasicFilter.fromJson(core.Map _json) {
|
| if (_json.containsKey("criteria")) {
|
| - criteria = commons.mapMap<core.Map<core.String, core.Object>, FilterCriteria>(_json["criteria"], (core.Map<core.String, core.Object> item) => new FilterCriteria.fromJson(item));
|
| + criteria =
|
| + commons.mapMap<core.Map<core.String, core.Object>, FilterCriteria>(
|
| + _json["criteria"],
|
| + (core.Map<core.String, core.Object> item) =>
|
| + new FilterCriteria.fromJson(item));
|
| }
|
| if (_json.containsKey("range")) {
|
| range = new GridRange.fromJson(_json["range"]);
|
| }
|
| if (_json.containsKey("sortSpecs")) {
|
| - sortSpecs = _json["sortSpecs"].map((value) => new SortSpec.fromJson(value)).toList();
|
| + sortSpecs = _json["sortSpecs"]
|
| + .map((value) => new SortSpec.fromJson(value))
|
| + .toList();
|
| }
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (criteria != null) {
|
| - _json["criteria"] = commons.mapMap<FilterCriteria, core.Map<core.String, core.Object>>(criteria, (FilterCriteria item) => (item).toJson());
|
| + _json["criteria"] =
|
| + commons.mapMap<FilterCriteria, core.Map<core.String, core.Object>>(
|
| + criteria, (FilterCriteria item) => (item).toJson());
|
| }
|
| if (range != null) {
|
| _json["range"] = (range).toJson();
|
| @@ -1863,9 +1886,9 @@ class BasicFilter {
|
| }
|
| }
|
|
|
| -/** The request for clearing more than one range of values in a spreadsheet. */
|
| +/// The request for clearing more than one range of values in a spreadsheet.
|
| class BatchClearValuesRequest {
|
| - /** The ranges to clear, in A1 notation. */
|
| + /// The ranges to clear, in A1 notation.
|
| core.List<core.String> ranges;
|
|
|
| BatchClearValuesRequest();
|
| @@ -1877,7 +1900,8 @@ class BatchClearValuesRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (ranges != null) {
|
| _json["ranges"] = ranges;
|
| }
|
| @@ -1885,16 +1909,15 @@ class BatchClearValuesRequest {
|
| }
|
| }
|
|
|
| -/** The response when clearing a range of values in a spreadsheet. */
|
| +/// The response when clearing a range of values in a spreadsheet.
|
| class BatchClearValuesResponse {
|
| - /**
|
| - * The ranges that were cleared, in A1 notation.
|
| - * (If the requests were for an unbounded range or a ranger larger
|
| - * than the bounds of the sheet, this will be the actual ranges
|
| - * that were cleared, bounded to the sheet's limits.)
|
| - */
|
| + /// The ranges that were cleared, in A1 notation.
|
| + /// (If the requests were for an unbounded range or a ranger larger
|
| + /// than the bounds of the sheet, this will be the actual ranges
|
| + /// that were cleared, bounded to the sheet's limits.)
|
| core.List<core.String> clearedRanges;
|
| - /** The spreadsheet the updates were applied to. */
|
| +
|
| + /// The spreadsheet the updates were applied to.
|
| core.String spreadsheetId;
|
|
|
| BatchClearValuesResponse();
|
| @@ -1909,7 +1932,8 @@ class BatchClearValuesResponse {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (clearedRanges != null) {
|
| _json["clearedRanges"] = clearedRanges;
|
| }
|
| @@ -1920,16 +1944,14 @@ class BatchClearValuesResponse {
|
| }
|
| }
|
|
|
| -/**
|
| - * The response when retrieving more than one range of values in a spreadsheet.
|
| - */
|
| +/// The response when retrieving more than one range of values in a
|
| +/// spreadsheet.
|
| class BatchGetValuesResponse {
|
| - /** The ID of the spreadsheet the data was retrieved from. */
|
| + /// The ID of the spreadsheet the data was retrieved from.
|
| core.String spreadsheetId;
|
| - /**
|
| - * The requested values. The order of the ValueRanges is the same as the
|
| - * order of the requested ranges.
|
| - */
|
| +
|
| + /// The requested values. The order of the ValueRanges is the same as the
|
| + /// order of the requested ranges.
|
| core.List<ValueRange> valueRanges;
|
|
|
| BatchGetValuesResponse();
|
| @@ -1939,45 +1961,44 @@ class BatchGetValuesResponse {
|
| spreadsheetId = _json["spreadsheetId"];
|
| }
|
| if (_json.containsKey("valueRanges")) {
|
| - valueRanges = _json["valueRanges"].map((value) => new ValueRange.fromJson(value)).toList();
|
| + valueRanges = _json["valueRanges"]
|
| + .map((value) => new ValueRange.fromJson(value))
|
| + .toList();
|
| }
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (spreadsheetId != null) {
|
| _json["spreadsheetId"] = spreadsheetId;
|
| }
|
| if (valueRanges != null) {
|
| - _json["valueRanges"] = valueRanges.map((value) => (value).toJson()).toList();
|
| + _json["valueRanges"] =
|
| + valueRanges.map((value) => (value).toJson()).toList();
|
| }
|
| return _json;
|
| }
|
| }
|
|
|
| -/** The request for updating any aspect of a spreadsheet. */
|
| +/// The request for updating any aspect of a spreadsheet.
|
| class BatchUpdateSpreadsheetRequest {
|
| - /**
|
| - * Determines if the update response should include the spreadsheet
|
| - * resource.
|
| - */
|
| + /// Determines if the update response should include the spreadsheet
|
| + /// resource.
|
| core.bool includeSpreadsheetInResponse;
|
| - /**
|
| - * A list of updates to apply to the spreadsheet.
|
| - * Requests will be applied in the order they are specified.
|
| - * If any request is not valid, no requests will be applied.
|
| - */
|
| +
|
| + /// A list of updates to apply to the spreadsheet.
|
| + /// Requests will be applied in the order they are specified.
|
| + /// If any request is not valid, no requests will be applied.
|
| core.List<Request> requests;
|
| - /**
|
| - * True if grid data should be returned. Meaningful only if
|
| - * if include_spreadsheet_response is 'true'.
|
| - * This parameter is ignored if a field mask was set in the request.
|
| - */
|
| +
|
| + /// True if grid data should be returned. Meaningful only if
|
| + /// if include_spreadsheet_response is 'true'.
|
| + /// This parameter is ignored if a field mask was set in the request.
|
| core.bool responseIncludeGridData;
|
| - /**
|
| - * Limits the ranges included in the response spreadsheet.
|
| - * Meaningful only if include_spreadsheet_response is 'true'.
|
| - */
|
| +
|
| + /// Limits the ranges included in the response spreadsheet.
|
| + /// Meaningful only if include_spreadsheet_response is 'true'.
|
| core.List<core.String> responseRanges;
|
|
|
| BatchUpdateSpreadsheetRequest();
|
| @@ -1987,7 +2008,9 @@ class BatchUpdateSpreadsheetRequest {
|
| includeSpreadsheetInResponse = _json["includeSpreadsheetInResponse"];
|
| }
|
| if (_json.containsKey("requests")) {
|
| - requests = _json["requests"].map((value) => new Request.fromJson(value)).toList();
|
| + requests = _json["requests"]
|
| + .map((value) => new Request.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("responseIncludeGridData")) {
|
| responseIncludeGridData = _json["responseIncludeGridData"];
|
| @@ -1998,7 +2021,8 @@ class BatchUpdateSpreadsheetRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (includeSpreadsheetInResponse != null) {
|
| _json["includeSpreadsheetInResponse"] = includeSpreadsheetInResponse;
|
| }
|
| @@ -2015,37 +2039,40 @@ class BatchUpdateSpreadsheetRequest {
|
| }
|
| }
|
|
|
| -/** The reply for batch updating a spreadsheet. */
|
| +/// The reply for batch updating a spreadsheet.
|
| class BatchUpdateSpreadsheetResponse {
|
| - /**
|
| - * The reply of the updates. This maps 1:1 with the updates, although
|
| - * replies to some requests may be empty.
|
| - */
|
| + /// The reply of the updates. This maps 1:1 with the updates, although
|
| + /// replies to some requests may be empty.
|
| core.List<Response> replies;
|
| - /** The spreadsheet the updates were applied to. */
|
| +
|
| + /// The spreadsheet the updates were applied to.
|
| core.String spreadsheetId;
|
| - /**
|
| - * The spreadsheet after updates were applied. This is only set if
|
| - * [BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is `true`.
|
| - */
|
| +
|
| + /// The spreadsheet after updates were applied. This is only set if
|
| + /// [BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is
|
| + /// `true`.
|
| Spreadsheet updatedSpreadsheet;
|
|
|
| BatchUpdateSpreadsheetResponse();
|
|
|
| BatchUpdateSpreadsheetResponse.fromJson(core.Map _json) {
|
| if (_json.containsKey("replies")) {
|
| - replies = _json["replies"].map((value) => new Response.fromJson(value)).toList();
|
| + replies = _json["replies"]
|
| + .map((value) => new Response.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("spreadsheetId")) {
|
| spreadsheetId = _json["spreadsheetId"];
|
| }
|
| if (_json.containsKey("updatedSpreadsheet")) {
|
| - updatedSpreadsheet = new Spreadsheet.fromJson(_json["updatedSpreadsheet"]);
|
| + updatedSpreadsheet =
|
| + new Spreadsheet.fromJson(_json["updatedSpreadsheet"]);
|
| }
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (replies != null) {
|
| _json["replies"] = replies.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -2059,84 +2086,84 @@ class BatchUpdateSpreadsheetResponse {
|
| }
|
| }
|
|
|
| -/** The request for updating more than one range of values in a spreadsheet. */
|
| +/// The request for updating more than one range of values in a spreadsheet.
|
| class BatchUpdateValuesRequest {
|
| - /** The new values to apply to the spreadsheet. */
|
| + /// The new values to apply to the spreadsheet.
|
| core.List<ValueRange> data;
|
| - /**
|
| - * Determines if the update response should include the values
|
| - * of the cells that were updated. By default, responses
|
| - * do not include the updated values. The `updatedData` field within
|
| - * each of the BatchUpdateValuesResponse.responses will contain
|
| - * the updated values. If the range to write was larger than than the range
|
| - * actually written, the response will include all values in the requested
|
| - * range (excluding trailing empty rows and columns).
|
| - */
|
| +
|
| + /// Determines if the update response should include the values
|
| + /// of the cells that were updated. By default, responses
|
| + /// do not include the updated values. The `updatedData` field within
|
| + /// each of the BatchUpdateValuesResponse.responses will contain
|
| + /// the updated values. If the range to write was larger than than the range
|
| + /// actually written, the response will include all values in the requested
|
| + /// range (excluding trailing empty rows and columns).
|
| core.bool includeValuesInResponse;
|
| - /**
|
| - * Determines how dates, times, and durations in the response should be
|
| - * rendered. This is ignored if response_value_render_option is
|
| - * FORMATTED_VALUE.
|
| - * The default dateTime render option is
|
| - * DateTimeRenderOption.SERIAL_NUMBER.
|
| - * Possible string values are:
|
| - * - "SERIAL_NUMBER" : Instructs date, time, datetime, and duration fields to
|
| - * be output
|
| - * as doubles in "serial number" format, as popularized by Lotus 1-2-3.
|
| - * The whole number portion of the value (left of the decimal) counts
|
| - * the days since December 30th 1899. The fractional portion (right of
|
| - * the decimal) counts the time as a fraction of the day. For example,
|
| - * January 1st 1900 at noon would be 2.5, 2 because it's 2 days after
|
| - * December 30st 1899, and .5 because noon is half a day. February 1st
|
| - * 1900 at 3pm would be 33.625. This correctly treats the year 1900 as
|
| - * not a leap year.
|
| - * - "FORMATTED_STRING" : Instructs date, time, datetime, and duration fields
|
| - * to be output
|
| - * as strings in their given number format (which is dependent
|
| - * on the spreadsheet locale).
|
| - */
|
| +
|
| + /// Determines how dates, times, and durations in the response should be
|
| + /// rendered. This is ignored if response_value_render_option is
|
| + /// FORMATTED_VALUE.
|
| + /// The default dateTime render option is
|
| + /// DateTimeRenderOption.SERIAL_NUMBER.
|
| + /// Possible string values are:
|
| + /// - "SERIAL_NUMBER" : Instructs date, time, datetime, and duration fields
|
| + /// to be output
|
| + /// as doubles in "serial number" format, as popularized by Lotus 1-2-3.
|
| + /// The whole number portion of the value (left of the decimal) counts
|
| + /// the days since December 30th 1899. The fractional portion (right of
|
| + /// the decimal) counts the time as a fraction of the day. For example,
|
| + /// January 1st 1900 at noon would be 2.5, 2 because it's 2 days after
|
| + /// December 30st 1899, and .5 because noon is half a day. February 1st
|
| + /// 1900 at 3pm would be 33.625. This correctly treats the year 1900 as
|
| + /// not a leap year.
|
| + /// - "FORMATTED_STRING" : Instructs date, time, datetime, and duration
|
| + /// fields to be output
|
| + /// as strings in their given number format (which is dependent
|
| + /// on the spreadsheet locale).
|
| core.String responseDateTimeRenderOption;
|
| - /**
|
| - * Determines how values in the response should be rendered.
|
| - * The default render option is ValueRenderOption.FORMATTED_VALUE.
|
| - * Possible string values are:
|
| - * - "FORMATTED_VALUE" : Values will be calculated & formatted in the reply
|
| - * according to the
|
| - * cell's formatting. Formatting is based on the spreadsheet's locale,
|
| - * not the requesting user's locale.
|
| - * For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,
|
| - * then `A2` would return `"$1.23"`.
|
| - * - "UNFORMATTED_VALUE" : Values will be calculated, but not formatted in the
|
| - * reply.
|
| - * For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,
|
| - * then `A2` would return the number `1.23`.
|
| - * - "FORMULA" : Values will not be calculated. The reply will include the
|
| - * formulas.
|
| - * For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,
|
| - * then A2 would return `"=A1"`.
|
| - */
|
| +
|
| + /// Determines how values in the response should be rendered.
|
| + /// The default render option is ValueRenderOption.FORMATTED_VALUE.
|
| + /// Possible string values are:
|
| + /// - "FORMATTED_VALUE" : Values will be calculated & formatted in the reply
|
| + /// according to the
|
| + /// cell's formatting. Formatting is based on the spreadsheet's locale,
|
| + /// not the requesting user's locale.
|
| + /// For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as
|
| + /// currency,
|
| + /// then `A2` would return `"$1.23"`.
|
| + /// - "UNFORMATTED_VALUE" : Values will be calculated, but not formatted in
|
| + /// the reply.
|
| + /// For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as
|
| + /// currency,
|
| + /// then `A2` would return the number `1.23`.
|
| + /// - "FORMULA" : Values will not be calculated. The reply will include the
|
| + /// formulas.
|
| + /// For example, if `A1` is `1.23` and `A2` is `=A1` and formatted as
|
| + /// currency,
|
| + /// then A2 would return `"=A1"`.
|
| core.String responseValueRenderOption;
|
| - /**
|
| - * How the input data should be interpreted.
|
| - * Possible string values are:
|
| - * - "INPUT_VALUE_OPTION_UNSPECIFIED" : Default input value. This value must
|
| - * not be used.
|
| - * - "RAW" : The values the user has entered will not be parsed and will be
|
| - * stored
|
| - * as-is.
|
| - * - "USER_ENTERED" : The values will be parsed as if the user typed them into
|
| - * the UI.
|
| - * Numbers will stay as numbers, but strings may be converted to numbers,
|
| - * dates, etc. following the same rules that are applied when entering
|
| - * text into a cell via the Google Sheets UI.
|
| - */
|
| +
|
| + /// How the input data should be interpreted.
|
| + /// Possible string values are:
|
| + /// - "INPUT_VALUE_OPTION_UNSPECIFIED" : Default input value. This value must
|
| + /// not be used.
|
| + /// - "RAW" : The values the user has entered will not be parsed and will be
|
| + /// stored
|
| + /// as-is.
|
| + /// - "USER_ENTERED" : The values will be parsed as if the user typed them
|
| + /// into the UI.
|
| + /// Numbers will stay as numbers, but strings may be converted to numbers,
|
| + /// dates, etc. following the same rules that are applied when entering
|
| + /// text into a cell via the Google Sheets UI.
|
| core.String valueInputOption;
|
|
|
| BatchUpdateValuesRequest();
|
|
|
| BatchUpdateValuesRequest.fromJson(core.Map _json) {
|
| if (_json.containsKey("data")) {
|
| - data = _json["data"].map((value) => new ValueRange.fromJson(value)).toList();
|
| + data =
|
| + _json["data"].map((value) => new ValueRange.fromJson(value)).toList();
|
| }
|
| if (_json.containsKey("includeValuesInResponse")) {
|
| includeValuesInResponse = _json["includeValuesInResponse"];
|
| @@ -2153,7 +2180,8 @@ class BatchUpdateValuesRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (data != null) {
|
| _json["data"] = data.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -2173,37 +2201,36 @@ class BatchUpdateValuesRequest {
|
| }
|
| }
|
|
|
| -/** The response when updating a range of values in a spreadsheet. */
|
| +/// The response when updating a range of values in a spreadsheet.
|
| class BatchUpdateValuesResponse {
|
| - /**
|
| - * One UpdateValuesResponse per requested range, in the same order as
|
| - * the requests appeared.
|
| - */
|
| + /// One UpdateValuesResponse per requested range, in the same order as
|
| + /// the requests appeared.
|
| core.List<UpdateValuesResponse> responses;
|
| - /** The spreadsheet the updates were applied to. */
|
| +
|
| + /// The spreadsheet the updates were applied to.
|
| core.String spreadsheetId;
|
| - /** The total number of cells updated. */
|
| +
|
| + /// The total number of cells updated.
|
| core.int totalUpdatedCells;
|
| - /**
|
| - * The total number of columns where at least one cell in the column was
|
| - * updated.
|
| - */
|
| +
|
| + /// The total number of columns where at least one cell in the column was
|
| + /// updated.
|
| core.int totalUpdatedColumns;
|
| - /**
|
| - * The total number of rows where at least one cell in the row was updated.
|
| - */
|
| +
|
| + /// The total number of rows where at least one cell in the row was updated.
|
| core.int totalUpdatedRows;
|
| - /**
|
| - * The total number of sheets where at least one cell in the sheet was
|
| - * updated.
|
| - */
|
| +
|
| + /// The total number of sheets where at least one cell in the sheet was
|
| + /// updated.
|
| core.int totalUpdatedSheets;
|
|
|
| BatchUpdateValuesResponse();
|
|
|
| BatchUpdateValuesResponse.fromJson(core.Map _json) {
|
| if (_json.containsKey("responses")) {
|
| - responses = _json["responses"].map((value) => new UpdateValuesResponse.fromJson(value)).toList();
|
| + responses = _json["responses"]
|
| + .map((value) => new UpdateValuesResponse.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("spreadsheetId")) {
|
| spreadsheetId = _json["spreadsheetId"];
|
| @@ -2223,7 +2250,8 @@ class BatchUpdateValuesResponse {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (responses != null) {
|
| _json["responses"] = responses.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -2246,131 +2274,128 @@ class BatchUpdateValuesResponse {
|
| }
|
| }
|
|
|
| -/**
|
| - * A condition that can evaluate to true or false.
|
| - * BooleanConditions are used by conditional formatting,
|
| - * data validation, and the criteria in filters.
|
| - */
|
| +/// A condition that can evaluate to true or false.
|
| +/// BooleanConditions are used by conditional formatting,
|
| +/// data validation, and the criteria in filters.
|
| class BooleanCondition {
|
| - /**
|
| - * The type of condition.
|
| - * Possible string values are:
|
| - * - "CONDITION_TYPE_UNSPECIFIED" : The default value, do not use.
|
| - * - "NUMBER_GREATER" : The cell's value must be greater than the condition's
|
| - * value.
|
| - * Supported by data validation, conditional formatting and filters.
|
| - * Requires a single ConditionValue.
|
| - * - "NUMBER_GREATER_THAN_EQ" : The cell's value must be greater than or equal
|
| - * to the condition's value.
|
| - * Supported by data validation, conditional formatting and filters.
|
| - * Requires a single ConditionValue.
|
| - * - "NUMBER_LESS" : The cell's value must be less than the condition's value.
|
| - * Supported by data validation, conditional formatting and filters.
|
| - * Requires a single ConditionValue.
|
| - * - "NUMBER_LESS_THAN_EQ" : The cell's value must be less than or equal to
|
| - * the condition's value.
|
| - * Supported by data validation, conditional formatting and filters.
|
| - * Requires a single ConditionValue.
|
| - * - "NUMBER_EQ" : The cell's value must be equal to the condition's value.
|
| - * Supported by data validation, conditional formatting and filters.
|
| - * Requires a single ConditionValue.
|
| - * - "NUMBER_NOT_EQ" : The cell's value must be not equal to the condition's
|
| - * value.
|
| - * Supported by data validation, conditional formatting and filters.
|
| - * Requires a single ConditionValue.
|
| - * - "NUMBER_BETWEEN" : The cell's value must be between the two condition
|
| - * values.
|
| - * Supported by data validation, conditional formatting and filters.
|
| - * Requires exactly two ConditionValues.
|
| - * - "NUMBER_NOT_BETWEEN" : The cell's value must not be between the two
|
| - * condition values.
|
| - * Supported by data validation, conditional formatting and filters.
|
| - * Requires exactly two ConditionValues.
|
| - * - "TEXT_CONTAINS" : The cell's value must contain the condition's value.
|
| - * Supported by data validation, conditional formatting and filters.
|
| - * Requires a single ConditionValue.
|
| - * - "TEXT_NOT_CONTAINS" : The cell's value must not contain the condition's
|
| - * value.
|
| - * Supported by data validation, conditional formatting and filters.
|
| - * Requires a single ConditionValue.
|
| - * - "TEXT_STARTS_WITH" : The cell's value must start with the condition's
|
| - * value.
|
| - * Supported by conditional formatting and filters.
|
| - * Requires a single ConditionValue.
|
| - * - "TEXT_ENDS_WITH" : The cell's value must end with the condition's value.
|
| - * Supported by conditional formatting and filters.
|
| - * Requires a single ConditionValue.
|
| - * - "TEXT_EQ" : The cell's value must be exactly the condition's value.
|
| - * Supported by data validation, conditional formatting and filters.
|
| - * Requires a single ConditionValue.
|
| - * - "TEXT_IS_EMAIL" : The cell's value must be a valid email address.
|
| - * Supported by data validation.
|
| - * Requires no ConditionValues.
|
| - * - "TEXT_IS_URL" : The cell's value must be a valid URL.
|
| - * Supported by data validation.
|
| - * Requires no ConditionValues.
|
| - * - "DATE_EQ" : The cell's value must be the same date as the condition's
|
| - * value.
|
| - * Supported by data validation, conditional formatting and filters.
|
| - * Requires a single ConditionValue.
|
| - * - "DATE_BEFORE" : The cell's value must be before the date of the
|
| - * condition's value.
|
| - * Supported by data validation, conditional formatting and filters.
|
| - * Requires a single ConditionValue
|
| - * that may be a relative date.
|
| - * - "DATE_AFTER" : The cell's value must be after the date of the condition's
|
| - * value.
|
| - * Supported by data validation, conditional formatting and filters.
|
| - * Requires a single ConditionValue
|
| - * that may be a relative date.
|
| - * - "DATE_ON_OR_BEFORE" : The cell's value must be on or before the date of
|
| - * the condition's value.
|
| - * Supported by data validation.
|
| - * Requires a single ConditionValue
|
| - * that may be a relative date.
|
| - * - "DATE_ON_OR_AFTER" : The cell's value must be on or after the date of the
|
| - * condition's value.
|
| - * Supported by data validation.
|
| - * Requires a single ConditionValue
|
| - * that may be a relative date.
|
| - * - "DATE_BETWEEN" : The cell's value must be between the dates of the two
|
| - * condition values.
|
| - * Supported by data validation.
|
| - * Requires exactly two ConditionValues.
|
| - * - "DATE_NOT_BETWEEN" : The cell's value must be outside the dates of the
|
| - * two condition values.
|
| - * Supported by data validation.
|
| - * Requires exactly two ConditionValues.
|
| - * - "DATE_IS_VALID" : The cell's value must be a date.
|
| - * Supported by data validation.
|
| - * Requires no ConditionValues.
|
| - * - "ONE_OF_RANGE" : The cell's value must be listed in the grid in condition
|
| - * value's range.
|
| - * Supported by data validation.
|
| - * Requires a single ConditionValue,
|
| - * and the value must be a valid range in A1 notation.
|
| - * - "ONE_OF_LIST" : The cell's value must in the list of condition values.
|
| - * Supported by data validation.
|
| - * Supports any number of condition values,
|
| - * one per item in the list.
|
| - * Formulas are not supported in the values.
|
| - * - "BLANK" : The cell's value must be empty.
|
| - * Supported by conditional formatting and filters.
|
| - * Requires no ConditionValues.
|
| - * - "NOT_BLANK" : The cell's value must not be empty.
|
| - * Supported by conditional formatting and filters.
|
| - * Requires no ConditionValues.
|
| - * - "CUSTOM_FORMULA" : The condition's formula must evaluate to true.
|
| - * Supported by data validation, conditional formatting and filters.
|
| - * Requires a single ConditionValue.
|
| - */
|
| + /// The type of condition.
|
| + /// Possible string values are:
|
| + /// - "CONDITION_TYPE_UNSPECIFIED" : The default value, do not use.
|
| + /// - "NUMBER_GREATER" : The cell's value must be greater than the
|
| + /// condition's value.
|
| + /// Supported by data validation, conditional formatting and filters.
|
| + /// Requires a single ConditionValue.
|
| + /// - "NUMBER_GREATER_THAN_EQ" : The cell's value must be greater than or
|
| + /// equal to the condition's value.
|
| + /// Supported by data validation, conditional formatting and filters.
|
| + /// Requires a single ConditionValue.
|
| + /// - "NUMBER_LESS" : The cell's value must be less than the condition's
|
| + /// value.
|
| + /// Supported by data validation, conditional formatting and filters.
|
| + /// Requires a single ConditionValue.
|
| + /// - "NUMBER_LESS_THAN_EQ" : The cell's value must be less than or equal to
|
| + /// the condition's value.
|
| + /// Supported by data validation, conditional formatting and filters.
|
| + /// Requires a single ConditionValue.
|
| + /// - "NUMBER_EQ" : The cell's value must be equal to the condition's value.
|
| + /// Supported by data validation, conditional formatting and filters.
|
| + /// Requires a single ConditionValue.
|
| + /// - "NUMBER_NOT_EQ" : The cell's value must be not equal to the condition's
|
| + /// value.
|
| + /// Supported by data validation, conditional formatting and filters.
|
| + /// Requires a single ConditionValue.
|
| + /// - "NUMBER_BETWEEN" : The cell's value must be between the two condition
|
| + /// values.
|
| + /// Supported by data validation, conditional formatting and filters.
|
| + /// Requires exactly two ConditionValues.
|
| + /// - "NUMBER_NOT_BETWEEN" : The cell's value must not be between the two
|
| + /// condition values.
|
| + /// Supported by data validation, conditional formatting and filters.
|
| + /// Requires exactly two ConditionValues.
|
| + /// - "TEXT_CONTAINS" : The cell's value must contain the condition's value.
|
| + /// Supported by data validation, conditional formatting and filters.
|
| + /// Requires a single ConditionValue.
|
| + /// - "TEXT_NOT_CONTAINS" : The cell's value must not contain the condition's
|
| + /// value.
|
| + /// Supported by data validation, conditional formatting and filters.
|
| + /// Requires a single ConditionValue.
|
| + /// - "TEXT_STARTS_WITH" : The cell's value must start with the condition's
|
| + /// value.
|
| + /// Supported by conditional formatting and filters.
|
| + /// Requires a single ConditionValue.
|
| + /// - "TEXT_ENDS_WITH" : The cell's value must end with the condition's
|
| + /// value.
|
| + /// Supported by conditional formatting and filters.
|
| + /// Requires a single ConditionValue.
|
| + /// - "TEXT_EQ" : The cell's value must be exactly the condition's value.
|
| + /// Supported by data validation, conditional formatting and filters.
|
| + /// Requires a single ConditionValue.
|
| + /// - "TEXT_IS_EMAIL" : The cell's value must be a valid email address.
|
| + /// Supported by data validation.
|
| + /// Requires no ConditionValues.
|
| + /// - "TEXT_IS_URL" : The cell's value must be a valid URL.
|
| + /// Supported by data validation.
|
| + /// Requires no ConditionValues.
|
| + /// - "DATE_EQ" : The cell's value must be the same date as the condition's
|
| + /// value.
|
| + /// Supported by data validation, conditional formatting and filters.
|
| + /// Requires a single ConditionValue.
|
| + /// - "DATE_BEFORE" : The cell's value must be before the date of the
|
| + /// condition's value.
|
| + /// Supported by data validation, conditional formatting and filters.
|
| + /// Requires a single ConditionValue
|
| + /// that may be a relative date.
|
| + /// - "DATE_AFTER" : The cell's value must be after the date of the
|
| + /// condition's value.
|
| + /// Supported by data validation, conditional formatting and filters.
|
| + /// Requires a single ConditionValue
|
| + /// that may be a relative date.
|
| + /// - "DATE_ON_OR_BEFORE" : The cell's value must be on or before the date of
|
| + /// the condition's value.
|
| + /// Supported by data validation.
|
| + /// Requires a single ConditionValue
|
| + /// that may be a relative date.
|
| + /// - "DATE_ON_OR_AFTER" : The cell's value must be on or after the date of
|
| + /// the condition's value.
|
| + /// Supported by data validation.
|
| + /// Requires a single ConditionValue
|
| + /// that may be a relative date.
|
| + /// - "DATE_BETWEEN" : The cell's value must be between the dates of the two
|
| + /// condition values.
|
| + /// Supported by data validation.
|
| + /// Requires exactly two ConditionValues.
|
| + /// - "DATE_NOT_BETWEEN" : The cell's value must be outside the dates of the
|
| + /// two condition values.
|
| + /// Supported by data validation.
|
| + /// Requires exactly two ConditionValues.
|
| + /// - "DATE_IS_VALID" : The cell's value must be a date.
|
| + /// Supported by data validation.
|
| + /// Requires no ConditionValues.
|
| + /// - "ONE_OF_RANGE" : The cell's value must be listed in the grid in
|
| + /// condition value's range.
|
| + /// Supported by data validation.
|
| + /// Requires a single ConditionValue,
|
| + /// and the value must be a valid range in A1 notation.
|
| + /// - "ONE_OF_LIST" : The cell's value must in the list of condition values.
|
| + /// Supported by data validation.
|
| + /// Supports any number of condition values,
|
| + /// one per item in the list.
|
| + /// Formulas are not supported in the values.
|
| + /// - "BLANK" : The cell's value must be empty.
|
| + /// Supported by conditional formatting and filters.
|
| + /// Requires no ConditionValues.
|
| + /// - "NOT_BLANK" : The cell's value must not be empty.
|
| + /// Supported by conditional formatting and filters.
|
| + /// Requires no ConditionValues.
|
| + /// - "CUSTOM_FORMULA" : The condition's formula must evaluate to true.
|
| + /// Supported by data validation, conditional formatting and filters.
|
| + /// Requires a single ConditionValue.
|
| core.String type;
|
| - /**
|
| - * The values of the condition. The number of supported values depends
|
| - * on the condition type. Some support zero values,
|
| - * others one or two values,
|
| - * and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
|
| - */
|
| +
|
| + /// The values of the condition. The number of supported values depends
|
| + /// on the condition type. Some support zero values,
|
| + /// others one or two values,
|
| + /// and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
|
| core.List<ConditionValue> values;
|
|
|
| BooleanCondition();
|
| @@ -2380,12 +2405,15 @@ class BooleanCondition {
|
| type = _json["type"];
|
| }
|
| if (_json.containsKey("values")) {
|
| - values = _json["values"].map((value) => new ConditionValue.fromJson(value)).toList();
|
| + values = _json["values"]
|
| + .map((value) => new ConditionValue.fromJson(value))
|
| + .toList();
|
| }
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (type != null) {
|
| _json["type"] = type;
|
| }
|
| @@ -2396,21 +2424,18 @@ class BooleanCondition {
|
| }
|
| }
|
|
|
| -/** A rule that may or may not match, depending on the condition. */
|
| +/// A rule that may or may not match, depending on the condition.
|
| class BooleanRule {
|
| - /**
|
| - * The condition of the rule. If the condition evaluates to true,
|
| - * the format will be applied.
|
| - */
|
| + /// The condition of the rule. If the condition evaluates to true,
|
| + /// the format will be applied.
|
| BooleanCondition condition;
|
| - /**
|
| - * The format to apply.
|
| - * Conditional formatting can only apply a subset of formatting:
|
| - * bold, italic,
|
| - * strikethrough,
|
| - * foreground color &
|
| - * background color.
|
| - */
|
| +
|
| + /// The format to apply.
|
| + /// Conditional formatting can only apply a subset of formatting:
|
| + /// bold, italic,
|
| + /// strikethrough,
|
| + /// foreground color &
|
| + /// background color.
|
| CellFormat format;
|
|
|
| BooleanRule();
|
| @@ -2425,7 +2450,8 @@ class BooleanRule {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (condition != null) {
|
| _json["condition"] = (condition).toJson();
|
| }
|
| @@ -2436,28 +2462,26 @@ class BooleanRule {
|
| }
|
| }
|
|
|
| -/** A border along a cell. */
|
| +/// A border along a cell.
|
| class Border {
|
| - /** The color of the border. */
|
| + /// The color of the border.
|
| Color color;
|
| - /**
|
| - * The style of the border.
|
| - * Possible string values are:
|
| - * - "STYLE_UNSPECIFIED" : The style is not specified. Do not use this.
|
| - * - "DOTTED" : The border is dotted.
|
| - * - "DASHED" : The border is dashed.
|
| - * - "SOLID" : The border is a thin solid line.
|
| - * - "SOLID_MEDIUM" : The border is a medium solid line.
|
| - * - "SOLID_THICK" : The border is a thick solid line.
|
| - * - "NONE" : No border.
|
| - * Used only when updating a border in order to erase it.
|
| - * - "DOUBLE" : The border is two solid lines.
|
| - */
|
| +
|
| + /// The style of the border.
|
| + /// Possible string values are:
|
| + /// - "STYLE_UNSPECIFIED" : The style is not specified. Do not use this.
|
| + /// - "DOTTED" : The border is dotted.
|
| + /// - "DASHED" : The border is dashed.
|
| + /// - "SOLID" : The border is a thin solid line.
|
| + /// - "SOLID_MEDIUM" : The border is a medium solid line.
|
| + /// - "SOLID_THICK" : The border is a thick solid line.
|
| + /// - "NONE" : No border.
|
| + /// Used only when updating a border in order to erase it.
|
| + /// - "DOUBLE" : The border is two solid lines.
|
| core.String style;
|
| - /**
|
| - * The width of the border, in pixels.
|
| - * Deprecated; the width is determined by the "style" field.
|
| - */
|
| +
|
| + /// The width of the border, in pixels.
|
| + /// Deprecated; the width is determined by the "style" field.
|
| core.int width;
|
|
|
| Border();
|
| @@ -2475,7 +2499,8 @@ class Border {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (color != null) {
|
| _json["color"] = (color).toJson();
|
| }
|
| @@ -2489,15 +2514,18 @@ class Border {
|
| }
|
| }
|
|
|
| -/** The borders of the cell. */
|
| +/// The borders of the cell.
|
| class Borders {
|
| - /** The bottom border of the cell. */
|
| + /// The bottom border of the cell.
|
| Border bottom;
|
| - /** The left border of the cell. */
|
| +
|
| + /// The left border of the cell.
|
| Border left;
|
| - /** The right border of the cell. */
|
| +
|
| + /// The right border of the cell.
|
| Border right;
|
| - /** The top border of the cell. */
|
| +
|
| + /// The top border of the cell.
|
| Border top;
|
|
|
| Borders();
|
| @@ -2518,7 +2546,8 @@ class Borders {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (bottom != null) {
|
| _json["bottom"] = (bottom).toJson();
|
| }
|
| @@ -2535,71 +2564,59 @@ class Borders {
|
| }
|
| }
|
|
|
| -/**
|
| - * A <a href="/chart/interactive/docs/gallery/bubblechart">bubble chart</a>.
|
| - */
|
| +/// A <a href="/chart/interactive/docs/gallery/bubblechart">bubble chart</a>.
|
| class BubbleChartSpec {
|
| - /** The bubble border color. */
|
| + /// The bubble border color.
|
| Color bubbleBorderColor;
|
| - /**
|
| - * The data containing the bubble labels. These do not need to be unique.
|
| - */
|
| +
|
| + /// The data containing the bubble labels. These do not need to be unique.
|
| ChartData bubbleLabels;
|
| - /**
|
| - * The max radius size of the bubbles, in pixels.
|
| - * If specified, the field must be a positive value.
|
| - */
|
| +
|
| + /// The max radius size of the bubbles, in pixels.
|
| + /// If specified, the field must be a positive value.
|
| core.int bubbleMaxRadiusSize;
|
| - /**
|
| - * The minimum radius size of the bubbles, in pixels.
|
| - * If specific, the field must be a positive value.
|
| - */
|
| +
|
| + /// The minimum radius size of the bubbles, in pixels.
|
| + /// If specific, the field must be a positive value.
|
| core.int bubbleMinRadiusSize;
|
| - /**
|
| - * The opacity of the bubbles between 0 and 1.0.
|
| - * 0 is fully transparent and 1 is fully opaque.
|
| - */
|
| +
|
| + /// The opacity of the bubbles between 0 and 1.0.
|
| + /// 0 is fully transparent and 1 is fully opaque.
|
| core.double bubbleOpacity;
|
| - /**
|
| - * The data contianing the bubble sizes. Bubble sizes are used to draw
|
| - * the bubbles at different sizes relative to each other.
|
| - * If specified, group_ids must also be specified. This field is
|
| - * optional.
|
| - */
|
| +
|
| + /// The data contianing the bubble sizes. Bubble sizes are used to draw
|
| + /// the bubbles at different sizes relative to each other.
|
| + /// If specified, group_ids must also be specified. This field is
|
| + /// optional.
|
| ChartData bubbleSizes;
|
| - /**
|
| - * The format of the text inside the bubbles.
|
| - * Underline and Strikethrough are not supported.
|
| - */
|
| +
|
| + /// The format of the text inside the bubbles.
|
| + /// Underline and Strikethrough are not supported.
|
| TextFormat bubbleTextStyle;
|
| - /**
|
| - * The data containing the bubble x-values. These values locate the bubbles
|
| - * in the chart horizontally.
|
| - */
|
| +
|
| + /// The data containing the bubble x-values. These values locate the bubbles
|
| + /// in the chart horizontally.
|
| ChartData domain;
|
| - /**
|
| - * The data containing the bubble group IDs. All bubbles with the same group
|
| - * ID will be drawn in the same color. If bubble_sizes is specified then
|
| - * this field must also be specified but may contain blank values.
|
| - * This field is optional.
|
| - */
|
| +
|
| + /// The data containing the bubble group IDs. All bubbles with the same group
|
| + /// ID will be drawn in the same color. If bubble_sizes is specified then
|
| + /// this field must also be specified but may contain blank values.
|
| + /// This field is optional.
|
| ChartData groupIds;
|
| - /**
|
| - * Where the legend of the chart should be drawn.
|
| - * Possible string values are:
|
| - * - "BUBBLE_CHART_LEGEND_POSITION_UNSPECIFIED" : Default value, do not use.
|
| - * - "BOTTOM_LEGEND" : The legend is rendered on the bottom of the chart.
|
| - * - "LEFT_LEGEND" : The legend is rendered on the left of the chart.
|
| - * - "RIGHT_LEGEND" : The legend is rendered on the right of the chart.
|
| - * - "TOP_LEGEND" : The legend is rendered on the top of the chart.
|
| - * - "NO_LEGEND" : No legend is rendered.
|
| - * - "INSIDE_LEGEND" : The legend is rendered inside the chart area.
|
| - */
|
| +
|
| + /// Where the legend of the chart should be drawn.
|
| + /// Possible string values are:
|
| + /// - "BUBBLE_CHART_LEGEND_POSITION_UNSPECIFIED" : Default value, do not use.
|
| + /// - "BOTTOM_LEGEND" : The legend is rendered on the bottom of the chart.
|
| + /// - "LEFT_LEGEND" : The legend is rendered on the left of the chart.
|
| + /// - "RIGHT_LEGEND" : The legend is rendered on the right of the chart.
|
| + /// - "TOP_LEGEND" : The legend is rendered on the top of the chart.
|
| + /// - "NO_LEGEND" : No legend is rendered.
|
| + /// - "INSIDE_LEGEND" : The legend is rendered inside the chart area.
|
| core.String legendPosition;
|
| - /**
|
| - * The data contianing the bubble y-values. These values locate the bubbles
|
| - * in the chart vertically.
|
| - */
|
| +
|
| + /// The data contianing the bubble y-values. These values locate the bubbles
|
| + /// in the chart vertically.
|
| ChartData series;
|
|
|
| BubbleChartSpec();
|
| @@ -2641,7 +2658,8 @@ class BubbleChartSpec {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (bubbleBorderColor != null) {
|
| _json["bubbleBorderColor"] = (bubbleBorderColor).toJson();
|
| }
|
| @@ -2679,28 +2697,25 @@ class BubbleChartSpec {
|
| }
|
| }
|
|
|
| -/**
|
| - * A <a href="/chart/interactive/docs/gallery/candlestickchart">candlestick
|
| - * chart</a>.
|
| - */
|
| +/// A <a href="/chart/interactive/docs/gallery/candlestickchart">candlestick
|
| +/// chart</a>.
|
| class CandlestickChartSpec {
|
| - /**
|
| - * The Candlestick chart data.
|
| - * Only one CandlestickData is supported.
|
| - */
|
| + /// The Candlestick chart data.
|
| + /// Only one CandlestickData is supported.
|
| core.List<CandlestickData> data;
|
| - /**
|
| - * The domain data (horizontal axis) for the candlestick chart. String data
|
| - * will be treated as discrete labels, other data will be treated as
|
| - * continuous values.
|
| - */
|
| +
|
| + /// The domain data (horizontal axis) for the candlestick chart. String data
|
| + /// will be treated as discrete labels, other data will be treated as
|
| + /// continuous values.
|
| CandlestickDomain domain;
|
|
|
| CandlestickChartSpec();
|
|
|
| CandlestickChartSpec.fromJson(core.Map _json) {
|
| if (_json.containsKey("data")) {
|
| - data = _json["data"].map((value) => new CandlestickData.fromJson(value)).toList();
|
| + data = _json["data"]
|
| + .map((value) => new CandlestickData.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("domain")) {
|
| domain = new CandlestickDomain.fromJson(_json["domain"]);
|
| @@ -2708,7 +2723,8 @@ class CandlestickChartSpec {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (data != null) {
|
| _json["data"] = data.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -2719,32 +2735,25 @@ class CandlestickChartSpec {
|
| }
|
| }
|
|
|
| -/**
|
| - * The Candlestick chart data, each containing the low, open, close, and high
|
| - * values for a series.
|
| - */
|
| +/// The Candlestick chart data, each containing the low, open, close, and high
|
| +/// values for a series.
|
| class CandlestickData {
|
| - /**
|
| - * The range data (vertical axis) for the close/final value for each candle.
|
| - * This is the top of the candle body. If greater than the open value the
|
| - * candle will be filled. Otherwise the candle will be hollow.
|
| - */
|
| + /// The range data (vertical axis) for the close/final value for each candle.
|
| + /// This is the top of the candle body. If greater than the open value the
|
| + /// candle will be filled. Otherwise the candle will be hollow.
|
| CandlestickSeries closeSeries;
|
| - /**
|
| - * The range data (vertical axis) for the high/maximum value for each
|
| - * candle. This is the top of the candle's center line.
|
| - */
|
| +
|
| + /// The range data (vertical axis) for the high/maximum value for each
|
| + /// candle. This is the top of the candle's center line.
|
| CandlestickSeries highSeries;
|
| - /**
|
| - * The range data (vertical axis) for the low/minimum value for each candle.
|
| - * This is the bottom of the candle's center line.
|
| - */
|
| +
|
| + /// The range data (vertical axis) for the low/minimum value for each candle.
|
| + /// This is the bottom of the candle's center line.
|
| CandlestickSeries lowSeries;
|
| - /**
|
| - * The range data (vertical axis) for the open/initial value for each
|
| - * candle. This is the bottom of the candle body. If less than the close
|
| - * value the candle will be filled. Otherwise the candle will be hollow.
|
| - */
|
| +
|
| + /// The range data (vertical axis) for the open/initial value for each
|
| + /// candle. This is the bottom of the candle body. If less than the close
|
| + /// value the candle will be filled. Otherwise the candle will be hollow.
|
| CandlestickSeries openSeries;
|
|
|
| CandlestickData();
|
| @@ -2765,7 +2774,8 @@ class CandlestickData {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (closeSeries != null) {
|
| _json["closeSeries"] = (closeSeries).toJson();
|
| }
|
| @@ -2782,11 +2792,12 @@ class CandlestickData {
|
| }
|
| }
|
|
|
| -/** The domain of a CandlestickChart. */
|
| +/// The domain of a CandlestickChart.
|
| class CandlestickDomain {
|
| - /** The data of the CandlestickDomain. */
|
| + /// The data of the CandlestickDomain.
|
| ChartData data;
|
| - /** True to reverse the order of the domain values (horizontal axis). */
|
| +
|
| + /// True to reverse the order of the domain values (horizontal axis).
|
| core.bool reversed;
|
|
|
| CandlestickDomain();
|
| @@ -2801,7 +2812,8 @@ class CandlestickDomain {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (data != null) {
|
| _json["data"] = (data).toJson();
|
| }
|
| @@ -2812,9 +2824,9 @@ class CandlestickDomain {
|
| }
|
| }
|
|
|
| -/** The series of a CandlestickData. */
|
| +/// The series of a CandlestickData.
|
| class CandlestickSeries {
|
| - /** The data of the CandlestickSeries. */
|
| + /// The data of the CandlestickSeries.
|
| ChartData data;
|
|
|
| CandlestickSeries();
|
| @@ -2826,7 +2838,8 @@ class CandlestickSeries {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (data != null) {
|
| _json["data"] = (data).toJson();
|
| }
|
| @@ -2834,76 +2847,69 @@ class CandlestickSeries {
|
| }
|
| }
|
|
|
| -/** Data about a specific cell. */
|
| +/// Data about a specific cell.
|
| class CellData {
|
| - /**
|
| - * A data validation rule on the cell, if any.
|
| - *
|
| - * When writing, the new data validation rule will overwrite any prior rule.
|
| - */
|
| + /// A data validation rule on the cell, if any.
|
| + ///
|
| + /// When writing, the new data validation rule will overwrite any prior rule.
|
| DataValidationRule dataValidation;
|
| - /**
|
| - * The effective format being used by the cell.
|
| - * This includes the results of applying any conditional formatting and,
|
| - * if the cell contains a formula, the computed number format.
|
| - * If the effective format is the default format, effective format will
|
| - * not be written.
|
| - * This field is read-only.
|
| - */
|
| +
|
| + /// The effective format being used by the cell.
|
| + /// This includes the results of applying any conditional formatting and,
|
| + /// if the cell contains a formula, the computed number format.
|
| + /// If the effective format is the default format, effective format will
|
| + /// not be written.
|
| + /// This field is read-only.
|
| CellFormat effectiveFormat;
|
| - /**
|
| - * The effective value of the cell. For cells with formulas, this will be
|
| - * the calculated value. For cells with literals, this will be
|
| - * the same as the user_entered_value.
|
| - * This field is read-only.
|
| - */
|
| +
|
| + /// The effective value of the cell. For cells with formulas, this will be
|
| + /// the calculated value. For cells with literals, this will be
|
| + /// the same as the user_entered_value.
|
| + /// This field is read-only.
|
| ExtendedValue effectiveValue;
|
| - /**
|
| - * The formatted value of the cell.
|
| - * This is the value as it's shown to the user.
|
| - * This field is read-only.
|
| - */
|
| +
|
| + /// The formatted value of the cell.
|
| + /// This is the value as it's shown to the user.
|
| + /// This field is read-only.
|
| core.String formattedValue;
|
| - /**
|
| - * A hyperlink this cell points to, if any.
|
| - * This field is read-only. (To set it, use a `=HYPERLINK` formula
|
| - * in the userEnteredValue.formulaValue
|
| - * field.)
|
| - */
|
| +
|
| + /// A hyperlink this cell points to, if any.
|
| + /// This field is read-only. (To set it, use a `=HYPERLINK` formula
|
| + /// in the userEnteredValue.formulaValue
|
| + /// field.)
|
| core.String hyperlink;
|
| - /** Any note on the cell. */
|
| +
|
| + /// Any note on the cell.
|
| core.String note;
|
| - /**
|
| - * A pivot table anchored at this cell. The size of pivot table itself
|
| - * is computed dynamically based on its data, grouping, filters, values,
|
| - * etc. Only the top-left cell of the pivot table contains the pivot table
|
| - * definition. The other cells will contain the calculated values of the
|
| - * results of the pivot in their effective_value fields.
|
| - */
|
| +
|
| + /// A pivot table anchored at this cell. The size of pivot table itself
|
| + /// is computed dynamically based on its data, grouping, filters, values,
|
| + /// etc. Only the top-left cell of the pivot table contains the pivot table
|
| + /// definition. The other cells will contain the calculated values of the
|
| + /// results of the pivot in their effective_value fields.
|
| PivotTable pivotTable;
|
| - /**
|
| - * Runs of rich text applied to subsections of the cell. Runs are only valid
|
| - * on user entered strings, not formulas, bools, or numbers.
|
| - * Runs start at specific indexes in the text and continue until the next
|
| - * run. Properties of a run will continue unless explicitly changed
|
| - * in a subsequent run (and properties of the first run will continue
|
| - * the properties of the cell unless explicitly changed).
|
| - *
|
| - * When writing, the new runs will overwrite any prior runs. When writing a
|
| - * new user_entered_value, previous runs will be erased.
|
| - */
|
| +
|
| + /// Runs of rich text applied to subsections of the cell. Runs are only
|
| + /// valid
|
| + /// on user entered strings, not formulas, bools, or numbers.
|
| + /// Runs start at specific indexes in the text and continue until the next
|
| + /// run. Properties of a run will continue unless explicitly changed
|
| + /// in a subsequent run (and properties of the first run will continue
|
| + /// the properties of the cell unless explicitly changed).
|
| + ///
|
| + /// When writing, the new runs will overwrite any prior runs. When writing a
|
| + /// new user_entered_value, previous runs will be erased.
|
| core.List<TextFormatRun> textFormatRuns;
|
| - /**
|
| - * The format the user entered for the cell.
|
| - *
|
| - * When writing, the new format will be merged with the existing format.
|
| - */
|
| +
|
| + /// The format the user entered for the cell.
|
| + ///
|
| + /// When writing, the new format will be merged with the existing format.
|
| CellFormat userEnteredFormat;
|
| - /**
|
| - * The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`
|
| - * Note: Dates, Times and DateTimes are represented as doubles in
|
| - * serial number format.
|
| - */
|
| +
|
| + /// The value the user entered in the cell. e.g, `1234`, `'Hello'`, or
|
| + /// `=NOW()`
|
| + /// Note: Dates, Times and DateTimes are represented as doubles in
|
| + /// serial number format.
|
| ExtendedValue userEnteredValue;
|
|
|
| CellData();
|
| @@ -2931,7 +2937,9 @@ class CellData {
|
| pivotTable = new PivotTable.fromJson(_json["pivotTable"]);
|
| }
|
| if (_json.containsKey("textFormatRuns")) {
|
| - textFormatRuns = _json["textFormatRuns"].map((value) => new TextFormatRun.fromJson(value)).toList();
|
| + textFormatRuns = _json["textFormatRuns"]
|
| + .map((value) => new TextFormatRun.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("userEnteredFormat")) {
|
| userEnteredFormat = new CellFormat.fromJson(_json["userEnteredFormat"]);
|
| @@ -2942,7 +2950,8 @@ class CellData {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (dataValidation != null) {
|
| _json["dataValidation"] = (dataValidation).toJson();
|
| }
|
| @@ -2965,7 +2974,8 @@ class CellData {
|
| _json["pivotTable"] = (pivotTable).toJson();
|
| }
|
| if (textFormatRuns != null) {
|
| - _json["textFormatRuns"] = textFormatRuns.map((value) => (value).toJson()).toList();
|
| + _json["textFormatRuns"] =
|
| + textFormatRuns.map((value) => (value).toJson()).toList();
|
| }
|
| if (userEnteredFormat != null) {
|
| _json["userEnteredFormat"] = (userEnteredFormat).toJson();
|
| @@ -2977,104 +2987,100 @@ class CellData {
|
| }
|
| }
|
|
|
| -/** The format of a cell. */
|
| +/// The format of a cell.
|
| class CellFormat {
|
| - /** The background color of the cell. */
|
| + /// The background color of the cell.
|
| Color backgroundColor;
|
| - /** The borders of the cell. */
|
| +
|
| + /// The borders of the cell.
|
| Borders borders;
|
| - /**
|
| - * The horizontal alignment of the value in the cell.
|
| - * Possible string values are:
|
| - * - "HORIZONTAL_ALIGN_UNSPECIFIED" : The horizontal alignment is not
|
| - * specified. Do not use this.
|
| - * - "LEFT" : The text is explicitly aligned to the left of the cell.
|
| - * - "CENTER" : The text is explicitly aligned to the center of the cell.
|
| - * - "RIGHT" : The text is explicitly aligned to the right of the cell.
|
| - */
|
| +
|
| + /// The horizontal alignment of the value in the cell.
|
| + /// Possible string values are:
|
| + /// - "HORIZONTAL_ALIGN_UNSPECIFIED" : The horizontal alignment is not
|
| + /// specified. Do not use this.
|
| + /// - "LEFT" : The text is explicitly aligned to the left of the cell.
|
| + /// - "CENTER" : The text is explicitly aligned to the center of the cell.
|
| + /// - "RIGHT" : The text is explicitly aligned to the right of the cell.
|
| core.String horizontalAlignment;
|
| - /**
|
| - * How a hyperlink, if it exists, should be displayed in the cell.
|
| - * Possible string values are:
|
| - * - "HYPERLINK_DISPLAY_TYPE_UNSPECIFIED" : The default value: the hyperlink
|
| - * is rendered. Do not use this.
|
| - * - "LINKED" : A hyperlink should be explicitly rendered.
|
| - * - "PLAIN_TEXT" : A hyperlink should not be rendered.
|
| - */
|
| +
|
| + /// How a hyperlink, if it exists, should be displayed in the cell.
|
| + /// Possible string values are:
|
| + /// - "HYPERLINK_DISPLAY_TYPE_UNSPECIFIED" : The default value: the hyperlink
|
| + /// is rendered. Do not use this.
|
| + /// - "LINKED" : A hyperlink should be explicitly rendered.
|
| + /// - "PLAIN_TEXT" : A hyperlink should not be rendered.
|
| core.String hyperlinkDisplayType;
|
| - /**
|
| - * A format describing how number values should be represented to the user.
|
| - */
|
| +
|
| + /// A format describing how number values should be represented to the user.
|
| NumberFormat numberFormat;
|
| - /** The padding of the cell. */
|
| +
|
| + /// The padding of the cell.
|
| Padding padding;
|
| - /**
|
| - * The direction of the text in the cell.
|
| - * Possible string values are:
|
| - * - "TEXT_DIRECTION_UNSPECIFIED" : The text direction is not specified. Do
|
| - * not use this.
|
| - * - "LEFT_TO_RIGHT" : The text direction of left-to-right was set by the
|
| - * user.
|
| - * - "RIGHT_TO_LEFT" : The text direction of right-to-left was set by the
|
| - * user.
|
| - */
|
| +
|
| + /// The direction of the text in the cell.
|
| + /// Possible string values are:
|
| + /// - "TEXT_DIRECTION_UNSPECIFIED" : The text direction is not specified. Do
|
| + /// not use this.
|
| + /// - "LEFT_TO_RIGHT" : The text direction of left-to-right was set by the
|
| + /// user.
|
| + /// - "RIGHT_TO_LEFT" : The text direction of right-to-left was set by the
|
| + /// user.
|
| core.String textDirection;
|
| - /**
|
| - * The format of the text in the cell (unless overridden by a format run).
|
| - */
|
| +
|
| + /// The format of the text in the cell (unless overridden by a format run).
|
| TextFormat textFormat;
|
| - /** The rotation applied to text in a cell */
|
| +
|
| + /// The rotation applied to text in a cell
|
| TextRotation textRotation;
|
| - /**
|
| - * The vertical alignment of the value in the cell.
|
| - * Possible string values are:
|
| - * - "VERTICAL_ALIGN_UNSPECIFIED" : The vertical alignment is not specified.
|
| - * Do not use this.
|
| - * - "TOP" : The text is explicitly aligned to the top of the cell.
|
| - * - "MIDDLE" : The text is explicitly aligned to the middle of the cell.
|
| - * - "BOTTOM" : The text is explicitly aligned to the bottom of the cell.
|
| - */
|
| +
|
| + /// The vertical alignment of the value in the cell.
|
| + /// Possible string values are:
|
| + /// - "VERTICAL_ALIGN_UNSPECIFIED" : The vertical alignment is not specified.
|
| + /// Do not use this.
|
| + /// - "TOP" : The text is explicitly aligned to the top of the cell.
|
| + /// - "MIDDLE" : The text is explicitly aligned to the middle of the cell.
|
| + /// - "BOTTOM" : The text is explicitly aligned to the bottom of the cell.
|
| core.String verticalAlignment;
|
| - /**
|
| - * The wrap strategy for the value in the cell.
|
| - * Possible string values are:
|
| - * - "WRAP_STRATEGY_UNSPECIFIED" : The default value, do not use.
|
| - * - "OVERFLOW_CELL" : Lines that are longer than the cell width will be
|
| - * written in the next
|
| - * cell over, so long as that cell is empty. If the next cell over is
|
| - * non-empty, this behaves the same as CLIP. The text will never wrap
|
| - * to the next line unless the user manually inserts a new line.
|
| - * Example:
|
| - *
|
| - * | First sentence. |
|
| - * | Manual newline that is very long. <- Text continues into next cell
|
| - * | Next newline. |
|
| - * - "LEGACY_WRAP" : This wrap strategy represents the old Google Sheets wrap
|
| - * strategy where
|
| - * words that are longer than a line are clipped rather than broken. This
|
| - * strategy is not supported on all platforms and is being phased out.
|
| - * Example:
|
| - *
|
| - * | Cell has a |
|
| - * | loooooooooo| <- Word is clipped.
|
| - * | word. |
|
| - * - "CLIP" : Lines that are longer than the cell width will be clipped.
|
| - * The text will never wrap to the next line unless the user manually
|
| - * inserts a new line.
|
| - * Example:
|
| - *
|
| - * | First sentence. |
|
| - * | Manual newline t| <- Text is clipped
|
| - * | Next newline. |
|
| - * - "WRAP" : Words that are longer than a line are wrapped at the character
|
| - * level
|
| - * rather than clipped.
|
| - * Example:
|
| - *
|
| - * | Cell has a |
|
| - * | loooooooooo| <- Word is broken.
|
| - * | ong word. |
|
| - */
|
| +
|
| + /// The wrap strategy for the value in the cell.
|
| + /// Possible string values are:
|
| + /// - "WRAP_STRATEGY_UNSPECIFIED" : The default value, do not use.
|
| + /// - "OVERFLOW_CELL" : Lines that are longer than the cell width will be
|
| + /// written in the next
|
| + /// cell over, so long as that cell is empty. If the next cell over is
|
| + /// non-empty, this behaves the same as CLIP. The text will never wrap
|
| + /// to the next line unless the user manually inserts a new line.
|
| + /// Example:
|
| + ///
|
| + /// | First sentence. |
|
| + /// | Manual newline that is very long. <- Text continues into next cell
|
| + /// | Next newline. |
|
| + /// - "LEGACY_WRAP" : This wrap strategy represents the old Google Sheets
|
| + /// wrap strategy where
|
| + /// words that are longer than a line are clipped rather than broken. This
|
| + /// strategy is not supported on all platforms and is being phased out.
|
| + /// Example:
|
| + ///
|
| + /// | Cell has a |
|
| + /// | loooooooooo| <- Word is clipped.
|
| + /// | word. |
|
| + /// - "CLIP" : Lines that are longer than the cell width will be clipped.
|
| + /// The text will never wrap to the next line unless the user manually
|
| + /// inserts a new line.
|
| + /// Example:
|
| + ///
|
| + /// | First sentence. |
|
| + /// | Manual newline t| <- Text is clipped
|
| + /// | Next newline. |
|
| + /// - "WRAP" : Words that are longer than a line are wrapped at the character
|
| + /// level
|
| + /// rather than clipped.
|
| + /// Example:
|
| + ///
|
| + /// | Cell has a |
|
| + /// | loooooooooo| <- Word is broken.
|
| + /// | ong word. |
|
| core.String wrapStrategy;
|
|
|
| CellFormat();
|
| @@ -3116,7 +3122,8 @@ class CellFormat {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (backgroundColor != null) {
|
| _json["backgroundColor"] = (backgroundColor).toJson();
|
| }
|
| @@ -3154,9 +3161,9 @@ class CellFormat {
|
| }
|
| }
|
|
|
| -/** The data included in a domain or series. */
|
| +/// The data included in a domain or series.
|
| class ChartData {
|
| - /** The source ranges of the data. */
|
| + /// The source ranges of the data.
|
| ChartSourceRange sourceRange;
|
|
|
| ChartData();
|
| @@ -3168,7 +3175,8 @@ class ChartData {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (sourceRange != null) {
|
| _json["sourceRange"] = (sourceRange).toJson();
|
| }
|
| @@ -3176,39 +3184,40 @@ class ChartData {
|
| }
|
| }
|
|
|
| -/** Source ranges for a chart. */
|
| +/// Source ranges for a chart.
|
| class ChartSourceRange {
|
| - /**
|
| - * The ranges of data for a series or domain.
|
| - * Exactly one dimension must have a length of 1,
|
| - * and all sources in the list must have the same dimension
|
| - * with length 1.
|
| - * The domain (if it exists) & all series must have the same number
|
| - * of source ranges. If using more than one source range, then the source
|
| - * range at a given offset must be contiguous across the domain and series.
|
| - *
|
| - * For example, these are valid configurations:
|
| - *
|
| - * domain sources: A1:A5
|
| - * series1 sources: B1:B5
|
| - * series2 sources: D6:D10
|
| - *
|
| - * domain sources: A1:A5, C10:C12
|
| - * series1 sources: B1:B5, D10:D12
|
| - * series2 sources: C1:C5, E10:E12
|
| - */
|
| + /// The ranges of data for a series or domain.
|
| + /// Exactly one dimension must have a length of 1,
|
| + /// and all sources in the list must have the same dimension
|
| + /// with length 1.
|
| + /// The domain (if it exists) & all series must have the same number
|
| + /// of source ranges. If using more than one source range, then the source
|
| + /// range at a given offset must be contiguous across the domain and series.
|
| + ///
|
| + /// For example, these are valid configurations:
|
| + ///
|
| + /// domain sources: A1:A5
|
| + /// series1 sources: B1:B5
|
| + /// series2 sources: D6:D10
|
| + ///
|
| + /// domain sources: A1:A5, C10:C12
|
| + /// series1 sources: B1:B5, D10:D12
|
| + /// series2 sources: C1:C5, E10:E12
|
| core.List<GridRange> sources;
|
|
|
| ChartSourceRange();
|
|
|
| ChartSourceRange.fromJson(core.Map _json) {
|
| if (_json.containsKey("sources")) {
|
| - sources = _json["sources"].map((value) => new GridRange.fromJson(value)).toList();
|
| + sources = _json["sources"]
|
| + .map((value) => new GridRange.fromJson(value))
|
| + .toList();
|
| }
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (sources != null) {
|
| _json["sources"] = sources.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -3216,64 +3225,62 @@ class ChartSourceRange {
|
| }
|
| }
|
|
|
| -/** The specifications of a chart. */
|
| +/// The specifications of a chart.
|
| class ChartSpec {
|
| - /**
|
| - * The alternative text that describes the chart. This is often used
|
| - * for accessibility.
|
| - */
|
| + /// The alternative text that describes the chart. This is often used
|
| + /// for accessibility.
|
| core.String altText;
|
| - /**
|
| - * The background color of the entire chart.
|
| - * Not applicable to Org charts.
|
| - */
|
| +
|
| + /// The background color of the entire chart.
|
| + /// Not applicable to Org charts.
|
| Color backgroundColor;
|
| - /**
|
| - * A basic chart specification, can be one of many kinds of charts.
|
| - * See BasicChartType for the list of all
|
| - * charts this supports.
|
| - */
|
| +
|
| + /// A basic chart specification, can be one of many kinds of charts.
|
| + /// See BasicChartType for the list of all
|
| + /// charts this supports.
|
| BasicChartSpec basicChart;
|
| - /** A bubble chart specification. */
|
| +
|
| + /// A bubble chart specification.
|
| BubbleChartSpec bubbleChart;
|
| - /** A candlestick chart specification. */
|
| +
|
| + /// A candlestick chart specification.
|
| CandlestickChartSpec candlestickChart;
|
| - /**
|
| - * The name of the font to use by default for all chart text (e.g. title,
|
| - * axis labels, legend). If a font is specified for a specific part of the
|
| - * chart it will override this font name.
|
| - */
|
| +
|
| + /// The name of the font to use by default for all chart text (e.g. title,
|
| + /// axis labels, legend). If a font is specified for a specific part of the
|
| + /// chart it will override this font name.
|
| core.String fontName;
|
| - /**
|
| - * Determines how the charts will use hidden rows or columns.
|
| - * Possible string values are:
|
| - * - "CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED" : Default value, do not
|
| - * use.
|
| - * - "SKIP_HIDDEN_ROWS_AND_COLUMNS" : Charts will skip hidden rows and
|
| - * columns.
|
| - * - "SKIP_HIDDEN_ROWS" : Charts will skip hidden rows only.
|
| - * - "SKIP_HIDDEN_COLUMNS" : Charts will skip hidden columns only.
|
| - * - "SHOW_ALL" : Charts will not skip any hidden rows or columns.
|
| - */
|
| +
|
| + /// Determines how the charts will use hidden rows or columns.
|
| + /// Possible string values are:
|
| + /// - "CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED" : Default value, do not
|
| + /// use.
|
| + /// - "SKIP_HIDDEN_ROWS_AND_COLUMNS" : Charts will skip hidden rows and
|
| + /// columns.
|
| + /// - "SKIP_HIDDEN_ROWS" : Charts will skip hidden rows only.
|
| + /// - "SKIP_HIDDEN_COLUMNS" : Charts will skip hidden columns only.
|
| + /// - "SHOW_ALL" : Charts will not skip any hidden rows or columns.
|
| core.String hiddenDimensionStrategy;
|
| - /** A histogram chart specification. */
|
| +
|
| + /// A histogram chart specification.
|
| HistogramChartSpec histogramChart;
|
| - /**
|
| - * True to make a chart fill the entire space in which it's rendered with
|
| - * minimum padding. False to use the default padding.
|
| - * (Not applicable to Geo and Org charts.)
|
| - */
|
| +
|
| + /// True to make a chart fill the entire space in which it's rendered with
|
| + /// minimum padding. False to use the default padding.
|
| + /// (Not applicable to Geo and Org charts.)
|
| core.bool maximized;
|
| - /** An org chart specification. */
|
| +
|
| + /// An org chart specification.
|
| OrgChartSpec orgChart;
|
| - /** A pie chart specification. */
|
| +
|
| + /// A pie chart specification.
|
| PieChartSpec pieChart;
|
| - /** The title of the chart. */
|
| +
|
| + /// The title of the chart.
|
| core.String title;
|
| - /**
|
| - * The title text format.
|
| - * Strikethrough and underline are not supported.
|
| - */
|
| +
|
| + /// The title text format.
|
| + /// Strikethrough and underline are not supported.
|
| TextFormat titleTextFormat;
|
|
|
| ChartSpec();
|
| @@ -3292,7 +3299,8 @@ class ChartSpec {
|
| bubbleChart = new BubbleChartSpec.fromJson(_json["bubbleChart"]);
|
| }
|
| if (_json.containsKey("candlestickChart")) {
|
| - candlestickChart = new CandlestickChartSpec.fromJson(_json["candlestickChart"]);
|
| + candlestickChart =
|
| + new CandlestickChartSpec.fromJson(_json["candlestickChart"]);
|
| }
|
| if (_json.containsKey("fontName")) {
|
| fontName = _json["fontName"];
|
| @@ -3321,7 +3329,8 @@ class ChartSpec {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (altText != null) {
|
| _json["altText"] = altText;
|
| }
|
| @@ -3365,9 +3374,9 @@ class ChartSpec {
|
| }
|
| }
|
|
|
| -/** Clears the basic filter, if any exists on the sheet. */
|
| +/// Clears the basic filter, if any exists on the sheet.
|
| class ClearBasicFilterRequest {
|
| - /** The sheet ID on which the basic filter should be cleared. */
|
| + /// The sheet ID on which the basic filter should be cleared.
|
| core.int sheetId;
|
|
|
| ClearBasicFilterRequest();
|
| @@ -3379,7 +3388,8 @@ class ClearBasicFilterRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (sheetId != null) {
|
| _json["sheetId"] = sheetId;
|
| }
|
| @@ -3387,30 +3397,28 @@ class ClearBasicFilterRequest {
|
| }
|
| }
|
|
|
| -/** The request for clearing a range of values in a spreadsheet. */
|
| +/// The request for clearing a range of values in a spreadsheet.
|
| class ClearValuesRequest {
|
| -
|
| ClearValuesRequest();
|
|
|
| - ClearValuesRequest.fromJson(core.Map _json) {
|
| - }
|
| + ClearValuesRequest.fromJson(core.Map _json) {}
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| return _json;
|
| }
|
| }
|
|
|
| -/** The response when clearing a range of values in a spreadsheet. */
|
| +/// The response when clearing a range of values in a spreadsheet.
|
| class ClearValuesResponse {
|
| - /**
|
| - * The range (in A1 notation) that was cleared.
|
| - * (If the request was for an unbounded range or a ranger larger
|
| - * than the bounds of the sheet, this will be the actual range
|
| - * that was cleared, bounded to the sheet's limits.)
|
| - */
|
| + /// The range (in A1 notation) that was cleared.
|
| + /// (If the request was for an unbounded range or a ranger larger
|
| + /// than the bounds of the sheet, this will be the actual range
|
| + /// that was cleared, bounded to the sheet's limits.)
|
| core.String clearedRange;
|
| - /** The spreadsheet the updates were applied to. */
|
| +
|
| + /// The spreadsheet the updates were applied to.
|
| core.String spreadsheetId;
|
|
|
| ClearValuesResponse();
|
| @@ -3425,7 +3433,8 @@ class ClearValuesResponse {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (clearedRange != null) {
|
| _json["clearedRange"] = clearedRange;
|
| }
|
| @@ -3436,142 +3445,145 @@ class ClearValuesResponse {
|
| }
|
| }
|
|
|
| -/**
|
| - * Represents a color in the RGBA color space. This representation is designed
|
| - * for simplicity of conversion to/from color representations in various
|
| - * languages over compactness; for example, the fields of this representation
|
| - * can be trivially provided to the constructor of "java.awt.Color" in Java; it
|
| - * can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
|
| - * method in iOS; and, with just a little work, it can be easily formatted into
|
| - * a CSS "rgba()" string in JavaScript, as well. Here are some examples:
|
| - *
|
| - * Example (Java):
|
| - *
|
| - * import com.google.type.Color;
|
| - *
|
| - * // ...
|
| - * public static java.awt.Color fromProto(Color protocolor) {
|
| - * float alpha = protocolor.hasAlpha()
|
| - * ? protocolor.getAlpha().getValue()
|
| - * : 1.0;
|
| - *
|
| - * return new java.awt.Color(
|
| - * protocolor.getRed(),
|
| - * protocolor.getGreen(),
|
| - * protocolor.getBlue(),
|
| - * alpha);
|
| - * }
|
| - *
|
| - * public static Color toProto(java.awt.Color color) {
|
| - * float red = (float) color.getRed();
|
| - * float green = (float) color.getGreen();
|
| - * float blue = (float) color.getBlue();
|
| - * float denominator = 255.0;
|
| - * Color.Builder resultBuilder =
|
| - * Color
|
| - * .newBuilder()
|
| - * .setRed(red / denominator)
|
| - * .setGreen(green / denominator)
|
| - * .setBlue(blue / denominator);
|
| - * int alpha = color.getAlpha();
|
| - * if (alpha != 255) {
|
| - * result.setAlpha(
|
| - * FloatValue
|
| - * .newBuilder()
|
| - * .setValue(((float) alpha) / denominator)
|
| - * .build());
|
| - * }
|
| - * return resultBuilder.build();
|
| - * }
|
| - * // ...
|
| - *
|
| - * Example (iOS / Obj-C):
|
| - *
|
| - * // ...
|
| - * static UIColor* fromProto(Color* protocolor) {
|
| - * float red = [protocolor red];
|
| - * float green = [protocolor green];
|
| - * float blue = [protocolor blue];
|
| - * FloatValue* alpha_wrapper = [protocolor alpha];
|
| - * float alpha = 1.0;
|
| - * if (alpha_wrapper != nil) {
|
| - * alpha = [alpha_wrapper value];
|
| - * }
|
| - * return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
|
| - * }
|
| - *
|
| - * static Color* toProto(UIColor* color) {
|
| - * CGFloat red, green, blue, alpha;
|
| - * if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
|
| - * return nil;
|
| - * }
|
| - * Color* result = [Color alloc] init];
|
| - * [result setRed:red];
|
| - * [result setGreen:green];
|
| - * [result setBlue:blue];
|
| - * if (alpha <= 0.9999) {
|
| - * [result setAlpha:floatWrapperWithValue(alpha)];
|
| - * }
|
| - * [result autorelease];
|
| - * return result;
|
| - * }
|
| - * // ...
|
| - *
|
| - * Example (JavaScript):
|
| - *
|
| - * // ...
|
| - *
|
| - * var protoToCssColor = function(rgb_color) {
|
| - * var redFrac = rgb_color.red || 0.0;
|
| - * var greenFrac = rgb_color.green || 0.0;
|
| - * var blueFrac = rgb_color.blue || 0.0;
|
| - * var red = Math.floor(redFrac * 255);
|
| - * var green = Math.floor(greenFrac * 255);
|
| - * var blue = Math.floor(blueFrac * 255);
|
| - *
|
| - * if (!('alpha' in rgb_color)) {
|
| - * return rgbToCssColor_(red, green, blue);
|
| - * }
|
| - *
|
| - * var alphaFrac = rgb_color.alpha.value || 0.0;
|
| - * var rgbParams = [red, green, blue].join(',');
|
| - * return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
|
| - * };
|
| - *
|
| - * var rgbToCssColor_ = function(red, green, blue) {
|
| - * var rgbNumber = new Number((red << 16) | (green << 8) | blue);
|
| - * var hexString = rgbNumber.toString(16);
|
| - * var missingZeros = 6 - hexString.length;
|
| - * var resultBuilder = ['#'];
|
| - * for (var i = 0; i < missingZeros; i++) {
|
| - * resultBuilder.push('0');
|
| - * }
|
| - * resultBuilder.push(hexString);
|
| - * return resultBuilder.join('');
|
| - * };
|
| - *
|
| - * // ...
|
| - */
|
| +/// Represents a color in the RGBA color space. This representation is designed
|
| +/// for simplicity of conversion to/from color representations in various
|
| +/// languages over compactness; for example, the fields of this representation
|
| +/// can be trivially provided to the constructor of "java.awt.Color" in Java;
|
| +/// it
|
| +/// can also be trivially provided to UIColor's
|
| +/// "+colorWithRed:green:blue:alpha"
|
| +/// method in iOS; and, with just a little work, it can be easily formatted
|
| +/// into
|
| +/// a CSS "rgba()" string in JavaScript, as well. Here are some examples:
|
| +///
|
| +/// Example (Java):
|
| +///
|
| +/// import com.google.type.Color;
|
| +///
|
| +/// // ...
|
| +/// public static java.awt.Color fromProto(Color protocolor) {
|
| +/// float alpha = protocolor.hasAlpha()
|
| +/// ? protocolor.getAlpha().getValue()
|
| +/// : 1.0;
|
| +///
|
| +/// return new java.awt.Color(
|
| +/// protocolor.getRed(),
|
| +/// protocolor.getGreen(),
|
| +/// protocolor.getBlue(),
|
| +/// alpha);
|
| +/// }
|
| +///
|
| +/// public static Color toProto(java.awt.Color color) {
|
| +/// float red = (float) color.getRed();
|
| +/// float green = (float) color.getGreen();
|
| +/// float blue = (float) color.getBlue();
|
| +/// float denominator = 255.0;
|
| +/// Color.Builder resultBuilder =
|
| +/// Color
|
| +/// .newBuilder()
|
| +/// .setRed(red / denominator)
|
| +/// .setGreen(green / denominator)
|
| +/// .setBlue(blue / denominator);
|
| +/// int alpha = color.getAlpha();
|
| +/// if (alpha != 255) {
|
| +/// result.setAlpha(
|
| +/// FloatValue
|
| +/// .newBuilder()
|
| +/// .setValue(((float) alpha) / denominator)
|
| +/// .build());
|
| +/// }
|
| +/// return resultBuilder.build();
|
| +/// }
|
| +/// // ...
|
| +///
|
| +/// Example (iOS / Obj-C):
|
| +///
|
| +/// // ...
|
| +/// static UIColor* fromProto(Color* protocolor) {
|
| +/// float red = [protocolor red];
|
| +/// float green = [protocolor green];
|
| +/// float blue = [protocolor blue];
|
| +/// FloatValue* alpha_wrapper = [protocolor alpha];
|
| +/// float alpha = 1.0;
|
| +/// if (alpha_wrapper != nil) {
|
| +/// alpha = [alpha_wrapper value];
|
| +/// }
|
| +/// return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
|
| +/// }
|
| +///
|
| +/// static Color* toProto(UIColor* color) {
|
| +/// CGFloat red, green, blue, alpha;
|
| +/// if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
|
| +/// return nil;
|
| +/// }
|
| +/// Color* result = [Color alloc] init];
|
| +/// [result setRed:red];
|
| +/// [result setGreen:green];
|
| +/// [result setBlue:blue];
|
| +/// if (alpha <= 0.9999) {
|
| +/// [result setAlpha:floatWrapperWithValue(alpha)];
|
| +/// }
|
| +/// [result autorelease];
|
| +/// return result;
|
| +/// }
|
| +/// // ...
|
| +///
|
| +/// Example (JavaScript):
|
| +///
|
| +/// // ...
|
| +///
|
| +/// var protoToCssColor = function(rgb_color) {
|
| +/// var redFrac = rgb_color.red || 0.0;
|
| +/// var greenFrac = rgb_color.green || 0.0;
|
| +/// var blueFrac = rgb_color.blue || 0.0;
|
| +/// var red = Math.floor(redFrac * 255);
|
| +/// var green = Math.floor(greenFrac * 255);
|
| +/// var blue = Math.floor(blueFrac * 255);
|
| +///
|
| +/// if (!('alpha' in rgb_color)) {
|
| +/// return rgbToCssColor_(red, green, blue);
|
| +/// }
|
| +///
|
| +/// var alphaFrac = rgb_color.alpha.value || 0.0;
|
| +/// var rgbParams = [red, green, blue].join(',');
|
| +/// return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
|
| +/// };
|
| +///
|
| +/// var rgbToCssColor_ = function(red, green, blue) {
|
| +/// var rgbNumber = new Number((red << 16) | (green << 8) | blue);
|
| +/// var hexString = rgbNumber.toString(16);
|
| +/// var missingZeros = 6 - hexString.length;
|
| +/// var resultBuilder = ['#'];
|
| +/// for (var i = 0; i < missingZeros; i++) {
|
| +/// resultBuilder.push('0');
|
| +/// }
|
| +/// resultBuilder.push(hexString);
|
| +/// return resultBuilder.join('');
|
| +/// };
|
| +///
|
| +/// // ...
|
| class Color {
|
| - /**
|
| - * The fraction of this color that should be applied to the pixel. That is,
|
| - * the final pixel color is defined by the equation:
|
| - *
|
| - * pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
|
| - *
|
| - * This means that a value of 1.0 corresponds to a solid color, whereas
|
| - * a value of 0.0 corresponds to a completely transparent color. This
|
| - * uses a wrapper message rather than a simple float scalar so that it is
|
| - * possible to distinguish between a default value and the value being unset.
|
| - * If omitted, this color object is to be rendered as a solid color
|
| - * (as if the alpha value had been explicitly given with a value of 1.0).
|
| - */
|
| + /// The fraction of this color that should be applied to the pixel. That is,
|
| + /// the final pixel color is defined by the equation:
|
| + ///
|
| + /// pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
|
| + ///
|
| + /// This means that a value of 1.0 corresponds to a solid color, whereas
|
| + /// a value of 0.0 corresponds to a completely transparent color. This
|
| + /// uses a wrapper message rather than a simple float scalar so that it is
|
| + /// possible to distinguish between a default value and the value being
|
| + /// unset.
|
| + /// If omitted, this color object is to be rendered as a solid color
|
| + /// (as if the alpha value had been explicitly given with a value of 1.0).
|
| core.double alpha;
|
| - /** The amount of blue in the color as a value in the interval [0, 1]. */
|
| +
|
| + /// The amount of blue in the color as a value in the interval [0, 1].
|
| core.double blue;
|
| - /** The amount of green in the color as a value in the interval [0, 1]. */
|
| +
|
| + /// The amount of green in the color as a value in the interval [0, 1].
|
| core.double green;
|
| - /** The amount of red in the color as a value in the interval [0, 1]. */
|
| +
|
| + /// The amount of red in the color as a value in the interval [0, 1].
|
| core.double red;
|
|
|
| Color();
|
| @@ -3592,7 +3604,8 @@ class Color {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (alpha != null) {
|
| _json["alpha"] = alpha;
|
| }
|
| @@ -3609,34 +3622,31 @@ class Color {
|
| }
|
| }
|
|
|
| -/** The value of the condition. */
|
| +/// The value of the condition.
|
| class ConditionValue {
|
| - /**
|
| - * A relative date (based on the current date).
|
| - * Valid only if the type is
|
| - * DATE_BEFORE,
|
| - * DATE_AFTER,
|
| - * DATE_ON_OR_BEFORE or
|
| - * DATE_ON_OR_AFTER.
|
| - *
|
| - * Relative dates are not supported in data validation.
|
| - * They are supported only in conditional formatting and
|
| - * conditional filters.
|
| - * Possible string values are:
|
| - * - "RELATIVE_DATE_UNSPECIFIED" : Default value, do not use.
|
| - * - "PAST_YEAR" : The value is one year before today.
|
| - * - "PAST_MONTH" : The value is one month before today.
|
| - * - "PAST_WEEK" : The value is one week before today.
|
| - * - "YESTERDAY" : The value is yesterday.
|
| - * - "TODAY" : The value is today.
|
| - * - "TOMORROW" : The value is tomorrow.
|
| - */
|
| + /// A relative date (based on the current date).
|
| + /// Valid only if the type is
|
| + /// DATE_BEFORE,
|
| + /// DATE_AFTER,
|
| + /// DATE_ON_OR_BEFORE or
|
| + /// DATE_ON_OR_AFTER.
|
| + ///
|
| + /// Relative dates are not supported in data validation.
|
| + /// They are supported only in conditional formatting and
|
| + /// conditional filters.
|
| + /// Possible string values are:
|
| + /// - "RELATIVE_DATE_UNSPECIFIED" : Default value, do not use.
|
| + /// - "PAST_YEAR" : The value is one year before today.
|
| + /// - "PAST_MONTH" : The value is one month before today.
|
| + /// - "PAST_WEEK" : The value is one week before today.
|
| + /// - "YESTERDAY" : The value is yesterday.
|
| + /// - "TODAY" : The value is today.
|
| + /// - "TOMORROW" : The value is tomorrow.
|
| core.String relativeDate;
|
| - /**
|
| - * A value the condition is based on.
|
| - * The value will be parsed as if the user typed into a cell.
|
| - * Formulas are supported (and must begin with an `=`).
|
| - */
|
| +
|
| + /// A value the condition is based on.
|
| + /// The value will be parsed as if the user typed into a cell.
|
| + /// Formulas are supported (and must begin with an `=`).
|
| core.String userEnteredValue;
|
|
|
| ConditionValue();
|
| @@ -3651,7 +3661,8 @@ class ConditionValue {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (relativeDate != null) {
|
| _json["relativeDate"] = relativeDate;
|
| }
|
| @@ -3662,16 +3673,16 @@ class ConditionValue {
|
| }
|
| }
|
|
|
| -/** A rule describing a conditional format. */
|
| +/// A rule describing a conditional format.
|
| class ConditionalFormatRule {
|
| - /** The formatting is either "on" or "off" according to the rule. */
|
| + /// The formatting is either "on" or "off" according to the rule.
|
| BooleanRule booleanRule;
|
| - /** The formatting will vary based on the gradients in the rule. */
|
| +
|
| + /// The formatting will vary based on the gradients in the rule.
|
| GradientRule gradientRule;
|
| - /**
|
| - * The ranges that will be formatted if the condition is true.
|
| - * All the ranges must be on the same grid.
|
| - */
|
| +
|
| + /// The ranges that will be formatted if the condition is true.
|
| + /// All the ranges must be on the same grid.
|
| core.List<GridRange> ranges;
|
|
|
| ConditionalFormatRule();
|
| @@ -3684,12 +3695,15 @@ class ConditionalFormatRule {
|
| gradientRule = new GradientRule.fromJson(_json["gradientRule"]);
|
| }
|
| if (_json.containsKey("ranges")) {
|
| - ranges = _json["ranges"].map((value) => new GridRange.fromJson(value)).toList();
|
| + ranges = _json["ranges"]
|
| + .map((value) => new GridRange.fromJson(value))
|
| + .toList();
|
| }
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (booleanRule != null) {
|
| _json["booleanRule"] = (booleanRule).toJson();
|
| }
|
| @@ -3703,39 +3717,37 @@ class ConditionalFormatRule {
|
| }
|
| }
|
|
|
| -/** Copies data from the source to the destination. */
|
| +/// Copies data from the source to the destination.
|
| class CopyPasteRequest {
|
| - /**
|
| - * The location to paste to. If the range covers a span that's
|
| - * a multiple of the source's height or width, then the
|
| - * data will be repeated to fill in the destination range.
|
| - * If the range is smaller than the source range, the entire
|
| - * source data will still be copied (beyond the end of the destination range).
|
| - */
|
| + /// The location to paste to. If the range covers a span that's
|
| + /// a multiple of the source's height or width, then the
|
| + /// data will be repeated to fill in the destination range.
|
| + /// If the range is smaller than the source range, the entire
|
| + /// source data will still be copied (beyond the end of the destination
|
| + /// range).
|
| GridRange destination;
|
| - /**
|
| - * How that data should be oriented when pasting.
|
| - * Possible string values are:
|
| - * - "NORMAL" : Paste normally.
|
| - * - "TRANSPOSE" : Paste transposed, where all rows become columns and vice
|
| - * versa.
|
| - */
|
| +
|
| + /// How that data should be oriented when pasting.
|
| + /// Possible string values are:
|
| + /// - "NORMAL" : Paste normally.
|
| + /// - "TRANSPOSE" : Paste transposed, where all rows become columns and vice
|
| + /// versa.
|
| core.String pasteOrientation;
|
| - /**
|
| - * What kind of data to paste.
|
| - * Possible string values are:
|
| - * - "PASTE_NORMAL" : Paste values, formulas, formats, and merges.
|
| - * - "PASTE_VALUES" : Paste the values ONLY without formats, formulas, or
|
| - * merges.
|
| - * - "PASTE_FORMAT" : Paste the format and data validation only.
|
| - * - "PASTE_NO_BORDERS" : Like PASTE_NORMAL but without borders.
|
| - * - "PASTE_FORMULA" : Paste the formulas only.
|
| - * - "PASTE_DATA_VALIDATION" : Paste the data validation only.
|
| - * - "PASTE_CONDITIONAL_FORMATTING" : Paste the conditional formatting rules
|
| - * only.
|
| - */
|
| +
|
| + /// What kind of data to paste.
|
| + /// Possible string values are:
|
| + /// - "PASTE_NORMAL" : Paste values, formulas, formats, and merges.
|
| + /// - "PASTE_VALUES" : Paste the values ONLY without formats, formulas, or
|
| + /// merges.
|
| + /// - "PASTE_FORMAT" : Paste the format and data validation only.
|
| + /// - "PASTE_NO_BORDERS" : Like PASTE_NORMAL but without borders.
|
| + /// - "PASTE_FORMULA" : Paste the formulas only.
|
| + /// - "PASTE_DATA_VALIDATION" : Paste the data validation only.
|
| + /// - "PASTE_CONDITIONAL_FORMATTING" : Paste the conditional formatting rules
|
| + /// only.
|
| core.String pasteType;
|
| - /** The source range to copy. */
|
| +
|
| + /// The source range to copy.
|
| GridRange source;
|
|
|
| CopyPasteRequest();
|
| @@ -3756,7 +3768,8 @@ class CopyPasteRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (destination != null) {
|
| _json["destination"] = (destination).toJson();
|
| }
|
| @@ -3773,9 +3786,9 @@ class CopyPasteRequest {
|
| }
|
| }
|
|
|
| -/** The request to copy a sheet across spreadsheets. */
|
| +/// The request to copy a sheet across spreadsheets.
|
| class CopySheetToAnotherSpreadsheetRequest {
|
| - /** The ID of the spreadsheet to copy the sheet to. */
|
| + /// The ID of the spreadsheet to copy the sheet to.
|
| core.String destinationSpreadsheetId;
|
|
|
| CopySheetToAnotherSpreadsheetRequest();
|
| @@ -3787,7 +3800,8 @@ class CopySheetToAnotherSpreadsheetRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (destinationSpreadsheetId != null) {
|
| _json["destinationSpreadsheetId"] = destinationSpreadsheetId;
|
| }
|
| @@ -3795,26 +3809,26 @@ class CopySheetToAnotherSpreadsheetRequest {
|
| }
|
| }
|
|
|
| -/** Moves data from the source to the destination. */
|
| +/// Moves data from the source to the destination.
|
| class CutPasteRequest {
|
| - /** The top-left coordinate where the data should be pasted. */
|
| + /// The top-left coordinate where the data should be pasted.
|
| GridCoordinate destination;
|
| - /**
|
| - * What kind of data to paste. All the source data will be cut, regardless
|
| - * of what is pasted.
|
| - * Possible string values are:
|
| - * - "PASTE_NORMAL" : Paste values, formulas, formats, and merges.
|
| - * - "PASTE_VALUES" : Paste the values ONLY without formats, formulas, or
|
| - * merges.
|
| - * - "PASTE_FORMAT" : Paste the format and data validation only.
|
| - * - "PASTE_NO_BORDERS" : Like PASTE_NORMAL but without borders.
|
| - * - "PASTE_FORMULA" : Paste the formulas only.
|
| - * - "PASTE_DATA_VALIDATION" : Paste the data validation only.
|
| - * - "PASTE_CONDITIONAL_FORMATTING" : Paste the conditional formatting rules
|
| - * only.
|
| - */
|
| +
|
| + /// What kind of data to paste. All the source data will be cut, regardless
|
| + /// of what is pasted.
|
| + /// Possible string values are:
|
| + /// - "PASTE_NORMAL" : Paste values, formulas, formats, and merges.
|
| + /// - "PASTE_VALUES" : Paste the values ONLY without formats, formulas, or
|
| + /// merges.
|
| + /// - "PASTE_FORMAT" : Paste the format and data validation only.
|
| + /// - "PASTE_NO_BORDERS" : Like PASTE_NORMAL but without borders.
|
| + /// - "PASTE_FORMULA" : Paste the formulas only.
|
| + /// - "PASTE_DATA_VALIDATION" : Paste the data validation only.
|
| + /// - "PASTE_CONDITIONAL_FORMATTING" : Paste the conditional formatting rules
|
| + /// only.
|
| core.String pasteType;
|
| - /** The source data to cut. */
|
| +
|
| + /// The source data to cut.
|
| GridRange source;
|
|
|
| CutPasteRequest();
|
| @@ -3832,7 +3846,8 @@ class CutPasteRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (destination != null) {
|
| _json["destination"] = (destination).toJson();
|
| }
|
| @@ -3846,18 +3861,19 @@ class CutPasteRequest {
|
| }
|
| }
|
|
|
| -/** A data validation rule. */
|
| +/// A data validation rule.
|
| class DataValidationRule {
|
| - /** The condition that data in the cell must match. */
|
| + /// The condition that data in the cell must match.
|
| BooleanCondition condition;
|
| - /** A message to show the user when adding data to the cell. */
|
| +
|
| + /// A message to show the user when adding data to the cell.
|
| core.String inputMessage;
|
| - /**
|
| - * True if the UI should be customized based on the kind of condition.
|
| - * If true, "List" conditions will show a dropdown.
|
| - */
|
| +
|
| + /// True if the UI should be customized based on the kind of condition.
|
| + /// If true, "List" conditions will show a dropdown.
|
| core.bool showCustomUi;
|
| - /** True if invalid data should be rejected. */
|
| +
|
| + /// True if invalid data should be rejected.
|
| core.bool strict;
|
|
|
| DataValidationRule();
|
| @@ -3878,7 +3894,8 @@ class DataValidationRule {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (condition != null) {
|
| _json["condition"] = (condition).toJson();
|
| }
|
| @@ -3895,9 +3912,9 @@ class DataValidationRule {
|
| }
|
| }
|
|
|
| -/** Removes the banded range with the given ID from the spreadsheet. */
|
| +/// Removes the banded range with the given ID from the spreadsheet.
|
| class DeleteBandingRequest {
|
| - /** The ID of the banded range to delete. */
|
| + /// The ID of the banded range to delete.
|
| core.int bandedRangeId;
|
|
|
| DeleteBandingRequest();
|
| @@ -3909,7 +3926,8 @@ class DeleteBandingRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (bandedRangeId != null) {
|
| _json["bandedRangeId"] = bandedRangeId;
|
| }
|
| @@ -3917,14 +3935,13 @@ class DeleteBandingRequest {
|
| }
|
| }
|
|
|
| -/**
|
| - * Deletes a conditional format rule at the given index.
|
| - * All subsequent rules' indexes are decremented.
|
| - */
|
| +/// Deletes a conditional format rule at the given index.
|
| +/// All subsequent rules' indexes are decremented.
|
| class DeleteConditionalFormatRuleRequest {
|
| - /** The zero-based index of the rule to be deleted. */
|
| + /// The zero-based index of the rule to be deleted.
|
| core.int index;
|
| - /** The sheet the rule is being deleted from. */
|
| +
|
| + /// The sheet the rule is being deleted from.
|
| core.int sheetId;
|
|
|
| DeleteConditionalFormatRuleRequest();
|
| @@ -3939,7 +3956,8 @@ class DeleteConditionalFormatRuleRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (index != null) {
|
| _json["index"] = index;
|
| }
|
| @@ -3950,9 +3968,9 @@ class DeleteConditionalFormatRuleRequest {
|
| }
|
| }
|
|
|
| -/** The result of deleting a conditional format rule. */
|
| +/// The result of deleting a conditional format rule.
|
| class DeleteConditionalFormatRuleResponse {
|
| - /** The rule that was deleted. */
|
| + /// The rule that was deleted.
|
| ConditionalFormatRule rule;
|
|
|
| DeleteConditionalFormatRuleResponse();
|
| @@ -3964,7 +3982,8 @@ class DeleteConditionalFormatRuleResponse {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (rule != null) {
|
| _json["rule"] = (rule).toJson();
|
| }
|
| @@ -3972,9 +3991,9 @@ class DeleteConditionalFormatRuleResponse {
|
| }
|
| }
|
|
|
| -/** Deletes the dimensions from the sheet. */
|
| +/// Deletes the dimensions from the sheet.
|
| class DeleteDimensionRequest {
|
| - /** The dimensions to delete from the sheet. */
|
| + /// The dimensions to delete from the sheet.
|
| DimensionRange range;
|
|
|
| DeleteDimensionRequest();
|
| @@ -3986,7 +4005,8 @@ class DeleteDimensionRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (range != null) {
|
| _json["range"] = (range).toJson();
|
| }
|
| @@ -3994,9 +4014,9 @@ class DeleteDimensionRequest {
|
| }
|
| }
|
|
|
| -/** Deletes the embedded object with the given ID. */
|
| +/// Deletes the embedded object with the given ID.
|
| class DeleteEmbeddedObjectRequest {
|
| - /** The ID of the embedded object to delete. */
|
| + /// The ID of the embedded object to delete.
|
| core.int objectId;
|
|
|
| DeleteEmbeddedObjectRequest();
|
| @@ -4008,7 +4028,8 @@ class DeleteEmbeddedObjectRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (objectId != null) {
|
| _json["objectId"] = objectId;
|
| }
|
| @@ -4016,9 +4037,9 @@ class DeleteEmbeddedObjectRequest {
|
| }
|
| }
|
|
|
| -/** Deletes a particular filter view. */
|
| +/// Deletes a particular filter view.
|
| class DeleteFilterViewRequest {
|
| - /** The ID of the filter to delete. */
|
| + /// The ID of the filter to delete.
|
| core.int filterId;
|
|
|
| DeleteFilterViewRequest();
|
| @@ -4030,7 +4051,8 @@ class DeleteFilterViewRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (filterId != null) {
|
| _json["filterId"] = filterId;
|
| }
|
| @@ -4038,9 +4060,9 @@ class DeleteFilterViewRequest {
|
| }
|
| }
|
|
|
| -/** Removes the named range with the given ID from the spreadsheet. */
|
| +/// Removes the named range with the given ID from the spreadsheet.
|
| class DeleteNamedRangeRequest {
|
| - /** The ID of the named range to delete. */
|
| + /// The ID of the named range to delete.
|
| core.String namedRangeId;
|
|
|
| DeleteNamedRangeRequest();
|
| @@ -4052,7 +4074,8 @@ class DeleteNamedRangeRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (namedRangeId != null) {
|
| _json["namedRangeId"] = namedRangeId;
|
| }
|
| @@ -4060,9 +4083,9 @@ class DeleteNamedRangeRequest {
|
| }
|
| }
|
|
|
| -/** Deletes the protected range with the given ID. */
|
| +/// Deletes the protected range with the given ID.
|
| class DeleteProtectedRangeRequest {
|
| - /** The ID of the protected range to delete. */
|
| + /// The ID of the protected range to delete.
|
| core.int protectedRangeId;
|
|
|
| DeleteProtectedRangeRequest();
|
| @@ -4074,7 +4097,8 @@ class DeleteProtectedRangeRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (protectedRangeId != null) {
|
| _json["protectedRangeId"] = protectedRangeId;
|
| }
|
| @@ -4082,20 +4106,19 @@ class DeleteProtectedRangeRequest {
|
| }
|
| }
|
|
|
| -/** Deletes a range of cells, shifting other cells into the deleted area. */
|
| +/// Deletes a range of cells, shifting other cells into the deleted area.
|
| class DeleteRangeRequest {
|
| - /** The range of cells to delete. */
|
| + /// The range of cells to delete.
|
| GridRange range;
|
| - /**
|
| - * The dimension from which deleted cells will be replaced with.
|
| - * If ROWS, existing cells will be shifted upward to
|
| - * replace the deleted cells. If COLUMNS, existing cells
|
| - * will be shifted left to replace the deleted cells.
|
| - * Possible string values are:
|
| - * - "DIMENSION_UNSPECIFIED" : The default value, do not use.
|
| - * - "ROWS" : Operates on the rows of a sheet.
|
| - * - "COLUMNS" : Operates on the columns of a sheet.
|
| - */
|
| +
|
| + /// The dimension from which deleted cells will be replaced with.
|
| + /// If ROWS, existing cells will be shifted upward to
|
| + /// replace the deleted cells. If COLUMNS, existing cells
|
| + /// will be shifted left to replace the deleted cells.
|
| + /// Possible string values are:
|
| + /// - "DIMENSION_UNSPECIFIED" : The default value, do not use.
|
| + /// - "ROWS" : Operates on the rows of a sheet.
|
| + /// - "COLUMNS" : Operates on the columns of a sheet.
|
| core.String shiftDimension;
|
|
|
| DeleteRangeRequest();
|
| @@ -4110,7 +4133,8 @@ class DeleteRangeRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (range != null) {
|
| _json["range"] = (range).toJson();
|
| }
|
| @@ -4121,9 +4145,9 @@ class DeleteRangeRequest {
|
| }
|
| }
|
|
|
| -/** Deletes the requested sheet. */
|
| +/// Deletes the requested sheet.
|
| class DeleteSheetRequest {
|
| - /** The ID of the sheet to delete. */
|
| + /// The ID of the sheet to delete.
|
| core.int sheetId;
|
|
|
| DeleteSheetRequest();
|
| @@ -4135,7 +4159,8 @@ class DeleteSheetRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (sheetId != null) {
|
| _json["sheetId"] = sheetId;
|
| }
|
| @@ -4143,18 +4168,16 @@ class DeleteSheetRequest {
|
| }
|
| }
|
|
|
| -/** Properties about a dimension. */
|
| +/// Properties about a dimension.
|
| class DimensionProperties {
|
| - /**
|
| - * True if this dimension is being filtered.
|
| - * This field is read-only.
|
| - */
|
| + /// True if this dimension is being filtered.
|
| + /// This field is read-only.
|
| core.bool hiddenByFilter;
|
| - /** True if this dimension is explicitly hidden. */
|
| +
|
| + /// True if this dimension is explicitly hidden.
|
| core.bool hiddenByUser;
|
| - /**
|
| - * The height (if a row) or width (if a column) of the dimension in pixels.
|
| - */
|
| +
|
| + /// The height (if a row) or width (if a column) of the dimension in pixels.
|
| core.int pixelSize;
|
|
|
| DimensionProperties();
|
| @@ -4172,7 +4195,8 @@ class DimensionProperties {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (hiddenByFilter != null) {
|
| _json["hiddenByFilter"] = hiddenByFilter;
|
| }
|
| @@ -4186,27 +4210,26 @@ class DimensionProperties {
|
| }
|
| }
|
|
|
| -/**
|
| - * A range along a single dimension on a sheet.
|
| - * All indexes are zero-based.
|
| - * Indexes are half open: the start index is inclusive
|
| - * and the end index is exclusive.
|
| - * Missing indexes indicate the range is unbounded on that side.
|
| - */
|
| +/// A range along a single dimension on a sheet.
|
| +/// All indexes are zero-based.
|
| +/// Indexes are half open: the start index is inclusive
|
| +/// and the end index is exclusive.
|
| +/// Missing indexes indicate the range is unbounded on that side.
|
| class DimensionRange {
|
| - /**
|
| - * The dimension of the span.
|
| - * Possible string values are:
|
| - * - "DIMENSION_UNSPECIFIED" : The default value, do not use.
|
| - * - "ROWS" : Operates on the rows of a sheet.
|
| - * - "COLUMNS" : Operates on the columns of a sheet.
|
| - */
|
| + /// The dimension of the span.
|
| + /// Possible string values are:
|
| + /// - "DIMENSION_UNSPECIFIED" : The default value, do not use.
|
| + /// - "ROWS" : Operates on the rows of a sheet.
|
| + /// - "COLUMNS" : Operates on the columns of a sheet.
|
| core.String dimension;
|
| - /** The end (exclusive) of the span, or not set if unbounded. */
|
| +
|
| + /// The end (exclusive) of the span, or not set if unbounded.
|
| core.int endIndex;
|
| - /** The sheet this span is on. */
|
| +
|
| + /// The sheet this span is on.
|
| core.int sheetId;
|
| - /** The start (inclusive) of the span, or not set if unbounded. */
|
| +
|
| + /// The start (inclusive) of the span, or not set if unbounded.
|
| core.int startIndex;
|
|
|
| DimensionRange();
|
| @@ -4227,7 +4250,8 @@ class DimensionRange {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (dimension != null) {
|
| _json["dimension"] = dimension;
|
| }
|
| @@ -4244,9 +4268,9 @@ class DimensionRange {
|
| }
|
| }
|
|
|
| -/** Duplicates a particular filter view. */
|
| +/// Duplicates a particular filter view.
|
| class DuplicateFilterViewRequest {
|
| - /** The ID of the filter being duplicated. */
|
| + /// The ID of the filter being duplicated.
|
| core.int filterId;
|
|
|
| DuplicateFilterViewRequest();
|
| @@ -4258,7 +4282,8 @@ class DuplicateFilterViewRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (filterId != null) {
|
| _json["filterId"] = filterId;
|
| }
|
| @@ -4266,9 +4291,9 @@ class DuplicateFilterViewRequest {
|
| }
|
| }
|
|
|
| -/** The result of a filter view being duplicated. */
|
| +/// The result of a filter view being duplicated.
|
| class DuplicateFilterViewResponse {
|
| - /** The newly created filter. */
|
| + /// The newly created filter.
|
| FilterView filter;
|
|
|
| DuplicateFilterViewResponse();
|
| @@ -4280,7 +4305,8 @@ class DuplicateFilterViewResponse {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (filter != null) {
|
| _json["filter"] = (filter).toJson();
|
| }
|
| @@ -4288,22 +4314,21 @@ class DuplicateFilterViewResponse {
|
| }
|
| }
|
|
|
| -/** Duplicates the contents of a sheet. */
|
| +/// Duplicates the contents of a sheet.
|
| class DuplicateSheetRequest {
|
| - /**
|
| - * The zero-based index where the new sheet should be inserted.
|
| - * The index of all sheets after this are incremented.
|
| - */
|
| + /// The zero-based index where the new sheet should be inserted.
|
| + /// The index of all sheets after this are incremented.
|
| core.int insertSheetIndex;
|
| - /**
|
| - * If set, the ID of the new sheet. If not set, an ID is chosen.
|
| - * If set, the ID must not conflict with any existing sheet ID.
|
| - * If set, it must be non-negative.
|
| - */
|
| +
|
| + /// If set, the ID of the new sheet. If not set, an ID is chosen.
|
| + /// If set, the ID must not conflict with any existing sheet ID.
|
| + /// If set, it must be non-negative.
|
| core.int newSheetId;
|
| - /** The name of the new sheet. If empty, a new name is chosen for you. */
|
| +
|
| + /// The name of the new sheet. If empty, a new name is chosen for you.
|
| core.String newSheetName;
|
| - /** The sheet to duplicate. */
|
| +
|
| + /// The sheet to duplicate.
|
| core.int sourceSheetId;
|
|
|
| DuplicateSheetRequest();
|
| @@ -4324,7 +4349,8 @@ class DuplicateSheetRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (insertSheetIndex != null) {
|
| _json["insertSheetIndex"] = insertSheetIndex;
|
| }
|
| @@ -4341,9 +4367,9 @@ class DuplicateSheetRequest {
|
| }
|
| }
|
|
|
| -/** The result of duplicating a sheet. */
|
| +/// The result of duplicating a sheet.
|
| class DuplicateSheetResponse {
|
| - /** The properties of the duplicate sheet. */
|
| + /// The properties of the duplicate sheet.
|
| SheetProperties properties;
|
|
|
| DuplicateSheetResponse();
|
| @@ -4355,7 +4381,8 @@ class DuplicateSheetResponse {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (properties != null) {
|
| _json["properties"] = (properties).toJson();
|
| }
|
| @@ -4363,16 +4390,16 @@ class DuplicateSheetResponse {
|
| }
|
| }
|
|
|
| -/** The editors of a protected range. */
|
| +/// The editors of a protected range.
|
| class Editors {
|
| - /**
|
| - * True if anyone in the document's domain has edit access to the protected
|
| - * range. Domain protection is only supported on documents within a domain.
|
| - */
|
| + /// True if anyone in the document's domain has edit access to the protected
|
| + /// range. Domain protection is only supported on documents within a domain.
|
| core.bool domainUsersCanEdit;
|
| - /** The email addresses of groups with edit access to the protected range. */
|
| +
|
| + /// The email addresses of groups with edit access to the protected range.
|
| core.List<core.String> groups;
|
| - /** The email addresses of users with edit access to the protected range. */
|
| +
|
| + /// The email addresses of users with edit access to the protected range.
|
| core.List<core.String> users;
|
|
|
| Editors();
|
| @@ -4390,7 +4417,8 @@ class Editors {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (domainUsersCanEdit != null) {
|
| _json["domainUsersCanEdit"] = domainUsersCanEdit;
|
| }
|
| @@ -4404,13 +4432,15 @@ class Editors {
|
| }
|
| }
|
|
|
| -/** A chart embedded in a sheet. */
|
| +/// A chart embedded in a sheet.
|
| class EmbeddedChart {
|
| - /** The ID of the chart. */
|
| + /// The ID of the chart.
|
| core.int chartId;
|
| - /** The position of the chart. */
|
| +
|
| + /// The position of the chart.
|
| EmbeddedObjectPosition position;
|
| - /** The specification of the chart. */
|
| +
|
| + /// The specification of the chart.
|
| ChartSpec spec;
|
|
|
| EmbeddedChart();
|
| @@ -4428,7 +4458,8 @@ class EmbeddedChart {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (chartId != null) {
|
| _json["chartId"] = chartId;
|
| }
|
| @@ -4442,19 +4473,17 @@ class EmbeddedChart {
|
| }
|
| }
|
|
|
| -/** The position of an embedded object such as a chart. */
|
| +/// The position of an embedded object such as a chart.
|
| class EmbeddedObjectPosition {
|
| - /**
|
| - * If true, the embedded object will be put on a new sheet whose ID
|
| - * is chosen for you. Used only when writing.
|
| - */
|
| + /// If true, the embedded object will be put on a new sheet whose ID
|
| + /// is chosen for you. Used only when writing.
|
| core.bool newSheet;
|
| - /** The position at which the object is overlaid on top of a grid. */
|
| +
|
| + /// The position at which the object is overlaid on top of a grid.
|
| OverlayPosition overlayPosition;
|
| - /**
|
| - * The sheet this is on. Set only if the embedded object
|
| - * is on its own sheet. Must be non-negative.
|
| - */
|
| +
|
| + /// The sheet this is on. Set only if the embedded object
|
| + /// is on its own sheet. Must be non-negative.
|
| core.int sheetId;
|
|
|
| EmbeddedObjectPosition();
|
| @@ -4472,7 +4501,8 @@ class EmbeddedObjectPosition {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (newSheet != null) {
|
| _json["newSheet"] = newSheet;
|
| }
|
| @@ -4486,27 +4516,24 @@ class EmbeddedObjectPosition {
|
| }
|
| }
|
|
|
| -/** An error in a cell. */
|
| +/// An error in a cell.
|
| class ErrorValue {
|
| - /**
|
| - * A message with more information about the error
|
| - * (in the spreadsheet's locale).
|
| - */
|
| + /// A message with more information about the error
|
| + /// (in the spreadsheet's locale).
|
| core.String message;
|
| - /**
|
| - * The type of error.
|
| - * Possible string values are:
|
| - * - "ERROR_TYPE_UNSPECIFIED" : The default error type, do not use this.
|
| - * - "ERROR" : Corresponds to the `#ERROR!` error.
|
| - * - "NULL_VALUE" : Corresponds to the `#NULL!` error.
|
| - * - "DIVIDE_BY_ZERO" : Corresponds to the `#DIV/0` error.
|
| - * - "VALUE" : Corresponds to the `#VALUE!` error.
|
| - * - "REF" : Corresponds to the `#REF!` error.
|
| - * - "NAME" : Corresponds to the `#NAME?` error.
|
| - * - "NUM" : Corresponds to the `#NUM`! error.
|
| - * - "N_A" : Corresponds to the `#N/A` error.
|
| - * - "LOADING" : Corresponds to the `Loading...` state.
|
| - */
|
| +
|
| + /// The type of error.
|
| + /// Possible string values are:
|
| + /// - "ERROR_TYPE_UNSPECIFIED" : The default error type, do not use this.
|
| + /// - "ERROR" : Corresponds to the `#ERROR!` error.
|
| + /// - "NULL_VALUE" : Corresponds to the `#NULL!` error.
|
| + /// - "DIVIDE_BY_ZERO" : Corresponds to the `#DIV/0` error.
|
| + /// - "VALUE" : Corresponds to the `#VALUE!` error.
|
| + /// - "REF" : Corresponds to the `#REF!` error.
|
| + /// - "NAME" : Corresponds to the `#NAME?` error.
|
| + /// - "NUM" : Corresponds to the `#NUM`! error.
|
| + /// - "N_A" : Corresponds to the `#N/A` error.
|
| + /// - "LOADING" : Corresponds to the `Loading...` state.
|
| core.String type;
|
|
|
| ErrorValue();
|
| @@ -4521,7 +4548,8 @@ class ErrorValue {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (message != null) {
|
| _json["message"] = message;
|
| }
|
| @@ -4532,29 +4560,27 @@ class ErrorValue {
|
| }
|
| }
|
|
|
| -/** The kinds of value that a cell in a spreadsheet can have. */
|
| +/// The kinds of value that a cell in a spreadsheet can have.
|
| class ExtendedValue {
|
| - /** Represents a boolean value. */
|
| + /// Represents a boolean value.
|
| core.bool boolValue;
|
| - /**
|
| - * Represents an error.
|
| - * This field is read-only.
|
| - */
|
| +
|
| + /// Represents an error.
|
| + /// This field is read-only.
|
| ErrorValue errorValue;
|
| - /** Represents a formula. */
|
| +
|
| + /// Represents a formula.
|
| core.String formulaValue;
|
| - /**
|
| - * Represents a double value.
|
| - * Note: Dates, Times and DateTimes are represented as doubles in
|
| - * "serial number" format.
|
| - */
|
| +
|
| + /// Represents a double value.
|
| + /// Note: Dates, Times and DateTimes are represented as doubles in
|
| + /// "serial number" format.
|
| core.double numberValue;
|
| - /**
|
| - * Represents a string value.
|
| - * Leading single quotes are not included. For example, if the user typed
|
| - * `'123` into the UI, this would be represented as a `stringValue` of
|
| - * `"123"`.
|
| - */
|
| +
|
| + /// Represents a string value.
|
| + /// Leading single quotes are not included. For example, if the user typed
|
| + /// `'123` into the UI, this would be represented as a `stringValue` of
|
| + /// `"123"`.
|
| core.String stringValue;
|
|
|
| ExtendedValue();
|
| @@ -4578,7 +4604,8 @@ class ExtendedValue {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (boolValue != null) {
|
| _json["boolValue"] = boolValue;
|
| }
|
| @@ -4598,15 +4625,14 @@ class ExtendedValue {
|
| }
|
| }
|
|
|
| -/** Criteria for showing/hiding rows in a filter or filter view. */
|
| +/// Criteria for showing/hiding rows in a filter or filter view.
|
| class FilterCriteria {
|
| - /**
|
| - * A condition that must be true for values to be shown.
|
| - * (This does not override hiddenValues -- if a value is listed there,
|
| - * it will still be hidden.)
|
| - */
|
| + /// A condition that must be true for values to be shown.
|
| + /// (This does not override hiddenValues -- if a value is listed there,
|
| + /// it will still be hidden.)
|
| BooleanCondition condition;
|
| - /** Values that should be hidden. */
|
| +
|
| + /// Values that should be hidden.
|
| core.List<core.String> hiddenValues;
|
|
|
| FilterCriteria();
|
| @@ -4621,7 +4647,8 @@ class FilterCriteria {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (condition != null) {
|
| _json["condition"] = (condition).toJson();
|
| }
|
| @@ -4632,43 +4659,44 @@ class FilterCriteria {
|
| }
|
| }
|
|
|
| -/** A filter view. */
|
| +/// A filter view.
|
| class FilterView {
|
| - /**
|
| - * The criteria for showing/hiding values per column.
|
| - * The map's key is the column index, and the value is the criteria for
|
| - * that column.
|
| - */
|
| + /// The criteria for showing/hiding values per column.
|
| + /// The map's key is the column index, and the value is the criteria for
|
| + /// that column.
|
| core.Map<core.String, FilterCriteria> criteria;
|
| - /** The ID of the filter view. */
|
| +
|
| + /// The ID of the filter view.
|
| core.int filterViewId;
|
| - /**
|
| - * The named range this filter view is backed by, if any.
|
| - *
|
| - * When writing, only one of range or named_range_id
|
| - * may be set.
|
| - */
|
| +
|
| + /// The named range this filter view is backed by, if any.
|
| + ///
|
| + /// When writing, only one of range or named_range_id
|
| + /// may be set.
|
| core.String namedRangeId;
|
| - /**
|
| - * The range this filter view covers.
|
| - *
|
| - * When writing, only one of range or named_range_id
|
| - * may be set.
|
| - */
|
| +
|
| + /// The range this filter view covers.
|
| + ///
|
| + /// When writing, only one of range or named_range_id
|
| + /// may be set.
|
| GridRange range;
|
| - /**
|
| - * The sort order per column. Later specifications are used when values
|
| - * are equal in the earlier specifications.
|
| - */
|
| +
|
| + /// The sort order per column. Later specifications are used when values
|
| + /// are equal in the earlier specifications.
|
| core.List<SortSpec> sortSpecs;
|
| - /** The name of the filter view. */
|
| +
|
| + /// The name of the filter view.
|
| core.String title;
|
|
|
| FilterView();
|
|
|
| FilterView.fromJson(core.Map _json) {
|
| if (_json.containsKey("criteria")) {
|
| - criteria = commons.mapMap<core.Map<core.String, core.Object>, FilterCriteria>(_json["criteria"], (core.Map<core.String, core.Object> item) => new FilterCriteria.fromJson(item));
|
| + criteria =
|
| + commons.mapMap<core.Map<core.String, core.Object>, FilterCriteria>(
|
| + _json["criteria"],
|
| + (core.Map<core.String, core.Object> item) =>
|
| + new FilterCriteria.fromJson(item));
|
| }
|
| if (_json.containsKey("filterViewId")) {
|
| filterViewId = _json["filterViewId"];
|
| @@ -4680,7 +4708,9 @@ class FilterView {
|
| range = new GridRange.fromJson(_json["range"]);
|
| }
|
| if (_json.containsKey("sortSpecs")) {
|
| - sortSpecs = _json["sortSpecs"].map((value) => new SortSpec.fromJson(value)).toList();
|
| + sortSpecs = _json["sortSpecs"]
|
| + .map((value) => new SortSpec.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("title")) {
|
| title = _json["title"];
|
| @@ -4688,9 +4718,12 @@ class FilterView {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (criteria != null) {
|
| - _json["criteria"] = commons.mapMap<FilterCriteria, core.Map<core.String, core.Object>>(criteria, (FilterCriteria item) => (item).toJson());
|
| + _json["criteria"] =
|
| + commons.mapMap<FilterCriteria, core.Map<core.String, core.Object>>(
|
| + criteria, (FilterCriteria item) => (item).toJson());
|
| }
|
| if (filterViewId != null) {
|
| _json["filterViewId"] = filterViewId;
|
| @@ -4711,37 +4744,43 @@ class FilterView {
|
| }
|
| }
|
|
|
| -/** Finds and replaces data in cells over a range, sheet, or all sheets. */
|
| +/// Finds and replaces data in cells over a range, sheet, or all sheets.
|
| class FindReplaceRequest {
|
| - /** True to find/replace over all sheets. */
|
| + /// True to find/replace over all sheets.
|
| core.bool allSheets;
|
| - /** The value to search. */
|
| +
|
| + /// The value to search.
|
| core.String find;
|
| - /**
|
| - * True if the search should include cells with formulas.
|
| - * False to skip cells with formulas.
|
| - */
|
| +
|
| + /// True if the search should include cells with formulas.
|
| + /// False to skip cells with formulas.
|
| core.bool includeFormulas;
|
| - /** True if the search is case sensitive. */
|
| +
|
| + /// True if the search is case sensitive.
|
| core.bool matchCase;
|
| - /** True if the find value should match the entire cell. */
|
| +
|
| + /// True if the find value should match the entire cell.
|
| core.bool matchEntireCell;
|
| - /** The range to find/replace over. */
|
| +
|
| + /// The range to find/replace over.
|
| GridRange range;
|
| - /** The value to use as the replacement. */
|
| +
|
| + /// The value to use as the replacement.
|
| core.String replacement;
|
| - /**
|
| - * True if the find value is a regex.
|
| - * The regular expression and replacement should follow Java regex rules
|
| - * at https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html.
|
| - * The replacement string is allowed to refer to capturing groups.
|
| - * For example, if one cell has the contents `"Google Sheets"` and another
|
| - * has `"Google Docs"`, then searching for `"o.* (.*)"` with a replacement of
|
| - * `"$1 Rocks"` would change the contents of the cells to
|
| - * `"GSheets Rocks"` and `"GDocs Rocks"` respectively.
|
| - */
|
| +
|
| + /// True if the find value is a regex.
|
| + /// The regular expression and replacement should follow Java regex rules
|
| + /// at
|
| + /// https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html.
|
| + /// The replacement string is allowed to refer to capturing groups.
|
| + /// For example, if one cell has the contents `"Google Sheets"` and another
|
| + /// has `"Google Docs"`, then searching for `"o.* (.*)"` with a replacement
|
| + /// of
|
| + /// `"$1 Rocks"` would change the contents of the cells to
|
| + /// `"GSheets Rocks"` and `"GDocs Rocks"` respectively.
|
| core.bool searchByRegex;
|
| - /** The sheet to find/replace over. */
|
| +
|
| + /// The sheet to find/replace over.
|
| core.int sheetId;
|
|
|
| FindReplaceRequest();
|
| @@ -4777,7 +4816,8 @@ class FindReplaceRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (allSheets != null) {
|
| _json["allSheets"] = allSheets;
|
| }
|
| @@ -4809,21 +4849,24 @@ class FindReplaceRequest {
|
| }
|
| }
|
|
|
| -/** The result of the find/replace. */
|
| +/// The result of the find/replace.
|
| class FindReplaceResponse {
|
| - /** The number of formula cells changed. */
|
| + /// The number of formula cells changed.
|
| core.int formulasChanged;
|
| - /**
|
| - * The number of occurrences (possibly multiple within a cell) changed.
|
| - * For example, if replacing `"e"` with `"o"` in `"Google Sheets"`, this would
|
| - * be `"3"` because `"Google Sheets"` -> `"Googlo Shoots"`.
|
| - */
|
| +
|
| + /// The number of occurrences (possibly multiple within a cell) changed.
|
| + /// For example, if replacing `"e"` with `"o"` in `"Google Sheets"`, this
|
| + /// would
|
| + /// be `"3"` because `"Google Sheets"` -> `"Googlo Shoots"`.
|
| core.int occurrencesChanged;
|
| - /** The number of rows changed. */
|
| +
|
| + /// The number of rows changed.
|
| core.int rowsChanged;
|
| - /** The number of sheets changed. */
|
| +
|
| + /// The number of sheets changed.
|
| core.int sheetsChanged;
|
| - /** The number of non-formula cells changed. */
|
| +
|
| + /// The number of non-formula cells changed.
|
| core.int valuesChanged;
|
|
|
| FindReplaceResponse();
|
| @@ -4847,7 +4890,8 @@ class FindReplaceResponse {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (formulasChanged != null) {
|
| _json["formulasChanged"] = formulasChanged;
|
| }
|
| @@ -4867,18 +4911,18 @@ class FindReplaceResponse {
|
| }
|
| }
|
|
|
| -/**
|
| - * A rule that applies a gradient color scale format, based on
|
| - * the interpolation points listed. The format of a cell will vary
|
| - * based on its contents as compared to the values of the interpolation
|
| - * points.
|
| - */
|
| +/// A rule that applies a gradient color scale format, based on
|
| +/// the interpolation points listed. The format of a cell will vary
|
| +/// based on its contents as compared to the values of the interpolation
|
| +/// points.
|
| class GradientRule {
|
| - /** The final interpolation point. */
|
| + /// The final interpolation point.
|
| InterpolationPoint maxpoint;
|
| - /** An optional midway interpolation point. */
|
| +
|
| + /// An optional midway interpolation point.
|
| InterpolationPoint midpoint;
|
| - /** The starting interpolation point. */
|
| +
|
| + /// The starting interpolation point.
|
| InterpolationPoint minpoint;
|
|
|
| GradientRule();
|
| @@ -4896,7 +4940,8 @@ class GradientRule {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (maxpoint != null) {
|
| _json["maxpoint"] = (maxpoint).toJson();
|
| }
|
| @@ -4910,16 +4955,16 @@ class GradientRule {
|
| }
|
| }
|
|
|
| -/**
|
| - * A coordinate in a sheet.
|
| - * All indexes are zero-based.
|
| - */
|
| +/// A coordinate in a sheet.
|
| +/// All indexes are zero-based.
|
| class GridCoordinate {
|
| - /** The column index of the coordinate. */
|
| + /// The column index of the coordinate.
|
| core.int columnIndex;
|
| - /** The row index of the coordinate. */
|
| +
|
| + /// The row index of the coordinate.
|
| core.int rowIndex;
|
| - /** The sheet this coordinate is on. */
|
| +
|
| + /// The sheet this coordinate is on.
|
| core.int sheetId;
|
|
|
| GridCoordinate();
|
| @@ -4937,7 +4982,8 @@ class GridCoordinate {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (columnIndex != null) {
|
| _json["columnIndex"] = columnIndex;
|
| }
|
| @@ -4951,41 +4997,45 @@ class GridCoordinate {
|
| }
|
| }
|
|
|
| -/** Data in the grid, as well as metadata about the dimensions. */
|
| +/// Data in the grid, as well as metadata about the dimensions.
|
| class GridData {
|
| - /**
|
| - * Metadata about the requested columns in the grid, starting with the column
|
| - * in start_column.
|
| - */
|
| + /// Metadata about the requested columns in the grid, starting with the
|
| + /// column
|
| + /// in start_column.
|
| core.List<DimensionProperties> columnMetadata;
|
| - /**
|
| - * The data in the grid, one entry per row,
|
| - * starting with the row in startRow.
|
| - * The values in RowData will correspond to columns starting
|
| - * at start_column.
|
| - */
|
| +
|
| + /// The data in the grid, one entry per row,
|
| + /// starting with the row in startRow.
|
| + /// The values in RowData will correspond to columns starting
|
| + /// at start_column.
|
| core.List<RowData> rowData;
|
| - /**
|
| - * Metadata about the requested rows in the grid, starting with the row
|
| - * in start_row.
|
| - */
|
| +
|
| + /// Metadata about the requested rows in the grid, starting with the row
|
| + /// in start_row.
|
| core.List<DimensionProperties> rowMetadata;
|
| - /** The first column this GridData refers to, zero-based. */
|
| +
|
| + /// The first column this GridData refers to, zero-based.
|
| core.int startColumn;
|
| - /** The first row this GridData refers to, zero-based. */
|
| +
|
| + /// The first row this GridData refers to, zero-based.
|
| core.int startRow;
|
|
|
| GridData();
|
|
|
| GridData.fromJson(core.Map _json) {
|
| if (_json.containsKey("columnMetadata")) {
|
| - columnMetadata = _json["columnMetadata"].map((value) => new DimensionProperties.fromJson(value)).toList();
|
| + columnMetadata = _json["columnMetadata"]
|
| + .map((value) => new DimensionProperties.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("rowData")) {
|
| - rowData = _json["rowData"].map((value) => new RowData.fromJson(value)).toList();
|
| + rowData =
|
| + _json["rowData"].map((value) => new RowData.fromJson(value)).toList();
|
| }
|
| if (_json.containsKey("rowMetadata")) {
|
| - rowMetadata = _json["rowMetadata"].map((value) => new DimensionProperties.fromJson(value)).toList();
|
| + rowMetadata = _json["rowMetadata"]
|
| + .map((value) => new DimensionProperties.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("startColumn")) {
|
| startColumn = _json["startColumn"];
|
| @@ -4996,15 +5046,18 @@ class GridData {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (columnMetadata != null) {
|
| - _json["columnMetadata"] = columnMetadata.map((value) => (value).toJson()).toList();
|
| + _json["columnMetadata"] =
|
| + columnMetadata.map((value) => (value).toJson()).toList();
|
| }
|
| if (rowData != null) {
|
| _json["rowData"] = rowData.map((value) => (value).toJson()).toList();
|
| }
|
| if (rowMetadata != null) {
|
| - _json["rowMetadata"] = rowMetadata.map((value) => (value).toJson()).toList();
|
| + _json["rowMetadata"] =
|
| + rowMetadata.map((value) => (value).toJson()).toList();
|
| }
|
| if (startColumn != null) {
|
| _json["startColumn"] = startColumn;
|
| @@ -5016,17 +5069,21 @@ class GridData {
|
| }
|
| }
|
|
|
| -/** Properties of a grid. */
|
| +/// Properties of a grid.
|
| class GridProperties {
|
| - /** The number of columns in the grid. */
|
| + /// The number of columns in the grid.
|
| core.int columnCount;
|
| - /** The number of columns that are frozen in the grid. */
|
| +
|
| + /// The number of columns that are frozen in the grid.
|
| core.int frozenColumnCount;
|
| - /** The number of rows that are frozen in the grid. */
|
| +
|
| + /// The number of rows that are frozen in the grid.
|
| core.int frozenRowCount;
|
| - /** True if the grid isn't showing gridlines in the UI. */
|
| +
|
| + /// True if the grid isn't showing gridlines in the UI.
|
| core.bool hideGridlines;
|
| - /** The number of rows in the grid. */
|
| +
|
| + /// The number of rows in the grid.
|
| core.int rowCount;
|
|
|
| GridProperties();
|
| @@ -5050,7 +5107,8 @@ class GridProperties {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (columnCount != null) {
|
| _json["columnCount"] = columnCount;
|
| }
|
| @@ -5070,47 +5128,49 @@ class GridProperties {
|
| }
|
| }
|
|
|
| -/**
|
| - * A range on a sheet.
|
| - * All indexes are zero-based.
|
| - * Indexes are half open, e.g the start index is inclusive
|
| - * and the end index is exclusive -- [start_index, end_index).
|
| - * Missing indexes indicate the range is unbounded on that side.
|
| - *
|
| - * For example, if `"Sheet1"` is sheet ID 0, then:
|
| - *
|
| - * `Sheet1!A1:A1 == sheet_id: 0,
|
| - * start_row_index: 0, end_row_index: 1,
|
| - * start_column_index: 0, end_column_index: 1`
|
| - *
|
| - * `Sheet1!A3:B4 == sheet_id: 0,
|
| - * start_row_index: 2, end_row_index: 4,
|
| - * start_column_index: 0, end_column_index: 2`
|
| - *
|
| - * `Sheet1!A:B == sheet_id: 0,
|
| - * start_column_index: 0, end_column_index: 2`
|
| - *
|
| - * `Sheet1!A5:B == sheet_id: 0,
|
| - * start_row_index: 4,
|
| - * start_column_index: 0, end_column_index: 2`
|
| - *
|
| - * `Sheet1 == sheet_id:0`
|
| - *
|
| - * The start index must always be less than or equal to the end index.
|
| - * If the start index equals the end index, then the range is empty.
|
| - * Empty ranges are typically not meaningful and are usually rendered in the
|
| - * UI as `#REF!`.
|
| - */
|
| +/// A range on a sheet.
|
| +/// All indexes are zero-based.
|
| +/// Indexes are half open, e.g the start index is inclusive
|
| +/// and the end index is exclusive -- [start_index, end_index).
|
| +/// Missing indexes indicate the range is unbounded on that side.
|
| +///
|
| +/// For example, if `"Sheet1"` is sheet ID 0, then:
|
| +///
|
| +/// `Sheet1!A1:A1 == sheet_id: 0,
|
| +/// start_row_index: 0, end_row_index: 1,
|
| +/// start_column_index: 0, end_column_index: 1`
|
| +///
|
| +/// `Sheet1!A3:B4 == sheet_id: 0,
|
| +/// start_row_index: 2, end_row_index: 4,
|
| +/// start_column_index: 0, end_column_index: 2`
|
| +///
|
| +/// `Sheet1!A:B == sheet_id: 0,
|
| +/// start_column_index: 0, end_column_index: 2`
|
| +///
|
| +/// `Sheet1!A5:B == sheet_id: 0,
|
| +/// start_row_index: 4,
|
| +/// start_column_index: 0, end_column_index: 2`
|
| +///
|
| +/// `Sheet1 == sheet_id:0`
|
| +///
|
| +/// The start index must always be less than or equal to the end index.
|
| +/// If the start index equals the end index, then the range is empty.
|
| +/// Empty ranges are typically not meaningful and are usually rendered in the
|
| +/// UI as `#REF!`.
|
| class GridRange {
|
| - /** The end column (exclusive) of the range, or not set if unbounded. */
|
| + /// The end column (exclusive) of the range, or not set if unbounded.
|
| core.int endColumnIndex;
|
| - /** The end row (exclusive) of the range, or not set if unbounded. */
|
| +
|
| + /// The end row (exclusive) of the range, or not set if unbounded.
|
| core.int endRowIndex;
|
| - /** The sheet this range is on. */
|
| +
|
| + /// The sheet this range is on.
|
| core.int sheetId;
|
| - /** The start column (inclusive) of the range, or not set if unbounded. */
|
| +
|
| + /// The start column (inclusive) of the range, or not set if unbounded.
|
| core.int startColumnIndex;
|
| - /** The start row (inclusive) of the range, or not set if unbounded. */
|
| +
|
| + /// The start row (inclusive) of the range, or not set if unbounded.
|
| core.int startRowIndex;
|
|
|
| GridRange();
|
| @@ -5134,7 +5194,8 @@ class GridRange {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (endColumnIndex != null) {
|
| _json["endColumnIndex"] = endColumnIndex;
|
| }
|
| @@ -5154,55 +5215,50 @@ class GridRange {
|
| }
|
| }
|
|
|
| -/**
|
| - * A <a href="/chart/interactive/docs/gallery/histogram">histogram chart</a>.
|
| - * A histogram chart groups data items into bins, displaying each bin as a
|
| - * column of stacked items. Histograms are used to display the distribution
|
| - * of a dataset. Each column of items represents a range into which those
|
| - * items fall. The number of bins can be chosen automatically or specified
|
| - * explicitly.
|
| - */
|
| +/// A <a href="/chart/interactive/docs/gallery/histogram">histogram chart</a>.
|
| +/// A histogram chart groups data items into bins, displaying each bin as a
|
| +/// column of stacked items. Histograms are used to display the distribution
|
| +/// of a dataset. Each column of items represents a range into which those
|
| +/// items fall. The number of bins can be chosen automatically or specified
|
| +/// explicitly.
|
| class HistogramChartSpec {
|
| - /**
|
| - * By default the bucket size (the range of values stacked in a single
|
| - * column) is chosen automatically, but it may be overridden here.
|
| - * E.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc.
|
| - * Cannot be negative.
|
| - * This field is optional.
|
| - */
|
| + /// By default the bucket size (the range of values stacked in a single
|
| + /// column) is chosen automatically, but it may be overridden here.
|
| + /// E.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0,
|
| + /// etc.
|
| + /// Cannot be negative.
|
| + /// This field is optional.
|
| core.double bucketSize;
|
| - /**
|
| - * The position of the chart legend.
|
| - * Possible string values are:
|
| - * - "HISTOGRAM_CHART_LEGEND_POSITION_UNSPECIFIED" : Default value, do not
|
| - * use.
|
| - * - "BOTTOM_LEGEND" : The legend is rendered on the bottom of the chart.
|
| - * - "LEFT_LEGEND" : The legend is rendered on the left of the chart.
|
| - * - "RIGHT_LEGEND" : The legend is rendered on the right of the chart.
|
| - * - "TOP_LEGEND" : The legend is rendered on the top of the chart.
|
| - * - "NO_LEGEND" : No legend is rendered.
|
| - * - "INSIDE_LEGEND" : The legend is rendered inside the chart area.
|
| - */
|
| +
|
| + /// The position of the chart legend.
|
| + /// Possible string values are:
|
| + /// - "HISTOGRAM_CHART_LEGEND_POSITION_UNSPECIFIED" : Default value, do not
|
| + /// use.
|
| + /// - "BOTTOM_LEGEND" : The legend is rendered on the bottom of the chart.
|
| + /// - "LEFT_LEGEND" : The legend is rendered on the left of the chart.
|
| + /// - "RIGHT_LEGEND" : The legend is rendered on the right of the chart.
|
| + /// - "TOP_LEGEND" : The legend is rendered on the top of the chart.
|
| + /// - "NO_LEGEND" : No legend is rendered.
|
| + /// - "INSIDE_LEGEND" : The legend is rendered inside the chart area.
|
| core.String legendPosition;
|
| - /**
|
| - * The outlier percentile is used to ensure that outliers do not adversely
|
| - * affect the calculation of bucket sizes. For example, setting an outlier
|
| - * percentile of 0.05 indicates that the top and bottom 5% of values when
|
| - * calculating buckets. The values are still included in the chart, they will
|
| - * be added to the first or last buckets instead of their own buckets.
|
| - * Must be between 0.0 and 0.5.
|
| - */
|
| +
|
| + /// The outlier percentile is used to ensure that outliers do not adversely
|
| + /// affect the calculation of bucket sizes. For example, setting an outlier
|
| + /// percentile of 0.05 indicates that the top and bottom 5% of values when
|
| + /// calculating buckets. The values are still included in the chart, they
|
| + /// will
|
| + /// be added to the first or last buckets instead of their own buckets.
|
| + /// Must be between 0.0 and 0.5.
|
| core.double outlierPercentile;
|
| - /**
|
| - * The series for a histogram may be either a single series of values to be
|
| - * bucketed or multiple series, each of the same length, containing the name
|
| - * of the series followed by the values to be bucketed for that series.
|
| - */
|
| +
|
| + /// The series for a histogram may be either a single series of values to be
|
| + /// bucketed or multiple series, each of the same length, containing the name
|
| + /// of the series followed by the values to be bucketed for that series.
|
| core.List<HistogramSeries> series;
|
| - /**
|
| - * Whether horizontal divider lines should be displayed between items in each
|
| - * column.
|
| - */
|
| +
|
| + /// Whether horizontal divider lines should be displayed between items in
|
| + /// each
|
| + /// column.
|
| core.bool showItemDividers;
|
|
|
| HistogramChartSpec();
|
| @@ -5218,7 +5274,9 @@ class HistogramChartSpec {
|
| outlierPercentile = _json["outlierPercentile"];
|
| }
|
| if (_json.containsKey("series")) {
|
| - series = _json["series"].map((value) => new HistogramSeries.fromJson(value)).toList();
|
| + series = _json["series"]
|
| + .map((value) => new HistogramSeries.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("showItemDividers")) {
|
| showItemDividers = _json["showItemDividers"];
|
| @@ -5226,7 +5284,8 @@ class HistogramChartSpec {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (bucketSize != null) {
|
| _json["bucketSize"] = bucketSize;
|
| }
|
| @@ -5246,14 +5305,13 @@ class HistogramChartSpec {
|
| }
|
| }
|
|
|
| -/** A histogram series containing the series color and data. */
|
| +/// A histogram series containing the series color and data.
|
| class HistogramSeries {
|
| - /**
|
| - * The color of the column representing this series in each bucket.
|
| - * This field is optional.
|
| - */
|
| + /// The color of the column representing this series in each bucket.
|
| + /// This field is optional.
|
| Color barColor;
|
| - /** The data for this histogram series. */
|
| +
|
| + /// The data for this histogram series.
|
| ChartData data;
|
|
|
| HistogramSeries();
|
| @@ -5268,7 +5326,8 @@ class HistogramSeries {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (barColor != null) {
|
| _json["barColor"] = (barColor).toJson();
|
| }
|
| @@ -5279,26 +5338,24 @@ class HistogramSeries {
|
| }
|
| }
|
|
|
| -/** Inserts rows or columns in a sheet at a particular index. */
|
| +/// Inserts rows or columns in a sheet at a particular index.
|
| class InsertDimensionRequest {
|
| - /**
|
| - * Whether dimension properties should be extended from the dimensions
|
| - * before or after the newly inserted dimensions.
|
| - * True to inherit from the dimensions before (in which case the start
|
| - * index must be greater than 0), and false to inherit from the dimensions
|
| - * after.
|
| - *
|
| - * For example, if row index 0 has red background and row index 1
|
| - * has a green background, then inserting 2 rows at index 1 can inherit
|
| - * either the green or red background. If `inheritFromBefore` is true,
|
| - * the two new rows will be red (because the row before the insertion point
|
| - * was red), whereas if `inheritFromBefore` is false, the two new rows will
|
| - * be green (because the row after the insertion point was green).
|
| - */
|
| + /// Whether dimension properties should be extended from the dimensions
|
| + /// before or after the newly inserted dimensions.
|
| + /// True to inherit from the dimensions before (in which case the start
|
| + /// index must be greater than 0), and false to inherit from the dimensions
|
| + /// after.
|
| + ///
|
| + /// For example, if row index 0 has red background and row index 1
|
| + /// has a green background, then inserting 2 rows at index 1 can inherit
|
| + /// either the green or red background. If `inheritFromBefore` is true,
|
| + /// the two new rows will be red (because the row before the insertion point
|
| + /// was red), whereas if `inheritFromBefore` is false, the two new rows will
|
| + /// be green (because the row after the insertion point was green).
|
| core.bool inheritFromBefore;
|
| - /**
|
| - * The dimensions to insert. Both the start and end indexes must be bounded.
|
| - */
|
| +
|
| + /// The dimensions to insert. Both the start and end indexes must be
|
| + /// bounded.
|
| DimensionRange range;
|
|
|
| InsertDimensionRequest();
|
| @@ -5313,7 +5370,8 @@ class InsertDimensionRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (inheritFromBefore != null) {
|
| _json["inheritFromBefore"] = inheritFromBefore;
|
| }
|
| @@ -5324,19 +5382,18 @@ class InsertDimensionRequest {
|
| }
|
| }
|
|
|
| -/** Inserts cells into a range, shifting the existing cells over or down. */
|
| +/// Inserts cells into a range, shifting the existing cells over or down.
|
| class InsertRangeRequest {
|
| - /** The range to insert new cells into. */
|
| + /// The range to insert new cells into.
|
| GridRange range;
|
| - /**
|
| - * The dimension which will be shifted when inserting cells.
|
| - * If ROWS, existing cells will be shifted down.
|
| - * If COLUMNS, existing cells will be shifted right.
|
| - * Possible string values are:
|
| - * - "DIMENSION_UNSPECIFIED" : The default value, do not use.
|
| - * - "ROWS" : Operates on the rows of a sheet.
|
| - * - "COLUMNS" : Operates on the columns of a sheet.
|
| - */
|
| +
|
| + /// The dimension which will be shifted when inserting cells.
|
| + /// If ROWS, existing cells will be shifted down.
|
| + /// If COLUMNS, existing cells will be shifted right.
|
| + /// Possible string values are:
|
| + /// - "DIMENSION_UNSPECIFIED" : The default value, do not use.
|
| + /// - "ROWS" : Operates on the rows of a sheet.
|
| + /// - "COLUMNS" : Operates on the columns of a sheet.
|
| core.String shiftDimension;
|
|
|
| InsertRangeRequest();
|
| @@ -5351,7 +5408,8 @@ class InsertRangeRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (range != null) {
|
| _json["range"] = (range).toJson();
|
| }
|
| @@ -5362,42 +5420,38 @@ class InsertRangeRequest {
|
| }
|
| }
|
|
|
| -/**
|
| - * A single interpolation point on a gradient conditional format.
|
| - * These pin the gradient color scale according to the color,
|
| - * type and value chosen.
|
| - */
|
| +/// A single interpolation point on a gradient conditional format.
|
| +/// These pin the gradient color scale according to the color,
|
| +/// type and value chosen.
|
| class InterpolationPoint {
|
| - /** The color this interpolation point should use. */
|
| + /// The color this interpolation point should use.
|
| Color color;
|
| - /**
|
| - * How the value should be interpreted.
|
| - * Possible string values are:
|
| - * - "INTERPOLATION_POINT_TYPE_UNSPECIFIED" : The default value, do not use.
|
| - * - "MIN" : The interpolation point will use the minimum value in the
|
| - * cells over the range of the conditional format.
|
| - * - "MAX" : The interpolation point will use the maximum value in the
|
| - * cells over the range of the conditional format.
|
| - * - "NUMBER" : The interpolation point will use exactly the value in
|
| - * InterpolationPoint.value.
|
| - * - "PERCENT" : The interpolation point will be the given percentage over
|
| - * all the cells in the range of the conditional format.
|
| - * This is equivalent to NUMBER if the value was:
|
| - * `=(MAX(FLATTEN(range)) * (value / 100))
|
| - * + (MIN(FLATTEN(range)) * (1 - (value / 100)))`
|
| - * (where errors in the range are ignored when flattening).
|
| - * - "PERCENTILE" : The interpolation point will be the given percentile
|
| - * over all the cells in the range of the conditional format.
|
| - * This is equivalent to NUMBER if the value was:
|
| - * `=PERCENTILE(FLATTEN(range), value / 100)`
|
| - * (where errors in the range are ignored when flattening).
|
| - */
|
| +
|
| + /// How the value should be interpreted.
|
| + /// Possible string values are:
|
| + /// - "INTERPOLATION_POINT_TYPE_UNSPECIFIED" : The default value, do not use.
|
| + /// - "MIN" : The interpolation point will use the minimum value in the
|
| + /// cells over the range of the conditional format.
|
| + /// - "MAX" : The interpolation point will use the maximum value in the
|
| + /// cells over the range of the conditional format.
|
| + /// - "NUMBER" : The interpolation point will use exactly the value in
|
| + /// InterpolationPoint.value.
|
| + /// - "PERCENT" : The interpolation point will be the given percentage over
|
| + /// all the cells in the range of the conditional format.
|
| + /// This is equivalent to NUMBER if the value was:
|
| + /// `=(MAX(FLATTEN(range)) * (value / 100))
|
| + /// + (MIN(FLATTEN(range)) * (1 - (value / 100)))`
|
| + /// (where errors in the range are ignored when flattening).
|
| + /// - "PERCENTILE" : The interpolation point will be the given percentile
|
| + /// over all the cells in the range of the conditional format.
|
| + /// This is equivalent to NUMBER if the value was:
|
| + /// `=PERCENTILE(FLATTEN(range), value / 100)`
|
| + /// (where errors in the range are ignored when flattening).
|
| core.String type;
|
| - /**
|
| - * The value this interpolation point uses. May be a formula.
|
| - * Unused if type is MIN or
|
| - * MAX.
|
| - */
|
| +
|
| + /// The value this interpolation point uses. May be a formula.
|
| + /// Unused if type is MIN or
|
| + /// MAX.
|
| core.String value;
|
|
|
| InterpolationPoint();
|
| @@ -5415,7 +5469,8 @@ class InterpolationPoint {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (color != null) {
|
| _json["color"] = (color).toJson();
|
| }
|
| @@ -5429,20 +5484,15 @@ class InterpolationPoint {
|
| }
|
| }
|
|
|
| -/**
|
| - * Settings to control how circular dependencies are resolved with iterative
|
| - * calculation.
|
| - */
|
| +/// Settings to control how circular dependencies are resolved with iterative
|
| +/// calculation.
|
| class IterativeCalculationSettings {
|
| - /**
|
| - * When iterative calculation is enabled and successive results differ by
|
| - * less than this threshold value, the calculation rounds stop.
|
| - */
|
| + /// When iterative calculation is enabled and successive results differ by
|
| + /// less than this threshold value, the calculation rounds stop.
|
| core.double convergenceThreshold;
|
| - /**
|
| - * When iterative calculation is enabled, the maximum number of calculation
|
| - * rounds to perform.
|
| - */
|
| +
|
| + /// When iterative calculation is enabled, the maximum number of calculation
|
| + /// rounds to perform.
|
| core.int maxIterations;
|
|
|
| IterativeCalculationSettings();
|
| @@ -5457,7 +5507,8 @@ class IterativeCalculationSettings {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (convergenceThreshold != null) {
|
| _json["convergenceThreshold"] = convergenceThreshold;
|
| }
|
| @@ -5468,17 +5519,16 @@ class IterativeCalculationSettings {
|
| }
|
| }
|
|
|
| -/** Merges all cells in the range. */
|
| +/// Merges all cells in the range.
|
| class MergeCellsRequest {
|
| - /**
|
| - * How the cells should be merged.
|
| - * Possible string values are:
|
| - * - "MERGE_ALL" : Create a single merge from the range
|
| - * - "MERGE_COLUMNS" : Create a merge for each column in the range
|
| - * - "MERGE_ROWS" : Create a merge for each row in the range
|
| - */
|
| + /// How the cells should be merged.
|
| + /// Possible string values are:
|
| + /// - "MERGE_ALL" : Create a single merge from the range
|
| + /// - "MERGE_COLUMNS" : Create a merge for each column in the range
|
| + /// - "MERGE_ROWS" : Create a merge for each row in the range
|
| core.String mergeType;
|
| - /** The range of cells to merge. */
|
| +
|
| + /// The range of cells to merge.
|
| GridRange range;
|
|
|
| MergeCellsRequest();
|
| @@ -5493,7 +5543,8 @@ class MergeCellsRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (mergeType != null) {
|
| _json["mergeType"] = mergeType;
|
| }
|
| @@ -5504,24 +5555,23 @@ class MergeCellsRequest {
|
| }
|
| }
|
|
|
| -/** Moves one or more rows or columns. */
|
| +/// Moves one or more rows or columns.
|
| class MoveDimensionRequest {
|
| - /**
|
| - * The zero-based start index of where to move the source data to,
|
| - * based on the coordinates *before* the source data is removed
|
| - * from the grid. Existing data will be shifted down or right
|
| - * (depending on the dimension) to make room for the moved dimensions.
|
| - * The source dimensions are removed from the grid, so the
|
| - * the data may end up in a different index than specified.
|
| - *
|
| - * For example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move
|
| - * `"1"` and `"2"` to between `"3"` and `"4"`, the source would be
|
| - * `ROWS [1..3)`,and the destination index would be `"4"`
|
| - * (the zero-based index of row 5).
|
| - * The end result would be `A1..A5` of `0, 3, 1, 2, 4`.
|
| - */
|
| + /// The zero-based start index of where to move the source data to,
|
| + /// based on the coordinates *before* the source data is removed
|
| + /// from the grid. Existing data will be shifted down or right
|
| + /// (depending on the dimension) to make room for the moved dimensions.
|
| + /// The source dimensions are removed from the grid, so the
|
| + /// the data may end up in a different index than specified.
|
| + ///
|
| + /// For example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move
|
| + /// `"1"` and `"2"` to between `"3"` and `"4"`, the source would be
|
| + /// `ROWS [1..3)`,and the destination index would be `"4"`
|
| + /// (the zero-based index of row 5).
|
| + /// The end result would be `A1..A5` of `0, 3, 1, 2, 4`.
|
| core.int destinationIndex;
|
| - /** The source dimensions to move. */
|
| +
|
| + /// The source dimensions to move.
|
| DimensionRange source;
|
|
|
| MoveDimensionRequest();
|
| @@ -5536,7 +5586,8 @@ class MoveDimensionRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (destinationIndex != null) {
|
| _json["destinationIndex"] = destinationIndex;
|
| }
|
| @@ -5547,13 +5598,15 @@ class MoveDimensionRequest {
|
| }
|
| }
|
|
|
| -/** A named range. */
|
| +/// A named range.
|
| class NamedRange {
|
| - /** The name of the named range. */
|
| + /// The name of the named range.
|
| core.String name;
|
| - /** The ID of the named range. */
|
| +
|
| + /// The ID of the named range.
|
| core.String namedRangeId;
|
| - /** The range this represents. */
|
| +
|
| + /// The range this represents.
|
| GridRange range;
|
|
|
| NamedRange();
|
| @@ -5571,7 +5624,8 @@ class NamedRange {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (name != null) {
|
| _json["name"] = name;
|
| }
|
| @@ -5585,32 +5639,30 @@ class NamedRange {
|
| }
|
| }
|
|
|
| -/** The number format of a cell. */
|
| +/// The number format of a cell.
|
| class NumberFormat {
|
| - /**
|
| - * Pattern string used for formatting. If not set, a default pattern based on
|
| - * the user's locale will be used if necessary for the given type.
|
| - * See the [Date and Number Formats guide](/sheets/api/guides/formats) for
|
| - * more
|
| - * information about the supported patterns.
|
| - */
|
| + /// Pattern string used for formatting. If not set, a default pattern based
|
| + /// on
|
| + /// the user's locale will be used if necessary for the given type.
|
| + /// See the [Date and Number Formats guide](/sheets/api/guides/formats) for
|
| + /// more
|
| + /// information about the supported patterns.
|
| core.String pattern;
|
| - /**
|
| - * The type of the number format.
|
| - * When writing, this field must be set.
|
| - * Possible string values are:
|
| - * - "NUMBER_FORMAT_TYPE_UNSPECIFIED" : The number format is not specified
|
| - * and is based on the contents of the cell.
|
| - * Do not explicitly use this.
|
| - * - "TEXT" : Text formatting, e.g `1000.12`
|
| - * - "NUMBER" : Number formatting, e.g, `1,000.12`
|
| - * - "PERCENT" : Percent formatting, e.g `10.12%`
|
| - * - "CURRENCY" : Currency formatting, e.g `$1,000.12`
|
| - * - "DATE" : Date formatting, e.g `9/26/2008`
|
| - * - "TIME" : Time formatting, e.g `3:59:00 PM`
|
| - * - "DATE_TIME" : Date+Time formatting, e.g `9/26/08 15:59:00`
|
| - * - "SCIENTIFIC" : Scientific number formatting, e.g `1.01E+03`
|
| - */
|
| +
|
| + /// The type of the number format.
|
| + /// When writing, this field must be set.
|
| + /// Possible string values are:
|
| + /// - "NUMBER_FORMAT_TYPE_UNSPECIFIED" : The number format is not specified
|
| + /// and is based on the contents of the cell.
|
| + /// Do not explicitly use this.
|
| + /// - "TEXT" : Text formatting, e.g `1000.12`
|
| + /// - "NUMBER" : Number formatting, e.g, `1,000.12`
|
| + /// - "PERCENT" : Percent formatting, e.g `10.12%`
|
| + /// - "CURRENCY" : Currency formatting, e.g `$1,000.12`
|
| + /// - "DATE" : Date formatting, e.g `9/26/2008`
|
| + /// - "TIME" : Time formatting, e.g `3:59:00 PM`
|
| + /// - "DATE_TIME" : Date+Time formatting, e.g `9/26/08 15:59:00`
|
| + /// - "SCIENTIFIC" : Scientific number formatting, e.g `1.01E+03`
|
| core.String type;
|
|
|
| NumberFormat();
|
| @@ -5625,7 +5677,8 @@ class NumberFormat {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (pattern != null) {
|
| _json["pattern"] = pattern;
|
| }
|
| @@ -5636,50 +5689,46 @@ class NumberFormat {
|
| }
|
| }
|
|
|
| -/**
|
| - * An <a href="/chart/interactive/docs/gallery/orgchart">org chart</a>.
|
| - * Org charts require a unique set of labels in labels and may
|
| - * optionally include parent_labels and tooltips.
|
| - * parent_labels contain, for each node, the label identifying the parent
|
| - * node. tooltips contain, for each node, an optional tooltip.
|
| - *
|
| - * For example, to describe an OrgChart with Alice as the CEO, Bob as the
|
| - * President (reporting to Alice) and Cathy as VP of Sales (also reporting to
|
| - * Alice), have labels contain "Alice", "Bob", "Cathy",
|
| - * parent_labels contain "", "Alice", "Alice" and tooltips contain
|
| - * "CEO", "President", "VP Sales".
|
| - */
|
| +/// An <a href="/chart/interactive/docs/gallery/orgchart">org chart</a>.
|
| +/// Org charts require a unique set of labels in labels and may
|
| +/// optionally include parent_labels and tooltips.
|
| +/// parent_labels contain, for each node, the label identifying the parent
|
| +/// node. tooltips contain, for each node, an optional tooltip.
|
| +///
|
| +/// For example, to describe an OrgChart with Alice as the CEO, Bob as the
|
| +/// President (reporting to Alice) and Cathy as VP of Sales (also reporting to
|
| +/// Alice), have labels contain "Alice", "Bob", "Cathy",
|
| +/// parent_labels contain "", "Alice", "Alice" and tooltips contain
|
| +/// "CEO", "President", "VP Sales".
|
| class OrgChartSpec {
|
| - /**
|
| - * The data containing the labels for all the nodes in the chart. Labels
|
| - * must be unique.
|
| - */
|
| + /// The data containing the labels for all the nodes in the chart. Labels
|
| + /// must be unique.
|
| ChartData labels;
|
| - /** The color of the org chart nodes. */
|
| +
|
| + /// The color of the org chart nodes.
|
| Color nodeColor;
|
| - /**
|
| - * The size of the org chart nodes.
|
| - * Possible string values are:
|
| - * - "ORG_CHART_LABEL_SIZE_UNSPECIFIED" : Default value, do not use.
|
| - * - "SMALL" : The small org chart node size.
|
| - * - "MEDIUM" : The medium org chart node size.
|
| - * - "LARGE" : The large org chart node size.
|
| - */
|
| +
|
| + /// The size of the org chart nodes.
|
| + /// Possible string values are:
|
| + /// - "ORG_CHART_LABEL_SIZE_UNSPECIFIED" : Default value, do not use.
|
| + /// - "SMALL" : The small org chart node size.
|
| + /// - "MEDIUM" : The medium org chart node size.
|
| + /// - "LARGE" : The large org chart node size.
|
| core.String nodeSize;
|
| - /**
|
| - * The data containing the label of the parent for the corresponding node.
|
| - * A blank value indicates that the node has no parent and is a top-level
|
| - * node.
|
| - * This field is optional.
|
| - */
|
| +
|
| + /// The data containing the label of the parent for the corresponding node.
|
| + /// A blank value indicates that the node has no parent and is a top-level
|
| + /// node.
|
| + /// This field is optional.
|
| ChartData parentLabels;
|
| - /** The color of the selected org chart nodes. */
|
| +
|
| + /// The color of the selected org chart nodes.
|
| Color selectedNodeColor;
|
| - /**
|
| - * The data containing the tooltip for the corresponding node. A blank value
|
| - * results in no tooltip being displayed for the node.
|
| - * This field is optional.
|
| - */
|
| +
|
| + /// The data containing the tooltip for the corresponding node. A blank
|
| + /// value
|
| + /// results in no tooltip being displayed for the node.
|
| + /// This field is optional.
|
| ChartData tooltips;
|
|
|
| OrgChartSpec();
|
| @@ -5706,7 +5755,8 @@ class OrgChartSpec {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (labels != null) {
|
| _json["labels"] = (labels).toJson();
|
| }
|
| @@ -5729,23 +5779,23 @@ class OrgChartSpec {
|
| }
|
| }
|
|
|
| -/** The location an object is overlaid on top of a grid. */
|
| +/// The location an object is overlaid on top of a grid.
|
| class OverlayPosition {
|
| - /** The cell the object is anchored to. */
|
| + /// The cell the object is anchored to.
|
| GridCoordinate anchorCell;
|
| - /** The height of the object, in pixels. Defaults to 371. */
|
| +
|
| + /// The height of the object, in pixels. Defaults to 371.
|
| core.int heightPixels;
|
| - /**
|
| - * The horizontal offset, in pixels, that the object is offset
|
| - * from the anchor cell.
|
| - */
|
| +
|
| + /// The horizontal offset, in pixels, that the object is offset
|
| + /// from the anchor cell.
|
| core.int offsetXPixels;
|
| - /**
|
| - * The vertical offset, in pixels, that the object is offset
|
| - * from the anchor cell.
|
| - */
|
| +
|
| + /// The vertical offset, in pixels, that the object is offset
|
| + /// from the anchor cell.
|
| core.int offsetYPixels;
|
| - /** The width of the object, in pixels. Defaults to 600. */
|
| +
|
| + /// The width of the object, in pixels. Defaults to 600.
|
| core.int widthPixels;
|
|
|
| OverlayPosition();
|
| @@ -5769,7 +5819,8 @@ class OverlayPosition {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (anchorCell != null) {
|
| _json["anchorCell"] = (anchorCell).toJson();
|
| }
|
| @@ -5789,18 +5840,19 @@ class OverlayPosition {
|
| }
|
| }
|
|
|
| -/**
|
| - * The amount of padding around the cell, in pixels.
|
| - * When updating padding, every field must be specified.
|
| - */
|
| +/// The amount of padding around the cell, in pixels.
|
| +/// When updating padding, every field must be specified.
|
| class Padding {
|
| - /** The bottom padding of the cell. */
|
| + /// The bottom padding of the cell.
|
| core.int bottom;
|
| - /** The left padding of the cell. */
|
| +
|
| + /// The left padding of the cell.
|
| core.int left;
|
| - /** The right padding of the cell. */
|
| +
|
| + /// The right padding of the cell.
|
| core.int right;
|
| - /** The top padding of the cell. */
|
| +
|
| + /// The top padding of the cell.
|
| core.int top;
|
|
|
| Padding();
|
| @@ -5821,7 +5873,8 @@ class Padding {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (bottom != null) {
|
| _json["bottom"] = bottom;
|
| }
|
| @@ -5838,29 +5891,31 @@ class Padding {
|
| }
|
| }
|
|
|
| -/** Inserts data into the spreadsheet starting at the specified coordinate. */
|
| +/// Inserts data into the spreadsheet starting at the specified coordinate.
|
| class PasteDataRequest {
|
| - /** The coordinate at which the data should start being inserted. */
|
| + /// The coordinate at which the data should start being inserted.
|
| GridCoordinate coordinate;
|
| - /** The data to insert. */
|
| +
|
| + /// The data to insert.
|
| core.String data;
|
| - /** The delimiter in the data. */
|
| +
|
| + /// The delimiter in the data.
|
| core.String delimiter;
|
| - /** True if the data is HTML. */
|
| +
|
| + /// True if the data is HTML.
|
| core.bool html;
|
| - /**
|
| - * How the data should be pasted.
|
| - * Possible string values are:
|
| - * - "PASTE_NORMAL" : Paste values, formulas, formats, and merges.
|
| - * - "PASTE_VALUES" : Paste the values ONLY without formats, formulas, or
|
| - * merges.
|
| - * - "PASTE_FORMAT" : Paste the format and data validation only.
|
| - * - "PASTE_NO_BORDERS" : Like PASTE_NORMAL but without borders.
|
| - * - "PASTE_FORMULA" : Paste the formulas only.
|
| - * - "PASTE_DATA_VALIDATION" : Paste the data validation only.
|
| - * - "PASTE_CONDITIONAL_FORMATTING" : Paste the conditional formatting rules
|
| - * only.
|
| - */
|
| +
|
| + /// How the data should be pasted.
|
| + /// Possible string values are:
|
| + /// - "PASTE_NORMAL" : Paste values, formulas, formats, and merges.
|
| + /// - "PASTE_VALUES" : Paste the values ONLY without formats, formulas, or
|
| + /// merges.
|
| + /// - "PASTE_FORMAT" : Paste the format and data validation only.
|
| + /// - "PASTE_NO_BORDERS" : Like PASTE_NORMAL but without borders.
|
| + /// - "PASTE_FORMULA" : Paste the formulas only.
|
| + /// - "PASTE_DATA_VALIDATION" : Paste the data validation only.
|
| + /// - "PASTE_CONDITIONAL_FORMATTING" : Paste the conditional formatting rules
|
| + /// only.
|
| core.String type;
|
|
|
| PasteDataRequest();
|
| @@ -5884,7 +5939,8 @@ class PasteDataRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (coordinate != null) {
|
| _json["coordinate"] = (coordinate).toJson();
|
| }
|
| @@ -5904,27 +5960,29 @@ class PasteDataRequest {
|
| }
|
| }
|
|
|
| -/** A <a href="/chart/interactive/docs/gallery/piechart">pie chart</a>. */
|
| +/// A <a href="/chart/interactive/docs/gallery/piechart">pie chart</a>.
|
| class PieChartSpec {
|
| - /** The data that covers the domain of the pie chart. */
|
| + /// The data that covers the domain of the pie chart.
|
| ChartData domain;
|
| - /**
|
| - * Where the legend of the pie chart should be drawn.
|
| - * Possible string values are:
|
| - * - "PIE_CHART_LEGEND_POSITION_UNSPECIFIED" : Default value, do not use.
|
| - * - "BOTTOM_LEGEND" : The legend is rendered on the bottom of the chart.
|
| - * - "LEFT_LEGEND" : The legend is rendered on the left of the chart.
|
| - * - "RIGHT_LEGEND" : The legend is rendered on the right of the chart.
|
| - * - "TOP_LEGEND" : The legend is rendered on the top of the chart.
|
| - * - "NO_LEGEND" : No legend is rendered.
|
| - * - "LABELED_LEGEND" : Each pie slice has a label attached to it.
|
| - */
|
| +
|
| + /// Where the legend of the pie chart should be drawn.
|
| + /// Possible string values are:
|
| + /// - "PIE_CHART_LEGEND_POSITION_UNSPECIFIED" : Default value, do not use.
|
| + /// - "BOTTOM_LEGEND" : The legend is rendered on the bottom of the chart.
|
| + /// - "LEFT_LEGEND" : The legend is rendered on the left of the chart.
|
| + /// - "RIGHT_LEGEND" : The legend is rendered on the right of the chart.
|
| + /// - "TOP_LEGEND" : The legend is rendered on the top of the chart.
|
| + /// - "NO_LEGEND" : No legend is rendered.
|
| + /// - "LABELED_LEGEND" : Each pie slice has a label attached to it.
|
| core.String legendPosition;
|
| - /** The size of the hole in the pie chart. */
|
| +
|
| + /// The size of the hole in the pie chart.
|
| core.double pieHole;
|
| - /** The data that covers the one and only series of the pie chart. */
|
| +
|
| + /// The data that covers the one and only series of the pie chart.
|
| ChartData series;
|
| - /** True if the pie is three dimensional. */
|
| +
|
| + /// True if the pie is three dimensional.
|
| core.bool threeDimensional;
|
|
|
| PieChartSpec();
|
| @@ -5948,7 +6006,8 @@ class PieChartSpec {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (domain != null) {
|
| _json["domain"] = (domain).toJson();
|
| }
|
| @@ -5968,9 +6027,9 @@ class PieChartSpec {
|
| }
|
| }
|
|
|
| -/** Criteria for showing/hiding rows in a pivot table. */
|
| +/// Criteria for showing/hiding rows in a pivot table.
|
| class PivotFilterCriteria {
|
| - /** Values that should be included. Values not listed here are excluded. */
|
| + /// Values that should be included. Values not listed here are excluded.
|
| core.List<core.String> visibleValues;
|
|
|
| PivotFilterCriteria();
|
| @@ -5982,7 +6041,8 @@ class PivotFilterCriteria {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (visibleValues != null) {
|
| _json["visibleValues"] = visibleValues;
|
| }
|
| @@ -5990,32 +6050,30 @@ class PivotFilterCriteria {
|
| }
|
| }
|
|
|
| -/** A single grouping (either row or column) in a pivot table. */
|
| +/// A single grouping (either row or column) in a pivot table.
|
| class PivotGroup {
|
| - /** True if the pivot table should include the totals for this grouping. */
|
| + /// True if the pivot table should include the totals for this grouping.
|
| core.bool showTotals;
|
| - /**
|
| - * The order the values in this group should be sorted.
|
| - * Possible string values are:
|
| - * - "SORT_ORDER_UNSPECIFIED" : Default value, do not use this.
|
| - * - "ASCENDING" : Sort ascending.
|
| - * - "DESCENDING" : Sort descending.
|
| - */
|
| +
|
| + /// The order the values in this group should be sorted.
|
| + /// Possible string values are:
|
| + /// - "SORT_ORDER_UNSPECIFIED" : Default value, do not use this.
|
| + /// - "ASCENDING" : Sort ascending.
|
| + /// - "DESCENDING" : Sort descending.
|
| core.String sortOrder;
|
| - /**
|
| - * The column offset of the source range that this grouping is based on.
|
| - *
|
| - * For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`
|
| - * means this group refers to column `C`, whereas the offset `1` would refer
|
| - * to column `D`.
|
| - */
|
| +
|
| + /// The column offset of the source range that this grouping is based on.
|
| + ///
|
| + /// For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`
|
| + /// means this group refers to column `C`, whereas the offset `1` would refer
|
| + /// to column `D`.
|
| core.int sourceColumnOffset;
|
| - /**
|
| - * The bucket of the opposite pivot group to sort by.
|
| - * If not specified, sorting is alphabetical by this group's values.
|
| - */
|
| +
|
| + /// The bucket of the opposite pivot group to sort by.
|
| + /// If not specified, sorting is alphabetical by this group's values.
|
| PivotGroupSortValueBucket valueBucket;
|
| - /** Metadata about values in the grouping. */
|
| +
|
| + /// Metadata about values in the grouping.
|
| core.List<PivotGroupValueMetadata> valueMetadata;
|
|
|
| PivotGroup();
|
| @@ -6031,15 +6089,19 @@ class PivotGroup {
|
| sourceColumnOffset = _json["sourceColumnOffset"];
|
| }
|
| if (_json.containsKey("valueBucket")) {
|
| - valueBucket = new PivotGroupSortValueBucket.fromJson(_json["valueBucket"]);
|
| + valueBucket =
|
| + new PivotGroupSortValueBucket.fromJson(_json["valueBucket"]);
|
| }
|
| if (_json.containsKey("valueMetadata")) {
|
| - valueMetadata = _json["valueMetadata"].map((value) => new PivotGroupValueMetadata.fromJson(value)).toList();
|
| + valueMetadata = _json["valueMetadata"]
|
| + .map((value) => new PivotGroupValueMetadata.fromJson(value))
|
| + .toList();
|
| }
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (showTotals != null) {
|
| _json["showTotals"] = showTotals;
|
| }
|
| @@ -6053,39 +6115,37 @@ class PivotGroup {
|
| _json["valueBucket"] = (valueBucket).toJson();
|
| }
|
| if (valueMetadata != null) {
|
| - _json["valueMetadata"] = valueMetadata.map((value) => (value).toJson()).toList();
|
| + _json["valueMetadata"] =
|
| + valueMetadata.map((value) => (value).toJson()).toList();
|
| }
|
| return _json;
|
| }
|
| }
|
|
|
| -/**
|
| - * Information about which values in a pivot group should be used for sorting.
|
| - */
|
| +/// Information about which values in a pivot group should be used for sorting.
|
| class PivotGroupSortValueBucket {
|
| - /**
|
| - * Determines the bucket from which values are chosen to sort.
|
| - *
|
| - * For example, in a pivot table with one row group & two column groups,
|
| - * the row group can list up to two values. The first value corresponds
|
| - * to a value within the first column group, and the second value
|
| - * corresponds to a value in the second column group. If no values
|
| - * are listed, this would indicate that the row should be sorted according
|
| - * to the "Grand Total" over the column groups. If a single value is listed,
|
| - * this would correspond to using the "Total" of that bucket.
|
| - */
|
| + /// Determines the bucket from which values are chosen to sort.
|
| + ///
|
| + /// For example, in a pivot table with one row group & two column groups,
|
| + /// the row group can list up to two values. The first value corresponds
|
| + /// to a value within the first column group, and the second value
|
| + /// corresponds to a value in the second column group. If no values
|
| + /// are listed, this would indicate that the row should be sorted according
|
| + /// to the "Grand Total" over the column groups. If a single value is listed,
|
| + /// this would correspond to using the "Total" of that bucket.
|
| core.List<ExtendedValue> buckets;
|
| - /**
|
| - * The offset in the PivotTable.values list which the values in this
|
| - * grouping should be sorted by.
|
| - */
|
| +
|
| + /// The offset in the PivotTable.values list which the values in this
|
| + /// grouping should be sorted by.
|
| core.int valuesIndex;
|
|
|
| PivotGroupSortValueBucket();
|
|
|
| PivotGroupSortValueBucket.fromJson(core.Map _json) {
|
| if (_json.containsKey("buckets")) {
|
| - buckets = _json["buckets"].map((value) => new ExtendedValue.fromJson(value)).toList();
|
| + buckets = _json["buckets"]
|
| + .map((value) => new ExtendedValue.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("valuesIndex")) {
|
| valuesIndex = _json["valuesIndex"];
|
| @@ -6093,7 +6153,8 @@ class PivotGroupSortValueBucket {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (buckets != null) {
|
| _json["buckets"] = buckets.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -6104,15 +6165,14 @@ class PivotGroupSortValueBucket {
|
| }
|
| }
|
|
|
| -/** Metadata about a value in a pivot grouping. */
|
| +/// Metadata about a value in a pivot grouping.
|
| class PivotGroupValueMetadata {
|
| - /** True if the data corresponding to the value is collapsed. */
|
| + /// True if the data corresponding to the value is collapsed.
|
| core.bool collapsed;
|
| - /**
|
| - * The calculated value the metadata corresponds to.
|
| - * (Note that formulaValue is not valid,
|
| - * because the values will be calculated.)
|
| - */
|
| +
|
| + /// The calculated value the metadata corresponds to.
|
| + /// (Note that formulaValue is not valid,
|
| + /// because the values will be calculated.)
|
| ExtendedValue value;
|
|
|
| PivotGroupValueMetadata();
|
| @@ -6127,7 +6187,8 @@ class PivotGroupValueMetadata {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (collapsed != null) {
|
| _json["collapsed"] = collapsed;
|
| }
|
| @@ -6138,47 +6199,56 @@ class PivotGroupValueMetadata {
|
| }
|
| }
|
|
|
| -/** A pivot table. */
|
| +/// A pivot table.
|
| class PivotTable {
|
| - /** Each column grouping in the pivot table. */
|
| + /// Each column grouping in the pivot table.
|
| core.List<PivotGroup> columns;
|
| - /**
|
| - * An optional mapping of filters per source column offset.
|
| - *
|
| - * The filters will be applied before aggregating data into the pivot table.
|
| - * The map's key is the column offset of the source range that you want to
|
| - * filter, and the value is the criteria for that column.
|
| - *
|
| - * For example, if the source was `C10:E15`, a key of `0` will have the filter
|
| - * for column `C`, whereas the key `1` is for column `D`.
|
| - */
|
| +
|
| + /// An optional mapping of filters per source column offset.
|
| + ///
|
| + /// The filters will be applied before aggregating data into the pivot table.
|
| + /// The map's key is the column offset of the source range that you want to
|
| + /// filter, and the value is the criteria for that column.
|
| + ///
|
| + /// For example, if the source was `C10:E15`, a key of `0` will have the
|
| + /// filter
|
| + /// for column `C`, whereas the key `1` is for column `D`.
|
| core.Map<core.String, PivotFilterCriteria> criteria;
|
| - /** Each row grouping in the pivot table. */
|
| +
|
| + /// Each row grouping in the pivot table.
|
| core.List<PivotGroup> rows;
|
| - /** The range the pivot table is reading data from. */
|
| +
|
| + /// The range the pivot table is reading data from.
|
| GridRange source;
|
| - /**
|
| - * Whether values should be listed horizontally (as columns)
|
| - * or vertically (as rows).
|
| - * Possible string values are:
|
| - * - "HORIZONTAL" : Values are laid out horizontally (as columns).
|
| - * - "VERTICAL" : Values are laid out vertically (as rows).
|
| - */
|
| +
|
| + /// Whether values should be listed horizontally (as columns)
|
| + /// or vertically (as rows).
|
| + /// Possible string values are:
|
| + /// - "HORIZONTAL" : Values are laid out horizontally (as columns).
|
| + /// - "VERTICAL" : Values are laid out vertically (as rows).
|
| core.String valueLayout;
|
| - /** A list of values to include in the pivot table. */
|
| +
|
| + /// A list of values to include in the pivot table.
|
| core.List<PivotValue> values;
|
|
|
| PivotTable();
|
|
|
| PivotTable.fromJson(core.Map _json) {
|
| if (_json.containsKey("columns")) {
|
| - columns = _json["columns"].map((value) => new PivotGroup.fromJson(value)).toList();
|
| + columns = _json["columns"]
|
| + .map((value) => new PivotGroup.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("criteria")) {
|
| - criteria = commons.mapMap<core.Map<core.String, core.Object>, PivotFilterCriteria>(_json["criteria"], (core.Map<core.String, core.Object> item) => new PivotFilterCriteria.fromJson(item));
|
| + criteria = commons
|
| + .mapMap<core.Map<core.String, core.Object>, PivotFilterCriteria>(
|
| + _json["criteria"],
|
| + (core.Map<core.String, core.Object> item) =>
|
| + new PivotFilterCriteria.fromJson(item));
|
| }
|
| if (_json.containsKey("rows")) {
|
| - rows = _json["rows"].map((value) => new PivotGroup.fromJson(value)).toList();
|
| + rows =
|
| + _json["rows"].map((value) => new PivotGroup.fromJson(value)).toList();
|
| }
|
| if (_json.containsKey("source")) {
|
| source = new GridRange.fromJson(_json["source"]);
|
| @@ -6187,17 +6257,22 @@ class PivotTable {
|
| valueLayout = _json["valueLayout"];
|
| }
|
| if (_json.containsKey("values")) {
|
| - values = _json["values"].map((value) => new PivotValue.fromJson(value)).toList();
|
| + values = _json["values"]
|
| + .map((value) => new PivotValue.fromJson(value))
|
| + .toList();
|
| }
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (columns != null) {
|
| _json["columns"] = columns.map((value) => (value).toJson()).toList();
|
| }
|
| if (criteria != null) {
|
| - _json["criteria"] = commons.mapMap<PivotFilterCriteria, core.Map<core.String, core.Object>>(criteria, (PivotFilterCriteria item) => (item).toJson());
|
| + _json["criteria"] = commons
|
| + .mapMap<PivotFilterCriteria, core.Map<core.String, core.Object>>(
|
| + criteria, (PivotFilterCriteria item) => (item).toJson());
|
| }
|
| if (rows != null) {
|
| _json["rows"] = rows.map((value) => (value).toJson()).toList();
|
| @@ -6215,51 +6290,46 @@ class PivotTable {
|
| }
|
| }
|
|
|
| -/** The definition of how a value in a pivot table should be calculated. */
|
| +/// The definition of how a value in a pivot table should be calculated.
|
| class PivotValue {
|
| - /**
|
| - * A custom formula to calculate the value. The formula must start
|
| - * with an `=` character.
|
| - */
|
| + /// A custom formula to calculate the value. The formula must start
|
| + /// with an `=` character.
|
| core.String formula;
|
| - /**
|
| - * A name to use for the value. This is only used if formula was set.
|
| - * Otherwise, the column name is used.
|
| - */
|
| +
|
| + /// A name to use for the value. This is only used if formula was set.
|
| + /// Otherwise, the column name is used.
|
| core.String name;
|
| - /**
|
| - * The column offset of the source range that this value reads from.
|
| - *
|
| - * For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`
|
| - * means this value refers to column `C`, whereas the offset `1` would
|
| - * refer to column `D`.
|
| - */
|
| +
|
| + /// The column offset of the source range that this value reads from.
|
| + ///
|
| + /// For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`
|
| + /// means this value refers to column `C`, whereas the offset `1` would
|
| + /// refer to column `D`.
|
| core.int sourceColumnOffset;
|
| - /**
|
| - * A function to summarize the value.
|
| - * If formula is set, the only supported values are
|
| - * SUM and
|
| - * CUSTOM.
|
| - * If sourceColumnOffset is set, then `CUSTOM`
|
| - * is not supported.
|
| - * Possible string values are:
|
| - * - "PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED" : The default, do not use.
|
| - * - "SUM" : Corresponds to the `SUM` function.
|
| - * - "COUNTA" : Corresponds to the `COUNTA` function.
|
| - * - "COUNT" : Corresponds to the `COUNT` function.
|
| - * - "COUNTUNIQUE" : Corresponds to the `COUNTUNIQUE` function.
|
| - * - "AVERAGE" : Corresponds to the `AVERAGE` function.
|
| - * - "MAX" : Corresponds to the `MAX` function.
|
| - * - "MIN" : Corresponds to the `MIN` function.
|
| - * - "MEDIAN" : Corresponds to the `MEDIAN` function.
|
| - * - "PRODUCT" : Corresponds to the `PRODUCT` function.
|
| - * - "STDEV" : Corresponds to the `STDEV` function.
|
| - * - "STDEVP" : Corresponds to the `STDEVP` function.
|
| - * - "VAR" : Corresponds to the `VAR` function.
|
| - * - "VARP" : Corresponds to the `VARP` function.
|
| - * - "CUSTOM" : Indicates the formula should be used as-is.
|
| - * Only valid if PivotValue.formula was set.
|
| - */
|
| +
|
| + /// A function to summarize the value.
|
| + /// If formula is set, the only supported values are
|
| + /// SUM and
|
| + /// CUSTOM.
|
| + /// If sourceColumnOffset is set, then `CUSTOM`
|
| + /// is not supported.
|
| + /// Possible string values are:
|
| + /// - "PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED" : The default, do not use.
|
| + /// - "SUM" : Corresponds to the `SUM` function.
|
| + /// - "COUNTA" : Corresponds to the `COUNTA` function.
|
| + /// - "COUNT" : Corresponds to the `COUNT` function.
|
| + /// - "COUNTUNIQUE" : Corresponds to the `COUNTUNIQUE` function.
|
| + /// - "AVERAGE" : Corresponds to the `AVERAGE` function.
|
| + /// - "MAX" : Corresponds to the `MAX` function.
|
| + /// - "MIN" : Corresponds to the `MIN` function.
|
| + /// - "MEDIAN" : Corresponds to the `MEDIAN` function.
|
| + /// - "PRODUCT" : Corresponds to the `PRODUCT` function.
|
| + /// - "STDEV" : Corresponds to the `STDEV` function.
|
| + /// - "STDEVP" : Corresponds to the `STDEVP` function.
|
| + /// - "VAR" : Corresponds to the `VAR` function.
|
| + /// - "VARP" : Corresponds to the `VARP` function.
|
| + /// - "CUSTOM" : Indicates the formula should be used as-is.
|
| + /// Only valid if PivotValue.formula was set.
|
| core.String summarizeFunction;
|
|
|
| PivotValue();
|
| @@ -6280,7 +6350,8 @@ class PivotValue {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (formula != null) {
|
| _json["formula"] = formula;
|
| }
|
| @@ -6297,60 +6368,53 @@ class PivotValue {
|
| }
|
| }
|
|
|
| -/** A protected range. */
|
| +/// A protected range.
|
| class ProtectedRange {
|
| - /** The description of this protected range. */
|
| + /// The description of this protected range.
|
| core.String description;
|
| - /**
|
| - * The users and groups with edit access to the protected range.
|
| - * This field is only visible to users with edit access to the protected
|
| - * range and the document.
|
| - * Editors are not supported with warning_only protection.
|
| - */
|
| +
|
| + /// The users and groups with edit access to the protected range.
|
| + /// This field is only visible to users with edit access to the protected
|
| + /// range and the document.
|
| + /// Editors are not supported with warning_only protection.
|
| Editors editors;
|
| - /**
|
| - * The named range this protected range is backed by, if any.
|
| - *
|
| - * When writing, only one of range or named_range_id
|
| - * may be set.
|
| - */
|
| +
|
| + /// The named range this protected range is backed by, if any.
|
| + ///
|
| + /// When writing, only one of range or named_range_id
|
| + /// may be set.
|
| core.String namedRangeId;
|
| - /**
|
| - * The ID of the protected range.
|
| - * This field is read-only.
|
| - */
|
| +
|
| + /// The ID of the protected range.
|
| + /// This field is read-only.
|
| core.int protectedRangeId;
|
| - /**
|
| - * The range that is being protected.
|
| - * The range may be fully unbounded, in which case this is considered
|
| - * a protected sheet.
|
| - *
|
| - * When writing, only one of range or named_range_id
|
| - * may be set.
|
| - */
|
| +
|
| + /// The range that is being protected.
|
| + /// The range may be fully unbounded, in which case this is considered
|
| + /// a protected sheet.
|
| + ///
|
| + /// When writing, only one of range or named_range_id
|
| + /// may be set.
|
| GridRange range;
|
| - /**
|
| - * True if the user who requested this protected range can edit the
|
| - * protected area.
|
| - * This field is read-only.
|
| - */
|
| +
|
| + /// True if the user who requested this protected range can edit the
|
| + /// protected area.
|
| + /// This field is read-only.
|
| core.bool requestingUserCanEdit;
|
| - /**
|
| - * The list of unprotected ranges within a protected sheet.
|
| - * Unprotected ranges are only supported on protected sheets.
|
| - */
|
| +
|
| + /// The list of unprotected ranges within a protected sheet.
|
| + /// Unprotected ranges are only supported on protected sheets.
|
| core.List<GridRange> unprotectedRanges;
|
| - /**
|
| - * True if this protected range will show a warning when editing.
|
| - * Warning-based protection means that every user can edit data in the
|
| - * protected range, except editing will prompt a warning asking the user
|
| - * to confirm the edit.
|
| - *
|
| - * When writing: if this field is true, then editors is ignored.
|
| - * Additionally, if this field is changed from true to false and the
|
| - * `editors` field is not set (nor included in the field mask), then
|
| - * the editors will be set to all the editors in the document.
|
| - */
|
| +
|
| + /// True if this protected range will show a warning when editing.
|
| + /// Warning-based protection means that every user can edit data in the
|
| + /// protected range, except editing will prompt a warning asking the user
|
| + /// to confirm the edit.
|
| + ///
|
| + /// When writing: if this field is true, then editors is ignored.
|
| + /// Additionally, if this field is changed from true to false and the
|
| + /// `editors` field is not set (nor included in the field mask), then
|
| + /// the editors will be set to all the editors in the document.
|
| core.bool warningOnly;
|
|
|
| ProtectedRange();
|
| @@ -6375,7 +6439,9 @@ class ProtectedRange {
|
| requestingUserCanEdit = _json["requestingUserCanEdit"];
|
| }
|
| if (_json.containsKey("unprotectedRanges")) {
|
| - unprotectedRanges = _json["unprotectedRanges"].map((value) => new GridRange.fromJson(value)).toList();
|
| + unprotectedRanges = _json["unprotectedRanges"]
|
| + .map((value) => new GridRange.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("warningOnly")) {
|
| warningOnly = _json["warningOnly"];
|
| @@ -6383,7 +6449,8 @@ class ProtectedRange {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (description != null) {
|
| _json["description"] = description;
|
| }
|
| @@ -6403,7 +6470,8 @@ class ProtectedRange {
|
| _json["requestingUserCanEdit"] = requestingUserCanEdit;
|
| }
|
| if (unprotectedRanges != null) {
|
| - _json["unprotectedRanges"] = unprotectedRanges.map((value) => (value).toJson()).toList();
|
| + _json["unprotectedRanges"] =
|
| + unprotectedRanges.map((value) => (value).toJson()).toList();
|
| }
|
| if (warningOnly != null) {
|
| _json["warningOnly"] = warningOnly;
|
| @@ -6412,9 +6480,9 @@ class ProtectedRange {
|
| }
|
| }
|
|
|
| -/** Randomizes the order of the rows in a range. */
|
| +/// Randomizes the order of the rows in a range.
|
| class RandomizeRangeRequest {
|
| - /** The range to randomize. */
|
| + /// The range to randomize.
|
| GridRange range;
|
|
|
| RandomizeRangeRequest();
|
| @@ -6426,7 +6494,8 @@ class RandomizeRangeRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (range != null) {
|
| _json["range"] = (range).toJson();
|
| }
|
| @@ -6434,31 +6503,29 @@ class RandomizeRangeRequest {
|
| }
|
| }
|
|
|
| -/**
|
| - * Updates all cells in the range to the values in the given Cell object.
|
| - * Only the fields listed in the fields field are updated; others are
|
| - * unchanged.
|
| - *
|
| - * If writing a cell with a formula, the formula's ranges will automatically
|
| - * increment for each field in the range.
|
| - * For example, if writing a cell with formula `=A1` into range B2:C4,
|
| - * B2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`,
|
| - * C2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`.
|
| - *
|
| - * To keep the formula's ranges static, use the `$` indicator.
|
| - * For example, use the formula `=$A$1` to prevent both the row and the
|
| - * column from incrementing.
|
| - */
|
| +/// Updates all cells in the range to the values in the given Cell object.
|
| +/// Only the fields listed in the fields field are updated; others are
|
| +/// unchanged.
|
| +///
|
| +/// If writing a cell with a formula, the formula's ranges will automatically
|
| +/// increment for each field in the range.
|
| +/// For example, if writing a cell with formula `=A1` into range B2:C4,
|
| +/// B2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`,
|
| +/// C2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`.
|
| +///
|
| +/// To keep the formula's ranges static, use the `$` indicator.
|
| +/// For example, use the formula `=$A$1` to prevent both the row and the
|
| +/// column from incrementing.
|
| class RepeatCellRequest {
|
| - /** The data to write. */
|
| + /// The data to write.
|
| CellData cell;
|
| - /**
|
| - * The fields that should be updated. At least one field must be specified.
|
| - * The root `cell` is implied and should not be specified.
|
| - * A single `"*"` can be used as short-hand for listing every field.
|
| - */
|
| +
|
| + /// The fields that should be updated. At least one field must be specified.
|
| + /// The root `cell` is implied and should not be specified.
|
| + /// A single `"*"` can be used as short-hand for listing every field.
|
| core.String fields;
|
| - /** The range to repeat the cell in. */
|
| +
|
| + /// The range to repeat the cell in.
|
| GridRange range;
|
|
|
| RepeatCellRequest();
|
| @@ -6476,7 +6543,8 @@ class RepeatCellRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (cell != null) {
|
| _json["cell"] = (cell).toJson();
|
| }
|
| @@ -6490,110 +6558,157 @@ class RepeatCellRequest {
|
| }
|
| }
|
|
|
| -/** A single kind of update to apply to a spreadsheet. */
|
| +/// A single kind of update to apply to a spreadsheet.
|
| class Request {
|
| - /** Adds a new banded range */
|
| + /// Adds a new banded range
|
| AddBandingRequest addBanding;
|
| - /** Adds a chart. */
|
| +
|
| + /// Adds a chart.
|
| AddChartRequest addChart;
|
| - /** Adds a new conditional format rule. */
|
| +
|
| + /// Adds a new conditional format rule.
|
| AddConditionalFormatRuleRequest addConditionalFormatRule;
|
| - /** Adds a filter view. */
|
| +
|
| + /// Adds a filter view.
|
| AddFilterViewRequest addFilterView;
|
| - /** Adds a named range. */
|
| +
|
| + /// Adds a named range.
|
| AddNamedRangeRequest addNamedRange;
|
| - /** Adds a protected range. */
|
| +
|
| + /// Adds a protected range.
|
| AddProtectedRangeRequest addProtectedRange;
|
| - /** Adds a sheet. */
|
| +
|
| + /// Adds a sheet.
|
| AddSheetRequest addSheet;
|
| - /** Appends cells after the last row with data in a sheet. */
|
| +
|
| + /// Appends cells after the last row with data in a sheet.
|
| AppendCellsRequest appendCells;
|
| - /** Appends dimensions to the end of a sheet. */
|
| +
|
| + /// Appends dimensions to the end of a sheet.
|
| AppendDimensionRequest appendDimension;
|
| - /** Automatically fills in more data based on existing data. */
|
| +
|
| + /// Automatically fills in more data based on existing data.
|
| AutoFillRequest autoFill;
|
| - /**
|
| - * Automatically resizes one or more dimensions based on the contents
|
| - * of the cells in that dimension.
|
| - */
|
| +
|
| + /// Automatically resizes one or more dimensions based on the contents
|
| + /// of the cells in that dimension.
|
| AutoResizeDimensionsRequest autoResizeDimensions;
|
| - /** Clears the basic filter on a sheet. */
|
| +
|
| + /// Clears the basic filter on a sheet.
|
| ClearBasicFilterRequest clearBasicFilter;
|
| - /** Copies data from one area and pastes it to another. */
|
| +
|
| + /// Copies data from one area and pastes it to another.
|
| CopyPasteRequest copyPaste;
|
| - /** Cuts data from one area and pastes it to another. */
|
| +
|
| + /// Cuts data from one area and pastes it to another.
|
| CutPasteRequest cutPaste;
|
| - /** Removes a banded range */
|
| +
|
| + /// Removes a banded range
|
| DeleteBandingRequest deleteBanding;
|
| - /** Deletes an existing conditional format rule. */
|
| +
|
| + /// Deletes an existing conditional format rule.
|
| DeleteConditionalFormatRuleRequest deleteConditionalFormatRule;
|
| - /** Deletes rows or columns in a sheet. */
|
| +
|
| + /// Deletes rows or columns in a sheet.
|
| DeleteDimensionRequest deleteDimension;
|
| - /** Deletes an embedded object (e.g, chart, image) in a sheet. */
|
| +
|
| + /// Deletes an embedded object (e.g, chart, image) in a sheet.
|
| DeleteEmbeddedObjectRequest deleteEmbeddedObject;
|
| - /** Deletes a filter view from a sheet. */
|
| +
|
| + /// Deletes a filter view from a sheet.
|
| DeleteFilterViewRequest deleteFilterView;
|
| - /** Deletes a named range. */
|
| +
|
| + /// Deletes a named range.
|
| DeleteNamedRangeRequest deleteNamedRange;
|
| - /** Deletes a protected range. */
|
| +
|
| + /// Deletes a protected range.
|
| DeleteProtectedRangeRequest deleteProtectedRange;
|
| - /** Deletes a range of cells from a sheet, shifting the remaining cells. */
|
| +
|
| + /// Deletes a range of cells from a sheet, shifting the remaining cells.
|
| DeleteRangeRequest deleteRange;
|
| - /** Deletes a sheet. */
|
| +
|
| + /// Deletes a sheet.
|
| DeleteSheetRequest deleteSheet;
|
| - /** Duplicates a filter view. */
|
| +
|
| + /// Duplicates a filter view.
|
| DuplicateFilterViewRequest duplicateFilterView;
|
| - /** Duplicates a sheet. */
|
| +
|
| + /// Duplicates a sheet.
|
| DuplicateSheetRequest duplicateSheet;
|
| - /** Finds and replaces occurrences of some text with other text. */
|
| +
|
| + /// Finds and replaces occurrences of some text with other text.
|
| FindReplaceRequest findReplace;
|
| - /** Inserts new rows or columns in a sheet. */
|
| +
|
| + /// Inserts new rows or columns in a sheet.
|
| InsertDimensionRequest insertDimension;
|
| - /** Inserts new cells in a sheet, shifting the existing cells. */
|
| +
|
| + /// Inserts new cells in a sheet, shifting the existing cells.
|
| InsertRangeRequest insertRange;
|
| - /** Merges cells together. */
|
| +
|
| + /// Merges cells together.
|
| MergeCellsRequest mergeCells;
|
| - /** Moves rows or columns to another location in a sheet. */
|
| +
|
| + /// Moves rows or columns to another location in a sheet.
|
| MoveDimensionRequest moveDimension;
|
| - /** Pastes data (HTML or delimited) into a sheet. */
|
| +
|
| + /// Pastes data (HTML or delimited) into a sheet.
|
| PasteDataRequest pasteData;
|
| - /** Randomizes the order of the rows in a range. */
|
| +
|
| + /// Randomizes the order of the rows in a range.
|
| RandomizeRangeRequest randomizeRange;
|
| - /** Repeats a single cell across a range. */
|
| +
|
| + /// Repeats a single cell across a range.
|
| RepeatCellRequest repeatCell;
|
| - /** Sets the basic filter on a sheet. */
|
| +
|
| + /// Sets the basic filter on a sheet.
|
| SetBasicFilterRequest setBasicFilter;
|
| - /** Sets data validation for one or more cells. */
|
| +
|
| + /// Sets data validation for one or more cells.
|
| SetDataValidationRequest setDataValidation;
|
| - /** Sorts data in a range. */
|
| +
|
| + /// Sorts data in a range.
|
| SortRangeRequest sortRange;
|
| - /** Converts a column of text into many columns of text. */
|
| +
|
| + /// Converts a column of text into many columns of text.
|
| TextToColumnsRequest textToColumns;
|
| - /** Unmerges merged cells. */
|
| +
|
| + /// Unmerges merged cells.
|
| UnmergeCellsRequest unmergeCells;
|
| - /** Updates a banded range */
|
| +
|
| + /// Updates a banded range
|
| UpdateBandingRequest updateBanding;
|
| - /** Updates the borders in a range of cells. */
|
| +
|
| + /// Updates the borders in a range of cells.
|
| UpdateBordersRequest updateBorders;
|
| - /** Updates many cells at once. */
|
| +
|
| + /// Updates many cells at once.
|
| UpdateCellsRequest updateCells;
|
| - /** Updates a chart's specifications. */
|
| +
|
| + /// Updates a chart's specifications.
|
| UpdateChartSpecRequest updateChartSpec;
|
| - /** Updates an existing conditional format rule. */
|
| +
|
| + /// Updates an existing conditional format rule.
|
| UpdateConditionalFormatRuleRequest updateConditionalFormatRule;
|
| - /** Updates dimensions' properties. */
|
| +
|
| + /// Updates dimensions' properties.
|
| UpdateDimensionPropertiesRequest updateDimensionProperties;
|
| - /** Updates an embedded object's (e.g. chart, image) position. */
|
| +
|
| + /// Updates an embedded object's (e.g. chart, image) position.
|
| UpdateEmbeddedObjectPositionRequest updateEmbeddedObjectPosition;
|
| - /** Updates the properties of a filter view. */
|
| +
|
| + /// Updates the properties of a filter view.
|
| UpdateFilterViewRequest updateFilterView;
|
| - /** Updates a named range. */
|
| +
|
| + /// Updates a named range.
|
| UpdateNamedRangeRequest updateNamedRange;
|
| - /** Updates a protected range. */
|
| +
|
| + /// Updates a protected range.
|
| UpdateProtectedRangeRequest updateProtectedRange;
|
| - /** Updates a sheet's properties. */
|
| +
|
| + /// Updates a sheet's properties.
|
| UpdateSheetPropertiesRequest updateSheetProperties;
|
| - /** Updates the spreadsheet's properties. */
|
| +
|
| + /// Updates the spreadsheet's properties.
|
| UpdateSpreadsheetPropertiesRequest updateSpreadsheetProperties;
|
|
|
| Request();
|
| @@ -6606,7 +6721,8 @@ class Request {
|
| addChart = new AddChartRequest.fromJson(_json["addChart"]);
|
| }
|
| if (_json.containsKey("addConditionalFormatRule")) {
|
| - addConditionalFormatRule = new AddConditionalFormatRuleRequest.fromJson(_json["addConditionalFormatRule"]);
|
| + addConditionalFormatRule = new AddConditionalFormatRuleRequest.fromJson(
|
| + _json["addConditionalFormatRule"]);
|
| }
|
| if (_json.containsKey("addFilterView")) {
|
| addFilterView = new AddFilterViewRequest.fromJson(_json["addFilterView"]);
|
| @@ -6615,7 +6731,8 @@ class Request {
|
| addNamedRange = new AddNamedRangeRequest.fromJson(_json["addNamedRange"]);
|
| }
|
| if (_json.containsKey("addProtectedRange")) {
|
| - addProtectedRange = new AddProtectedRangeRequest.fromJson(_json["addProtectedRange"]);
|
| + addProtectedRange =
|
| + new AddProtectedRangeRequest.fromJson(_json["addProtectedRange"]);
|
| }
|
| if (_json.containsKey("addSheet")) {
|
| addSheet = new AddSheetRequest.fromJson(_json["addSheet"]);
|
| @@ -6624,16 +6741,19 @@ class Request {
|
| appendCells = new AppendCellsRequest.fromJson(_json["appendCells"]);
|
| }
|
| if (_json.containsKey("appendDimension")) {
|
| - appendDimension = new AppendDimensionRequest.fromJson(_json["appendDimension"]);
|
| + appendDimension =
|
| + new AppendDimensionRequest.fromJson(_json["appendDimension"]);
|
| }
|
| if (_json.containsKey("autoFill")) {
|
| autoFill = new AutoFillRequest.fromJson(_json["autoFill"]);
|
| }
|
| if (_json.containsKey("autoResizeDimensions")) {
|
| - autoResizeDimensions = new AutoResizeDimensionsRequest.fromJson(_json["autoResizeDimensions"]);
|
| + autoResizeDimensions = new AutoResizeDimensionsRequest.fromJson(
|
| + _json["autoResizeDimensions"]);
|
| }
|
| if (_json.containsKey("clearBasicFilter")) {
|
| - clearBasicFilter = new ClearBasicFilterRequest.fromJson(_json["clearBasicFilter"]);
|
| + clearBasicFilter =
|
| + new ClearBasicFilterRequest.fromJson(_json["clearBasicFilter"]);
|
| }
|
| if (_json.containsKey("copyPaste")) {
|
| copyPaste = new CopyPasteRequest.fromJson(_json["copyPaste"]);
|
| @@ -6645,22 +6765,29 @@ class Request {
|
| deleteBanding = new DeleteBandingRequest.fromJson(_json["deleteBanding"]);
|
| }
|
| if (_json.containsKey("deleteConditionalFormatRule")) {
|
| - deleteConditionalFormatRule = new DeleteConditionalFormatRuleRequest.fromJson(_json["deleteConditionalFormatRule"]);
|
| + deleteConditionalFormatRule =
|
| + new DeleteConditionalFormatRuleRequest.fromJson(
|
| + _json["deleteConditionalFormatRule"]);
|
| }
|
| if (_json.containsKey("deleteDimension")) {
|
| - deleteDimension = new DeleteDimensionRequest.fromJson(_json["deleteDimension"]);
|
| + deleteDimension =
|
| + new DeleteDimensionRequest.fromJson(_json["deleteDimension"]);
|
| }
|
| if (_json.containsKey("deleteEmbeddedObject")) {
|
| - deleteEmbeddedObject = new DeleteEmbeddedObjectRequest.fromJson(_json["deleteEmbeddedObject"]);
|
| + deleteEmbeddedObject = new DeleteEmbeddedObjectRequest.fromJson(
|
| + _json["deleteEmbeddedObject"]);
|
| }
|
| if (_json.containsKey("deleteFilterView")) {
|
| - deleteFilterView = new DeleteFilterViewRequest.fromJson(_json["deleteFilterView"]);
|
| + deleteFilterView =
|
| + new DeleteFilterViewRequest.fromJson(_json["deleteFilterView"]);
|
| }
|
| if (_json.containsKey("deleteNamedRange")) {
|
| - deleteNamedRange = new DeleteNamedRangeRequest.fromJson(_json["deleteNamedRange"]);
|
| + deleteNamedRange =
|
| + new DeleteNamedRangeRequest.fromJson(_json["deleteNamedRange"]);
|
| }
|
| if (_json.containsKey("deleteProtectedRange")) {
|
| - deleteProtectedRange = new DeleteProtectedRangeRequest.fromJson(_json["deleteProtectedRange"]);
|
| + deleteProtectedRange = new DeleteProtectedRangeRequest.fromJson(
|
| + _json["deleteProtectedRange"]);
|
| }
|
| if (_json.containsKey("deleteRange")) {
|
| deleteRange = new DeleteRangeRequest.fromJson(_json["deleteRange"]);
|
| @@ -6669,16 +6796,19 @@ class Request {
|
| deleteSheet = new DeleteSheetRequest.fromJson(_json["deleteSheet"]);
|
| }
|
| if (_json.containsKey("duplicateFilterView")) {
|
| - duplicateFilterView = new DuplicateFilterViewRequest.fromJson(_json["duplicateFilterView"]);
|
| + duplicateFilterView =
|
| + new DuplicateFilterViewRequest.fromJson(_json["duplicateFilterView"]);
|
| }
|
| if (_json.containsKey("duplicateSheet")) {
|
| - duplicateSheet = new DuplicateSheetRequest.fromJson(_json["duplicateSheet"]);
|
| + duplicateSheet =
|
| + new DuplicateSheetRequest.fromJson(_json["duplicateSheet"]);
|
| }
|
| if (_json.containsKey("findReplace")) {
|
| findReplace = new FindReplaceRequest.fromJson(_json["findReplace"]);
|
| }
|
| if (_json.containsKey("insertDimension")) {
|
| - insertDimension = new InsertDimensionRequest.fromJson(_json["insertDimension"]);
|
| + insertDimension =
|
| + new InsertDimensionRequest.fromJson(_json["insertDimension"]);
|
| }
|
| if (_json.containsKey("insertRange")) {
|
| insertRange = new InsertRangeRequest.fromJson(_json["insertRange"]);
|
| @@ -6693,16 +6823,19 @@ class Request {
|
| pasteData = new PasteDataRequest.fromJson(_json["pasteData"]);
|
| }
|
| if (_json.containsKey("randomizeRange")) {
|
| - randomizeRange = new RandomizeRangeRequest.fromJson(_json["randomizeRange"]);
|
| + randomizeRange =
|
| + new RandomizeRangeRequest.fromJson(_json["randomizeRange"]);
|
| }
|
| if (_json.containsKey("repeatCell")) {
|
| repeatCell = new RepeatCellRequest.fromJson(_json["repeatCell"]);
|
| }
|
| if (_json.containsKey("setBasicFilter")) {
|
| - setBasicFilter = new SetBasicFilterRequest.fromJson(_json["setBasicFilter"]);
|
| + setBasicFilter =
|
| + new SetBasicFilterRequest.fromJson(_json["setBasicFilter"]);
|
| }
|
| if (_json.containsKey("setDataValidation")) {
|
| - setDataValidation = new SetDataValidationRequest.fromJson(_json["setDataValidation"]);
|
| + setDataValidation =
|
| + new SetDataValidationRequest.fromJson(_json["setDataValidation"]);
|
| }
|
| if (_json.containsKey("sortRange")) {
|
| sortRange = new SortRangeRequest.fromJson(_json["sortRange"]);
|
| @@ -6723,36 +6856,49 @@ class Request {
|
| updateCells = new UpdateCellsRequest.fromJson(_json["updateCells"]);
|
| }
|
| if (_json.containsKey("updateChartSpec")) {
|
| - updateChartSpec = new UpdateChartSpecRequest.fromJson(_json["updateChartSpec"]);
|
| + updateChartSpec =
|
| + new UpdateChartSpecRequest.fromJson(_json["updateChartSpec"]);
|
| }
|
| if (_json.containsKey("updateConditionalFormatRule")) {
|
| - updateConditionalFormatRule = new UpdateConditionalFormatRuleRequest.fromJson(_json["updateConditionalFormatRule"]);
|
| + updateConditionalFormatRule =
|
| + new UpdateConditionalFormatRuleRequest.fromJson(
|
| + _json["updateConditionalFormatRule"]);
|
| }
|
| if (_json.containsKey("updateDimensionProperties")) {
|
| - updateDimensionProperties = new UpdateDimensionPropertiesRequest.fromJson(_json["updateDimensionProperties"]);
|
| + updateDimensionProperties = new UpdateDimensionPropertiesRequest.fromJson(
|
| + _json["updateDimensionProperties"]);
|
| }
|
| if (_json.containsKey("updateEmbeddedObjectPosition")) {
|
| - updateEmbeddedObjectPosition = new UpdateEmbeddedObjectPositionRequest.fromJson(_json["updateEmbeddedObjectPosition"]);
|
| + updateEmbeddedObjectPosition =
|
| + new UpdateEmbeddedObjectPositionRequest.fromJson(
|
| + _json["updateEmbeddedObjectPosition"]);
|
| }
|
| if (_json.containsKey("updateFilterView")) {
|
| - updateFilterView = new UpdateFilterViewRequest.fromJson(_json["updateFilterView"]);
|
| + updateFilterView =
|
| + new UpdateFilterViewRequest.fromJson(_json["updateFilterView"]);
|
| }
|
| if (_json.containsKey("updateNamedRange")) {
|
| - updateNamedRange = new UpdateNamedRangeRequest.fromJson(_json["updateNamedRange"]);
|
| + updateNamedRange =
|
| + new UpdateNamedRangeRequest.fromJson(_json["updateNamedRange"]);
|
| }
|
| if (_json.containsKey("updateProtectedRange")) {
|
| - updateProtectedRange = new UpdateProtectedRangeRequest.fromJson(_json["updateProtectedRange"]);
|
| + updateProtectedRange = new UpdateProtectedRangeRequest.fromJson(
|
| + _json["updateProtectedRange"]);
|
| }
|
| if (_json.containsKey("updateSheetProperties")) {
|
| - updateSheetProperties = new UpdateSheetPropertiesRequest.fromJson(_json["updateSheetProperties"]);
|
| + updateSheetProperties = new UpdateSheetPropertiesRequest.fromJson(
|
| + _json["updateSheetProperties"]);
|
| }
|
| if (_json.containsKey("updateSpreadsheetProperties")) {
|
| - updateSpreadsheetProperties = new UpdateSpreadsheetPropertiesRequest.fromJson(_json["updateSpreadsheetProperties"]);
|
| + updateSpreadsheetProperties =
|
| + new UpdateSpreadsheetPropertiesRequest.fromJson(
|
| + _json["updateSpreadsheetProperties"]);
|
| }
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (addBanding != null) {
|
| _json["addBanding"] = (addBanding).toJson();
|
| }
|
| @@ -6799,7 +6945,8 @@ class Request {
|
| _json["deleteBanding"] = (deleteBanding).toJson();
|
| }
|
| if (deleteConditionalFormatRule != null) {
|
| - _json["deleteConditionalFormatRule"] = (deleteConditionalFormatRule).toJson();
|
| + _json["deleteConditionalFormatRule"] =
|
| + (deleteConditionalFormatRule).toJson();
|
| }
|
| if (deleteDimension != null) {
|
| _json["deleteDimension"] = (deleteDimension).toJson();
|
| @@ -6880,13 +7027,15 @@ class Request {
|
| _json["updateChartSpec"] = (updateChartSpec).toJson();
|
| }
|
| if (updateConditionalFormatRule != null) {
|
| - _json["updateConditionalFormatRule"] = (updateConditionalFormatRule).toJson();
|
| + _json["updateConditionalFormatRule"] =
|
| + (updateConditionalFormatRule).toJson();
|
| }
|
| if (updateDimensionProperties != null) {
|
| _json["updateDimensionProperties"] = (updateDimensionProperties).toJson();
|
| }
|
| if (updateEmbeddedObjectPosition != null) {
|
| - _json["updateEmbeddedObjectPosition"] = (updateEmbeddedObjectPosition).toJson();
|
| + _json["updateEmbeddedObjectPosition"] =
|
| + (updateEmbeddedObjectPosition).toJson();
|
| }
|
| if (updateFilterView != null) {
|
| _json["updateFilterView"] = (updateFilterView).toJson();
|
| @@ -6901,37 +7050,49 @@ class Request {
|
| _json["updateSheetProperties"] = (updateSheetProperties).toJson();
|
| }
|
| if (updateSpreadsheetProperties != null) {
|
| - _json["updateSpreadsheetProperties"] = (updateSpreadsheetProperties).toJson();
|
| + _json["updateSpreadsheetProperties"] =
|
| + (updateSpreadsheetProperties).toJson();
|
| }
|
| return _json;
|
| }
|
| }
|
|
|
| -/** A single response from an update. */
|
| +/// A single response from an update.
|
| class Response {
|
| - /** A reply from adding a banded range. */
|
| + /// A reply from adding a banded range.
|
| AddBandingResponse addBanding;
|
| - /** A reply from adding a chart. */
|
| +
|
| + /// A reply from adding a chart.
|
| AddChartResponse addChart;
|
| - /** A reply from adding a filter view. */
|
| +
|
| + /// A reply from adding a filter view.
|
| AddFilterViewResponse addFilterView;
|
| - /** A reply from adding a named range. */
|
| +
|
| + /// A reply from adding a named range.
|
| AddNamedRangeResponse addNamedRange;
|
| - /** A reply from adding a protected range. */
|
| +
|
| + /// A reply from adding a protected range.
|
| AddProtectedRangeResponse addProtectedRange;
|
| - /** A reply from adding a sheet. */
|
| +
|
| + /// A reply from adding a sheet.
|
| AddSheetResponse addSheet;
|
| - /** A reply from deleting a conditional format rule. */
|
| +
|
| + /// A reply from deleting a conditional format rule.
|
| DeleteConditionalFormatRuleResponse deleteConditionalFormatRule;
|
| - /** A reply from duplicating a filter view. */
|
| +
|
| + /// A reply from duplicating a filter view.
|
| DuplicateFilterViewResponse duplicateFilterView;
|
| - /** A reply from duplicating a sheet. */
|
| +
|
| + /// A reply from duplicating a sheet.
|
| DuplicateSheetResponse duplicateSheet;
|
| - /** A reply from doing a find/replace. */
|
| +
|
| + /// A reply from doing a find/replace.
|
| FindReplaceResponse findReplace;
|
| - /** A reply from updating a conditional format rule. */
|
| +
|
| + /// A reply from updating a conditional format rule.
|
| UpdateConditionalFormatRuleResponse updateConditionalFormatRule;
|
| - /** A reply from updating an embedded object's position. */
|
| +
|
| + /// A reply from updating an embedded object's position.
|
| UpdateEmbeddedObjectPositionResponse updateEmbeddedObjectPosition;
|
|
|
| Response();
|
| @@ -6944,39 +7105,51 @@ class Response {
|
| addChart = new AddChartResponse.fromJson(_json["addChart"]);
|
| }
|
| if (_json.containsKey("addFilterView")) {
|
| - addFilterView = new AddFilterViewResponse.fromJson(_json["addFilterView"]);
|
| + addFilterView =
|
| + new AddFilterViewResponse.fromJson(_json["addFilterView"]);
|
| }
|
| if (_json.containsKey("addNamedRange")) {
|
| - addNamedRange = new AddNamedRangeResponse.fromJson(_json["addNamedRange"]);
|
| + addNamedRange =
|
| + new AddNamedRangeResponse.fromJson(_json["addNamedRange"]);
|
| }
|
| if (_json.containsKey("addProtectedRange")) {
|
| - addProtectedRange = new AddProtectedRangeResponse.fromJson(_json["addProtectedRange"]);
|
| + addProtectedRange =
|
| + new AddProtectedRangeResponse.fromJson(_json["addProtectedRange"]);
|
| }
|
| if (_json.containsKey("addSheet")) {
|
| addSheet = new AddSheetResponse.fromJson(_json["addSheet"]);
|
| }
|
| if (_json.containsKey("deleteConditionalFormatRule")) {
|
| - deleteConditionalFormatRule = new DeleteConditionalFormatRuleResponse.fromJson(_json["deleteConditionalFormatRule"]);
|
| + deleteConditionalFormatRule =
|
| + new DeleteConditionalFormatRuleResponse.fromJson(
|
| + _json["deleteConditionalFormatRule"]);
|
| }
|
| if (_json.containsKey("duplicateFilterView")) {
|
| - duplicateFilterView = new DuplicateFilterViewResponse.fromJson(_json["duplicateFilterView"]);
|
| + duplicateFilterView = new DuplicateFilterViewResponse.fromJson(
|
| + _json["duplicateFilterView"]);
|
| }
|
| if (_json.containsKey("duplicateSheet")) {
|
| - duplicateSheet = new DuplicateSheetResponse.fromJson(_json["duplicateSheet"]);
|
| + duplicateSheet =
|
| + new DuplicateSheetResponse.fromJson(_json["duplicateSheet"]);
|
| }
|
| if (_json.containsKey("findReplace")) {
|
| findReplace = new FindReplaceResponse.fromJson(_json["findReplace"]);
|
| }
|
| if (_json.containsKey("updateConditionalFormatRule")) {
|
| - updateConditionalFormatRule = new UpdateConditionalFormatRuleResponse.fromJson(_json["updateConditionalFormatRule"]);
|
| + updateConditionalFormatRule =
|
| + new UpdateConditionalFormatRuleResponse.fromJson(
|
| + _json["updateConditionalFormatRule"]);
|
| }
|
| if (_json.containsKey("updateEmbeddedObjectPosition")) {
|
| - updateEmbeddedObjectPosition = new UpdateEmbeddedObjectPositionResponse.fromJson(_json["updateEmbeddedObjectPosition"]);
|
| + updateEmbeddedObjectPosition =
|
| + new UpdateEmbeddedObjectPositionResponse.fromJson(
|
| + _json["updateEmbeddedObjectPosition"]);
|
| }
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (addBanding != null) {
|
| _json["addBanding"] = (addBanding).toJson();
|
| }
|
| @@ -6996,7 +7169,8 @@ class Response {
|
| _json["addSheet"] = (addSheet).toJson();
|
| }
|
| if (deleteConditionalFormatRule != null) {
|
| - _json["deleteConditionalFormatRule"] = (deleteConditionalFormatRule).toJson();
|
| + _json["deleteConditionalFormatRule"] =
|
| + (deleteConditionalFormatRule).toJson();
|
| }
|
| if (duplicateFilterView != null) {
|
| _json["duplicateFilterView"] = (duplicateFilterView).toJson();
|
| @@ -7008,30 +7182,34 @@ class Response {
|
| _json["findReplace"] = (findReplace).toJson();
|
| }
|
| if (updateConditionalFormatRule != null) {
|
| - _json["updateConditionalFormatRule"] = (updateConditionalFormatRule).toJson();
|
| + _json["updateConditionalFormatRule"] =
|
| + (updateConditionalFormatRule).toJson();
|
| }
|
| if (updateEmbeddedObjectPosition != null) {
|
| - _json["updateEmbeddedObjectPosition"] = (updateEmbeddedObjectPosition).toJson();
|
| + _json["updateEmbeddedObjectPosition"] =
|
| + (updateEmbeddedObjectPosition).toJson();
|
| }
|
| return _json;
|
| }
|
| }
|
|
|
| -/** Data about each cell in a row. */
|
| +/// Data about each cell in a row.
|
| class RowData {
|
| - /** The values in the row, one per column. */
|
| + /// The values in the row, one per column.
|
| core.List<CellData> values;
|
|
|
| RowData();
|
|
|
| RowData.fromJson(core.Map _json) {
|
| if (_json.containsKey("values")) {
|
| - values = _json["values"].map((value) => new CellData.fromJson(value)).toList();
|
| + values =
|
| + _json["values"].map((value) => new CellData.fromJson(value)).toList();
|
| }
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (values != null) {
|
| _json["values"] = values.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -7039,9 +7217,9 @@ class RowData {
|
| }
|
| }
|
|
|
| -/** Sets the basic filter associated with a sheet. */
|
| +/// Sets the basic filter associated with a sheet.
|
| class SetBasicFilterRequest {
|
| - /** The filter to set. */
|
| + /// The filter to set.
|
| BasicFilter filter;
|
|
|
| SetBasicFilterRequest();
|
| @@ -7053,7 +7231,8 @@ class SetBasicFilterRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (filter != null) {
|
| _json["filter"] = (filter).toJson();
|
| }
|
| @@ -7061,17 +7240,14 @@ class SetBasicFilterRequest {
|
| }
|
| }
|
|
|
| -/**
|
| - * Sets a data validation rule to every cell in the range.
|
| - * To clear validation in a range, call this with no rule specified.
|
| - */
|
| +/// Sets a data validation rule to every cell in the range.
|
| +/// To clear validation in a range, call this with no rule specified.
|
| class SetDataValidationRequest {
|
| - /** The range the data validation rule should apply to. */
|
| + /// The range the data validation rule should apply to.
|
| GridRange range;
|
| - /**
|
| - * The data validation rule to set on each cell in the range,
|
| - * or empty to clear the data validation in the range.
|
| - */
|
| +
|
| + /// The data validation rule to set on each cell in the range,
|
| + /// or empty to clear the data validation in the range.
|
| DataValidationRule rule;
|
|
|
| SetDataValidationRequest();
|
| @@ -7086,7 +7262,8 @@ class SetDataValidationRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (range != null) {
|
| _json["range"] = (range).toJson();
|
| }
|
| @@ -7097,72 +7274,93 @@ class SetDataValidationRequest {
|
| }
|
| }
|
|
|
| -/** A sheet in a spreadsheet. */
|
| +/// A sheet in a spreadsheet.
|
| class Sheet {
|
| - /** The banded (i.e. alternating colors) ranges on this sheet. */
|
| + /// The banded (i.e. alternating colors) ranges on this sheet.
|
| core.List<BandedRange> bandedRanges;
|
| - /** The filter on this sheet, if any. */
|
| +
|
| + /// The filter on this sheet, if any.
|
| BasicFilter basicFilter;
|
| - /** The specifications of every chart on this sheet. */
|
| +
|
| + /// The specifications of every chart on this sheet.
|
| core.List<EmbeddedChart> charts;
|
| - /** The conditional format rules in this sheet. */
|
| +
|
| + /// The conditional format rules in this sheet.
|
| core.List<ConditionalFormatRule> conditionalFormats;
|
| - /**
|
| - * Data in the grid, if this is a grid sheet.
|
| - * The number of GridData objects returned is dependent on the number of
|
| - * ranges requested on this sheet. For example, if this is representing
|
| - * `Sheet1`, and the spreadsheet was requested with ranges
|
| - * `Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a
|
| - * startRow/startColumn of `0`,
|
| - * while the second one will have `startRow 14` (zero-based row 15),
|
| - * and `startColumn 3` (zero-based column D).
|
| - */
|
| +
|
| + /// Data in the grid, if this is a grid sheet.
|
| + /// The number of GridData objects returned is dependent on the number of
|
| + /// ranges requested on this sheet. For example, if this is representing
|
| + /// `Sheet1`, and the spreadsheet was requested with ranges
|
| + /// `Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a
|
| + /// startRow/startColumn of `0`,
|
| + /// while the second one will have `startRow 14` (zero-based row 15),
|
| + /// and `startColumn 3` (zero-based column D).
|
| core.List<GridData> data;
|
| - /** The filter views in this sheet. */
|
| +
|
| + /// The filter views in this sheet.
|
| core.List<FilterView> filterViews;
|
| - /** The ranges that are merged together. */
|
| +
|
| + /// The ranges that are merged together.
|
| core.List<GridRange> merges;
|
| - /** The properties of the sheet. */
|
| +
|
| + /// The properties of the sheet.
|
| SheetProperties properties;
|
| - /** The protected ranges in this sheet. */
|
| +
|
| + /// The protected ranges in this sheet.
|
| core.List<ProtectedRange> protectedRanges;
|
|
|
| Sheet();
|
|
|
| Sheet.fromJson(core.Map _json) {
|
| if (_json.containsKey("bandedRanges")) {
|
| - bandedRanges = _json["bandedRanges"].map((value) => new BandedRange.fromJson(value)).toList();
|
| + bandedRanges = _json["bandedRanges"]
|
| + .map((value) => new BandedRange.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("basicFilter")) {
|
| basicFilter = new BasicFilter.fromJson(_json["basicFilter"]);
|
| }
|
| if (_json.containsKey("charts")) {
|
| - charts = _json["charts"].map((value) => new EmbeddedChart.fromJson(value)).toList();
|
| + charts = _json["charts"]
|
| + .map((value) => new EmbeddedChart.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("conditionalFormats")) {
|
| - conditionalFormats = _json["conditionalFormats"].map((value) => new ConditionalFormatRule.fromJson(value)).toList();
|
| + conditionalFormats = _json["conditionalFormats"]
|
| + .map((value) => new ConditionalFormatRule.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("data")) {
|
| - data = _json["data"].map((value) => new GridData.fromJson(value)).toList();
|
| + data =
|
| + _json["data"].map((value) => new GridData.fromJson(value)).toList();
|
| }
|
| if (_json.containsKey("filterViews")) {
|
| - filterViews = _json["filterViews"].map((value) => new FilterView.fromJson(value)).toList();
|
| + filterViews = _json["filterViews"]
|
| + .map((value) => new FilterView.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("merges")) {
|
| - merges = _json["merges"].map((value) => new GridRange.fromJson(value)).toList();
|
| + merges = _json["merges"]
|
| + .map((value) => new GridRange.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("properties")) {
|
| properties = new SheetProperties.fromJson(_json["properties"]);
|
| }
|
| if (_json.containsKey("protectedRanges")) {
|
| - protectedRanges = _json["protectedRanges"].map((value) => new ProtectedRange.fromJson(value)).toList();
|
| + protectedRanges = _json["protectedRanges"]
|
| + .map((value) => new ProtectedRange.fromJson(value))
|
| + .toList();
|
| }
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (bandedRanges != null) {
|
| - _json["bandedRanges"] = bandedRanges.map((value) => (value).toJson()).toList();
|
| + _json["bandedRanges"] =
|
| + bandedRanges.map((value) => (value).toJson()).toList();
|
| }
|
| if (basicFilter != null) {
|
| _json["basicFilter"] = (basicFilter).toJson();
|
| @@ -7171,13 +7369,15 @@ class Sheet {
|
| _json["charts"] = charts.map((value) => (value).toJson()).toList();
|
| }
|
| if (conditionalFormats != null) {
|
| - _json["conditionalFormats"] = conditionalFormats.map((value) => (value).toJson()).toList();
|
| + _json["conditionalFormats"] =
|
| + conditionalFormats.map((value) => (value).toJson()).toList();
|
| }
|
| if (data != null) {
|
| _json["data"] = data.map((value) => (value).toJson()).toList();
|
| }
|
| if (filterViews != null) {
|
| - _json["filterViews"] = filterViews.map((value) => (value).toJson()).toList();
|
| + _json["filterViews"] =
|
| + filterViews.map((value) => (value).toJson()).toList();
|
| }
|
| if (merges != null) {
|
| _json["merges"] = merges.map((value) => (value).toJson()).toList();
|
| @@ -7186,56 +7386,57 @@ class Sheet {
|
| _json["properties"] = (properties).toJson();
|
| }
|
| if (protectedRanges != null) {
|
| - _json["protectedRanges"] = protectedRanges.map((value) => (value).toJson()).toList();
|
| + _json["protectedRanges"] =
|
| + protectedRanges.map((value) => (value).toJson()).toList();
|
| }
|
| return _json;
|
| }
|
| }
|
|
|
| -/** Properties of a sheet. */
|
| +/// Properties of a sheet.
|
| class SheetProperties {
|
| - /**
|
| - * Additional properties of the sheet if this sheet is a grid.
|
| - * (If the sheet is an object sheet, containing a chart or image, then
|
| - * this field will be absent.)
|
| - * When writing it is an error to set any grid properties on non-grid sheets.
|
| - */
|
| + /// Additional properties of the sheet if this sheet is a grid.
|
| + /// (If the sheet is an object sheet, containing a chart or image, then
|
| + /// this field will be absent.)
|
| + /// When writing it is an error to set any grid properties on non-grid
|
| + /// sheets.
|
| GridProperties gridProperties;
|
| - /** True if the sheet is hidden in the UI, false if it's visible. */
|
| +
|
| + /// True if the sheet is hidden in the UI, false if it's visible.
|
| core.bool hidden;
|
| - /**
|
| - * The index of the sheet within the spreadsheet.
|
| - * When adding or updating sheet properties, if this field
|
| - * is excluded then the sheet will be added or moved to the end
|
| - * of the sheet list. When updating sheet indices or inserting
|
| - * sheets, movement is considered in "before the move" indexes.
|
| - * For example, if there were 3 sheets (S1, S2, S3) in order to
|
| - * move S1 ahead of S2 the index would have to be set to 2. A sheet
|
| - * index update request will be ignored if the requested index is
|
| - * identical to the sheets current index or if the requested new
|
| - * index is equal to the current sheet index + 1.
|
| - */
|
| +
|
| + /// The index of the sheet within the spreadsheet.
|
| + /// When adding or updating sheet properties, if this field
|
| + /// is excluded then the sheet will be added or moved to the end
|
| + /// of the sheet list. When updating sheet indices or inserting
|
| + /// sheets, movement is considered in "before the move" indexes.
|
| + /// For example, if there were 3 sheets (S1, S2, S3) in order to
|
| + /// move S1 ahead of S2 the index would have to be set to 2. A sheet
|
| + /// index update request will be ignored if the requested index is
|
| + /// identical to the sheets current index or if the requested new
|
| + /// index is equal to the current sheet index + 1.
|
| core.int index;
|
| - /** True if the sheet is an RTL sheet instead of an LTR sheet. */
|
| +
|
| + /// True if the sheet is an RTL sheet instead of an LTR sheet.
|
| core.bool rightToLeft;
|
| - /**
|
| - * The ID of the sheet. Must be non-negative.
|
| - * This field cannot be changed once set.
|
| - */
|
| +
|
| + /// The ID of the sheet. Must be non-negative.
|
| + /// This field cannot be changed once set.
|
| core.int sheetId;
|
| - /**
|
| - * The type of sheet. Defaults to GRID.
|
| - * This field cannot be changed once set.
|
| - * Possible string values are:
|
| - * - "SHEET_TYPE_UNSPECIFIED" : Default value, do not use.
|
| - * - "GRID" : The sheet is a grid.
|
| - * - "OBJECT" : The sheet has no grid and instead has an object like a chart
|
| - * or image.
|
| - */
|
| +
|
| + /// The type of sheet. Defaults to GRID.
|
| + /// This field cannot be changed once set.
|
| + /// Possible string values are:
|
| + /// - "SHEET_TYPE_UNSPECIFIED" : Default value, do not use.
|
| + /// - "GRID" : The sheet is a grid.
|
| + /// - "OBJECT" : The sheet has no grid and instead has an object like a chart
|
| + /// or image.
|
| core.String sheetType;
|
| - /** The color of the tab in the UI. */
|
| +
|
| + /// The color of the tab in the UI.
|
| Color tabColor;
|
| - /** The name of the sheet. */
|
| +
|
| + /// The name of the sheet.
|
| core.String title;
|
|
|
| SheetProperties();
|
| @@ -7268,7 +7469,8 @@ class SheetProperties {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (gridProperties != null) {
|
| _json["gridProperties"] = (gridProperties).toJson();
|
| }
|
| @@ -7297,14 +7499,13 @@ class SheetProperties {
|
| }
|
| }
|
|
|
| -/** Sorts data in rows based on a sort order per column. */
|
| +/// Sorts data in rows based on a sort order per column.
|
| class SortRangeRequest {
|
| - /** The range to sort. */
|
| + /// The range to sort.
|
| GridRange range;
|
| - /**
|
| - * The sort order per column. Later specifications are used when values
|
| - * are equal in the earlier specifications.
|
| - */
|
| +
|
| + /// The sort order per column. Later specifications are used when values
|
| + /// are equal in the earlier specifications.
|
| core.List<SortSpec> sortSpecs;
|
|
|
| SortRangeRequest();
|
| @@ -7314,12 +7515,15 @@ class SortRangeRequest {
|
| range = new GridRange.fromJson(_json["range"]);
|
| }
|
| if (_json.containsKey("sortSpecs")) {
|
| - sortSpecs = _json["sortSpecs"].map((value) => new SortSpec.fromJson(value)).toList();
|
| + sortSpecs = _json["sortSpecs"]
|
| + .map((value) => new SortSpec.fromJson(value))
|
| + .toList();
|
| }
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (range != null) {
|
| _json["range"] = (range).toJson();
|
| }
|
| @@ -7330,17 +7534,16 @@ class SortRangeRequest {
|
| }
|
| }
|
|
|
| -/** A sort order associated with a specific column or row. */
|
| +/// A sort order associated with a specific column or row.
|
| class SortSpec {
|
| - /** The dimension the sort should be applied to. */
|
| + /// The dimension the sort should be applied to.
|
| core.int dimensionIndex;
|
| - /**
|
| - * The order data should be sorted.
|
| - * Possible string values are:
|
| - * - "SORT_ORDER_UNSPECIFIED" : Default value, do not use this.
|
| - * - "ASCENDING" : Sort ascending.
|
| - * - "DESCENDING" : Sort descending.
|
| - */
|
| +
|
| + /// The order data should be sorted.
|
| + /// Possible string values are:
|
| + /// - "SORT_ORDER_UNSPECIFIED" : Default value, do not use this.
|
| + /// - "ASCENDING" : Sort ascending.
|
| + /// - "DESCENDING" : Sort descending.
|
| core.String sortOrder;
|
|
|
| SortSpec();
|
| @@ -7355,7 +7558,8 @@ class SortSpec {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (dimensionIndex != null) {
|
| _json["dimensionIndex"] = dimensionIndex;
|
| }
|
| @@ -7366,24 +7570,22 @@ class SortSpec {
|
| }
|
| }
|
|
|
| -/** A combination of a source range and how to extend that source. */
|
| +/// A combination of a source range and how to extend that source.
|
| class SourceAndDestination {
|
| - /**
|
| - * The dimension that data should be filled into.
|
| - * Possible string values are:
|
| - * - "DIMENSION_UNSPECIFIED" : The default value, do not use.
|
| - * - "ROWS" : Operates on the rows of a sheet.
|
| - * - "COLUMNS" : Operates on the columns of a sheet.
|
| - */
|
| + /// The dimension that data should be filled into.
|
| + /// Possible string values are:
|
| + /// - "DIMENSION_UNSPECIFIED" : The default value, do not use.
|
| + /// - "ROWS" : Operates on the rows of a sheet.
|
| + /// - "COLUMNS" : Operates on the columns of a sheet.
|
| core.String dimension;
|
| - /**
|
| - * The number of rows or columns that data should be filled into.
|
| - * Positive numbers expand beyond the last row or last column
|
| - * of the source. Negative numbers expand before the first row
|
| - * or first column of the source.
|
| - */
|
| +
|
| + /// The number of rows or columns that data should be filled into.
|
| + /// Positive numbers expand beyond the last row or last column
|
| + /// of the source. Negative numbers expand before the first row
|
| + /// or first column of the source.
|
| core.int fillLength;
|
| - /** The location of the data to use as the source of the autofill. */
|
| +
|
| + /// The location of the data to use as the source of the autofill.
|
| GridRange source;
|
|
|
| SourceAndDestination();
|
| @@ -7401,7 +7603,8 @@ class SourceAndDestination {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (dimension != null) {
|
| _json["dimension"] = dimension;
|
| }
|
| @@ -7415,36 +7618,39 @@ class SourceAndDestination {
|
| }
|
| }
|
|
|
| -/** Resource that represents a spreadsheet. */
|
| +/// Resource that represents a spreadsheet.
|
| class Spreadsheet {
|
| - /** The named ranges defined in a spreadsheet. */
|
| + /// The named ranges defined in a spreadsheet.
|
| core.List<NamedRange> namedRanges;
|
| - /** Overall properties of a spreadsheet. */
|
| +
|
| + /// Overall properties of a spreadsheet.
|
| SpreadsheetProperties properties;
|
| - /** The sheets that are part of a spreadsheet. */
|
| +
|
| + /// The sheets that are part of a spreadsheet.
|
| core.List<Sheet> sheets;
|
| - /**
|
| - * The ID of the spreadsheet.
|
| - * This field is read-only.
|
| - */
|
| +
|
| + /// The ID of the spreadsheet.
|
| + /// This field is read-only.
|
| core.String spreadsheetId;
|
| - /**
|
| - * The url of the spreadsheet.
|
| - * This field is read-only.
|
| - */
|
| +
|
| + /// The url of the spreadsheet.
|
| + /// This field is read-only.
|
| core.String spreadsheetUrl;
|
|
|
| Spreadsheet();
|
|
|
| Spreadsheet.fromJson(core.Map _json) {
|
| if (_json.containsKey("namedRanges")) {
|
| - namedRanges = _json["namedRanges"].map((value) => new NamedRange.fromJson(value)).toList();
|
| + namedRanges = _json["namedRanges"]
|
| + .map((value) => new NamedRange.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("properties")) {
|
| properties = new SpreadsheetProperties.fromJson(_json["properties"]);
|
| }
|
| if (_json.containsKey("sheets")) {
|
| - sheets = _json["sheets"].map((value) => new Sheet.fromJson(value)).toList();
|
| + sheets =
|
| + _json["sheets"].map((value) => new Sheet.fromJson(value)).toList();
|
| }
|
| if (_json.containsKey("spreadsheetId")) {
|
| spreadsheetId = _json["spreadsheetId"];
|
| @@ -7455,9 +7661,11 @@ class Spreadsheet {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (namedRanges != null) {
|
| - _json["namedRanges"] = namedRanges.map((value) => (value).toJson()).toList();
|
| + _json["namedRanges"] =
|
| + namedRanges.map((value) => (value).toJson()).toList();
|
| }
|
| if (properties != null) {
|
| _json["properties"] = (properties).toJson();
|
| @@ -7475,51 +7683,48 @@ class Spreadsheet {
|
| }
|
| }
|
|
|
| -/** Properties of a spreadsheet. */
|
| +/// Properties of a spreadsheet.
|
| class SpreadsheetProperties {
|
| - /**
|
| - * The amount of time to wait before volatile functions are recalculated.
|
| - * Possible string values are:
|
| - * - "RECALCULATION_INTERVAL_UNSPECIFIED" : Default value. This value must not
|
| - * be used.
|
| - * - "ON_CHANGE" : Volatile functions are updated on every change.
|
| - * - "MINUTE" : Volatile functions are updated on every change and every
|
| - * minute.
|
| - * - "HOUR" : Volatile functions are updated on every change and hourly.
|
| - */
|
| + /// The amount of time to wait before volatile functions are recalculated.
|
| + /// Possible string values are:
|
| + /// - "RECALCULATION_INTERVAL_UNSPECIFIED" : Default value. This value must
|
| + /// not be used.
|
| + /// - "ON_CHANGE" : Volatile functions are updated on every change.
|
| + /// - "MINUTE" : Volatile functions are updated on every change and every
|
| + /// minute.
|
| + /// - "HOUR" : Volatile functions are updated on every change and hourly.
|
| core.String autoRecalc;
|
| - /**
|
| - * The default format of all cells in the spreadsheet.
|
| - * CellData.effectiveFormat will not be set if the
|
| - * cell's format is equal to this default format.
|
| - * This field is read-only.
|
| - */
|
| +
|
| + /// The default format of all cells in the spreadsheet.
|
| + /// CellData.effectiveFormat will not be set if the
|
| + /// cell's format is equal to this default format.
|
| + /// This field is read-only.
|
| CellFormat defaultFormat;
|
| - /**
|
| - * Determines whether and how circular references are resolved with iterative
|
| - * calculation. Absence of this field means that circular references will
|
| - * result in calculation errors.
|
| - */
|
| +
|
| + /// Determines whether and how circular references are resolved with
|
| + /// iterative
|
| + /// calculation. Absence of this field means that circular references will
|
| + /// result in calculation errors.
|
| IterativeCalculationSettings iterativeCalculationSettings;
|
| - /**
|
| - * The locale of the spreadsheet in one of the following formats:
|
| - *
|
| - * * an ISO 639-1 language code such as `en`
|
| - *
|
| - * * an ISO 639-2 language code such as `fil`, if no 639-1 code exists
|
| - *
|
| - * * a combination of the ISO language code and country code, such as `en_US`
|
| - *
|
| - * Note: when updating this field, not all locales/languages are supported.
|
| - */
|
| +
|
| + /// The locale of the spreadsheet in one of the following formats:
|
| + ///
|
| + /// * an ISO 639-1 language code such as `en`
|
| + ///
|
| + /// * an ISO 639-2 language code such as `fil`, if no 639-1 code exists
|
| + ///
|
| + /// * a combination of the ISO language code and country code, such as
|
| + /// `en_US`
|
| + ///
|
| + /// Note: when updating this field, not all locales/languages are supported.
|
| core.String locale;
|
| - /**
|
| - * The time zone of the spreadsheet, in CLDR format such as
|
| - * `America/New_York`. If the time zone isn't recognized, this may
|
| - * be a custom time zone such as `GMT-07:00`.
|
| - */
|
| +
|
| + /// The time zone of the spreadsheet, in CLDR format such as
|
| + /// `America/New_York`. If the time zone isn't recognized, this may
|
| + /// be a custom time zone such as `GMT-07:00`.
|
| core.String timeZone;
|
| - /** The title of the spreadsheet. */
|
| +
|
| + /// The title of the spreadsheet.
|
| core.String title;
|
|
|
| SpreadsheetProperties();
|
| @@ -7532,7 +7737,8 @@ class SpreadsheetProperties {
|
| defaultFormat = new CellFormat.fromJson(_json["defaultFormat"]);
|
| }
|
| if (_json.containsKey("iterativeCalculationSettings")) {
|
| - iterativeCalculationSettings = new IterativeCalculationSettings.fromJson(_json["iterativeCalculationSettings"]);
|
| + iterativeCalculationSettings = new IterativeCalculationSettings.fromJson(
|
| + _json["iterativeCalculationSettings"]);
|
| }
|
| if (_json.containsKey("locale")) {
|
| locale = _json["locale"];
|
| @@ -7546,7 +7752,8 @@ class SpreadsheetProperties {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (autoRecalc != null) {
|
| _json["autoRecalc"] = autoRecalc;
|
| }
|
| @@ -7554,7 +7761,8 @@ class SpreadsheetProperties {
|
| _json["defaultFormat"] = (defaultFormat).toJson();
|
| }
|
| if (iterativeCalculationSettings != null) {
|
| - _json["iterativeCalculationSettings"] = (iterativeCalculationSettings).toJson();
|
| + _json["iterativeCalculationSettings"] =
|
| + (iterativeCalculationSettings).toJson();
|
| }
|
| if (locale != null) {
|
| _json["locale"] = locale;
|
| @@ -7569,24 +7777,28 @@ class SpreadsheetProperties {
|
| }
|
| }
|
|
|
| -/**
|
| - * The format of a run of text in a cell.
|
| - * Absent values indicate that the field isn't specified.
|
| - */
|
| +/// The format of a run of text in a cell.
|
| +/// Absent values indicate that the field isn't specified.
|
| class TextFormat {
|
| - /** True if the text is bold. */
|
| + /// True if the text is bold.
|
| core.bool bold;
|
| - /** The font family. */
|
| +
|
| + /// The font family.
|
| core.String fontFamily;
|
| - /** The size of the font. */
|
| +
|
| + /// The size of the font.
|
| core.int fontSize;
|
| - /** The foreground color of the text. */
|
| +
|
| + /// The foreground color of the text.
|
| Color foregroundColor;
|
| - /** True if the text is italicized. */
|
| +
|
| + /// True if the text is italicized.
|
| core.bool italic;
|
| - /** True if the text has a strikethrough. */
|
| +
|
| + /// True if the text has a strikethrough.
|
| core.bool strikethrough;
|
| - /** True if the text is underlined. */
|
| +
|
| + /// True if the text is underlined.
|
| core.bool underline;
|
|
|
| TextFormat();
|
| @@ -7616,7 +7828,8 @@ class TextFormat {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (bold != null) {
|
| _json["bold"] = bold;
|
| }
|
| @@ -7642,15 +7855,14 @@ class TextFormat {
|
| }
|
| }
|
|
|
| -/**
|
| - * A run of a text format. The format of this run continues until the start
|
| - * index of the next run.
|
| - * When updating, all fields must be set.
|
| - */
|
| +/// A run of a text format. The format of this run continues until the start
|
| +/// index of the next run.
|
| +/// When updating, all fields must be set.
|
| class TextFormatRun {
|
| - /** The format of this run. Absent values inherit the cell's format. */
|
| + /// The format of this run. Absent values inherit the cell's format.
|
| TextFormat format;
|
| - /** The character index where this run starts. */
|
| +
|
| + /// The character index where this run starts.
|
| core.int startIndex;
|
|
|
| TextFormatRun();
|
| @@ -7665,7 +7877,8 @@ class TextFormatRun {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (format != null) {
|
| _json["format"] = (format).toJson();
|
| }
|
| @@ -7676,31 +7889,28 @@ class TextFormatRun {
|
| }
|
| }
|
|
|
| -/** The rotation applied to text in a cell. */
|
| +/// The rotation applied to text in a cell.
|
| class TextRotation {
|
| - /**
|
| - * The angle between the standard orientation and the desired orientation.
|
| - * Measured in degrees. Valid values are between -90 and 90. Positive
|
| - * angles are angled upwards, negative are angled downwards.
|
| - *
|
| - * Note: For LTR text direction positive angles are in the counterclockwise
|
| - * direction, whereas for RTL they are in the clockwise direction
|
| - */
|
| + /// The angle between the standard orientation and the desired orientation.
|
| + /// Measured in degrees. Valid values are between -90 and 90. Positive
|
| + /// angles are angled upwards, negative are angled downwards.
|
| + ///
|
| + /// Note: For LTR text direction positive angles are in the counterclockwise
|
| + /// direction, whereas for RTL they are in the clockwise direction
|
| core.int angle;
|
| - /**
|
| - * If true, text reads top to bottom, but the orientation of individual
|
| - * characters is unchanged.
|
| - * For example:
|
| - *
|
| - * | V |
|
| - * | e |
|
| - * | r |
|
| - * | t |
|
| - * | i |
|
| - * | c |
|
| - * | a |
|
| - * | l |
|
| - */
|
| +
|
| + /// If true, text reads top to bottom, but the orientation of individual
|
| + /// characters is unchanged.
|
| + /// For example:
|
| + ///
|
| + /// | V |
|
| + /// | e |
|
| + /// | r |
|
| + /// | t |
|
| + /// | i |
|
| + /// | c |
|
| + /// | a |
|
| + /// | l |
|
| core.bool vertical;
|
|
|
| TextRotation();
|
| @@ -7715,7 +7925,8 @@ class TextRotation {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (angle != null) {
|
| _json["angle"] = angle;
|
| }
|
| @@ -7726,29 +7937,25 @@ class TextRotation {
|
| }
|
| }
|
|
|
| -/**
|
| - * Splits a column of text into multiple columns,
|
| - * based on a delimiter in each cell.
|
| - */
|
| +/// Splits a column of text into multiple columns,
|
| +/// based on a delimiter in each cell.
|
| class TextToColumnsRequest {
|
| - /**
|
| - * The delimiter to use. Used only if delimiterType is
|
| - * CUSTOM.
|
| - */
|
| + /// The delimiter to use. Used only if delimiterType is
|
| + /// CUSTOM.
|
| core.String delimiter;
|
| - /**
|
| - * The delimiter type to use.
|
| - * Possible string values are:
|
| - * - "DELIMITER_TYPE_UNSPECIFIED" : Default value. This value must not be
|
| - * used.
|
| - * - "COMMA" : ","
|
| - * - "SEMICOLON" : ";"
|
| - * - "PERIOD" : "."
|
| - * - "SPACE" : " "
|
| - * - "CUSTOM" : A custom value as defined in delimiter.
|
| - */
|
| +
|
| + /// The delimiter type to use.
|
| + /// Possible string values are:
|
| + /// - "DELIMITER_TYPE_UNSPECIFIED" : Default value. This value must not be
|
| + /// used.
|
| + /// - "COMMA" : ","
|
| + /// - "SEMICOLON" : ";"
|
| + /// - "PERIOD" : "."
|
| + /// - "SPACE" : " "
|
| + /// - "CUSTOM" : A custom value as defined in delimiter.
|
| core.String delimiterType;
|
| - /** The source data range. This must span exactly one column. */
|
| +
|
| + /// The source data range. This must span exactly one column.
|
| GridRange source;
|
|
|
| TextToColumnsRequest();
|
| @@ -7766,7 +7973,8 @@ class TextToColumnsRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (delimiter != null) {
|
| _json["delimiter"] = delimiter;
|
| }
|
| @@ -7780,13 +7988,11 @@ class TextToColumnsRequest {
|
| }
|
| }
|
|
|
| -/** Unmerges cells in the given range. */
|
| +/// Unmerges cells in the given range.
|
| class UnmergeCellsRequest {
|
| - /**
|
| - * The range within which all cells should be unmerged.
|
| - * If the range spans multiple merges, all will be unmerged.
|
| - * The range must not partially span any merge.
|
| - */
|
| + /// The range within which all cells should be unmerged.
|
| + /// If the range spans multiple merges, all will be unmerged.
|
| + /// The range must not partially span any merge.
|
| GridRange range;
|
|
|
| UnmergeCellsRequest();
|
| @@ -7798,7 +8004,8 @@ class UnmergeCellsRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (range != null) {
|
| _json["range"] = (range).toJson();
|
| }
|
| @@ -7806,15 +8013,14 @@ class UnmergeCellsRequest {
|
| }
|
| }
|
|
|
| -/** Updates properties of the supplied banded range. */
|
| +/// Updates properties of the supplied banded range.
|
| class UpdateBandingRequest {
|
| - /** The banded range to update with the new properties. */
|
| + /// The banded range to update with the new properties.
|
| BandedRange bandedRange;
|
| - /**
|
| - * The fields that should be updated. At least one field must be specified.
|
| - * The root `bandedRange` is implied and should not be specified.
|
| - * A single `"*"` can be used as short-hand for listing every field.
|
| - */
|
| +
|
| + /// The fields that should be updated. At least one field must be specified.
|
| + /// The root `bandedRange` is implied and should not be specified.
|
| + /// A single `"*"` can be used as short-hand for listing every field.
|
| core.String fields;
|
|
|
| UpdateBandingRequest();
|
| @@ -7829,7 +8035,8 @@ class UpdateBandingRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (bandedRange != null) {
|
| _json["bandedRange"] = (bandedRange).toJson();
|
| }
|
| @@ -7840,33 +8047,37 @@ class UpdateBandingRequest {
|
| }
|
| }
|
|
|
| -/**
|
| - * Updates the borders of a range.
|
| - * If a field is not set in the request, that means the border remains as-is.
|
| - * For example, with two subsequent UpdateBordersRequest:
|
| - *
|
| - * 1. range: A1:A5 `{ top: RED, bottom: WHITE }`
|
| - * 2. range: A1:A5 `{ left: BLUE }`
|
| - *
|
| - * That would result in A1:A5 having a borders of
|
| - * `{ top: RED, bottom: WHITE, left: BLUE }`.
|
| - * If you want to clear a border, explicitly set the style to
|
| - * NONE.
|
| - */
|
| +/// Updates the borders of a range.
|
| +/// If a field is not set in the request, that means the border remains as-is.
|
| +/// For example, with two subsequent UpdateBordersRequest:
|
| +///
|
| +/// 1. range: A1:A5 `{ top: RED, bottom: WHITE }`
|
| +/// 2. range: A1:A5 `{ left: BLUE }`
|
| +///
|
| +/// That would result in A1:A5 having a borders of
|
| +/// `{ top: RED, bottom: WHITE, left: BLUE }`.
|
| +/// If you want to clear a border, explicitly set the style to
|
| +/// NONE.
|
| class UpdateBordersRequest {
|
| - /** The border to put at the bottom of the range. */
|
| + /// The border to put at the bottom of the range.
|
| Border bottom;
|
| - /** The horizontal border to put within the range. */
|
| +
|
| + /// The horizontal border to put within the range.
|
| Border innerHorizontal;
|
| - /** The vertical border to put within the range. */
|
| +
|
| + /// The vertical border to put within the range.
|
| Border innerVertical;
|
| - /** The border to put at the left of the range. */
|
| +
|
| + /// The border to put at the left of the range.
|
| Border left;
|
| - /** The range whose borders should be updated. */
|
| +
|
| + /// The range whose borders should be updated.
|
| GridRange range;
|
| - /** The border to put at the right of the range. */
|
| +
|
| + /// The border to put at the right of the range.
|
| Border right;
|
| - /** The border to put at the top of the range. */
|
| +
|
| + /// The border to put at the top of the range.
|
| Border top;
|
|
|
| UpdateBordersRequest();
|
| @@ -7896,7 +8107,8 @@ class UpdateBordersRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (bottom != null) {
|
| _json["bottom"] = (bottom).toJson();
|
| }
|
| @@ -7922,29 +8134,26 @@ class UpdateBordersRequest {
|
| }
|
| }
|
|
|
| -/** Updates all cells in a range with new data. */
|
| +/// Updates all cells in a range with new data.
|
| class UpdateCellsRequest {
|
| - /**
|
| - * The fields of CellData that should be updated.
|
| - * At least one field must be specified.
|
| - * The root is the CellData; 'row.values.' should not be specified.
|
| - * A single `"*"` can be used as short-hand for listing every field.
|
| - */
|
| + /// The fields of CellData that should be updated.
|
| + /// At least one field must be specified.
|
| + /// The root is the CellData; 'row.values.' should not be specified.
|
| + /// A single `"*"` can be used as short-hand for listing every field.
|
| core.String fields;
|
| - /**
|
| - * The range to write data to.
|
| - *
|
| - * If the data in rows does not cover the entire requested range,
|
| - * the fields matching those set in fields will be cleared.
|
| - */
|
| +
|
| + /// The range to write data to.
|
| + ///
|
| + /// If the data in rows does not cover the entire requested range,
|
| + /// the fields matching those set in fields will be cleared.
|
| GridRange range;
|
| - /** The data to write. */
|
| +
|
| + /// The data to write.
|
| core.List<RowData> rows;
|
| - /**
|
| - * The coordinate to start writing data at.
|
| - * Any number of rows and columns (including a different number of
|
| - * columns per row) may be written.
|
| - */
|
| +
|
| + /// The coordinate to start writing data at.
|
| + /// Any number of rows and columns (including a different number of
|
| + /// columns per row) may be written.
|
| GridCoordinate start;
|
|
|
| UpdateCellsRequest();
|
| @@ -7965,7 +8174,8 @@ class UpdateCellsRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (fields != null) {
|
| _json["fields"] = fields;
|
| }
|
| @@ -7982,15 +8192,14 @@ class UpdateCellsRequest {
|
| }
|
| }
|
|
|
| -/**
|
| - * Updates a chart's specifications.
|
| - * (This does not move or resize a chart. To move or resize a chart, use
|
| - * UpdateEmbeddedObjectPositionRequest.)
|
| - */
|
| +/// Updates a chart's specifications.
|
| +/// (This does not move or resize a chart. To move or resize a chart, use
|
| +/// UpdateEmbeddedObjectPositionRequest.)
|
| class UpdateChartSpecRequest {
|
| - /** The ID of the chart to update. */
|
| + /// The ID of the chart to update.
|
| core.int chartId;
|
| - /** The specification to apply to the chart. */
|
| +
|
| + /// The specification to apply to the chart.
|
| ChartSpec spec;
|
|
|
| UpdateChartSpecRequest();
|
| @@ -8005,7 +8214,8 @@ class UpdateChartSpecRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (chartId != null) {
|
| _json["chartId"] = chartId;
|
| }
|
| @@ -8016,21 +8226,20 @@ class UpdateChartSpecRequest {
|
| }
|
| }
|
|
|
| -/**
|
| - * Updates a conditional format rule at the given index,
|
| - * or moves a conditional format rule to another index.
|
| - */
|
| +/// Updates a conditional format rule at the given index,
|
| +/// or moves a conditional format rule to another index.
|
| class UpdateConditionalFormatRuleRequest {
|
| - /** The zero-based index of the rule that should be replaced or moved. */
|
| + /// The zero-based index of the rule that should be replaced or moved.
|
| core.int index;
|
| - /** The zero-based new index the rule should end up at. */
|
| +
|
| + /// The zero-based new index the rule should end up at.
|
| core.int newIndex;
|
| - /** The rule that should replace the rule at the given index. */
|
| +
|
| + /// The rule that should replace the rule at the given index.
|
| ConditionalFormatRule rule;
|
| - /**
|
| - * The sheet of the rule to move. Required if new_index is set,
|
| - * unused otherwise.
|
| - */
|
| +
|
| + /// The sheet of the rule to move. Required if new_index is set,
|
| + /// unused otherwise.
|
| core.int sheetId;
|
|
|
| UpdateConditionalFormatRuleRequest();
|
| @@ -8051,7 +8260,8 @@ class UpdateConditionalFormatRuleRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (index != null) {
|
| _json["index"] = index;
|
| }
|
| @@ -8068,24 +8278,21 @@ class UpdateConditionalFormatRuleRequest {
|
| }
|
| }
|
|
|
| -/** The result of updating a conditional format rule. */
|
| +/// The result of updating a conditional format rule.
|
| class UpdateConditionalFormatRuleResponse {
|
| - /** The index of the new rule. */
|
| + /// The index of the new rule.
|
| core.int newIndex;
|
| - /**
|
| - * The new rule that replaced the old rule (if replacing),
|
| - * or the rule that was moved (if moved)
|
| - */
|
| +
|
| + /// The new rule that replaced the old rule (if replacing),
|
| + /// or the rule that was moved (if moved)
|
| ConditionalFormatRule newRule;
|
| - /**
|
| - * The old index of the rule. Not set if a rule was replaced
|
| - * (because it is the same as new_index).
|
| - */
|
| +
|
| + /// The old index of the rule. Not set if a rule was replaced
|
| + /// (because it is the same as new_index).
|
| core.int oldIndex;
|
| - /**
|
| - * The old (deleted) rule. Not set if a rule was moved
|
| - * (because it is the same as new_rule).
|
| - */
|
| +
|
| + /// The old (deleted) rule. Not set if a rule was moved
|
| + /// (because it is the same as new_rule).
|
| ConditionalFormatRule oldRule;
|
|
|
| UpdateConditionalFormatRuleResponse();
|
| @@ -8106,7 +8313,8 @@ class UpdateConditionalFormatRuleResponse {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (newIndex != null) {
|
| _json["newIndex"] = newIndex;
|
| }
|
| @@ -8123,17 +8331,17 @@ class UpdateConditionalFormatRuleResponse {
|
| }
|
| }
|
|
|
| -/** Updates properties of dimensions within the specified range. */
|
| +/// Updates properties of dimensions within the specified range.
|
| class UpdateDimensionPropertiesRequest {
|
| - /**
|
| - * The fields that should be updated. At least one field must be specified.
|
| - * The root `properties` is implied and should not be specified.
|
| - * A single `"*"` can be used as short-hand for listing every field.
|
| - */
|
| + /// The fields that should be updated. At least one field must be specified.
|
| + /// The root `properties` is implied and should not be specified.
|
| + /// A single `"*"` can be used as short-hand for listing every field.
|
| core.String fields;
|
| - /** Properties to update. */
|
| +
|
| + /// Properties to update.
|
| DimensionProperties properties;
|
| - /** The rows or columns to update. */
|
| +
|
| + /// The rows or columns to update.
|
| DimensionRange range;
|
|
|
| UpdateDimensionPropertiesRequest();
|
| @@ -8151,7 +8359,8 @@ class UpdateDimensionPropertiesRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (fields != null) {
|
| _json["fields"] = fields;
|
| }
|
| @@ -8165,30 +8374,26 @@ class UpdateDimensionPropertiesRequest {
|
| }
|
| }
|
|
|
| -/**
|
| - * Update an embedded object's position (such as a moving or resizing a
|
| - * chart or image).
|
| - */
|
| +/// Update an embedded object's position (such as a moving or resizing a
|
| +/// chart or image).
|
| class UpdateEmbeddedObjectPositionRequest {
|
| - /**
|
| - * The fields of OverlayPosition
|
| - * that should be updated when setting a new position. Used only if
|
| - * newPosition.overlayPosition
|
| - * is set, in which case at least one field must
|
| - * be specified. The root `newPosition.overlayPosition` is implied and
|
| - * should not be specified.
|
| - * A single `"*"` can be used as short-hand for listing every field.
|
| - */
|
| + /// The fields of OverlayPosition
|
| + /// that should be updated when setting a new position. Used only if
|
| + /// newPosition.overlayPosition
|
| + /// is set, in which case at least one field must
|
| + /// be specified. The root `newPosition.overlayPosition` is implied and
|
| + /// should not be specified.
|
| + /// A single `"*"` can be used as short-hand for listing every field.
|
| core.String fields;
|
| - /**
|
| - * An explicit position to move the embedded object to.
|
| - * If newPosition.sheetId is set,
|
| - * a new sheet with that ID will be created.
|
| - * If newPosition.newSheet is set to true,
|
| - * a new sheet will be created with an ID that will be chosen for you.
|
| - */
|
| +
|
| + /// An explicit position to move the embedded object to.
|
| + /// If newPosition.sheetId is set,
|
| + /// a new sheet with that ID will be created.
|
| + /// If newPosition.newSheet is set to true,
|
| + /// a new sheet will be created with an ID that will be chosen for you.
|
| EmbeddedObjectPosition newPosition;
|
| - /** The ID of the object to moved. */
|
| +
|
| + /// The ID of the object to moved.
|
| core.int objectId;
|
|
|
| UpdateEmbeddedObjectPositionRequest();
|
| @@ -8206,7 +8411,8 @@ class UpdateEmbeddedObjectPositionRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (fields != null) {
|
| _json["fields"] = fields;
|
| }
|
| @@ -8220,9 +8426,9 @@ class UpdateEmbeddedObjectPositionRequest {
|
| }
|
| }
|
|
|
| -/** The result of updating an embedded object's position. */
|
| +/// The result of updating an embedded object's position.
|
| class UpdateEmbeddedObjectPositionResponse {
|
| - /** The new position of the embedded object. */
|
| + /// The new position of the embedded object.
|
| EmbeddedObjectPosition position;
|
|
|
| UpdateEmbeddedObjectPositionResponse();
|
| @@ -8234,7 +8440,8 @@ class UpdateEmbeddedObjectPositionResponse {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (position != null) {
|
| _json["position"] = (position).toJson();
|
| }
|
| @@ -8242,15 +8449,14 @@ class UpdateEmbeddedObjectPositionResponse {
|
| }
|
| }
|
|
|
| -/** Updates properties of the filter view. */
|
| +/// Updates properties of the filter view.
|
| class UpdateFilterViewRequest {
|
| - /**
|
| - * The fields that should be updated. At least one field must be specified.
|
| - * The root `filter` is implied and should not be specified.
|
| - * A single `"*"` can be used as short-hand for listing every field.
|
| - */
|
| + /// The fields that should be updated. At least one field must be specified.
|
| + /// The root `filter` is implied and should not be specified.
|
| + /// A single `"*"` can be used as short-hand for listing every field.
|
| core.String fields;
|
| - /** The new properties of the filter view. */
|
| +
|
| + /// The new properties of the filter view.
|
| FilterView filter;
|
|
|
| UpdateFilterViewRequest();
|
| @@ -8265,7 +8471,8 @@ class UpdateFilterViewRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (fields != null) {
|
| _json["fields"] = fields;
|
| }
|
| @@ -8276,18 +8483,15 @@ class UpdateFilterViewRequest {
|
| }
|
| }
|
|
|
| -/**
|
| - * Updates properties of the named range with the specified
|
| - * namedRangeId.
|
| - */
|
| +/// Updates properties of the named range with the specified
|
| +/// namedRangeId.
|
| class UpdateNamedRangeRequest {
|
| - /**
|
| - * The fields that should be updated. At least one field must be specified.
|
| - * The root `namedRange` is implied and should not be specified.
|
| - * A single `"*"` can be used as short-hand for listing every field.
|
| - */
|
| + /// The fields that should be updated. At least one field must be specified.
|
| + /// The root `namedRange` is implied and should not be specified.
|
| + /// A single `"*"` can be used as short-hand for listing every field.
|
| core.String fields;
|
| - /** The named range to update with the new properties. */
|
| +
|
| + /// The named range to update with the new properties.
|
| NamedRange namedRange;
|
|
|
| UpdateNamedRangeRequest();
|
| @@ -8302,7 +8506,8 @@ class UpdateNamedRangeRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (fields != null) {
|
| _json["fields"] = fields;
|
| }
|
| @@ -8313,18 +8518,15 @@ class UpdateNamedRangeRequest {
|
| }
|
| }
|
|
|
| -/**
|
| - * Updates an existing protected range with the specified
|
| - * protectedRangeId.
|
| - */
|
| +/// Updates an existing protected range with the specified
|
| +/// protectedRangeId.
|
| class UpdateProtectedRangeRequest {
|
| - /**
|
| - * The fields that should be updated. At least one field must be specified.
|
| - * The root `protectedRange` is implied and should not be specified.
|
| - * A single `"*"` can be used as short-hand for listing every field.
|
| - */
|
| + /// The fields that should be updated. At least one field must be specified.
|
| + /// The root `protectedRange` is implied and should not be specified.
|
| + /// A single `"*"` can be used as short-hand for listing every field.
|
| core.String fields;
|
| - /** The protected range to update with the new properties. */
|
| +
|
| + /// The protected range to update with the new properties.
|
| ProtectedRange protectedRange;
|
|
|
| UpdateProtectedRangeRequest();
|
| @@ -8339,7 +8541,8 @@ class UpdateProtectedRangeRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (fields != null) {
|
| _json["fields"] = fields;
|
| }
|
| @@ -8350,18 +8553,15 @@ class UpdateProtectedRangeRequest {
|
| }
|
| }
|
|
|
| -/**
|
| - * Updates properties of the sheet with the specified
|
| - * sheetId.
|
| - */
|
| +/// Updates properties of the sheet with the specified
|
| +/// sheetId.
|
| class UpdateSheetPropertiesRequest {
|
| - /**
|
| - * The fields that should be updated. At least one field must be specified.
|
| - * The root `properties` is implied and should not be specified.
|
| - * A single `"*"` can be used as short-hand for listing every field.
|
| - */
|
| + /// The fields that should be updated. At least one field must be specified.
|
| + /// The root `properties` is implied and should not be specified.
|
| + /// A single `"*"` can be used as short-hand for listing every field.
|
| core.String fields;
|
| - /** The properties to update. */
|
| +
|
| + /// The properties to update.
|
| SheetProperties properties;
|
|
|
| UpdateSheetPropertiesRequest();
|
| @@ -8376,7 +8576,8 @@ class UpdateSheetPropertiesRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (fields != null) {
|
| _json["fields"] = fields;
|
| }
|
| @@ -8387,15 +8588,14 @@ class UpdateSheetPropertiesRequest {
|
| }
|
| }
|
|
|
| -/** Updates properties of a spreadsheet. */
|
| +/// Updates properties of a spreadsheet.
|
| class UpdateSpreadsheetPropertiesRequest {
|
| - /**
|
| - * The fields that should be updated. At least one field must be specified.
|
| - * The root 'properties' is implied and should not be specified.
|
| - * A single `"*"` can be used as short-hand for listing every field.
|
| - */
|
| + /// The fields that should be updated. At least one field must be specified.
|
| + /// The root 'properties' is implied and should not be specified.
|
| + /// A single `"*"` can be used as short-hand for listing every field.
|
| core.String fields;
|
| - /** The properties to update. */
|
| +
|
| + /// The properties to update.
|
| SpreadsheetProperties properties;
|
|
|
| UpdateSpreadsheetPropertiesRequest();
|
| @@ -8410,7 +8610,8 @@ class UpdateSpreadsheetPropertiesRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (fields != null) {
|
| _json["fields"] = fields;
|
| }
|
| @@ -8421,25 +8622,26 @@ class UpdateSpreadsheetPropertiesRequest {
|
| }
|
| }
|
|
|
| -/** The response when updating a range of values in a spreadsheet. */
|
| +/// The response when updating a range of values in a spreadsheet.
|
| class UpdateValuesResponse {
|
| - /** The spreadsheet the updates were applied to. */
|
| + /// The spreadsheet the updates were applied to.
|
| core.String spreadsheetId;
|
| - /** The number of cells updated. */
|
| +
|
| + /// The number of cells updated.
|
| core.int updatedCells;
|
| - /**
|
| - * The number of columns where at least one cell in the column was updated.
|
| - */
|
| +
|
| + /// The number of columns where at least one cell in the column was updated.
|
| core.int updatedColumns;
|
| - /**
|
| - * The values of the cells after updates were applied.
|
| - * This is only included if the request's `includeValuesInResponse` field
|
| - * was `true`.
|
| - */
|
| +
|
| + /// The values of the cells after updates were applied.
|
| + /// This is only included if the request's `includeValuesInResponse` field
|
| + /// was `true`.
|
| ValueRange updatedData;
|
| - /** The range (in A1 notation) that updates were applied to. */
|
| +
|
| + /// The range (in A1 notation) that updates were applied to.
|
| core.String updatedRange;
|
| - /** The number of rows where at least one cell in the row was updated. */
|
| +
|
| + /// The number of rows where at least one cell in the row was updated.
|
| core.int updatedRows;
|
|
|
| UpdateValuesResponse();
|
| @@ -8466,7 +8668,8 @@ class UpdateValuesResponse {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (spreadsheetId != null) {
|
| _json["spreadsheetId"] = spreadsheetId;
|
| }
|
| @@ -8489,51 +8692,47 @@ class UpdateValuesResponse {
|
| }
|
| }
|
|
|
| -/** Data within a range of the spreadsheet. */
|
| +/// Data within a range of the spreadsheet.
|
| class ValueRange {
|
| - /**
|
| - * The major dimension of the values.
|
| - *
|
| - * For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
|
| - * then requesting `range=A1:B2,majorDimension=ROWS` will return
|
| - * `[[1,2],[3,4]]`,
|
| - * whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
|
| - * `[[1,3],[2,4]]`.
|
| - *
|
| - * For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`
|
| - * will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`
|
| - * then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.
|
| - *
|
| - * When writing, if this field is not set, it defaults to ROWS.
|
| - * Possible string values are:
|
| - * - "DIMENSION_UNSPECIFIED" : The default value, do not use.
|
| - * - "ROWS" : Operates on the rows of a sheet.
|
| - * - "COLUMNS" : Operates on the columns of a sheet.
|
| - */
|
| + /// The major dimension of the values.
|
| + ///
|
| + /// For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
|
| + /// then requesting `range=A1:B2,majorDimension=ROWS` will return
|
| + /// `[[1,2],[3,4]]`,
|
| + /// whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
|
| + /// `[[1,3],[2,4]]`.
|
| + ///
|
| + /// For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`
|
| + /// will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`
|
| + /// then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.
|
| + ///
|
| + /// When writing, if this field is not set, it defaults to ROWS.
|
| + /// Possible string values are:
|
| + /// - "DIMENSION_UNSPECIFIED" : The default value, do not use.
|
| + /// - "ROWS" : Operates on the rows of a sheet.
|
| + /// - "COLUMNS" : Operates on the columns of a sheet.
|
| core.String majorDimension;
|
| - /**
|
| - * The range the values cover, in A1 notation.
|
| - * For output, this range indicates the entire requested range,
|
| - * even though the values will exclude trailing rows and columns.
|
| - * When appending values, this field represents the range to search for a
|
| - * table, after which values will be appended.
|
| - */
|
| +
|
| + /// The range the values cover, in A1 notation.
|
| + /// For output, this range indicates the entire requested range,
|
| + /// even though the values will exclude trailing rows and columns.
|
| + /// When appending values, this field represents the range to search for a
|
| + /// table, after which values will be appended.
|
| core.String range;
|
| - /**
|
| - * The data that was read or to be written. This is an array of arrays,
|
| - * the outer array representing all the data and each inner array
|
| - * representing a major dimension. Each item in the inner array
|
| - * corresponds with one cell.
|
| - *
|
| - * For output, empty trailing rows and columns will not be included.
|
| - *
|
| - * For input, supported value types are: bool, string, and double.
|
| - * Null values will be skipped.
|
| - * To set a cell to an empty value, set the string value to an empty string.
|
| - *
|
| - * The values for Object must be JSON objects. It can consist of `num`,
|
| - * `String`, `bool` and `null` as well as `Map` and `List` values.
|
| - */
|
| +
|
| + /// The data that was read or to be written. This is an array of arrays,
|
| + /// the outer array representing all the data and each inner array
|
| + /// representing a major dimension. Each item in the inner array
|
| + /// corresponds with one cell.
|
| + ///
|
| + /// For output, empty trailing rows and columns will not be included.
|
| + ///
|
| + /// For input, supported value types are: bool, string, and double.
|
| + /// Null values will be skipped.
|
| + /// To set a cell to an empty value, set the string value to an empty string.
|
| + ///
|
| + /// The values for Object must be JSON objects. It can consist of `num`,
|
| + /// `String`, `bool` and `null` as well as `Map` and `List` values.
|
| core.List<core.List<core.Object>> values;
|
|
|
| ValueRange();
|
| @@ -8551,7 +8750,8 @@ class ValueRange {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (majorDimension != null) {
|
| _json["majorDimension"] = majorDimension;
|
| }
|
|
|
Chromium Code Reviews
Issue 3006323002:
Api-Roll 54: 2017-09-11 (Closed)
