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-07-22 17:02:09 -0700

[diff] [blame]

105

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

106

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

107

# This field cannot be changed once set.

Bu Sun Kim

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

[diff] [blame]

108

"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]

109

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

110

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

Bu Sun Kim

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

[diff] [blame]

111

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

112

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

Jon Wayne Parrott

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

[diff] [blame]

113

# 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]

114

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

115

#

116

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

117

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

118

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

119

# space.

Jon Wayne Parrott

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

[diff] [blame]

120

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

121

# Note: when color equality needs to be decided, implementations, unless

122

# documented otherwise, will treat two colors to be equal if all their red,

123

# green, blue and alpha values each differ by at most 1e-5.

124

#

Jon Wayne Parrott

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

[diff] [blame]

125

# Example (Java):

126

#

127

# import com.google.type.Color;

128

#

129

# // ...

130

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

131

# float alpha = protocolor.hasAlpha()

132

# ? protocolor.getAlpha().getValue()

133

# : 1.0;

134

#

135

# return new java.awt.Color(

136

# protocolor.getRed(),

137

# protocolor.getGreen(),

138

# protocolor.getBlue(),

# alpha);

# }

#

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

143

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

144

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

145

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

146

# float denominator = 255.0;

147

# Color.Builder resultBuilder =

148

# Color

149

# .newBuilder()

150

# .setRed(red / denominator)

151

# .setGreen(green / denominator)

152

# .setBlue(blue / denominator);

153

# int alpha = color.getAlpha();

154

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

159

# .build());

160

# }

161

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

166

#

167

# // ...

168

# static UIColor* fromProto(Color* protocolor) {

169

# float red = [protocolor red];

170

# float green = [protocolor green];

171

# float blue = [protocolor blue];

172

# FloatValue* alpha_wrapper = [protocolor alpha];

173

# float alpha = 1.0;

174

# if (alpha_wrapper != nil) {

175

# alpha = [alpha_wrapper value];

176

# }

177

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

178

# }

179

#

180

# static Color* toProto(UIColor* color) {

181

# CGFloat red, green, blue, alpha;

Dan O'Meara

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

[diff] [blame]

182

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

Jon Wayne Parrott

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

[diff] [blame]

183

# return nil;

184

# }

Bu Sun Kim

715bd7f

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

[diff] [blame]

185

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

Jon Wayne Parrott

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

[diff] [blame]

186

# [result setRed:red];

187

# [result setGreen:green];

188

# [result setBlue:blue];

Dan O'Meara

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

[diff] [blame]

189

# if (alpha <= 0.9999) {

Jon Wayne Parrott

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

[diff] [blame]

190

# [result setAlpha:floatWrapperWithValue(alpha)];

191

# }

192

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

202

# var redFrac = rgb_color.red || 0.0;

203

# var greenFrac = rgb_color.green || 0.0;

204

# var blueFrac = rgb_color.blue || 0.0;

205

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

206

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

207

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

208

#

Bu Sun Kim

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

[diff] [blame]

209

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

Jon Wayne Parrott

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

[diff] [blame]

210

# return rgbToCssColor_(red, green, blue);

211

# }

212

#

213

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

Bu Sun Kim

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

[diff] [blame]

214

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

215

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

Jon Wayne Parrott

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

[diff] [blame]

216

# };

217

#

218

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

Dan O'Meara

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

[diff] [blame]

219

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

Jon Wayne Parrott

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

[diff] [blame]

220

# var hexString = rgbNumber.toString(16);

221

# var missingZeros = 6 - hexString.length;

Bu Sun Kim

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

[diff] [blame]

222

# var resultBuilder = ['#'];

Dan O'Meara

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

[diff] [blame]

223

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

Bu Sun Kim

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

[diff] [blame]

224

# resultBuilder.push('0');

Jon Wayne Parrott

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

[diff] [blame]

225

# }

226

# resultBuilder.push(hexString);

Bu Sun Kim

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

[diff] [blame]

227

# return resultBuilder.join('');

Jon Wayne Parrott

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

[diff] [blame]

228

# };

229

#

230

# // ...

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

231

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

232

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

233

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

Bu Sun Kim

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

[diff] [blame]

234

"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]

235

# the final pixel color is defined by the equation:

236

#

237

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

238

#

239

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

240

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

241

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

242

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

243

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

244

# (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]

245

},

Bu Sun Kim

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

