Blame - docs/dyn/sheets_v4.spreadsheets.sheets.html - platform/external/python/google-api-python-client

2020-05-01 07:42:23 -0700

[diff] [blame]

78

<code><a href="#copyTo">copyTo(spreadsheetId, sheetId, body=None, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

79

<p class="firstline">Copies a single sheet from a spreadsheet to another spreadsheet.</p>

80

<h3>Method Details</h3>

81

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

82

<code class="details" id="copyTo">copyTo(spreadsheetId, sheetId, body=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

83

<pre>Copies a single sheet from a spreadsheet to another spreadsheet.

84

Returns the properties of the newly created sheet.

85

86

Args:

Jon Wayne Parrott

7d5badb

2016-08-16 12:44:29 -0700

[diff] [blame]

87

spreadsheetId: string, The ID of the spreadsheet containing the sheet to copy. (required)

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

88

sheetId: integer, The ID of the sheet to copy. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

89

body: object, The request body.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

90

The object takes the form of:

91

92

{ # The request to copy a sheet across spreadsheets.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

93

"destinationSpreadsheetId": "A String", # The ID of the spreadsheet to copy the sheet to.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

94

}

95

96

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

103

104

{ # Properties of a sheet.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

105

"index": 42, # The index of the sheet within the spreadsheet.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

106

# When adding or updating sheet properties, if this field

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

107

# is excluded then the sheet is added or moved to the end

Jon Wayne Parrott

692617a

2017-01-06 09:58:29 -0800

[diff] [blame]

108

# of the sheet list. When updating sheet indices or inserting

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

109

# sheets, movement is considered in "before the move" indexes.

Jon Wayne Parrott

692617a

2017-01-06 09:58:29 -0800

[diff] [blame]

110

# For example, if there were 3 sheets (S1, S2, S3) in order to

111

# move S1 ahead of S2 the index would have to be set to 2. A sheet

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

112

# index update request is ignored if the requested index is

Jon Wayne Parrott

692617a

2017-01-06 09:58:29 -0800

[diff] [blame]

113

# identical to the sheets current index or if the requested new

114

# index is equal to the current sheet index + 1.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

115

"title": "A String", # The name of the sheet.

116

"gridProperties": { # Properties of a grid. # Additional properties of the sheet if this sheet is a grid.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

117

# (If the sheet is an object sheet, containing a chart or image, then

118

# this field will be absent.)

119

# When writing it is an error to set any grid properties on non-grid sheets.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

120

"rowCount": 42, # The number of rows in the grid.

121

"columnCount": 42, # The number of columns in the grid.

122

"frozenRowCount": 42, # The number of rows that are frozen in the grid.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

123

"rowGroupControlAfter": True or False, # True if the row grouping control toggle is shown after the group.

124

"hideGridlines": True or False, # True if the grid isn't showing gridlines in the UI.

125

"frozenColumnCount": 42, # The number of columns that are frozen in the grid.

126

"columnGroupControlAfter": True or False, # True if the column grouping control toggle is shown after the group.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

127

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

128

"tabColor": { # Represents a color in the RGBA color space. This representation is designed # The color of the tab in the UI.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

129

# for simplicity of conversion to/from color representations in various

130

# languages over compactness; for example, the fields of this representation

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

131

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

132

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

133

# method in iOS; and, with just a little work, it can be easily formatted into

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

134

# a CSS "rgba()" string in JavaScript, as well.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

135

#

136

# Note: this proto does not carry information about the absolute color space

137

# that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB,

138

# DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color

139

# space.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

#

# Example (Java):

#

# import com.google.type.Color;

144

#

145

# // ...

146

# public static java.awt.Color fromProto(Color protocolor) {

147

# float alpha = protocolor.hasAlpha()

148

# ? protocolor.getAlpha().getValue()

149

# : 1.0;

150

#

151

# return new java.awt.Color(

152

# protocolor.getRed(),

153

# protocolor.getGreen(),

154

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

159

# float red = (float) color.getRed();

160

# float green = (float) color.getGreen();

161

# float blue = (float) color.getBlue();

162

# float denominator = 255.0;

163

# Color.Builder resultBuilder =

164

# Color

165

# .newBuilder()

166

# .setRed(red / denominator)

167

# .setGreen(green / denominator)

168

# .setBlue(blue / denominator);

169

# int alpha = color.getAlpha();

170

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

175

# .build());

176

# }

177

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

182

#

183

# // ...

184

# static UIColor* fromProto(Color* protocolor) {

185

# float red = [protocolor red];

186

# float green = [protocolor green];

187

# float blue = [protocolor blue];

188

# FloatValue* alpha_wrapper = [protocolor alpha];

189

# float alpha = 1.0;

190

# if (alpha_wrapper != nil) {

191

# alpha = [alpha_wrapper value];

192

# }

193

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

194

# }

195

#

196

# static Color* toProto(UIColor* color) {

197

# CGFloat red, green, blue, alpha;

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

198

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

199

# return nil;

200

# }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

201

# Color* result = [[Color alloc] init];

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

202

# [result setRed:red];

203

# [result setGreen:green];

204

# [result setBlue:blue];

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

205

# if (alpha <= 0.9999) {

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

206

# [result setAlpha:floatWrapperWithValue(alpha)];

207

# }

208

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

218

# var redFrac = rgb_color.red || 0.0;

219

# var greenFrac = rgb_color.green || 0.0;

220

# var blueFrac = rgb_color.blue || 0.0;

221

# var red = Math.floor(redFrac * 255);

222

# var green = Math.floor(greenFrac * 255);

223

# var blue = Math.floor(blueFrac * 255);

224

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

225

# if (!('alpha' in rgb_color)) {

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

226

# return rgbToCssColor_(red, green, blue);

227

# }

228

#

229

# var alphaFrac = rgb_color.alpha.value || 0.0;

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

230

# var rgbParams = [red, green, blue].join(',');

231

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

232

# };

233

#

234

# var rgbToCssColor_ = function(red, green, blue) {

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

235

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

236

# var hexString = rgbNumber.toString(16);

237

# var missingZeros = 6 - hexString.length;

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

238

# var resultBuilder = ['#'];

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

239

# for (var i = 0; i < missingZeros; i++) {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

240

# resultBuilder.push('0');

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

241

# }

242

# resultBuilder.push(hexString);

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

243

# return resultBuilder.join('');

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

244

# };

245

#

246

# // ...

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

247

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

248

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

249

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

250

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

251

# the final pixel color is defined by the equation:

252

#

253

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

254

#

255

# This means that a value of 1.0 corresponds to a solid color, whereas

256

# a value of 0.0 corresponds to a completely transparent color. This

257

# uses a wrapper message rather than a simple float scalar so that it is

258

# possible to distinguish between a default value and the value being unset.

259

# If omitted, this color object is to be rendered as a solid color

260

# (as if the alpha value had been explicitly given with a value of 1.0).

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

261

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

262

"sheetId": 42, # The ID of the sheet. Must be non-negative.

263

# This field cannot be changed once set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

264

"rightToLeft": True or False, # True if the sheet is an RTL sheet instead of an LTR sheet.

265

"tabColorStyle": { # A color value. # The color of the tab in the UI.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

266

# If tab_color is also set, this field takes precedence.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

267

"themeColor": "A String", # Theme color.

268

"rgbColor": { # Represents a color in the RGBA color space. This representation is designed # RGB color.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

269

# for simplicity of conversion to/from color representations in various

270

# languages over compactness; for example, the fields of this representation

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

271

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

272

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

273

# method in iOS; and, with just a little work, it can be easily formatted into

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

274

# a CSS "rgba()" string in JavaScript, as well.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

275

#

276

# Note: this proto does not carry information about the absolute color space

277

# that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB,

278

# DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color

# space.

#

# Example (Java):

#

# import com.google.type.Color;

284

#

285

# // ...

286

# public static java.awt.Color fromProto(Color protocolor) {

287

# float alpha = protocolor.hasAlpha()

288

# ? protocolor.getAlpha().getValue()

289

# : 1.0;

290

#

291

# return new java.awt.Color(

292

# protocolor.getRed(),

293

# protocolor.getGreen(),

294

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

299

# float red = (float) color.getRed();

300

# float green = (float) color.getGreen();

301

# float blue = (float) color.getBlue();

302

# float denominator = 255.0;

303

# Color.Builder resultBuilder =

304

# Color

305

# .newBuilder()

306

# .setRed(red / denominator)

307

# .setGreen(green / denominator)

308

# .setBlue(blue / denominator);

309

# int alpha = color.getAlpha();

310

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

315

# .build());

316

# }

317

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

322

#

323

# // ...

324

# static UIColor* fromProto(Color* protocolor) {

325

# float red = [protocolor red];

326

# float green = [protocolor green];

327

# float blue = [protocolor blue];

328

# FloatValue* alpha_wrapper = [protocolor alpha];

329

# float alpha = 1.0;

330

# if (alpha_wrapper != nil) {

331

# alpha = [alpha_wrapper value];

332

# }

333

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

334

# }

335

#

336

# static Color* toProto(UIColor* color) {

337

# CGFloat red, green, blue, alpha;

338

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

339

# return nil;

340

# }

341

# Color* result = [[Color alloc] init];

342

# [result setRed:red];

343

# [result setGreen:green];

344

# [result setBlue:blue];

345

# if (alpha <= 0.9999) {

346

# [result setAlpha:floatWrapperWithValue(alpha)];

347

# }

348

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

358

# var redFrac = rgb_color.red || 0.0;

359

# var greenFrac = rgb_color.green || 0.0;

360

# var blueFrac = rgb_color.blue || 0.0;

361

# var red = Math.floor(redFrac * 255);

362

# var green = Math.floor(greenFrac * 255);

363

# var blue = Math.floor(blueFrac * 255);

364

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

365

# if (!('alpha' in rgb_color)) {

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

366

# return rgbToCssColor_(red, green, blue);

367

# }

368

#

369

# var alphaFrac = rgb_color.alpha.value || 0.0;

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

370

# var rgbParams = [red, green, blue].join(',');

371

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

372

# };

373

#

374

# var rgbToCssColor_ = function(red, green, blue) {

375

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

376

# var hexString = rgbNumber.toString(16);

377

# var missingZeros = 6 - hexString.length;

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

378

# var resultBuilder = ['#'];

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

379

# for (var i = 0; i < missingZeros; i++) {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

380

# resultBuilder.push('0');

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

381

# }

382

# resultBuilder.push(hexString);

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

383

# return resultBuilder.join('');

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

384

# };

385

#

386

# // ...

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

387

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

388

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

389

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

390

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

391

# the final pixel color is defined by the equation:

392

#

393

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

394

#

395

# This means that a value of 1.0 corresponds to a solid color, whereas

396

# a value of 0.0 corresponds to a completely transparent color. This

397

# uses a wrapper message rather than a simple float scalar so that it is

398

# possible to distinguish between a default value and the value being unset.

399

# If omitted, this color object is to be rendered as a solid color

400

# (as if the alpha value had been explicitly given with a value of 1.0).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

401

},

402

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

403

"hidden": True or False, # True if the sheet is hidden in the UI, false if it's visible.

404

"sheetType": "A String", # The type of sheet. Defaults to GRID.

Jon Wayne Parrott