[diff] [blame]

246

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

Dan O'Meara

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

[diff] [blame]

247

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

Bu Sun Kim

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

[diff] [blame]

248

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

249

"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]

250

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

251

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

Bu Sun Kim

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

[diff] [blame]

252

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

253

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

Dan O'Meara

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

[diff] [blame]

254

# 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]

255

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

Dan O'Meara

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

[diff] [blame]

256

#

257

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

258

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

259

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

260

# space.

261

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

262

# Note: when color equality needs to be decided, implementations, unless

263

# documented otherwise, will treat two colors to be equal if all their red,

264

# green, blue and alpha values each differ by at most 1e-5.

265

#

Dan O'Meara

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

[diff] [blame]

266

# Example (Java):

267

#

268

# import com.google.type.Color;

269

#

270

# // ...

271

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

272

# float alpha = protocolor.hasAlpha()

273

# ? protocolor.getAlpha().getValue()

274

# : 1.0;

275

#

276

# return new java.awt.Color(

277

# protocolor.getRed(),

278

# protocolor.getGreen(),

279

# protocolor.getBlue(),

# alpha);

# }

#

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

284

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

285

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

286

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

287

# float denominator = 255.0;

288

# Color.Builder resultBuilder =

289

# Color

290

# .newBuilder()

291

# .setRed(red / denominator)

292

# .setGreen(green / denominator)

293

# .setBlue(blue / denominator);

294

# int alpha = color.getAlpha();

295

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

300

# .build());

301

# }

302

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

307

#

308

# // ...

309

# static UIColor* fromProto(Color* protocolor) {

310

# float red = [protocolor red];

311

# float green = [protocolor green];

312

# float blue = [protocolor blue];

313

# FloatValue* alpha_wrapper = [protocolor alpha];

314

# float alpha = 1.0;

315

# if (alpha_wrapper != nil) {

316

# alpha = [alpha_wrapper value];

317

# }

318

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

319

# }

320

#

321

# static Color* toProto(UIColor* color) {

322

# CGFloat red, green, blue, alpha;

323

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

324

# return nil;

325

# }

326

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

327

# [result setRed:red];

328

# [result setGreen:green];

329

# [result setBlue:blue];

330

# if (alpha <= 0.9999) {

331

# [result setAlpha:floatWrapperWithValue(alpha)];

332

# }

333

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

343

# var redFrac = rgb_color.red || 0.0;

344

# var greenFrac = rgb_color.green || 0.0;

345

# var blueFrac = rgb_color.blue || 0.0;

346

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

347

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

348

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

349

#

Bu Sun Kim

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

[diff] [blame]

350

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

Dan O'Meara

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

[diff] [blame]

351

# return rgbToCssColor_(red, green, blue);

352

# }

353

#

354

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

Bu Sun Kim

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

[diff] [blame]

355

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

356

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

Dan O'Meara

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

[diff] [blame]

357

# };

358

#

359

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

360

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

361

# var hexString = rgbNumber.toString(16);

362

# var missingZeros = 6 - hexString.length;

Bu Sun Kim

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

[diff] [blame]

363

# var resultBuilder = ['#'];

Dan O'Meara

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

[diff] [blame]

364

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

Bu Sun Kim

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

[diff] [blame]

365

# resultBuilder.push('0');

Dan O'Meara

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

[diff] [blame]

366

# }

367

# resultBuilder.push(hexString);

Bu Sun Kim

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

[diff] [blame]

368

# return resultBuilder.join('');

Dan O'Meara

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

[diff] [blame]

369

# };

370

#

371

# // ...

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

372

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

373

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

374

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

Bu Sun Kim

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

[diff] [blame]

375

"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]

376

# the final pixel color is defined by the equation:

377

#

378

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

379

#

380

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

381

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

382

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

383

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

384

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

385

# (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]

386

},

387

},

Bu Sun Kim

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

[diff] [blame]

388

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

Jon Wayne Parrott

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

[diff] [blame]

389

# This field cannot be changed once set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

390

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

391

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

392

# When adding or updating sheet properties, if this field

393

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

394

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

395

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

396

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

397

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

398

# index update request is ignored if the requested index is

399

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

400

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

401

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

402

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

403

# this field will be absent.)

404

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

405

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

406

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

407

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

408

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

409

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

410

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

411

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

412

},

413

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

Jon Wayne Parrott