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

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

[diff] [blame]

185

"overlayPosition": { # The location an object is overlaid on top of a grid. # The position at which the object is overlaid on top of a grid.

Jon Wayne Parrott

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

[diff] [blame]

186

"anchorCell": { # A coordinate in a sheet. # The cell the object is anchored to.

187

# All indexes are zero-based.

188

"rowIndex": 42, # The row index of the coordinate.

189

"columnIndex": 42, # The column index of the coordinate.

190

"sheetId": 42, # The sheet this coordinate is on.

191

},

192

"offsetYPixels": 42, # The vertical offset, in pixels, that the object is offset

193

# from the anchor cell.

194

"widthPixels": 42, # The width of the object, in pixels. Defaults to 600.

195

"offsetXPixels": 42, # The horizontal offset, in pixels, that the object is offset

196

# from the anchor cell.

197

"heightPixels": 42, # The height of the object, in pixels. Defaults to 371.

198

},

199

},

Jon Wayne Parrott

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

[diff] [blame]

200

"fields": "A String", # The fields of OverlayPosition

201

# that should be updated when setting a new position. Used only if

Jon Wayne Parrott

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

[diff] [blame]

202

# newPosition.overlayPosition

203

# is set, in which case at least one field must

204

# be specified. The root `newPosition.overlayPosition` is implied and

205

# should not be specified.

206

# A single `"*"` can be used as short-hand for listing every field.

Jon Wayne Parrott

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

[diff] [blame]

207

"objectId": 42, # The ID of the object to moved.

Jon Wayne Parrott

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

[diff] [blame]

208

},

209

"updateConditionalFormatRule": { # Updates a conditional format rule at the given index, # Updates an existing conditional format rule.

210

# or moves a conditional format rule to another index.

211

"index": 42, # The zero-based index of the rule that should be replaced or moved.

212

"newIndex": 42, # The zero-based new index the rule should end up at.

Jon Wayne Parrott

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

[diff] [blame]

213

"sheetId": 42, # The sheet of the rule to move. Required if new_index is set,

Jon Wayne Parrott

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

[diff] [blame]

214

# unused otherwise.

215

"rule": { # A rule describing a conditional format. # The rule that should replace the rule at the given index.

216

"ranges": [ # The ranges that will be formatted if the condition is true.

217

# All the ranges must be on the same grid.

218

{ # A range on a sheet.

219

# All indexes are zero-based.

220

# Indexes are half open, e.g the start index is inclusive

221

# and the end index is exclusive -- [start_index, end_index).

222

# Missing indexes indicate the range is unbounded on that side.

223

#

Jon Wayne Parrott

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

[diff] [blame]

224

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

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

[diff] [blame]

225

#

Jon Wayne Parrott

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

[diff] [blame]

226

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

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

[diff] [blame]

227

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

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

[diff] [blame]

228

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

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

[diff] [blame]

229

#

Jon Wayne Parrott

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

[diff] [blame]

230

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

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

[diff] [blame]

231

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

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

[diff] [blame]

232

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

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

[diff] [blame]

233

#

Jon Wayne Parrott

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

[diff] [blame]

234

# `Sheet1!A:B == sheet_id: 0,

235

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

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

[diff] [blame]

236

#

Jon Wayne Parrott

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

[diff] [blame]

237

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

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

[diff] [blame]

238

# start_row_index: 4,

Jon Wayne Parrott

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

[diff] [blame]

239

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

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

[diff] [blame]

240

#

Jon Wayne Parrott

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

[diff] [blame]

241

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

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

[diff] [blame]

242

#

243

# The start index must always be less than or equal to the end index.

244

# If the start index equals the end index, then the range is empty.

245

# Empty ranges are typically not meaningful and are usually rendered in the

246

# UI as `#REF!`.

247

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

248

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

249

"sheetId": 42, # The sheet this range is on.

250

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

251

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

252

},

253

],

254

"booleanRule": { # A rule that may or may not match, depending on the condition. # The formatting is either "on" or "off" according to the rule.

255

"condition": { # A condition that can evaluate to true or false. # The condition of the rule. If the condition evaluates to true,

256

# the format will be applied.

257

# BooleanConditions are used by conditional formatting,

258

# data validation, and the criteria in filters.

259

"type": "A String", # The type of condition.

260

"values": [ # The values of the condition. The number of supported values depends

261

# on the condition type. Some support zero values,

262

# others one or two values,

263

# and ConditionType.ONE_OF_LIST supports an arbitrary number of values.

264

{ # The value of the condition.

265

"relativeDate": "A String", # A relative date (based on the current date).

266

# Valid only if the type is

267

# DATE_BEFORE,

268

# DATE_AFTER,

269

# DATE_ON_OR_BEFORE or

270

# DATE_ON_OR_AFTER.

271

#

272

# Relative dates are not supported in data validation.

273

# They are supported only in conditional formatting and

274

# conditional filters.

275

"userEnteredValue": "A String", # A value the condition is based on.

276

# The value will be parsed as if the user typed into a cell.

277

# Formulas are supported (and must begin with an `=`).

},

],

},

"format": { # The format of a cell. # The format to apply.

282

# Conditional formatting can only apply a subset of formatting:

# bold, italic,

# strikethrough,

# foreground color &

# background color.

"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.

Jon Wayne Parrott

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

[diff] [blame]

288

"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on

289

# the user's locale will be used if necessary for the given type.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame^]

290

# See the [Date and Number Formats guide](/sheets/guides/formats) for more

291

# information about the supported patterns.

Jon Wayne Parrott

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

[diff] [blame]

292

"type": "A String", # The type of the number format.

Jon Wayne Parrott

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

[diff] [blame]

293

# When writing, this field must be set.

Jon Wayne Parrott

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

[diff] [blame]

294

},

295

"textDirection": "A String", # The direction of the text in the cell.

296

"padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.

297

# When updating padding, every field must be specified.

298

"top": 42, # The top padding of the cell.

299

"right": 42, # The right padding of the cell.

300

"bottom": 42, # The bottom padding of the cell.

301

"left": 42, # The left padding of the cell.

302

},

Jon Wayne Parrott

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

[diff] [blame]

303

"horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.

Jon Wayne Parrott

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

[diff] [blame]

304

"backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.

305

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

306

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

307

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

308

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

309

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

310

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

315

#

316

# // ...

317

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

318

# float alpha = protocolor.hasAlpha()

319

# ? protocolor.getAlpha().getValue()

320

# : 1.0;

321

#

322

# return new java.awt.Color(

323

# protocolor.getRed(),

324

# protocolor.getGreen(),

325

# protocolor.getBlue(),

# alpha);

# }

#

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

330

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

331

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

332

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

333

# float denominator = 255.0;

334

# Color.Builder resultBuilder =

335

# Color

336

# .newBuilder()

337

# .setRed(red / denominator)

338

# .setGreen(green / denominator)

339

# .setBlue(blue / denominator);

340

# int alpha = color.getAlpha();

341

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

346

# .build());

347

# }

348

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

353

#

354

# // ...

355

# static UIColor* fromProto(Color* protocolor) {

356

# float red = [protocolor red];

357

# float green = [protocolor green];

358

# float blue = [protocolor blue];

359

# FloatValue* alpha_wrapper = [protocolor alpha];

360

# float alpha = 1.0;

361

# if (alpha_wrapper != nil) {

362

# alpha = [alpha_wrapper value];

363

# }

364

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

365

# }

366

#

367

# static Color* toProto(UIColor* color) {

368

# CGFloat red, green, blue, alpha;

369

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

370

# return nil;

371

# }

372

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

373

# [result setRed:red];

374

# [result setGreen:green];

375

# [result setBlue:blue];

376

# if (alpha <= 0.9999) {

377

# [result setAlpha:floatWrapperWithValue(alpha)];

378

# }

379

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

389

# var redFrac = rgb_color.red || 0.0;

390

# var greenFrac = rgb_color.green || 0.0;

391

# var blueFrac = rgb_color.blue || 0.0;

392

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

393

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

394

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

395

#

396

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

397

# return rgbToCssColor_(red, green, blue);

398

# }

399

#

400

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

401

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

402

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

403

# };

404

#

405

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

406

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

407

# var hexString = rgbNumber.toString(16);

408

# var missingZeros = 6 - hexString.length;

409

# var resultBuilder = ['#'];

410

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

411

# resultBuilder.push('0');

412

# }

413

# resultBuilder.push(hexString);

414

# return resultBuilder.join('');

# };

#

# // ...

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

419

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

420

# the final pixel color is defined by the equation:

421

#

422

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

423

#

424

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

425

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

426

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

427

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

428

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

429

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

430

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

431

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

432

},

Jon Wayne Parrott

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

[diff] [blame]

433

"verticalAlignment": "A String", # The vertical alignment of the value in the cell.

Jon Wayne Parrott

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

[diff] [blame]

434

"textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).

435

# Absent values indicate that the field isn't specified.

436

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

437

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

438

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

439

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

440

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

441

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

442

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

447

#

448

# // ...

449

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

450

# float alpha = protocolor.hasAlpha()

451

# ? protocolor.getAlpha().getValue()

452

# : 1.0;

453

#

454

# return new java.awt.Color(

455

# protocolor.getRed(),

456

# protocolor.getGreen(),

457

# protocolor.getBlue(),

# alpha);

# }

#

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

462

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

463

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

464

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

465

# float denominator = 255.0;

466

# Color.Builder resultBuilder =

467

# Color

468

# .newBuilder()

469

# .setRed(red / denominator)

470

# .setGreen(green / denominator)

471

# .setBlue(blue / denominator);

472

# int alpha = color.getAlpha();

473

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

478

# .build());

479

# }

480

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

485

#

486

# // ...

487

# static UIColor* fromProto(Color* protocolor) {

488

# float red = [protocolor red];

489

# float green = [protocolor green];

490

# float blue = [protocolor blue];

491

# FloatValue* alpha_wrapper = [protocolor alpha];

492

# float alpha = 1.0;

493

# if (alpha_wrapper != nil) {

494

# alpha = [alpha_wrapper value];

495

# }

496

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

497

# }

498

#

499

# static Color* toProto(UIColor* color) {

500

# CGFloat red, green, blue, alpha;

501

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

502

# return nil;

503

# }

504

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

505

# [result setRed:red];

506

# [result setGreen:green];

507

# [result setBlue:blue];

508

# if (alpha <= 0.9999) {

509

# [result setAlpha:floatWrapperWithValue(alpha)];

510

# }

511

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

521

# var redFrac = rgb_color.red || 0.0;

522

# var greenFrac = rgb_color.green || 0.0;

523

# var blueFrac = rgb_color.blue || 0.0;

524

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

525

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

526

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

527

#

528

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

529

# return rgbToCssColor_(red, green, blue);

530

# }

531

#

532

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

533

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

534

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

535

# };

536

#

537

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

538

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

539

# var hexString = rgbNumber.toString(16);

540

# var missingZeros = 6 - hexString.length;

541

# var resultBuilder = ['#'];

542

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

543

# resultBuilder.push('0');

544

# }

545

# resultBuilder.push(hexString);

546

# return resultBuilder.join('');

# };

#

# // ...

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

551

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

552

# the final pixel color is defined by the equation:

553

#

554

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

555

#

556

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

557

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

558

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

559

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

560

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

561

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

562

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

563

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

564

},

565

"bold": True or False, # True if the text is bold.

566

"strikethrough": True or False, # True if the text has a strikethrough.

567

"fontFamily": "A String", # The font family.

568

"fontSize": 42, # The size of the font.

569

"italic": True or False, # True if the text is italicized.

570

"underline": True or False, # True if the text is underlined.

571

},

572

"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.

573

"borders": { # The borders of the cell. # The borders of the cell.

574

"top": { # A border along a cell. # The top border of the cell.

575

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

576

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

577

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

578

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

579

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

580

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

581

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

586

#

587

# // ...

588

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

589

# float alpha = protocolor.hasAlpha()

590

# ? protocolor.getAlpha().getValue()

591

# : 1.0;

592

#

593

# return new java.awt.Color(

594

# protocolor.getRed(),

595

# protocolor.getGreen(),

596

# protocolor.getBlue(),

# alpha);

# }

#

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

601

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

602

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

603

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

604

# float denominator = 255.0;

605

# Color.Builder resultBuilder =

606

# Color

607

# .newBuilder()

608

# .setRed(red / denominator)

609

# .setGreen(green / denominator)

610

# .setBlue(blue / denominator);

611

# int alpha = color.getAlpha();

612

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

617

# .build());

618

# }

619

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

624

#

625

# // ...

626

# static UIColor* fromProto(Color* protocolor) {

627

# float red = [protocolor red];

628

# float green = [protocolor green];

629

# float blue = [protocolor blue];

630

# FloatValue* alpha_wrapper = [protocolor alpha];

631

# float alpha = 1.0;

632

# if (alpha_wrapper != nil) {

633

# alpha = [alpha_wrapper value];

634

# }

635

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

636

# }

637

#

638

# static Color* toProto(UIColor* color) {

639

# CGFloat red, green, blue, alpha;

640

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

641

# return nil;

642

# }

643

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

644

# [result setRed:red];

645

# [result setGreen:green];

646

# [result setBlue:blue];

647

# if (alpha <= 0.9999) {

648

# [result setAlpha:floatWrapperWithValue(alpha)];

649

# }

650

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

660

# var redFrac = rgb_color.red || 0.0;

661

# var greenFrac = rgb_color.green || 0.0;

662

# var blueFrac = rgb_color.blue || 0.0;

663

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

664

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

665

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

666

#

667

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

668

# return rgbToCssColor_(red, green, blue);

669

# }

670

#

671

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

672

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

673

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

674

# };

675

#

676

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

677

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

678

# var hexString = rgbNumber.toString(16);

679

# var missingZeros = 6 - hexString.length;

680

# var resultBuilder = ['#'];

681

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

682

# resultBuilder.push('0');

683

# }

684

# resultBuilder.push(hexString);

685

# return resultBuilder.join('');

# };

#

# // ...

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

690

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

691

# the final pixel color is defined by the equation:

692

#

693

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

694

#

695

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

696

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

697

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

698

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

699

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

700

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

701

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

702

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

703

},

704

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

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

[diff] [blame]

705

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

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

[diff] [blame]

706

"style": "A String", # The style of the border.

707

},

708

"right": { # A border along a cell. # The right border of the cell.

709

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

710

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

711

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

712

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

713

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

714

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

715

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

720

#

721

# // ...

722

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

723

# float alpha = protocolor.hasAlpha()

724

# ? protocolor.getAlpha().getValue()

725

# : 1.0;

726

#

727

# return new java.awt.Color(

728

# protocolor.getRed(),

729

# protocolor.getGreen(),

730

# protocolor.getBlue(),

# alpha);

# }

#

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

735

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

736

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

737

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

738

# float denominator = 255.0;

739

# Color.Builder resultBuilder =

740

# Color

741

# .newBuilder()

742

# .setRed(red / denominator)

743

# .setGreen(green / denominator)

744

# .setBlue(blue / denominator);

745

# int alpha = color.getAlpha();

746

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

751

# .build());

752

# }

753

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

758

#

759

# // ...

760

# static UIColor* fromProto(Color* protocolor) {

761

# float red = [protocolor red];

762

# float green = [protocolor green];

763

# float blue = [protocolor blue];

764

# FloatValue* alpha_wrapper = [protocolor alpha];

765

# float alpha = 1.0;

766

# if (alpha_wrapper != nil) {

767

# alpha = [alpha_wrapper value];

768

# }

769

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

770

# }

771

#

772

# static Color* toProto(UIColor* color) {

773

# CGFloat red, green, blue, alpha;

774

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

775

# return nil;

776

# }

777

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

778

# [result setRed:red];

779

# [result setGreen:green];

780

# [result setBlue:blue];

781

# if (alpha <= 0.9999) {

782

# [result setAlpha:floatWrapperWithValue(alpha)];

783

# }

784

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

794

# var redFrac = rgb_color.red || 0.0;

795

# var greenFrac = rgb_color.green || 0.0;

796

# var blueFrac = rgb_color.blue || 0.0;

797

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

798

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

799

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

800

#

801

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

802

# return rgbToCssColor_(red, green, blue);

803

# }

804

#

805

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

806

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

807

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

808

# };

809

#

810

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

811

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

812

# var hexString = rgbNumber.toString(16);

813

# var missingZeros = 6 - hexString.length;

814

# var resultBuilder = ['#'];

815

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

816

# resultBuilder.push('0');

817

# }

818

# resultBuilder.push(hexString);

819

# return resultBuilder.join('');

# };

#

# // ...

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

824

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

825

# the final pixel color is defined by the equation:

826

#

827

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

828

#

829

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

830

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

831

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

832

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

833

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

834

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

835

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

836

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

837

},

838

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

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

[diff] [blame]

839

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

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

[diff] [blame]

840

"style": "A String", # The style of the border.

841

},

842

"bottom": { # A border along a cell. # The bottom border of the cell.

843

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

844

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

845

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

846

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

847

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

848

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

849

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

854

#

855

# // ...

856

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

857

# float alpha = protocolor.hasAlpha()

858

# ? protocolor.getAlpha().getValue()

859

# : 1.0;

860

#

861

# return new java.awt.Color(

862

# protocolor.getRed(),

863

# protocolor.getGreen(),

864

# protocolor.getBlue(),

# alpha);

# }

#

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

869

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

870

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

871

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

872

# float denominator = 255.0;

873

# Color.Builder resultBuilder =

874

# Color

875

# .newBuilder()

876

# .setRed(red / denominator)

877

# .setGreen(green / denominator)

878

# .setBlue(blue / denominator);

879

# int alpha = color.getAlpha();

880

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

885

# .build());

886

# }

887

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

892

#

893

# // ...

894

# static UIColor* fromProto(Color* protocolor) {

895

# float red = [protocolor red];

896

# float green = [protocolor green];

897

# float blue = [protocolor blue];

898

# FloatValue* alpha_wrapper = [protocolor alpha];

899

# float alpha = 1.0;

900

# if (alpha_wrapper != nil) {

901

# alpha = [alpha_wrapper value];

902

# }

903

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

904

# }

905

#

906

# static Color* toProto(UIColor* color) {

907

# CGFloat red, green, blue, alpha;

908

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

909

# return nil;

910

# }

911

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

912

# [result setRed:red];

913

# [result setGreen:green];

914

# [result setBlue:blue];

915

# if (alpha <= 0.9999) {

916

# [result setAlpha:floatWrapperWithValue(alpha)];

917

# }

918

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

928

# var redFrac = rgb_color.red || 0.0;

929

# var greenFrac = rgb_color.green || 0.0;

930

# var blueFrac = rgb_color.blue || 0.0;

931

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

932

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

933

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

934

#

935

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

936

# return rgbToCssColor_(red, green, blue);

937

# }

938

#

939

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

940

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

941

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

942

# };

943

#

944

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

945

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

946

# var hexString = rgbNumber.toString(16);

947

# var missingZeros = 6 - hexString.length;

948

# var resultBuilder = ['#'];

949

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

950

# resultBuilder.push('0');

951

# }

952

# resultBuilder.push(hexString);

953

# return resultBuilder.join('');

# };

#

# // ...

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

958

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

959

# the final pixel color is defined by the equation:

960

#

961

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

962

#

963

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

964

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

965

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

966

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

967

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

968

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

969

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

970

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

971

},

972

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

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

[diff] [blame]

973

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

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

[diff] [blame]

974

"style": "A String", # The style of the border.

975

},

976

"left": { # A border along a cell. # The left border of the cell.

977

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

978

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

979

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

980

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

981

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

982

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

983

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

988

#

989

# // ...

990

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

991

# float alpha = protocolor.hasAlpha()

992

# ? protocolor.getAlpha().getValue()

993

# : 1.0;

994

#

995

# return new java.awt.Color(

996

# protocolor.getRed(),

997

# protocolor.getGreen(),

998

# protocolor.getBlue(),

# alpha);

# }

#

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

1003

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

1004

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

1005

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

1006

# float denominator = 255.0;

1007

# Color.Builder resultBuilder =

1008

# Color

1009

# .newBuilder()

1010

# .setRed(red / denominator)

1011

# .setGreen(green / denominator)

1012

# .setBlue(blue / denominator);

1013

# int alpha = color.getAlpha();

1014

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

1019

# .build());

1020

# }

1021

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

1026

#

1027

# // ...

1028

# static UIColor* fromProto(Color* protocolor) {

1029

# float red = [protocolor red];

1030

# float green = [protocolor green];

1031

# float blue = [protocolor blue];

1032

# FloatValue* alpha_wrapper = [protocolor alpha];

1033

# float alpha = 1.0;

1034

# if (alpha_wrapper != nil) {

1035

# alpha = [alpha_wrapper value];

1036

# }

1037

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

1038

# }

1039

#

1040

# static Color* toProto(UIColor* color) {

1041

# CGFloat red, green, blue, alpha;

1042

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

1043

# return nil;

1044

# }

1045

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

1046

# [result setRed:red];

1047

# [result setGreen:green];

1048

# [result setBlue:blue];

1049

# if (alpha <= 0.9999) {

1050

# [result setAlpha:floatWrapperWithValue(alpha)];

1051

# }

1052

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

1062

# var redFrac = rgb_color.red || 0.0;

1063

# var greenFrac = rgb_color.green || 0.0;

1064

# var blueFrac = rgb_color.blue || 0.0;

1065

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

1066

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

1067

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

1068

#

1069

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

1070

# return rgbToCssColor_(red, green, blue);

1071

# }

1072

#

1073

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

1074

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

1075

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

1076

# };

1077

#

1078

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

1079

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

1080

# var hexString = rgbNumber.toString(16);

1081

# var missingZeros = 6 - hexString.length;

1082

# var resultBuilder = ['#'];

1083

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

1084

# resultBuilder.push('0');

1085

# }

1086

# resultBuilder.push(hexString);

1087

# return resultBuilder.join('');

# };

#

# // ...

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

1092

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

1093

# the final pixel color is defined by the equation:

1094

#

1095

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

1096

#

1097

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

1098

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

1099

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

1100

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

1101

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

1102

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

1103

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

1104

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

1105

},

1106

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

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

[diff] [blame]

1107

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

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

[diff] [blame]

1108

"style": "A String", # The style of the border.

1109

},

1110

},

1111

"wrapStrategy": "A String", # The wrap strategy for the value in the cell.

1112

},

1113

},

1114

"gradientRule": { # A rule that applies a gradient color scale format, based on # The formatting will vary based on the gradients in the rule.

1115

# the interpolation points listed. The format of a cell will vary

1116

# based on its contents as compared to the values of the interpolation

1117

# points.

Jon Wayne Parrott

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

[diff] [blame]

1118

"maxpoint": { # A single interpolation point on a gradient conditional format. # The final interpolation point.

Jon Wayne Parrott

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

[diff] [blame]

1119

# These pin the gradient color scale according to the color,

1120

# type and value chosen.

1121

"color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.

1122

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

1123

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

1124

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

1125

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

1126

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

1127

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

1132

#

1133

# // ...

1134

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

1135

# float alpha = protocolor.hasAlpha()

1136

# ? protocolor.getAlpha().getValue()

1137

# : 1.0;

1138

#

1139

# return new java.awt.Color(

1140

# protocolor.getRed(),

1141

# protocolor.getGreen(),

1142

# protocolor.getBlue(),

# alpha);

# }

#

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

1147

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

1148

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

1149

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

1150

# float denominator = 255.0;

1151

# Color.Builder resultBuilder =

1152

# Color

1153

# .newBuilder()

1154

# .setRed(red / denominator)

1155

# .setGreen(green / denominator)

1156

# .setBlue(blue / denominator);

1157

# int alpha = color.getAlpha();

1158

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

1163

# .build());

1164

# }

1165

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

1170

#

1171

# // ...

1172

# static UIColor* fromProto(Color* protocolor) {

1173

# float red = [protocolor red];

1174

# float green = [protocolor green];

1175

# float blue = [protocolor blue];

1176

# FloatValue* alpha_wrapper = [protocolor alpha];

1177

# float alpha = 1.0;

1178

# if (alpha_wrapper != nil) {

1179

# alpha = [alpha_wrapper value];

1180

# }

1181

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

1182

# }

1183

#

1184

# static Color* toProto(UIColor* color) {

1185

# CGFloat red, green, blue, alpha;

1186

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

1187

# return nil;

1188

# }

1189

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

1190

# [result setRed:red];

1191

# [result setGreen:green];

1192

# [result setBlue:blue];

1193

# if (alpha <= 0.9999) {

1194

# [result setAlpha:floatWrapperWithValue(alpha)];

1195

# }

1196

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

1206

# var redFrac = rgb_color.red || 0.0;

1207

# var greenFrac = rgb_color.green || 0.0;

1208

# var blueFrac = rgb_color.blue || 0.0;

1209

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

1210

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

1211

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

1212

#

1213

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

1214

# return rgbToCssColor_(red, green, blue);

1215

# }

1216

#

1217

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

1218

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

1219

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

1220

# };

1221

#

1222

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

1223

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

1224

# var hexString = rgbNumber.toString(16);

1225

# var missingZeros = 6 - hexString.length;

1226

# var resultBuilder = ['#'];

1227

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

1228

# resultBuilder.push('0');

1229

# }

1230

# resultBuilder.push(hexString);

1231

# return resultBuilder.join('');

# };

#

# // ...

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

1236

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

1237

# the final pixel color is defined by the equation:

1238

#

1239

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

1240

#

1241

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

1242

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

1243

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

1244

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

1245

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

1246

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

1247

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

1248

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

1249

},

1250

"type": "A String", # How the value should be interpreted.

1251

"value": "A String", # The value this interpolation point uses. May be a formula.

1252

# Unused if type is MIN or

1253

# MAX.

1254

},

Jon Wayne Parrott

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

[diff] [blame]

1255

"midpoint": { # A single interpolation point on a gradient conditional format. # An optional midway interpolation point.

Jon Wayne Parrott

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

[diff] [blame]

1256

# These pin the gradient color scale according to the color,

1257

# type and value chosen.

1258

"color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.

1259

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

1260

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

1261

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

1262

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

1263

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

1264

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

1269

#

1270

# // ...

1271

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

1272

# float alpha = protocolor.hasAlpha()

1273

# ? protocolor.getAlpha().getValue()

1274

# : 1.0;

1275

#

1276

# return new java.awt.Color(

1277

# protocolor.getRed(),

1278

# protocolor.getGreen(),

1279

# protocolor.getBlue(),

# alpha);

# }

#

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

1284

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

1285

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

1286

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

1287

# float denominator = 255.0;

1288

# Color.Builder resultBuilder =

1289

# Color

1290

# .newBuilder()

1291

# .setRed(red / denominator)

1292

# .setGreen(green / denominator)

1293

# .setBlue(blue / denominator);

1294

# int alpha = color.getAlpha();

1295

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

1300

# .build());

1301

# }

1302

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

1307

#

1308

# // ...

1309

# static UIColor* fromProto(Color* protocolor) {

1310

# float red = [protocolor red];

1311

# float green = [protocolor green];

1312

# float blue = [protocolor blue];

1313

# FloatValue* alpha_wrapper = [protocolor alpha];

1314

# float alpha = 1.0;

1315

# if (alpha_wrapper != nil) {

1316

# alpha = [alpha_wrapper value];

1317

# }

1318

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

1319

# }

1320

#

1321

# static Color* toProto(UIColor* color) {

1322

# CGFloat red, green, blue, alpha;

1323

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

1324

# return nil;

1325

# }

1326

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

1327

# [result setRed:red];

1328

# [result setGreen:green];

1329

# [result setBlue:blue];

1330

# if (alpha <= 0.9999) {

1331

# [result setAlpha:floatWrapperWithValue(alpha)];

1332

# }

1333

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

1343

# var redFrac = rgb_color.red || 0.0;

1344

# var greenFrac = rgb_color.green || 0.0;

1345

# var blueFrac = rgb_color.blue || 0.0;

1346

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

1347

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

1348

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

1349

#

1350

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

1351

# return rgbToCssColor_(red, green, blue);

1352

# }

1353

#

1354

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

1355

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

1356

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

1357

# };

1358

#

1359

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

1360

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

1361

# var hexString = rgbNumber.toString(16);

1362

# var missingZeros = 6 - hexString.length;

1363

# var resultBuilder = ['#'];

1364

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

1365

# resultBuilder.push('0');

1366

# }

1367

# resultBuilder.push(hexString);

1368

# return resultBuilder.join('');

# };

#

# // ...

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

1373

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

1374

# the final pixel color is defined by the equation:

1375

#

1376

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

1377

#

1378

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

1379

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

1380

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

1381

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

1382

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

1383

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

1384

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

1385

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

1386

},

1387

"type": "A String", # How the value should be interpreted.

1388

"value": "A String", # The value this interpolation point uses. May be a formula.

1389

# Unused if type is MIN or

1390

# MAX.

1391

},

Jon Wayne Parrott

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

[diff] [blame]

1392

"minpoint": { # A single interpolation point on a gradient conditional format. # The starting interpolation point.

Jon Wayne Parrott

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

[diff] [blame]

1393

# These pin the gradient color scale according to the color,

1394

# type and value chosen.

1395

"color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.

1396

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

1397

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

1398

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

1399

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

1400

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

1401

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

1406

#

1407

# // ...

1408

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

1409

# float alpha = protocolor.hasAlpha()

1410

# ? protocolor.getAlpha().getValue()

1411

# : 1.0;

1412

#

1413

# return new java.awt.Color(

1414

# protocolor.getRed(),

1415

# protocolor.getGreen(),

1416

# protocolor.getBlue(),

# alpha);

# }

#

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

1421

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

1422

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

1423

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

1424

# float denominator = 255.0;

1425

# Color.Builder resultBuilder =

1426

# Color

1427

# .newBuilder()

1428

# .setRed(red / denominator)

1429

# .setGreen(green / denominator)

1430

# .setBlue(blue / denominator);

1431

# int alpha = color.getAlpha();

1432

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

1437

# .build());

1438

# }

1439

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

1444

#

1445

# // ...

1446

# static UIColor* fromProto(Color* protocolor) {

1447

# float red = [protocolor red];

1448

# float green = [protocolor green];

1449

# float blue = [protocolor blue];

1450

# FloatValue* alpha_wrapper = [protocolor alpha];

1451

# float alpha = 1.0;

1452

# if (alpha_wrapper != nil) {

1453

# alpha = [alpha_wrapper value];

1454

# }

1455

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

1456

# }

1457

#

1458

# static Color* toProto(UIColor* color) {

1459

# CGFloat red, green, blue, alpha;

1460

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

1461

# return nil;

1462

# }

1463

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

1464

# [result setRed:red];

1465

# [result setGreen:green];

1466

# [result setBlue:blue];

1467

# if (alpha <= 0.9999) {

1468

# [result setAlpha:floatWrapperWithValue(alpha)];

1469

# }

1470

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

1480

# var redFrac = rgb_color.red || 0.0;

1481

# var greenFrac = rgb_color.green || 0.0;

1482

# var blueFrac = rgb_color.blue || 0.0;

1483

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

1484

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

1485

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

1486

#

1487

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

1488

# return rgbToCssColor_(red, green, blue);

1489

# }

1490

#

1491

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

1492

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

1493

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

1494

# };

1495

#

1496

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

1497

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

1498

# var hexString = rgbNumber.toString(16);

1499

# var missingZeros = 6 - hexString.length;

1500

# var resultBuilder = ['#'];

1501

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

1502

# resultBuilder.push('0');

1503

# }

1504

# resultBuilder.push(hexString);

1505

# return resultBuilder.join('');

# };

#

# // ...

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

1510

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

1511

# the final pixel color is defined by the equation:

1512

#

1513

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

1514

#

1515

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

1516

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

1517

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

1518

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

1519

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

1520

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

1521

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

1522

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

1523

},

1524

"type": "A String", # How the value should be interpreted.

1525

"value": "A String", # The value this interpolation point uses. May be a formula.

1526

# Unused if type is MIN or

# MAX.

},

},

},

},

"updateProtectedRange": { # Updates an existing protected range with the specified # Updates a protected range.

1533

# protectedRangeId.

1534

"fields": "A String", # The fields that should be updated. At least one field must be specified.

1535

# The root `protectedRange` is implied and should not be specified.

1536

# A single `"*"` can be used as short-hand for listing every field.

Jon Wayne Parrott

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

[diff] [blame]

1537

"protectedRange": { # A protected range. # The protected range to update with the new properties.

Jon Wayne Parrott

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

[diff] [blame]

1538

"unprotectedRanges": [ # The list of unprotected ranges within a protected sheet.

1539

# Unprotected ranges are only supported on protected sheets.

1540

{ # A range on a sheet.

1541

# All indexes are zero-based.

1542

# Indexes are half open, e.g the start index is inclusive

1543

# and the end index is exclusive -- [start_index, end_index).

1544

# Missing indexes indicate the range is unbounded on that side.

1545

#

Jon Wayne Parrott

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

[diff] [blame]

1546

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

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

[diff] [blame]

1547

#

Jon Wayne Parrott

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

[diff] [blame]

1548

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

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

[diff] [blame]

1549

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

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

[diff] [blame]

1550

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

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

[diff] [blame]

1551

#

Jon Wayne Parrott

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

[diff] [blame]

1552

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

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

[diff] [blame]

1553

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

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

[diff] [blame]

1554

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

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

[diff] [blame]

1555

#

Jon Wayne Parrott

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

[diff] [blame]

1556

# `Sheet1!A:B == sheet_id: 0,

1557

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

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

[diff] [blame]

1558

#

Jon Wayne Parrott

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

[diff] [blame]

1559

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

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

[diff] [blame]

1560

# start_row_index: 4,

Jon Wayne Parrott

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

[diff] [blame]

1561

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

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

[diff] [blame]

1562

#

Jon Wayne Parrott

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

[diff] [blame]

1563

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

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

[diff] [blame]

1564

#

1565

# The start index must always be less than or equal to the end index.

1566

# If the start index equals the end index, then the range is empty.

1567

# Empty ranges are typically not meaningful and are usually rendered in the

1568

# UI as `#REF!`.

1569

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

1570

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

1571

"sheetId": 42, # The sheet this range is on.

1572

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

1573

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

1574

},

1575

],

1576

"requestingUserCanEdit": True or False, # True if the user who requested this protected range can edit the

1577

# protected area.

1578

# This field is read-only.

1579

"description": "A String", # The description of this protected range.

1580

"namedRangeId": "A String", # The named range this protected range is backed by, if any.

1581

#

Jon Wayne Parrott

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

[diff] [blame]

1582

# When writing, only one of range or named_range_id

Jon Wayne Parrott

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

[diff] [blame]

1583

# may be set.

1584

"editors": { # The editors of a protected range. # The users and groups with edit access to the protected range.

1585

# This field is only visible to users with edit access to the protected

1586

# range and the document.

Jon Wayne Parrott

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

[diff] [blame]

1587

# Editors are not supported with warning_only protection.

Jon Wayne Parrott

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

[diff] [blame]

1588

"domainUsersCanEdit": True or False, # True if anyone in the document's domain has edit access to the protected

1589

# range. Domain protection is only supported on documents within a domain.

1590

"users": [ # The email addresses of users with edit access to the protected range.

1591

"A String",

1592

],

1593

"groups": [ # The email addresses of groups with edit access to the protected range.

"A String",

],

},

"protectedRangeId": 42, # The ID of the protected range.

1598

# This field is read-only.

Jon Wayne Parrott

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

[diff] [blame]

1599

"warningOnly": True or False, # True if this protected range will show a warning when editing.

Jon Wayne Parrott

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

[diff] [blame]

1600

# Warning-based protection means that every user can edit data in the

1601

# protected range, except editing will prompt a warning asking the user

1602

# to confirm the edit.

1603

#

Jon Wayne Parrott

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

[diff] [blame]

1604

# When writing: if this field is true, then editors is ignored.

Jon Wayne Parrott

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

[diff] [blame]

1605

# Additionally, if this field is changed from true to false and the

1606

# `editors` field is not set (nor included in the field mask), then

1607

# the editors will be set to all the editors in the document.

1608

"range": { # A range on a sheet. # The range that is being protected.

1609

# The range may be fully unbounded, in which case this is considered

1610

# a protected sheet.

1611

#

Jon Wayne Parrott

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

[diff] [blame]

1612

# When writing, only one of range or named_range_id

Jon Wayne Parrott

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

[diff] [blame]

1613

# may be set.

1614

# All indexes are zero-based.

1615

# Indexes are half open, e.g the start index is inclusive

1616

# and the end index is exclusive -- [start_index, end_index).

1617

# Missing indexes indicate the range is unbounded on that side.

1618

#

Jon Wayne Parrott

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

[diff] [blame]

1619

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

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

[diff] [blame]

1620

#

Jon Wayne Parrott

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

[diff] [blame]

1621

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

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

[diff] [blame]

1622

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

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

[diff] [blame]

1623

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

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

[diff] [blame]

1624

#

Jon Wayne Parrott

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

[diff] [blame]

1625

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

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

[diff] [blame]

1626

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

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

[diff] [blame]

1627

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

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

[diff] [blame]

1628

#

Jon Wayne Parrott

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

[diff] [blame]

1629

# `Sheet1!A:B == sheet_id: 0,

1630

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

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

[diff] [blame]

1631

#

Jon Wayne Parrott

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

[diff] [blame]

1632

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

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

[diff] [blame]

1633

# start_row_index: 4,

Jon Wayne Parrott

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

[diff] [blame]

1634

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

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

[diff] [blame]

1635

#

Jon Wayne Parrott

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

[diff] [blame]

1636

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

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

[diff] [blame]

1637

#

1638

# The start index must always be less than or equal to the end index.

1639

# If the start index equals the end index, then the range is empty.

1640

# Empty ranges are typically not meaningful and are usually rendered in the

1641

# UI as `#REF!`.

1642

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

1643

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

1644

"sheetId": 42, # The sheet this range is on.

1645

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

1646

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

},

},

"deleteDimension": { # Deletes the dimensions from the sheet. # Deletes rows or columns in a sheet.

1651

"range": { # A range along a single dimension on a sheet. # The dimensions to delete from the sheet.

1652

# All indexes are zero-based.

1653

# Indexes are half open: the start index is inclusive

1654

# and the end index is exclusive.

1655

# Missing indexes indicate the range is unbounded on that side.

1656

"endIndex": 42, # The end (exclusive) of the span, or not set if unbounded.

1657

"startIndex": 42, # The start (inclusive) of the span, or not set if unbounded.

1658

"sheetId": 42, # The sheet this span is on.

1659

"dimension": "A String", # The dimension of the span.

1660

},

1661

},

1662

"addProtectedRange": { # Adds a new protected range. # Adds a protected range.

Jon Wayne Parrott

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

[diff] [blame]

1663

"protectedRange": { # A protected range. # The protected range to be added. The

1664

# protectedRangeId field is optional; if

1665

# one is not set, an id will be randomly generated. (It is an error to

1666

# specify the ID of a range that already exists.)

Jon Wayne Parrott

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

[diff] [blame]

1667

"unprotectedRanges": [ # The list of unprotected ranges within a protected sheet.

1668

# Unprotected ranges are only supported on protected sheets.

1669

{ # A range on a sheet.

1670

# All indexes are zero-based.

1671

# Indexes are half open, e.g the start index is inclusive

1672

# and the end index is exclusive -- [start_index, end_index).

1673

# Missing indexes indicate the range is unbounded on that side.

1674

#

Jon Wayne Parrott

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

[diff] [blame]

1675

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

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

[diff] [blame]

1676

#

Jon Wayne Parrott

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

[diff] [blame]

1677

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

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

[diff] [blame]

1678

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

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

[diff] [blame]

1679

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

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

[diff] [blame]

1680

#

Jon Wayne Parrott

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

[diff] [blame]

1681

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

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

[diff] [blame]

1682

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

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

[diff] [blame]

1683

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

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

[diff] [blame]

1684

#

Jon Wayne Parrott

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

[diff] [blame]

1685

# `Sheet1!A:B == sheet_id: 0,

1686

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

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

[diff] [blame]

1687

#

Jon Wayne Parrott

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

[diff] [blame]

1688

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

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

[diff] [blame]

1689

# start_row_index: 4,

Jon Wayne Parrott

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

[diff] [blame]

1690

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

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

[diff] [blame]

1691

#

Jon Wayne Parrott

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

[diff] [blame]

1692

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

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

[diff] [blame]

1693

#

1694

# The start index must always be less than or equal to the end index.

1695

# If the start index equals the end index, then the range is empty.

1696

# Empty ranges are typically not meaningful and are usually rendered in the

1697

# UI as `#REF!`.

1698

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

1699

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

1700

"sheetId": 42, # The sheet this range is on.

1701

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

1702

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

1703

},

1704

],

1705

"requestingUserCanEdit": True or False, # True if the user who requested this protected range can edit the

1706

# protected area.

1707

# This field is read-only.

1708

"description": "A String", # The description of this protected range.

1709

"namedRangeId": "A String", # The named range this protected range is backed by, if any.

1710

#

Jon Wayne Parrott

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

[diff] [blame]

1711

# When writing, only one of range or named_range_id

Jon Wayne Parrott

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

[diff] [blame]

1712

# may be set.

1713

"editors": { # The editors of a protected range. # The users and groups with edit access to the protected range.

1714

# This field is only visible to users with edit access to the protected

1715

# range and the document.

Jon Wayne Parrott

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

[diff] [blame]

1716

# Editors are not supported with warning_only protection.

Jon Wayne Parrott

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

[diff] [blame]

1717

"domainUsersCanEdit": True or False, # True if anyone in the document's domain has edit access to the protected

1718

# range. Domain protection is only supported on documents within a domain.

1719

"users": [ # The email addresses of users with edit access to the protected range.

1720

"A String",

1721

],

1722

"groups": [ # The email addresses of groups with edit access to the protected range.

"A String",

],

},

"protectedRangeId": 42, # The ID of the protected range.

1727

# This field is read-only.

Jon Wayne Parrott

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

[diff] [blame]

1728

"warningOnly": True or False, # True if this protected range will show a warning when editing.

Jon Wayne Parrott

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

[diff] [blame]

1729

# Warning-based protection means that every user can edit data in the

1730

# protected range, except editing will prompt a warning asking the user

1731

# to confirm the edit.

1732

#

Jon Wayne Parrott

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

[diff] [blame]

1733

# When writing: if this field is true, then editors is ignored.

Jon Wayne Parrott

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

[diff] [blame]

1734

# Additionally, if this field is changed from true to false and the

1735

# `editors` field is not set (nor included in the field mask), then

1736

# the editors will be set to all the editors in the document.

1737

"range": { # A range on a sheet. # The range that is being protected.

1738

# The range may be fully unbounded, in which case this is considered

1739

# a protected sheet.

1740

#

Jon Wayne Parrott

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

[diff] [blame]

1741

# When writing, only one of range or named_range_id

Jon Wayne Parrott

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

[diff] [blame]

1742

# may be set.

1743

# All indexes are zero-based.

1744

# Indexes are half open, e.g the start index is inclusive

1745

# and the end index is exclusive -- [start_index, end_index).

1746

# Missing indexes indicate the range is unbounded on that side.

1747

#

Jon Wayne Parrott

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

[diff] [blame]

1748

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

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

[diff] [blame]

1749

#

Jon Wayne Parrott

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

[diff] [blame]

1750

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

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

[diff] [blame]

1751

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

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

[diff] [blame]

1752

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

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

[diff] [blame]

1753

#

Jon Wayne Parrott

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

[diff] [blame]

1754

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

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

[diff] [blame]

1755

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

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

[diff] [blame]

1756

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

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

[diff] [blame]

1757

#

Jon Wayne Parrott

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

[diff] [blame]

1758

# `Sheet1!A:B == sheet_id: 0,

1759

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

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

[diff] [blame]

1760

#

Jon Wayne Parrott

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

[diff] [blame]

1761

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

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

[diff] [blame]

1762

# start_row_index: 4,

Jon Wayne Parrott

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

[diff] [blame]

1763

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

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

[diff] [blame]

1764

#

Jon Wayne Parrott

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

[diff] [blame]

1765

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

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

[diff] [blame]

1766

#

1767

# The start index must always be less than or equal to the end index.

1768

# If the start index equals the end index, then the range is empty.

1769

# Empty ranges are typically not meaningful and are usually rendered in the

1770

# UI as `#REF!`.

1771

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

1772

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

1773

"sheetId": 42, # The sheet this range is on.

1774

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

1775

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

},

},

"deleteEmbeddedObject": { # Deletes the embedded object with the given ID. # Deletes an embedded object (e.g, chart, image) in a sheet.

1780

"objectId": 42, # The ID of the embedded object to delete.

1781

},

1782

"pasteData": { # Inserts data into the spreadsheet starting at the specified coordinate. # Pastes data (HTML or delimited) into a sheet.

1783

"coordinate": { # A coordinate in a sheet. # The coordinate at which the data should start being inserted.

1784

# All indexes are zero-based.

1785

"rowIndex": 42, # The row index of the coordinate.

1786

"columnIndex": 42, # The column index of the coordinate.

1787

"sheetId": 42, # The sheet this coordinate is on.

1788

},

1789

"type": "A String", # How the data should be pasted.

1790

"delimiter": "A String", # The delimiter in the data.

1791

"html": True or False, # True if the data is HTML.

1792

"data": "A String", # The data to insert.

1793

},

Jon Wayne Parrott

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

[diff] [blame]

1794

"appendCells": { # Adds new cells after the last row with data in a sheet, # Appends cells after the last row with data in a sheet.

Jon Wayne Parrott

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

[diff] [blame]

1795

# inserting new rows into the sheet if necessary.

1796

"fields": "A String", # The fields of CellData that should be updated.

1797

# At least one field must be specified.

1798

# The root is the CellData; 'row.values.' should not be specified.

1799

# A single `"*"` can be used as short-hand for listing every field.

1800

"rows": [ # The data to append.

1801

{ # Data about each cell in a row.

1802

"values": [ # The values in the row, one per column.

1803

{ # Data about a specific cell.

1804

"pivotTable": { # A pivot table. # A pivot table anchored at this cell. The size of pivot table itself

1805

# is computed dynamically based on its data, grouping, filters, values,

Jon Wayne Parrott

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

[diff] [blame]

1806

# etc. Only the top-left cell of the pivot table contains the pivot table

Jon Wayne Parrott

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

[diff] [blame]

1807

# definition. The other cells will contain the calculated values of the

Jon Wayne Parrott

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

[diff] [blame]

1808

# results of the pivot in their effective_value fields.

Jon Wayne Parrott

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

[diff] [blame]

1809

"valueLayout": "A String", # Whether values should be listed horizontally (as columns)

1810

# or vertically (as rows).

1811

"rows": [ # Each row grouping in the pivot table.

1812

{ # A single grouping (either row or column) in a pivot table.

1813

"showTotals": True or False, # True if the pivot table should include the totals for this grouping.

1814

"valueMetadata": [ # Metadata about values in the grouping.

1815

{ # Metadata about a value in a pivot grouping.

1816

"collapsed": True or False, # True if the data corresponding to the value is collapsed.

1817

"value": { # The kinds of value that a cell in a spreadsheet can have. # The calculated value the metadata corresponds to.

1818

# (Note that formulaValue is not valid,

1819

# because the values will be calculated.)

1820

"numberValue": 3.14, # Represents a double value.

1821

# Note: Dates, Times and DateTimes are represented as doubles in

1822

# "serial number" format.

1823

"boolValue": True or False, # Represents a boolean value.

1824

"formulaValue": "A String", # Represents a formula.

1825

"stringValue": "A String", # Represents a string value.

1826

# Leading single quotes are not included. For example, if the user typed

1827

# `'123` into the UI, this would be represented as a `stringValue` of

1828

# `"123"`.

1829

"errorValue": { # An error in a cell. # Represents an error.

1830

# This field is read-only.

1831

"message": "A String", # A message with more information about the error

1832

# (in the spreadsheet's locale).

1833

"type": "A String", # The type of error.

},

},

},

],

"valueBucket": { # Information about which values in a pivot group should be used for sorting. # The bucket of the opposite pivot group to sort by.

1839

# If not specified, sorting is alphabetical by this group's values.

1840

"buckets": [ # Determines the bucket from which values are chosen to sort.

1841

#

1842

# For example, in a pivot table with one row group & two column groups,

1843

# the row group can list up to two values. The first value corresponds

1844

# to a value within the first column group, and the second value

1845

# corresponds to a value in the second column group. If no values

1846

# are listed, this would indicate that the row should be sorted according

1847

# to the "Grand Total" over the column groups. If a single value is listed,

1848

# this would correspond to using the "Total" of that bucket.

1849

{ # The kinds of value that a cell in a spreadsheet can have.

1850

"numberValue": 3.14, # Represents a double value.

1851

# Note: Dates, Times and DateTimes are represented as doubles in

1852

# "serial number" format.

1853

"boolValue": True or False, # Represents a boolean value.

1854

"formulaValue": "A String", # Represents a formula.

1855

"stringValue": "A String", # Represents a string value.

1856

# Leading single quotes are not included. For example, if the user typed

1857

# `'123` into the UI, this would be represented as a `stringValue` of

1858

# `"123"`.

1859

"errorValue": { # An error in a cell. # Represents an error.

1860

# This field is read-only.

1861

"message": "A String", # A message with more information about the error

1862

# (in the spreadsheet's locale).

1863

"type": "A String", # The type of error.

1864

},

1865

},

1866

],

Jon Wayne Parrott

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

[diff] [blame]

1867

"valuesIndex": 42, # The offset in the PivotTable.values list which the values in this

Jon Wayne Parrott

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

[diff] [blame]

1868

# grouping should be sorted by.

1869

},

1870

"sortOrder": "A String", # The order the values in this group should be sorted.

1871

"sourceColumnOffset": 42, # The column offset of the source range that this grouping is based on.

1872

#

Jon Wayne Parrott

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

[diff] [blame]

1873

# For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`

Jon Wayne Parrott

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

[diff] [blame]

1874

# means this group refers to column `C`, whereas the offset `1` would refer

# to column `D`.

},

],

"source": { # A range on a sheet. # The range the pivot table is reading data from.

1879

# All indexes are zero-based.

1880

# Indexes are half open, e.g the start index is inclusive

1881

# and the end index is exclusive -- [start_index, end_index).

1882

# Missing indexes indicate the range is unbounded on that side.

1883

#

Jon Wayne Parrott

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

[diff] [blame]

1884

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

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

[diff] [blame]

1885

#

Jon Wayne Parrott

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

[diff] [blame]

1886

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

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

[diff] [blame]

1887

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

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

[diff] [blame]

1888

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

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

[diff] [blame]

1889

#

Jon Wayne Parrott

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

[diff] [blame]

1890

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

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

[diff] [blame]

1891

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

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

[diff] [blame]

1892

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

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

[diff] [blame]

1893

#

Jon Wayne Parrott

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

[diff] [blame]

1894

# `Sheet1!A:B == sheet_id: 0,

1895

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

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

[diff] [blame]

1896

#

Jon Wayne Parrott

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

[diff] [blame]

1897

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

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

[diff] [blame]

1898

# start_row_index: 4,

Jon Wayne Parrott

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

[diff] [blame]

1899

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

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

[diff] [blame]

1900

#

Jon Wayne Parrott

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

[diff] [blame]

1901

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

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

[diff] [blame]

1902

#

1903

# The start index must always be less than or equal to the end index.

1904

# If the start index equals the end index, then the range is empty.

1905

# Empty ranges are typically not meaningful and are usually rendered in the

1906

# UI as `#REF!`.

1907

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

1908

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

1909

"sheetId": 42, # The sheet this range is on.

1910

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

1911

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

1912

},

1913

"values": [ # A list of values to include in the pivot table.

1914

{ # The definition of how a value in a pivot table should be calculated.

1915

"formula": "A String", # A custom formula to calculate the value. The formula must start

1916

# with an `=` character.

1917

"summarizeFunction": "A String", # A function to summarize the value.

1918

# If formula is set, the only supported values are

1919

# SUM and

1920

# CUSTOM.

1921

# If sourceColumnOffset is set, then `CUSTOM`

1922

# is not supported.

1923

"sourceColumnOffset": 42, # The column offset of the source range that this value reads from.

1924

#

Jon Wayne Parrott

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

[diff] [blame]

1925

# For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`

Jon Wayne Parrott

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

[diff] [blame]

1926

# means this value refers to column `C`, whereas the offset `1` would

1927

# refer to column `D`.

1928

"name": "A String", # A name to use for the value. This is only used if formula was set.

1929

# Otherwise, the column name is used.

1930

},

1931

],

1932

"criteria": { # An optional mapping of filters per source column offset.

1933

#

1934

# The filters will be applied before aggregating data into the pivot table.

1935

# The map's key is the column offset of the source range that you want to

1936

# filter, and the value is the criteria for that column.

1937

#

Jon Wayne Parrott

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

[diff] [blame]

1938

# For example, if the source was `C10:E15`, a key of `0` will have the filter

Jon Wayne Parrott

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

[diff] [blame]

1939

# for column `C`, whereas the key `1` is for column `D`.

1940

"a_key": { # Criteria for showing/hiding rows in a pivot table.

1941

"visibleValues": [ # Values that should be included. Values not listed here are excluded.

"A String",

],

},

},

"columns": [ # Each column grouping in the pivot table.

1947

{ # A single grouping (either row or column) in a pivot table.

1948

"showTotals": True or False, # True if the pivot table should include the totals for this grouping.

1949

"valueMetadata": [ # Metadata about values in the grouping.

1950

{ # Metadata about a value in a pivot grouping.

1951

"collapsed": True or False, # True if the data corresponding to the value is collapsed.

1952

"value": { # The kinds of value that a cell in a spreadsheet can have. # The calculated value the metadata corresponds to.

1953

# (Note that formulaValue is not valid,

1954

# because the values will be calculated.)

1955

"numberValue": 3.14, # Represents a double value.

1956

# Note: Dates, Times and DateTimes are represented as doubles in

1957

# "serial number" format.

1958

"boolValue": True or False, # Represents a boolean value.

1959

"formulaValue": "A String", # Represents a formula.

1960

"stringValue": "A String", # Represents a string value.

1961

# Leading single quotes are not included. For example, if the user typed

1962

# `'123` into the UI, this would be represented as a `stringValue` of

1963

# `"123"`.

1964

"errorValue": { # An error in a cell. # Represents an error.

1965

# This field is read-only.

1966

"message": "A String", # A message with more information about the error

1967

# (in the spreadsheet's locale).

1968

"type": "A String", # The type of error.

},

},

},

],

"valueBucket": { # Information about which values in a pivot group should be used for sorting. # The bucket of the opposite pivot group to sort by.

1974

# If not specified, sorting is alphabetical by this group's values.

1975

"buckets": [ # Determines the bucket from which values are chosen to sort.

1976

#

1977

# For example, in a pivot table with one row group & two column groups,

1978

# the row group can list up to two values. The first value corresponds

1979

# to a value within the first column group, and the second value

1980

# corresponds to a value in the second column group. If no values

1981

# are listed, this would indicate that the row should be sorted according

1982

# to the "Grand Total" over the column groups. If a single value is listed,

1983

# this would correspond to using the "Total" of that bucket.

1984

{ # The kinds of value that a cell in a spreadsheet can have.

1985

"numberValue": 3.14, # Represents a double value.

1986

# Note: Dates, Times and DateTimes are represented as doubles in

1987

# "serial number" format.

1988

"boolValue": True or False, # Represents a boolean value.

1989

"formulaValue": "A String", # Represents a formula.

1990

"stringValue": "A String", # Represents a string value.

1991

# Leading single quotes are not included. For example, if the user typed

1992

# `'123` into the UI, this would be represented as a `stringValue` of

1993

# `"123"`.

1994

"errorValue": { # An error in a cell. # Represents an error.

1995

# This field is read-only.

1996

"message": "A String", # A message with more information about the error

1997

# (in the spreadsheet's locale).

1998

"type": "A String", # The type of error.

1999

},

2000

},

2001

],

Jon Wayne Parrott

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

[diff] [blame]

2002

"valuesIndex": 42, # The offset in the PivotTable.values list which the values in this

Jon Wayne Parrott

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

[diff] [blame]

2003

# grouping should be sorted by.

2004

},

2005

"sortOrder": "A String", # The order the values in this group should be sorted.

2006

"sourceColumnOffset": 42, # The column offset of the source range that this grouping is based on.

2007

#

Jon Wayne Parrott

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

[diff] [blame]

2008

# For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`

Jon Wayne Parrott

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

[diff] [blame]

2009

# means this group refers to column `C`, whereas the offset `1` would refer

# to column `D`.

},

],

},

"hyperlink": "A String", # A hyperlink this cell points to, if any.

2015

# This field is read-only. (To set it, use a `=HYPERLINK` formula.)

2016

"effectiveValue": { # The kinds of value that a cell in a spreadsheet can have. # The effective value of the cell. For cells with formulas, this will be

2017

# the calculated value. For cells with literals, this will be

2018

# the same as the user_entered_value.

2019

# This field is read-only.

2020

"numberValue": 3.14, # Represents a double value.

2021

# Note: Dates, Times and DateTimes are represented as doubles in

2022

# "serial number" format.

2023

"boolValue": True or False, # Represents a boolean value.

2024

"formulaValue": "A String", # Represents a formula.

2025

"stringValue": "A String", # Represents a string value.

2026

# Leading single quotes are not included. For example, if the user typed

2027

# `'123` into the UI, this would be represented as a `stringValue` of

2028

# `"123"`.

2029

"errorValue": { # An error in a cell. # Represents an error.

2030

# This field is read-only.

2031

"message": "A String", # A message with more information about the error

2032

# (in the spreadsheet's locale).

2033

"type": "A String", # The type of error.

2034

},

2035

},

2036

"formattedValue": "A String", # The formatted value of the cell.

2037

# This is the value as it's shown to the user.

2038

# This field is read-only.

2039

"userEnteredValue": { # The kinds of value that a cell in a spreadsheet can have. # The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`

2040

# Note: Dates, Times and DateTimes are represented as doubles in

2041

# serial number format.

2042

"numberValue": 3.14, # Represents a double value.

2043

# Note: Dates, Times and DateTimes are represented as doubles in

2044

# "serial number" format.

2045

"boolValue": True or False, # Represents a boolean value.

2046

"formulaValue": "A String", # Represents a formula.

2047

"stringValue": "A String", # Represents a string value.

2048

# Leading single quotes are not included. For example, if the user typed

2049

# `'123` into the UI, this would be represented as a `stringValue` of

2050

# `"123"`.

2051

"errorValue": { # An error in a cell. # Represents an error.

2052

# This field is read-only.

2053

"message": "A String", # A message with more information about the error

2054

# (in the spreadsheet's locale).

2055

"type": "A String", # The type of error.

2056

},

2057

},

2058

"note": "A String", # Any note on the cell.

2059

"effectiveFormat": { # The format of a cell. # The effective format being used by the cell.

2060

# This includes the results of applying any conditional formatting and,

2061

# if the cell contains a formula, the computed number format.

2062

# If the effective format is the default format, effective format will

2063

# not be written.

2064

# This field is read-only.

2065

"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.

Jon Wayne Parrott

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

[diff] [blame]

2066

"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on

2067

# the user's locale will be used if necessary for the given type.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame^]

2068

# See the [Date and Number Formats guide](/sheets/guides/formats) for more

2069

# information about the supported patterns.

Jon Wayne Parrott

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

[diff] [blame]

2070

"type": "A String", # The type of the number format.

Jon Wayne Parrott

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

[diff] [blame]

2071

# When writing, this field must be set.

Jon Wayne Parrott

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

[diff] [blame]

2072

},

2073

"textDirection": "A String", # The direction of the text in the cell.

2074

"padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.

2075

# When updating padding, every field must be specified.

2076

"top": 42, # The top padding of the cell.

2077

"right": 42, # The right padding of the cell.

2078

"bottom": 42, # The bottom padding of the cell.

2079

"left": 42, # The left padding of the cell.

2080

},

Jon Wayne Parrott

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

[diff] [blame]

2081

"horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.

Jon Wayne Parrott

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

[diff] [blame]

2082

"backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.

2083

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

2084

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

2085

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

2086

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

2087

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

2088

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

2093

#

2094

# // ...

2095

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

2096

# float alpha = protocolor.hasAlpha()

2097

# ? protocolor.getAlpha().getValue()

2098

# : 1.0;

2099

#

2100

# return new java.awt.Color(

2101

# protocolor.getRed(),

2102

# protocolor.getGreen(),

2103

# protocolor.getBlue(),

# alpha);

# }

#

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

2108

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

2109

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

2110

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

2111

# float denominator = 255.0;

2112

# Color.Builder resultBuilder =

2113

# Color

2114

# .newBuilder()

2115

# .setRed(red / denominator)

2116

# .setGreen(green / denominator)

2117

# .setBlue(blue / denominator);

2118

# int alpha = color.getAlpha();

2119

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

2124

# .build());

2125

# }

2126

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

2131

#

2132

# // ...

2133

# static UIColor* fromProto(Color* protocolor) {

2134

# float red = [protocolor red];

2135

# float green = [protocolor green];

2136

# float blue = [protocolor blue];

2137

# FloatValue* alpha_wrapper = [protocolor alpha];

2138

# float alpha = 1.0;

2139

# if (alpha_wrapper != nil) {

2140

# alpha = [alpha_wrapper value];

2141

# }

2142

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

2143

# }

2144

#

2145

# static Color* toProto(UIColor* color) {

2146

# CGFloat red, green, blue, alpha;

2147

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

2148

# return nil;

2149

# }

2150

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

2151

# [result setRed:red];

2152

# [result setGreen:green];

2153

# [result setBlue:blue];

2154

# if (alpha <= 0.9999) {

2155

# [result setAlpha:floatWrapperWithValue(alpha)];

2156

# }

2157

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

2167

# var redFrac = rgb_color.red || 0.0;

2168

# var greenFrac = rgb_color.green || 0.0;

2169

# var blueFrac = rgb_color.blue || 0.0;

2170

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

2171

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

2172

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

2173

#

2174

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

2175

# return rgbToCssColor_(red, green, blue);

2176

# }

2177

#

2178

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

2179

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

2180

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

2181

# };

2182

#

2183

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

2184

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

2185

# var hexString = rgbNumber.toString(16);

2186

# var missingZeros = 6 - hexString.length;

2187

# var resultBuilder = ['#'];

2188

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

2189

# resultBuilder.push('0');

2190

# }

2191

# resultBuilder.push(hexString);

2192

# return resultBuilder.join('');

# };

#

# // ...

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

2197

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

2198

# the final pixel color is defined by the equation:

2199

#

2200

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

2201

#

2202

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

2203

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

2204

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

2205

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

2206

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

2207

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

2208

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

2209

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

2210

},

Jon Wayne Parrott

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

[diff] [blame]

2211

"verticalAlignment": "A String", # The vertical alignment of the value in the cell.

Jon Wayne Parrott

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

[diff] [blame]

2212

"textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).

2213

# Absent values indicate that the field isn't specified.

2214

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

2215

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

2216

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

2217

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

2218

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

2219

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

2220

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

2225

#

2226

# // ...

2227

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

2228

# float alpha = protocolor.hasAlpha()

2229

# ? protocolor.getAlpha().getValue()

2230

# : 1.0;

2231

#

2232

# return new java.awt.Color(

2233

# protocolor.getRed(),

2234

# protocolor.getGreen(),

2235

# protocolor.getBlue(),

# alpha);

# }

#

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

2240

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

2241

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

2242

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

2243

# float denominator = 255.0;

2244

# Color.Builder resultBuilder =

2245

# Color

2246

# .newBuilder()

2247

# .setRed(red / denominator)

2248

# .setGreen(green / denominator)

2249

# .setBlue(blue / denominator);

2250

# int alpha = color.getAlpha();

2251

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

2256

# .build());

2257

# }

2258

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

2263

#

2264

# // ...

2265

# static UIColor* fromProto(Color* protocolor) {

2266

# float red = [protocolor red];

2267

# float green = [protocolor green];

2268

# float blue = [protocolor blue];

2269

# FloatValue* alpha_wrapper = [protocolor alpha];

2270

# float alpha = 1.0;

2271

# if (alpha_wrapper != nil) {

2272

# alpha = [alpha_wrapper value];

2273

# }

2274

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

2275

# }

2276

#

2277

# static Color* toProto(UIColor* color) {

2278

# CGFloat red, green, blue, alpha;

2279

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

2280

# return nil;

2281

# }

2282

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

2283

# [result setRed:red];

2284

# [result setGreen:green];

2285

# [result setBlue:blue];

2286

# if (alpha <= 0.9999) {

2287

# [result setAlpha:floatWrapperWithValue(alpha)];

2288

# }

2289

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

2299

# var redFrac = rgb_color.red || 0.0;

2300

# var greenFrac = rgb_color.green || 0.0;

2301

# var blueFrac = rgb_color.blue || 0.0;

2302

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

2303

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

2304

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

2305

#

2306

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

2307

# return rgbToCssColor_(red, green, blue);

2308

# }

2309

#

2310

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

2311

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

2312

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

2313

# };

2314

#

2315

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

2316

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

2317

# var hexString = rgbNumber.toString(16);

2318

# var missingZeros = 6 - hexString.length;

2319

# var resultBuilder = ['#'];

2320

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

2321

# resultBuilder.push('0');

2322

# }

2323

# resultBuilder.push(hexString);

2324

# return resultBuilder.join('');

# };

#

# // ...

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

2329

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

2330

# the final pixel color is defined by the equation:

2331

#

2332

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

2333

#

2334

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

2335

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

2336

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

2337

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

2338

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

2339

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

2340

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

2341

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

2342

},

2343

"bold": True or False, # True if the text is bold.

2344

"strikethrough": True or False, # True if the text has a strikethrough.

2345

"fontFamily": "A String", # The font family.

2346

"fontSize": 42, # The size of the font.

2347

"italic": True or False, # True if the text is italicized.

2348

"underline": True or False, # True if the text is underlined.

2349

},

2350

"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.

2351

"borders": { # The borders of the cell. # The borders of the cell.

2352

"top": { # A border along a cell. # The top border of the cell.

2353

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

2354

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

2355

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

2356

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

2357

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

2358

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

2359

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

2364

#

2365

# // ...

2366

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

2367

# float alpha = protocolor.hasAlpha()

2368

# ? protocolor.getAlpha().getValue()

2369

# : 1.0;

2370

#

2371

# return new java.awt.Color(

2372

# protocolor.getRed(),

2373

# protocolor.getGreen(),

2374

# protocolor.getBlue(),

# alpha);

# }

#

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

2379

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

2380

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

2381

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

2382

# float denominator = 255.0;

2383

# Color.Builder resultBuilder =

2384

# Color

2385

# .newBuilder()

2386

# .setRed(red / denominator)

2387

# .setGreen(green / denominator)

2388

# .setBlue(blue / denominator);

2389

# int alpha = color.getAlpha();

2390

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

2395

# .build());

2396

# }

2397

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

2402

#

2403

# // ...

2404

# static UIColor* fromProto(Color* protocolor) {

2405

# float red = [protocolor red];

2406

# float green = [protocolor green];

2407

# float blue = [protocolor blue];

2408

# FloatValue* alpha_wrapper = [protocolor alpha];

2409

# float alpha = 1.0;

2410

# if (alpha_wrapper != nil) {

2411

# alpha = [alpha_wrapper value];

2412

# }

2413

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

2414

# }

2415

#

2416

# static Color* toProto(UIColor* color) {

2417

# CGFloat red, green, blue, alpha;

2418

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

2419

# return nil;

2420

# }

2421

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

2422

# [result setRed:red];

2423

# [result setGreen:green];

2424

# [result setBlue:blue];

2425

# if (alpha <= 0.9999) {

2426

# [result setAlpha:floatWrapperWithValue(alpha)];

2427

# }

2428

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

2438

# var redFrac = rgb_color.red || 0.0;

2439

# var greenFrac = rgb_color.green || 0.0;

2440

# var blueFrac = rgb_color.blue || 0.0;

2441

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

2442

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

2443

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

2444

#

2445

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

2446

# return rgbToCssColor_(red, green, blue);

2447

# }

2448

#

2449

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

2450

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

2451

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

2452

# };

2453

#

2454

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

2455

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

2456

# var hexString = rgbNumber.toString(16);

2457

# var missingZeros = 6 - hexString.length;

2458

# var resultBuilder = ['#'];

2459

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

2460

# resultBuilder.push('0');

2461

# }

2462

# resultBuilder.push(hexString);

2463

# return resultBuilder.join('');

# };

#

# // ...

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

2468

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

2469

# the final pixel color is defined by the equation:

2470

#

2471

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

2472

#

2473

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

2474

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

2475

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

2476

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

2477

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

2478

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

2479

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

2480

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

2481

},

2482

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

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

[diff] [blame]

2483

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

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

[diff] [blame]

2484

"style": "A String", # The style of the border.

2485

},

2486

"right": { # A border along a cell. # The right border of the cell.

2487

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

2488

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

2489

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

2490

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

2491

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

2492

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

2493

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

2498

#

2499

# // ...

2500

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

2501

# float alpha = protocolor.hasAlpha()

2502

# ? protocolor.getAlpha().getValue()

2503

# : 1.0;

2504

#

2505

# return new java.awt.Color(

2506

# protocolor.getRed(),

2507

# protocolor.getGreen(),

2508

# protocolor.getBlue(),

# alpha);

# }

#

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

2513

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

2514

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

2515

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

2516

# float denominator = 255.0;

2517

# Color.Builder resultBuilder =

2518

# Color

2519

# .newBuilder()

2520

# .setRed(red / denominator)

2521

# .setGreen(green / denominator)

2522

# .setBlue(blue / denominator);

2523

# int alpha = color.getAlpha();

2524

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

2529

# .build());

2530

# }

2531

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

2536

#

2537

# // ...

2538

# static UIColor* fromProto(Color* protocolor) {

2539

# float red = [protocolor red];

2540

# float green = [protocolor green];

2541

# float blue = [protocolor blue];

2542

# FloatValue* alpha_wrapper = [protocolor alpha];

2543

# float alpha = 1.0;

2544

# if (alpha_wrapper != nil) {

2545

# alpha = [alpha_wrapper value];

2546

# }

2547

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

2548

# }

2549

#

2550

# static Color* toProto(UIColor* color) {

2551

# CGFloat red, green, blue, alpha;

2552

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

2553

# return nil;

2554

# }

2555

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

2556

# [result setRed:red];

2557

# [result setGreen:green];

2558

# [result setBlue:blue];

2559

# if (alpha <= 0.9999) {

2560

# [result setAlpha:floatWrapperWithValue(alpha)];

2561

# }

2562

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

2572

# var redFrac = rgb_color.red || 0.0;

2573

# var greenFrac = rgb_color.green || 0.0;

2574

# var blueFrac = rgb_color.blue || 0.0;

2575

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

2576

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

2577

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

2578

#

2579

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

2580

# return rgbToCssColor_(red, green, blue);

2581

# }

2582

#

2583

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

2584

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

2585

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

2586

# };

2587

#

2588

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

2589

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

2590

# var hexString = rgbNumber.toString(16);

2591

# var missingZeros = 6 - hexString.length;

2592

# var resultBuilder = ['#'];

2593

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

2594

# resultBuilder.push('0');

2595

# }

2596

# resultBuilder.push(hexString);

2597

# return resultBuilder.join('');

# };

#

# // ...

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

2602

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

2603

# the final pixel color is defined by the equation:

2604

#

2605

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

2606

#

2607

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

2608

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

2609

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

2610

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

2611

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

2612

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

2613

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

2614

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

2615

},

2616

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

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

[diff] [blame]

2617

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

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

[diff] [blame]

2618

"style": "A String", # The style of the border.

2619

},

2620

"bottom": { # A border along a cell. # The bottom border of the cell.

2621

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

2622

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

2623

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

2624

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

2625

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

2626

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

2627

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

2632

#

2633

# // ...

2634

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

2635

# float alpha = protocolor.hasAlpha()

2636

# ? protocolor.getAlpha().getValue()

2637

# : 1.0;

2638

#

2639

# return new java.awt.Color(

2640

# protocolor.getRed(),

2641

# protocolor.getGreen(),

2642

# protocolor.getBlue(),

# alpha);

# }

#

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

2647

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

2648

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

2649

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

2650

# float denominator = 255.0;

2651

# Color.Builder resultBuilder =

2652

# Color

2653

# .newBuilder()

2654

# .setRed(red / denominator)

2655

# .setGreen(green / denominator)

2656

# .setBlue(blue / denominator);

2657

# int alpha = color.getAlpha();

2658

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

2663

# .build());

2664

# }

2665

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

2670

#

2671

# // ...

2672

# static UIColor* fromProto(Color* protocolor) {

2673

# float red = [protocolor red];

2674

# float green = [protocolor green];

2675

# float blue = [protocolor blue];

2676

# FloatValue* alpha_wrapper = [protocolor alpha];

2677

# float alpha = 1.0;

2678

# if (alpha_wrapper != nil) {

2679

# alpha = [alpha_wrapper value];

2680

# }

2681

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

2682

# }

2683

#

2684

# static Color* toProto(UIColor* color) {

2685

# CGFloat red, green, blue, alpha;

2686

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

2687

# return nil;

2688

# }

2689

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

2690

# [result setRed:red];

2691

# [result setGreen:green];

2692

# [result setBlue:blue];

2693

# if (alpha <= 0.9999) {

2694

# [result setAlpha:floatWrapperWithValue(alpha)];

2695

# }

2696

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

2706

# var redFrac = rgb_color.red || 0.0;

2707

# var greenFrac = rgb_color.green || 0.0;

2708

# var blueFrac = rgb_color.blue || 0.0;

2709

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

2710

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

2711

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

2712

#

2713

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

2714

# return rgbToCssColor_(red, green, blue);

2715

# }

2716

#

2717

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

2718

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

2719

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

2720

# };

2721

#

2722

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

2723

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

2724

# var hexString = rgbNumber.toString(16);

2725

# var missingZeros = 6 - hexString.length;

2726

# var resultBuilder = ['#'];

2727

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

2728

# resultBuilder.push('0');

2729

# }

2730

# resultBuilder.push(hexString);

2731

# return resultBuilder.join('');

# };

#

# // ...

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

2736

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

2737

# the final pixel color is defined by the equation:

2738

#

2739

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

2740

#

2741

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

2742

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

2743

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

2744

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

2745

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

2746

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

2747

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

2748

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

2749

},

2750

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

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

[diff] [blame]

2751

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

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

[diff] [blame]

2752

"style": "A String", # The style of the border.

2753

},

2754

"left": { # A border along a cell. # The left border of the cell.

2755

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

2756

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

2757

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

2758

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

2759

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

2760

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

2761

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

2766

#

2767

# // ...

2768

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

2769

# float alpha = protocolor.hasAlpha()

2770

# ? protocolor.getAlpha().getValue()

2771

# : 1.0;

2772

#

2773

# return new java.awt.Color(

2774

# protocolor.getRed(),

2775

# protocolor.getGreen(),

2776

# protocolor.getBlue(),

# alpha);

# }

#

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

2781

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

2782

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

2783

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

2784

# float denominator = 255.0;

2785

# Color.Builder resultBuilder =

2786

# Color

2787

# .newBuilder()

2788

# .setRed(red / denominator)

2789

# .setGreen(green / denominator)

2790

# .setBlue(blue / denominator);

2791

# int alpha = color.getAlpha();

2792

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

2797

# .build());

2798

# }

2799

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

2804

#

2805

# // ...

2806

# static UIColor* fromProto(Color* protocolor) {

2807

# float red = [protocolor red];

2808

# float green = [protocolor green];

2809

# float blue = [protocolor blue];

2810

# FloatValue* alpha_wrapper = [protocolor alpha];

2811

# float alpha = 1.0;

2812

# if (alpha_wrapper != nil) {

2813

# alpha = [alpha_wrapper value];

2814

# }

2815

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

2816

# }

2817

#

2818

# static Color* toProto(UIColor* color) {

2819

# CGFloat red, green, blue, alpha;

2820

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

2821

# return nil;

2822

# }

2823

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

2824

# [result setRed:red];

2825

# [result setGreen:green];

2826

# [result setBlue:blue];

2827

# if (alpha <= 0.9999) {

2828

# [result setAlpha:floatWrapperWithValue(alpha)];

2829

# }

2830

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

2840

# var redFrac = rgb_color.red || 0.0;

2841

# var greenFrac = rgb_color.green || 0.0;

2842

# var blueFrac = rgb_color.blue || 0.0;

2843

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

2844

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

2845

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

2846

#

2847

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

2848

# return rgbToCssColor_(red, green, blue);

2849

# }

2850

#

2851

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

2852

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

2853

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

2854

# };

2855

#

2856

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

2857

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

2858

# var hexString = rgbNumber.toString(16);

2859

# var missingZeros = 6 - hexString.length;

2860

# var resultBuilder = ['#'];

2861

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

2862

# resultBuilder.push('0');

2863

# }

2864

# resultBuilder.push(hexString);

2865

# return resultBuilder.join('');

# };

#

# // ...

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

2870

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

2871

# the final pixel color is defined by the equation:

2872

#

2873

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

2874

#

2875

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

2876

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

2877

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

2878

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

2879

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

2880

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

2881

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

2882

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

2883

},

2884

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

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

[diff] [blame]

2885

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

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

[diff] [blame]

2886

"style": "A String", # The style of the border.

2887

},

2888

},

2889

"wrapStrategy": "A String", # The wrap strategy for the value in the cell.

2890

},

2891

"userEnteredFormat": { # The format of a cell. # The format the user entered for the cell.

2892

#

2893

# When writing, the new format will be merged with the existing format.

2894

"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.

Jon Wayne Parrott

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

[diff] [blame]

2895

"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on

2896

# the user's locale will be used if necessary for the given type.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame^]

2897

# See the [Date and Number Formats guide](/sheets/guides/formats) for more

2898

# information about the supported patterns.

Jon Wayne Parrott

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

[diff] [blame]

2899

"type": "A String", # The type of the number format.

Jon Wayne Parrott

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

[diff] [blame]

2900

# When writing, this field must be set.

Jon Wayne Parrott

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

[diff] [blame]

2901

},

2902

"textDirection": "A String", # The direction of the text in the cell.

2903

"padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.

2904

# When updating padding, every field must be specified.

2905

"top": 42, # The top padding of the cell.

2906

"right": 42, # The right padding of the cell.

2907

"bottom": 42, # The bottom padding of the cell.

2908

"left": 42, # The left padding of the cell.

2909

},

Jon Wayne Parrott

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

[diff] [blame]

2910

"horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.

Jon Wayne Parrott

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

[diff] [blame]

2911

"backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.

2912

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

2913

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

2914

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

2915

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

2916

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

2917

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

2922

#

2923

# // ...

2924

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

2925

# float alpha = protocolor.hasAlpha()

2926

# ? protocolor.getAlpha().getValue()

2927

# : 1.0;

2928

#

2929

# return new java.awt.Color(

2930

# protocolor.getRed(),

2931

# protocolor.getGreen(),

2932

# protocolor.getBlue(),

# alpha);

# }

#

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

2937

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

2938

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

2939

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

2940

# float denominator = 255.0;

2941

# Color.Builder resultBuilder =

2942

# Color

2943

# .newBuilder()

2944

# .setRed(red / denominator)

2945

# .setGreen(green / denominator)

2946

# .setBlue(blue / denominator);

2947

# int alpha = color.getAlpha();

2948

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

2953

# .build());

2954

# }

2955

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

2960

#

2961

# // ...

2962

# static UIColor* fromProto(Color* protocolor) {

2963

# float red = [protocolor red];

2964

# float green = [protocolor green];

2965

# float blue = [protocolor blue];

2966

# FloatValue* alpha_wrapper = [protocolor alpha];

2967

# float alpha = 1.0;

2968

# if (alpha_wrapper != nil) {

2969

# alpha = [alpha_wrapper value];

2970

# }

2971

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

2972

# }

2973

#

2974

# static Color* toProto(UIColor* color) {

2975

# CGFloat red, green, blue, alpha;

2976

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

2977

# return nil;

2978

# }

2979

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

2980

# [result setRed:red];

2981

# [result setGreen:green];

2982

# [result setBlue:blue];

2983

# if (alpha <= 0.9999) {

2984

# [result setAlpha:floatWrapperWithValue(alpha)];

2985

# }

2986

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

2996

# var redFrac = rgb_color.red || 0.0;

2997

# var greenFrac = rgb_color.green || 0.0;

2998

# var blueFrac = rgb_color.blue || 0.0;

2999

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

3000

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

3001

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

3002

#

3003

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

3004

# return rgbToCssColor_(red, green, blue);

3005

# }

3006

#

3007

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

3008

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

3009

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

3010

# };

3011

#

3012

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

3013

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

3014

# var hexString = rgbNumber.toString(16);

3015

# var missingZeros = 6 - hexString.length;

3016

# var resultBuilder = ['#'];

3017

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

3018

# resultBuilder.push('0');

3019

# }

3020

# resultBuilder.push(hexString);

3021

# return resultBuilder.join('');

# };

#

# // ...

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

3026

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

3027

# the final pixel color is defined by the equation:

3028

#

3029

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

3030

#

3031

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

3032

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

3033

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

3034

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

3035

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

3036

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

3037

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

3038

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

3039

},

Jon Wayne Parrott

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

[diff] [blame]

3040

"verticalAlignment": "A String", # The vertical alignment of the value in the cell.

Jon Wayne Parrott

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

[diff] [blame]

3041

"textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).

3042

# Absent values indicate that the field isn't specified.

3043

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

3044

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

3045

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

3046

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

3047

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

3048

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

3049

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

3054

#

3055

# // ...

3056

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

3057

# float alpha = protocolor.hasAlpha()

3058

# ? protocolor.getAlpha().getValue()

3059

# : 1.0;

3060

#

3061

# return new java.awt.Color(

3062

# protocolor.getRed(),

3063

# protocolor.getGreen(),

3064

# protocolor.getBlue(),

# alpha);

# }

#

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

3069

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

3070

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

3071

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

3072

# float denominator = 255.0;

3073

# Color.Builder resultBuilder =

3074

# Color

3075

# .newBuilder()

3076

# .setRed(red / denominator)

3077

# .setGreen(green / denominator)

3078

# .setBlue(blue / denominator);

3079

# int alpha = color.getAlpha();

3080

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

3085

# .build());

3086

# }

3087

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

3092

#

3093

# // ...

3094

# static UIColor* fromProto(Color* protocolor) {

3095

# float red = [protocolor red];

3096

# float green = [protocolor green];

3097

# float blue = [protocolor blue];

3098

# FloatValue* alpha_wrapper = [protocolor alpha];

3099

# float alpha = 1.0;

3100

# if (alpha_wrapper != nil) {

3101

# alpha = [alpha_wrapper value];

3102

# }

3103

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

3104

# }

3105

#

3106

# static Color* toProto(UIColor* color) {

3107

# CGFloat red, green, blue, alpha;

3108

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

3109

# return nil;

3110

# }

3111

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

3112

# [result setRed:red];

3113

# [result setGreen:green];

3114

# [result setBlue:blue];

3115

# if (alpha <= 0.9999) {

3116

# [result setAlpha:floatWrapperWithValue(alpha)];

3117

# }

3118

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

3128

# var redFrac = rgb_color.red || 0.0;

3129

# var greenFrac = rgb_color.green || 0.0;

3130

# var blueFrac = rgb_color.blue || 0.0;

3131

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

3132

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

3133

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

3134

#

3135

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

3136

# return rgbToCssColor_(red, green, blue);

3137

# }

3138

#

3139

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

3140

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

3141

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

3142

# };

3143

#

3144

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

3145

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

3146

# var hexString = rgbNumber.toString(16);

3147

# var missingZeros = 6 - hexString.length;

3148

# var resultBuilder = ['#'];

3149

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

3150

# resultBuilder.push('0');

3151

# }

3152

# resultBuilder.push(hexString);

3153

# return resultBuilder.join('');

# };

#

# // ...

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

3158

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

3159

# the final pixel color is defined by the equation:

3160

#

3161

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

3162

#

3163

# This means that a value of 1.0 corresponds to a solid color, whereas

3164

# a value of 0.0 corresponds to a completely transparent color. This

3165

# uses a wrapper message rather than a simple float scalar so that it is

3166

# possible to distinguish between a default value and the value being unset.

3167

# If omitted, this color object is to be rendered as a solid color

3168

# (as if the alpha value had been explicitly given with a value of 1.0).

3169

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

3170

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

3171

},

3172

"bold": True or False, # True if the text is bold.

3173

"strikethrough": True or False, # True if the text has a strikethrough.

3174

"fontFamily": "A String", # The font family.

3175

"fontSize": 42, # The size of the font.

3176

"italic": True or False, # True if the text is italicized.

3177

"underline": True or False, # True if the text is underlined.

3178

},

3179

"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.

3180

"borders": { # The borders of the cell. # The borders of the cell.

3181

"top": { # A border along a cell. # The top border of the cell.

3182

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

3183

# for simplicity of conversion to/from color representations in various

3184

# languages over compactness; for example, the fields of this representation

3185

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

3186

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

3187

# method in iOS; and, with just a little work, it can be easily formatted into

3188

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

3193

#

3194

# // ...

3195

# public static java.awt.Color fromProto(Color protocolor) {

3196

# float alpha = protocolor.hasAlpha()

3197

# ? protocolor.getAlpha().getValue()

3198

# : 1.0;

3199

#

3200

# return new java.awt.Color(

3201

# protocolor.getRed(),

3202

# protocolor.getGreen(),

3203

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

3208

# float red = (float) color.getRed();

3209

# float green = (float) color.getGreen();

3210

# float blue = (float) color.getBlue();

3211

# float denominator = 255.0;

3212

# Color.Builder resultBuilder =

3213

# Color

3214

# .newBuilder()

3215

# .setRed(red / denominator)

3216

# .setGreen(green / denominator)

3217

# .setBlue(blue / denominator);

3218

# int alpha = color.getAlpha();

3219

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

3224

# .build());

3225

# }

3226

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

3231

#

3232

# // ...

3233

# static UIColor* fromProto(Color* protocolor) {

3234

# float red = [protocolor red];

3235

# float green = [protocolor green];

3236

# float blue = [protocolor blue];

3237

# FloatValue* alpha_wrapper = [protocolor alpha];

3238

# float alpha = 1.0;

3239

# if (alpha_wrapper != nil) {

3240

# alpha = [alpha_wrapper value];

3241

# }

3242

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

3243

# }

3244

#

3245

# static Color* toProto(UIColor* color) {

3246

# CGFloat red, green, blue, alpha;

3247

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

3248

# return nil;

3249

# }

3250

# Color* result = [Color alloc] init];

3251

# [result setRed:red];

3252

# [result setGreen:green];

3253

# [result setBlue:blue];

3254

# if (alpha <= 0.9999) {

3255

# [result setAlpha:floatWrapperWithValue(alpha)];

3256

# }

3257

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

3267

# var redFrac = rgb_color.red || 0.0;

3268

# var greenFrac = rgb_color.green || 0.0;

3269

# var blueFrac = rgb_color.blue || 0.0;

3270

# var red = Math.floor(redFrac * 255);

3271

# var green = Math.floor(greenFrac * 255);

3272

# var blue = Math.floor(blueFrac * 255);

3273

#

3274

# if (!('alpha' in rgb_color)) {

3275

# return rgbToCssColor_(red, green, blue);

3276

# }

3277

#

3278

# var alphaFrac = rgb_color.alpha.value || 0.0;

3279

# var rgbParams = [red, green, blue].join(',');

3280

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

3281

# };

3282

#

3283

# var rgbToCssColor_ = function(red, green, blue) {

3284

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

3285

# var hexString = rgbNumber.toString(16);

3286

# var missingZeros = 6 - hexString.length;

3287

# var resultBuilder = ['#'];

3288

# for (var i = 0; i < missingZeros; i++) {

3289

# resultBuilder.push('0');

3290

# }

3291

# resultBuilder.push(hexString);

3292

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

3297

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

3298

# the final pixel color is defined by the equation:

3299

#

3300

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

3301

#

3302

# This means that a value of 1.0 corresponds to a solid color, whereas

3303

# a value of 0.0 corresponds to a completely transparent color. This

3304

# uses a wrapper message rather than a simple float scalar so that it is

3305

# possible to distinguish between a default value and the value being unset.

3306

# If omitted, this color object is to be rendered as a solid color

3307

# (as if the alpha value had been explicitly given with a value of 1.0).

3308

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

3309

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

3310

},

3311

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3312

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

3313

"style": "A String", # The style of the border.

3314

},

3315

"right": { # A border along a cell. # The right border of the cell.

3316

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

3317

# for simplicity of conversion to/from color representations in various

3318

# languages over compactness; for example, the fields of this representation

3319

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

3320

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

3321

# method in iOS; and, with just a little work, it can be easily formatted into

3322

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

3327

#

3328

# // ...

3329

# public static java.awt.Color fromProto(Color protocolor) {

3330

# float alpha = protocolor.hasAlpha()

3331

# ? protocolor.getAlpha().getValue()

3332

# : 1.0;

3333

#

3334

# return new java.awt.Color(

3335

# protocolor.getRed(),

3336

# protocolor.getGreen(),

3337

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

3342

# float red = (float) color.getRed();

3343

# float green = (float) color.getGreen();

3344

# float blue = (float) color.getBlue();

3345

# float denominator = 255.0;

3346

# Color.Builder resultBuilder =

3347

# Color

3348

# .newBuilder()

3349

# .setRed(red / denominator)

3350

# .setGreen(green / denominator)

3351

# .setBlue(blue / denominator);

3352

# int alpha = color.getAlpha();

3353

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

3358

# .build());

3359

# }

3360

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

3365

#

3366

# // ...

3367

# static UIColor* fromProto(Color* protocolor) {

3368

# float red = [protocolor red];

3369

# float green = [protocolor green];

3370

# float blue = [protocolor blue];

3371

# FloatValue* alpha_wrapper = [protocolor alpha];

3372

# float alpha = 1.0;

3373

# if (alpha_wrapper != nil) {

3374

# alpha = [alpha_wrapper value];

3375

# }

3376

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

3377

# }

3378

#

3379

# static Color* toProto(UIColor* color) {

3380

# CGFloat red, green, blue, alpha;

3381

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

3382

# return nil;

3383

# }

3384

# Color* result = [Color alloc] init];

3385

# [result setRed:red];

3386

# [result setGreen:green];

3387

# [result setBlue:blue];

3388

# if (alpha <= 0.9999) {

3389

# [result setAlpha:floatWrapperWithValue(alpha)];

3390

# }

3391

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

3401

# var redFrac = rgb_color.red || 0.0;

3402

# var greenFrac = rgb_color.green || 0.0;

3403

# var blueFrac = rgb_color.blue || 0.0;

3404

# var red = Math.floor(redFrac * 255);

3405

# var green = Math.floor(greenFrac * 255);

3406

# var blue = Math.floor(blueFrac * 255);

3407

#

3408

# if (!('alpha' in rgb_color)) {

3409

# return rgbToCssColor_(red, green, blue);

3410

# }

3411

#

3412

# var alphaFrac = rgb_color.alpha.value || 0.0;

3413

# var rgbParams = [red, green, blue].join(',');

3414

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

3415

# };

3416

#

3417

# var rgbToCssColor_ = function(red, green, blue) {

3418

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

3419

# var hexString = rgbNumber.toString(16);

3420

# var missingZeros = 6 - hexString.length;

3421

# var resultBuilder = ['#'];

3422

# for (var i = 0; i < missingZeros; i++) {

3423

# resultBuilder.push('0');

3424

# }

3425

# resultBuilder.push(hexString);

3426

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

3431

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

3432

# the final pixel color is defined by the equation:

3433

#

3434

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

3435

#

3436

# This means that a value of 1.0 corresponds to a solid color, whereas

3437

# a value of 0.0 corresponds to a completely transparent color. This

3438

# uses a wrapper message rather than a simple float scalar so that it is

3439

# possible to distinguish between a default value and the value being unset.

3440

# If omitted, this color object is to be rendered as a solid color

3441

# (as if the alpha value had been explicitly given with a value of 1.0).

3442

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

3443

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

3444

},

3445

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3446

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

3447

"style": "A String", # The style of the border.

3448

},

3449

"bottom": { # A border along a cell. # The bottom border of the cell.

3450

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

3451

# for simplicity of conversion to/from color representations in various

3452

# languages over compactness; for example, the fields of this representation

3453

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

3454

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

3455

# method in iOS; and, with just a little work, it can be easily formatted into

3456

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

3461

#

3462

# // ...

3463

# public static java.awt.Color fromProto(Color protocolor) {

3464

# float alpha = protocolor.hasAlpha()

3465

# ? protocolor.getAlpha().getValue()

3466

# : 1.0;

3467

#

3468

# return new java.awt.Color(

3469

# protocolor.getRed(),

3470

# protocolor.getGreen(),

3471

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

3476

# float red = (float) color.getRed();

3477

# float green = (float) color.getGreen();

3478

# float blue = (float) color.getBlue();

3479

# float denominator = 255.0;

3480

# Color.Builder resultBuilder =

3481

# Color

3482

# .newBuilder()

3483

# .setRed(red / denominator)

3484

# .setGreen(green / denominator)

3485

# .setBlue(blue / denominator);

3486

# int alpha = color.getAlpha();

3487

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

3492

# .build());

3493

# }

3494

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

3499

#

3500

# // ...

3501

# static UIColor* fromProto(Color* protocolor) {

3502

# float red = [protocolor red];

3503

# float green = [protocolor green];

3504

# float blue = [protocolor blue];

3505

# FloatValue* alpha_wrapper = [protocolor alpha];

3506

# float alpha = 1.0;

3507

# if (alpha_wrapper != nil) {

3508

# alpha = [alpha_wrapper value];

3509

# }

3510

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

3511

# }

3512

#

3513

# static Color* toProto(UIColor* color) {

3514

# CGFloat red, green, blue, alpha;

3515

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

3516

# return nil;

3517

# }

3518

# Color* result = [Color alloc] init];

3519

# [result setRed:red];

3520

# [result setGreen:green];

3521

# [result setBlue:blue];

3522

# if (alpha <= 0.9999) {

3523

# [result setAlpha:floatWrapperWithValue(alpha)];

3524

# }

3525

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

3535

# var redFrac = rgb_color.red || 0.0;

3536

# var greenFrac = rgb_color.green || 0.0;

3537

# var blueFrac = rgb_color.blue || 0.0;

3538

# var red = Math.floor(redFrac * 255);

3539

# var green = Math.floor(greenFrac * 255);

3540

# var blue = Math.floor(blueFrac * 255);

3541

#

3542

# if (!('alpha' in rgb_color)) {

3543

# return rgbToCssColor_(red, green, blue);

3544

# }

3545

#

3546

# var alphaFrac = rgb_color.alpha.value || 0.0;

3547

# var rgbParams = [red, green, blue].join(',');

3548

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

3549

# };

3550

#

3551

# var rgbToCssColor_ = function(red, green, blue) {

3552

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

3553

# var hexString = rgbNumber.toString(16);

3554

# var missingZeros = 6 - hexString.length;

3555

# var resultBuilder = ['#'];

3556

# for (var i = 0; i < missingZeros; i++) {

3557

# resultBuilder.push('0');

3558

# }

3559

# resultBuilder.push(hexString);

3560

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

3565

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

3566

# the final pixel color is defined by the equation:

3567

#

3568

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

3569

#

3570

# This means that a value of 1.0 corresponds to a solid color, whereas

3571

# a value of 0.0 corresponds to a completely transparent color. This

3572

# uses a wrapper message rather than a simple float scalar so that it is

3573

# possible to distinguish between a default value and the value being unset.

3574

# If omitted, this color object is to be rendered as a solid color

3575

# (as if the alpha value had been explicitly given with a value of 1.0).

3576

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

3577

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

3578

},

3579

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3580

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

3581

"style": "A String", # The style of the border.

3582

},

3583

"left": { # A border along a cell. # The left border of the cell.

3584

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

3585

# for simplicity of conversion to/from color representations in various

3586

# languages over compactness; for example, the fields of this representation

3587

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

3588

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

3589

# method in iOS; and, with just a little work, it can be easily formatted into

3590

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

3595

#

3596

# // ...

3597

# public static java.awt.Color fromProto(Color protocolor) {

3598

# float alpha = protocolor.hasAlpha()

3599

# ? protocolor.getAlpha().getValue()

3600

# : 1.0;

3601

#

3602

# return new java.awt.Color(

3603

# protocolor.getRed(),

3604

# protocolor.getGreen(),

3605

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

3610

# float red = (float) color.getRed();

3611

# float green = (float) color.getGreen();

3612

# float blue = (float) color.getBlue();

3613

# float denominator = 255.0;

3614

# Color.Builder resultBuilder =

3615

# Color

3616

# .newBuilder()

3617

# .setRed(red / denominator)

3618

# .setGreen(green / denominator)

3619

# .setBlue(blue / denominator);

3620

# int alpha = color.getAlpha();

3621

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

3626

# .build());

3627

# }

3628

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

3633

#

3634

# // ...

3635

# static UIColor* fromProto(Color* protocolor) {

3636

# float red = [protocolor red];

3637

# float green = [protocolor green];

3638

# float blue = [protocolor blue];

3639

# FloatValue* alpha_wrapper = [protocolor alpha];

3640

# float alpha = 1.0;

3641

# if (alpha_wrapper != nil) {

3642

# alpha = [alpha_wrapper value];

3643

# }

3644

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

3645

# }

3646

#

3647

# static Color* toProto(UIColor* color) {

3648

# CGFloat red, green, blue, alpha;

3649

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

3650

# return nil;

3651

# }

3652

# Color* result = [Color alloc] init];

3653

# [result setRed:red];

3654

# [result setGreen:green];

3655

# [result setBlue:blue];

3656

# if (alpha <= 0.9999) {

3657

# [result setAlpha:floatWrapperWithValue(alpha)];

3658

# }

3659

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

3669

# var redFrac = rgb_color.red || 0.0;

3670

# var greenFrac = rgb_color.green || 0.0;

3671

# var blueFrac = rgb_color.blue || 0.0;

3672

# var red = Math.floor(redFrac * 255);

3673

# var green = Math.floor(greenFrac * 255);

3674

# var blue = Math.floor(blueFrac * 255);

3675

#

3676

# if (!('alpha' in rgb_color)) {

3677

# return rgbToCssColor_(red, green, blue);

3678

# }

3679

#

3680

# var alphaFrac = rgb_color.alpha.value || 0.0;

3681

# var rgbParams = [red, green, blue].join(',');

3682

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

3683

# };

3684

#

3685

# var rgbToCssColor_ = function(red, green, blue) {

3686

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

3687

# var hexString = rgbNumber.toString(16);

3688

# var missingZeros = 6 - hexString.length;

3689

# var resultBuilder = ['#'];

3690

# for (var i = 0; i < missingZeros; i++) {

3691

# resultBuilder.push('0');

3692

# }

3693

# resultBuilder.push(hexString);

3694

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

3699

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

3700

# the final pixel color is defined by the equation:

3701

#

3702

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

3703

#

3704

# This means that a value of 1.0 corresponds to a solid color, whereas

3705

# a value of 0.0 corresponds to a completely transparent color. This

3706

# uses a wrapper message rather than a simple float scalar so that it is

3707

# possible to distinguish between a default value and the value being unset.

3708

# If omitted, this color object is to be rendered as a solid color

3709

# (as if the alpha value had been explicitly given with a value of 1.0).

3710

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

3711

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

3712

},

3713

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3714

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

3715

"style": "A String", # The style of the border.

3716

},

3717

},

3718

"wrapStrategy": "A String", # The wrap strategy for the value in the cell.

3719

},

3720

"dataValidation": { # A data validation rule. # A data validation rule on the cell, if any.

3721

#

3722

# When writing, the new data validation rule will overwrite any prior rule.

3723

"showCustomUi": True or False, # True if the UI should be customized based on the kind of condition.

3724

# If true, "List" conditions will show a dropdown.

3725

"strict": True or False, # True if invalid data should be rejected.

3726

"inputMessage": "A String", # A message to show the user when adding data to the cell.

3727

"condition": { # A condition that can evaluate to true or false. # The condition that data in the cell must match.

3728

# BooleanConditions are used by conditional formatting,

3729

# data validation, and the criteria in filters.

3730

"type": "A String", # The type of condition.

3731

"values": [ # The values of the condition. The number of supported values depends

3732

# on the condition type. Some support zero values,

3733

# others one or two values,

3734

# and ConditionType.ONE_OF_LIST supports an arbitrary number of values.

3735

{ # The value of the condition.

3736

"relativeDate": "A String", # A relative date (based on the current date).

3737

# Valid only if the type is

3738

# DATE_BEFORE,

3739

# DATE_AFTER,

3740

# DATE_ON_OR_BEFORE or

3741

# DATE_ON_OR_AFTER.

3742

#

3743

# Relative dates are not supported in data validation.

3744

# They are supported only in conditional formatting and

3745

# conditional filters.

3746

"userEnteredValue": "A String", # A value the condition is based on.

3747

# The value will be parsed as if the user typed into a cell.

3748

# Formulas are supported (and must begin with an `=`).

},

],

},

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3753

"textFormatRuns": [ # Runs of rich text applied to subsections of the cell. Runs are only valid

3754

# on user entered strings, not formulas, bools, or numbers.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

3755

# Runs start at specific indexes in the text and continue until the next

3756

# run. Properties of a run will continue unless explicitly changed

3757

# in a subsequent run (and properties of the first run will continue

3758

# the properties of the cell unless explicitly changed).

3759

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3760

# When writing, the new runs will overwrite any prior runs. When writing a

3761

# new user_entered_value, previous runs will be erased.

3762

{ # A run of a text format. The format of this run continues until the start

3763

# index of the next run.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

3764

# When updating, all fields must be set.

3765

"startIndex": 42, # The character index where this run starts.

3766

"format": { # The format of a run of text in a cell. # The format of this run. Absent values inherit the cell's format.

3767

# Absent values indicate that the field isn't specified.

3768

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

3769

# for simplicity of conversion to/from color representations in various

3770

# languages over compactness; for example, the fields of this representation

3771

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

3772

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

3773

# method in iOS; and, with just a little work, it can be easily formatted into

3774

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

3779

#

3780

# // ...

3781

# public static java.awt.Color fromProto(Color protocolor) {

3782

# float alpha = protocolor.hasAlpha()

3783

# ? protocolor.getAlpha().getValue()

3784

# : 1.0;

3785

#

3786

# return new java.awt.Color(

3787

# protocolor.getRed(),

3788

# protocolor.getGreen(),

3789

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

3794

# float red = (float) color.getRed();

3795

# float green = (float) color.getGreen();

3796

# float blue = (float) color.getBlue();

3797

# float denominator = 255.0;

3798

# Color.Builder resultBuilder =

3799

# Color

3800

# .newBuilder()

3801

# .setRed(red / denominator)

3802

# .setGreen(green / denominator)

3803

# .setBlue(blue / denominator);

3804

# int alpha = color.getAlpha();

3805

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

3810

# .build());

3811

# }

3812

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

3817

#

3818

# // ...

3819

# static UIColor* fromProto(Color* protocolor) {

3820

# float red = [protocolor red];

3821

# float green = [protocolor green];

3822

# float blue = [protocolor blue];

3823

# FloatValue* alpha_wrapper = [protocolor alpha];

3824

# float alpha = 1.0;

3825

# if (alpha_wrapper != nil) {

3826

# alpha = [alpha_wrapper value];

3827

# }

3828

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

3829

# }

3830

#

3831

# static Color* toProto(UIColor* color) {

3832

# CGFloat red, green, blue, alpha;

3833

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

3834

# return nil;

3835

# }

3836

# Color* result = [Color alloc] init];

3837

# [result setRed:red];

3838

# [result setGreen:green];

3839

# [result setBlue:blue];

3840

# if (alpha <= 0.9999) {

3841

# [result setAlpha:floatWrapperWithValue(alpha)];

3842

# }

3843

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

3853

# var redFrac = rgb_color.red || 0.0;

3854

# var greenFrac = rgb_color.green || 0.0;

3855

# var blueFrac = rgb_color.blue || 0.0;

3856

# var red = Math.floor(redFrac * 255);

3857

# var green = Math.floor(greenFrac * 255);

3858

# var blue = Math.floor(blueFrac * 255);

3859

#

3860

# if (!('alpha' in rgb_color)) {

3861

# return rgbToCssColor_(red, green, blue);

3862

# }

3863

#

3864

# var alphaFrac = rgb_color.alpha.value || 0.0;

3865

# var rgbParams = [red, green, blue].join(',');

3866

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

3867

# };

3868

#

3869

# var rgbToCssColor_ = function(red, green, blue) {

3870

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

3871

# var hexString = rgbNumber.toString(16);

3872

# var missingZeros = 6 - hexString.length;

3873

# var resultBuilder = ['#'];

3874

# for (var i = 0; i < missingZeros; i++) {

3875

# resultBuilder.push('0');

3876

# }

3877

# resultBuilder.push(hexString);

3878

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

3883

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

3884

# the final pixel color is defined by the equation:

3885

#

3886

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

3887

#

3888

# This means that a value of 1.0 corresponds to a solid color, whereas

3889

# a value of 0.0 corresponds to a completely transparent color. This

3890

# uses a wrapper message rather than a simple float scalar so that it is

3891

# possible to distinguish between a default value and the value being unset.

3892

# If omitted, this color object is to be rendered as a solid color

3893

# (as if the alpha value had been explicitly given with a value of 1.0).

3894

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

3895

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

3896

},

3897

"bold": True or False, # True if the text is bold.

3898

"strikethrough": True or False, # True if the text has a strikethrough.

3899

"fontFamily": "A String", # The font family.

3900

"fontSize": 42, # The size of the font.

3901

"italic": True or False, # True if the text is italicized.

3902

"underline": True or False, # True if the text is underlined.

},

},

],

},

],

},

],

"sheetId": 42, # The sheet ID to append the data to.

3911

},

3912

"duplicateSheet": { # Duplicates the contents of a sheet. # Duplicates a sheet.

3913

"sourceSheetId": 42, # The sheet to duplicate.

3914

"insertSheetIndex": 42, # The zero-based index where the new sheet should be inserted.

3915

# The index of all sheets after this are incremented.

3916

"newSheetName": "A String", # The name of the new sheet. If empty, a new name is chosen for you.

3917

"newSheetId": 42, # If set, the ID of the new sheet. If not set, an ID is chosen.

3918

# If set, the ID must not conflict with any existing sheet ID.

3919

# If set, it must be non-negative.

3920

},

3921

"updateSheetProperties": { # Updates properties of the sheet with the specified # Updates a sheet's properties.

3922

# sheetId.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

3923

"fields": "A String", # The fields that should be updated. At least one field must be specified.

3924

# The root `properties` is implied and should not be specified.

3925

# A single `"*"` can be used as short-hand for listing every field.

3926

"properties": { # Properties of a sheet. # The properties to update.

3927

"sheetType": "A String", # The type of sheet. Defaults to GRID.

3928

# This field cannot be changed once set.

3929

"index": 42, # The index of the sheet within the spreadsheet.

3930

# When adding or updating sheet properties, if this field

3931

# is excluded then the sheet will be added or moved to the end

3932

# of the sheet list.

3933

"title": "A String", # The name of the sheet.

3934

"gridProperties": { # Properties of a grid. # Additional properties of the sheet if this sheet is a grid.

3935

# (If the sheet is an object sheet, containing a chart or image, then

3936

# this field will be absent.)

3937

# When writing it is an error to set any grid properties on non-grid sheets.

3938

"columnCount": 42, # The number of columns in the grid.

3939

"rowCount": 42, # The number of rows in the grid.

3940

"frozenColumnCount": 42, # The number of columns that are frozen in the grid.

3941

"hideGridlines": True or False, # True if the grid isn't showing gridlines in the UI.

3942

"frozenRowCount": 42, # The number of rows that are frozen in the grid.

3943

},

3944

"rightToLeft": True or False, # True if the sheet is an RTL sheet instead of an LTR sheet.

3945

"tabColor": { # Represents a color in the RGBA color space. This representation is designed # The color of the tab in the UI.

3946

# for simplicity of conversion to/from color representations in various

3947

# languages over compactness; for example, the fields of this representation

3948

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

3949

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

3950

# method in iOS; and, with just a little work, it can be easily formatted into

3951

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

3956

#

3957

# // ...

3958

# public static java.awt.Color fromProto(Color protocolor) {

3959

# float alpha = protocolor.hasAlpha()

3960

# ? protocolor.getAlpha().getValue()

3961

# : 1.0;

3962

#

3963

# return new java.awt.Color(

3964

# protocolor.getRed(),

3965

# protocolor.getGreen(),

3966

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

3971

# float red = (float) color.getRed();

3972

# float green = (float) color.getGreen();

3973

# float blue = (float) color.getBlue();

3974

# float denominator = 255.0;

3975

# Color.Builder resultBuilder =

3976

# Color

3977

# .newBuilder()

3978

# .setRed(red / denominator)

3979

# .setGreen(green / denominator)

3980

# .setBlue(blue / denominator);

3981

# int alpha = color.getAlpha();

3982

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

3987

# .build());

3988

# }

3989

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

3994

#

3995

# // ...

3996

# static UIColor* fromProto(Color* protocolor) {

3997

# float red = [protocolor red];

3998

# float green = [protocolor green];

3999

# float blue = [protocolor blue];

4000

# FloatValue* alpha_wrapper = [protocolor alpha];

4001

# float alpha = 1.0;

4002

# if (alpha_wrapper != nil) {

4003

# alpha = [alpha_wrapper value];

4004

# }

4005

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

4006

# }

4007

#

4008

# static Color* toProto(UIColor* color) {

4009

# CGFloat red, green, blue, alpha;

4010

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

4011

# return nil;

4012

# }

4013

# Color* result = [Color alloc] init];

4014

# [result setRed:red];

4015

# [result setGreen:green];

4016

# [result setBlue:blue];

4017

# if (alpha <= 0.9999) {

4018

# [result setAlpha:floatWrapperWithValue(alpha)];

4019

# }

4020

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

4030

# var redFrac = rgb_color.red || 0.0;

4031

# var greenFrac = rgb_color.green || 0.0;

4032

# var blueFrac = rgb_color.blue || 0.0;

4033

# var red = Math.floor(redFrac * 255);

4034

# var green = Math.floor(greenFrac * 255);

4035

# var blue = Math.floor(blueFrac * 255);

4036

#

4037

# if (!('alpha' in rgb_color)) {

4038

# return rgbToCssColor_(red, green, blue);

4039

# }

4040

#

4041

# var alphaFrac = rgb_color.alpha.value || 0.0;

4042

# var rgbParams = [red, green, blue].join(',');

4043

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

4044

# };

4045

#

4046

# var rgbToCssColor_ = function(red, green, blue) {

4047

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

4048

# var hexString = rgbNumber.toString(16);

4049

# var missingZeros = 6 - hexString.length;

4050

# var resultBuilder = ['#'];

4051

# for (var i = 0; i < missingZeros; i++) {

4052

# resultBuilder.push('0');

4053

# }

4054

# resultBuilder.push(hexString);

4055

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

4060

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

4061

# the final pixel color is defined by the equation:

4062

#

4063

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

4064

#

4065

# This means that a value of 1.0 corresponds to a solid color, whereas

4066

# a value of 0.0 corresponds to a completely transparent color. This

4067

# uses a wrapper message rather than a simple float scalar so that it is

4068

# possible to distinguish between a default value and the value being unset.

4069

# If omitted, this color object is to be rendered as a solid color

4070

# (as if the alpha value had been explicitly given with a value of 1.0).

4071

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

4072

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

4073

},

4074

"hidden": True or False, # True if the sheet is hidden in the UI, false if it's visible.

4075

"sheetId": 42, # The ID of the sheet. Must be non-negative.

4076

# This field cannot be changed once set.

4077

},

4078

},

4079

"addChart": { # Adds a chart to a sheet in the spreadsheet. # Adds a chart.

4080

"chart": { # A chart embedded in a sheet. # The chart that should be added to the spreadsheet, including the position

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4081

# where it should be placed. The chartId

4082

# field is optional; if one is not set, an id will be randomly generated. (It

4083

# is an error to specify the ID of a chart that already exists.)

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4084

"chartId": 42, # The ID of the chart.

4085

"position": { # The position of an embedded object such as a chart. # The position of the chart.

4086

"newSheet": True or False, # If true, the embedded object will be put on a new sheet whose ID

4087

# is chosen for you. Used only when writing.

4088

"sheetId": 42, # The sheet this is on. Set only if the embedded object

4089

# is on its own sheet. Must be non-negative.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4090

"overlayPosition": { # The location an object is overlaid on top of a grid. # The position at which the object is overlaid on top of a grid.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4091

"anchorCell": { # A coordinate in a sheet. # The cell the object is anchored to.

4092

# All indexes are zero-based.

4093

"rowIndex": 42, # The row index of the coordinate.

4094

"columnIndex": 42, # The column index of the coordinate.

4095

"sheetId": 42, # The sheet this coordinate is on.

4096

},

4097

"offsetYPixels": 42, # The vertical offset, in pixels, that the object is offset

4098

# from the anchor cell.

4099

"widthPixels": 42, # The width of the object, in pixels. Defaults to 600.

4100

"offsetXPixels": 42, # The horizontal offset, in pixels, that the object is offset

4101

# from the anchor cell.

4102

"heightPixels": 42, # The height of the object, in pixels. Defaults to 371.

4103

},

4104

},

4105

"spec": { # The specifications of a chart. # The specification of the chart.

4106

"hiddenDimensionStrategy": "A String", # Determines how the charts will use hidden rows or columns.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4107

"pieChart": { # A <a href="/chart/interactive/docs/gallery/piechart">pie chart</a>. # A pie chart specification.

4108

"series": { # The data included in a domain or series. # The data that covers the one and only series of the pie chart.

4109

"sourceRange": { # Source ranges for a chart. # The source ranges of the data.

4110

"sources": [ # The ranges of data for a series or domain.

4111

# Exactly one dimension must have a length of 1,

4112

# and all sources in the list must have the same dimension

4113

# with length 1.

4114

# The domain (if it exists) & all series must have the same number

4115

# of source ranges. If using more than one source range, then the source

4116

# range at a given offset must be contiguous across the domain and series.

4117

#

4118

# For example, these are valid configurations:

4119

#

4120

# domain sources: A1:A5

4121

# series1 sources: B1:B5

4122

# series2 sources: D6:D10

4123

#

4124

# domain sources: A1:A5, C10:C12

4125

# series1 sources: B1:B5, D10:D12

4126

# series2 sources: C1:C5, E10:E12

4127

{ # A range on a sheet.

4128

# All indexes are zero-based.

4129

# Indexes are half open, e.g the start index is inclusive

4130

# and the end index is exclusive -- [start_index, end_index).

4131

# Missing indexes indicate the range is unbounded on that side.

4132

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4133

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4134

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4135

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4136

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4137

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4138

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4139

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4140

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4141

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4142

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4143

# `Sheet1!A:B == sheet_id: 0,

4144

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4145

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4146

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4147

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4148

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4149

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4150

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4151

#

4152

# The start index must always be less than or equal to the end index.

4153

# If the start index equals the end index, then the range is empty.

4154

# Empty ranges are typically not meaningful and are usually rendered in the

4155

# UI as `#REF!`.

4156

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

4157

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

4158

"sheetId": 42, # The sheet this range is on.

4159

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

4160

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

],

},

},

"domain": { # The data included in a domain or series. # The data that covers the domain of the pie chart.

4166

"sourceRange": { # Source ranges for a chart. # The source ranges of the data.

4167

"sources": [ # The ranges of data for a series or domain.

4168

# Exactly one dimension must have a length of 1,

4169

# and all sources in the list must have the same dimension

4170

# with length 1.

4171

# The domain (if it exists) & all series must have the same number

4172

# of source ranges. If using more than one source range, then the source

4173

# range at a given offset must be contiguous across the domain and series.

4174

#

4175

# For example, these are valid configurations:

4176

#

4177

# domain sources: A1:A5

4178

# series1 sources: B1:B5

4179

# series2 sources: D6:D10

4180

#

4181

# domain sources: A1:A5, C10:C12

4182

# series1 sources: B1:B5, D10:D12

4183

# series2 sources: C1:C5, E10:E12

4184

{ # A range on a sheet.

4185

# All indexes are zero-based.

4186

# Indexes are half open, e.g the start index is inclusive

4187

# and the end index is exclusive -- [start_index, end_index).

4188

# Missing indexes indicate the range is unbounded on that side.

4189

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4190

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4191

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4192

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4193

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4194

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4195

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4196

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4197

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4198

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4199

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4200

# `Sheet1!A:B == sheet_id: 0,

4201

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4202

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4203

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4204

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4205

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4206

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4207

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4208

#

4209

# The start index must always be less than or equal to the end index.

4210

# If the start index equals the end index, then the range is empty.

4211

# Empty ranges are typically not meaningful and are usually rendered in the

4212

# UI as `#REF!`.

4213

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

4214

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

4215

"sheetId": 42, # The sheet this range is on.

4216

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

4217

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

],

},

},

"threeDimensional": True or False, # True if the pie is three dimensional.

4223

"legendPosition": "A String", # Where the legend of the pie chart should be drawn.

4224

"pieHole": 3.14, # The size of the hole in the pie chart.

4225

},

4226

"basicChart": { # The specification for a basic chart. See BasicChartType for the list # A basic chart specification, can be one of many kinds of charts.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4227

# See BasicChartType for the list of all

4228

# charts this supports.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4229

# of charts this supports.

4230

"headerCount": 42, # The number of rows or columns in the data that are "headers".

4231

# If not set, Google Sheets will guess how many rows are headers based

4232

# on the data.

4233

#

4234

# (Note that BasicChartAxis.title may override the axis title

4235

# inferred from the header values.)

4236

"series": [ # The data this chart is visualizing.

4237

{ # A single series of data in a chart.

4238

# For example, if charting stock prices over time, multiple series may exist,

4239

# one for the "Open Price", "High Price", "Low Price" and "Close Price".

4240

"series": { # The data included in a domain or series. # The data being visualized in this chart series.

4241

"sourceRange": { # Source ranges for a chart. # The source ranges of the data.

4242

"sources": [ # The ranges of data for a series or domain.

4243

# Exactly one dimension must have a length of 1,

4244

# and all sources in the list must have the same dimension

4245

# with length 1.

4246

# The domain (if it exists) & all series must have the same number

4247

# of source ranges. If using more than one source range, then the source

4248

# range at a given offset must be contiguous across the domain and series.

4249

#

4250

# For example, these are valid configurations:

4251

#

4252

# domain sources: A1:A5

4253

# series1 sources: B1:B5

4254

# series2 sources: D6:D10

4255

#

4256

# domain sources: A1:A5, C10:C12

4257

# series1 sources: B1:B5, D10:D12

4258

# series2 sources: C1:C5, E10:E12

4259

{ # A range on a sheet.

4260

# All indexes are zero-based.

4261

# Indexes are half open, e.g the start index is inclusive

4262

# and the end index is exclusive -- [start_index, end_index).

4263

# Missing indexes indicate the range is unbounded on that side.

4264

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4265

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4266

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4267

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4268

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4269

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4270

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4271

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4272

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4273

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4274

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4275

# `Sheet1!A:B == sheet_id: 0,

4276

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4277

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4278

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4279

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4280

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4281

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4282

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4283

#

4284

# The start index must always be less than or equal to the end index.

4285

# If the start index equals the end index, then the range is empty.

4286

# Empty ranges are typically not meaningful and are usually rendered in the

4287

# UI as `#REF!`.

4288

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

4289

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

4290

"sheetId": 42, # The sheet this range is on.

4291

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

4292

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

],

},

},

"targetAxis": "A String", # The minor axis that will specify the range of values for this series.

4298

# For example, if charting stocks over time, the "Volume" series

4299

# may want to be pinned to the right with the prices pinned to the left,

4300

# because the scale of trading volume is different than the scale of

4301

# prices.

4302

# It is an error to specify an axis that isn't a valid minor axis

4303

# for the chart's type.

4304

"type": "A String", # The type of this series. Valid only if the

4305

# chartType is

4306

# COMBO.

4307

# Different types will change the way the series is visualized.

4308

# Only LINE, AREA,

4309

# and COLUMN are supported.

4310

},

4311

],

4312

"legendPosition": "A String", # The position of the chart legend.

4313

"domains": [ # The domain of data this is charting.

4314

# Only a single domain is currently supported.

4315

{ # The domain of a chart.

4316

# For example, if charting stock prices over time, this would be the date.

4317

"domain": { # The data included in a domain or series. # The data of the domain. For example, if charting stock prices over time,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4318

# this is the data representing the dates.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4319

"sourceRange": { # Source ranges for a chart. # The source ranges of the data.

4320

"sources": [ # The ranges of data for a series or domain.

4321

# Exactly one dimension must have a length of 1,

4322

# and all sources in the list must have the same dimension

4323

# with length 1.

4324

# The domain (if it exists) & all series must have the same number

4325

# of source ranges. If using more than one source range, then the source

4326

# range at a given offset must be contiguous across the domain and series.

4327

#

4328

# For example, these are valid configurations:

4329

#

4330

# domain sources: A1:A5

4331

# series1 sources: B1:B5

4332

# series2 sources: D6:D10

4333

#

4334

# domain sources: A1:A5, C10:C12

4335

# series1 sources: B1:B5, D10:D12

4336

# series2 sources: C1:C5, E10:E12

4337

{ # A range on a sheet.

4338

# All indexes are zero-based.

4339

# Indexes are half open, e.g the start index is inclusive

4340

# and the end index is exclusive -- [start_index, end_index).

4341

# Missing indexes indicate the range is unbounded on that side.

4342

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4343

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4344

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4345

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4346

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4347

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4348

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4349

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4350

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4351

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4352

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4353

# `Sheet1!A:B == sheet_id: 0,

4354

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4355

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4356

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4357

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4358

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4359

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4360

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4361

#

4362

# The start index must always be less than or equal to the end index.

4363

# If the start index equals the end index, then the range is empty.

4364

# Empty ranges are typically not meaningful and are usually rendered in the

4365

# UI as `#REF!`.

4366

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

4367

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

4368

"sheetId": 42, # The sheet this range is on.

4369

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

4370

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

],

},

},

},

],

"chartType": "A String", # The type of the chart.

4378

"axis": [ # The axis on the chart.

4379

{ # An axis of the chart.

4380

# A chart may not have more than one axis per

4381

# axis position.

4382

"position": "A String", # The position of this axis.

4383

"format": { # The format of a run of text in a cell. # The format of the title.

4384

# Only valid if the axis is not associated with the domain.

4385

# Absent values indicate that the field isn't specified.

4386

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

4387

# for simplicity of conversion to/from color representations in various

4388

# languages over compactness; for example, the fields of this representation

4389

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

4390

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

4391

# method in iOS; and, with just a little work, it can be easily formatted into

4392

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

4397

#

4398

# // ...

4399

# public static java.awt.Color fromProto(Color protocolor) {

4400

# float alpha = protocolor.hasAlpha()

4401

# ? protocolor.getAlpha().getValue()

4402

# : 1.0;

4403

#

4404

# return new java.awt.Color(

4405

# protocolor.getRed(),

4406

# protocolor.getGreen(),

4407

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

4412

# float red = (float) color.getRed();

4413

# float green = (float) color.getGreen();

4414

# float blue = (float) color.getBlue();

4415

# float denominator = 255.0;

4416

# Color.Builder resultBuilder =

4417

# Color

4418

# .newBuilder()

4419

# .setRed(red / denominator)

4420

# .setGreen(green / denominator)

4421

# .setBlue(blue / denominator);

4422

# int alpha = color.getAlpha();

4423

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

4428

# .build());

4429

# }

4430

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

4435

#

4436

# // ...

4437

# static UIColor* fromProto(Color* protocolor) {

4438

# float red = [protocolor red];

4439

# float green = [protocolor green];

4440

# float blue = [protocolor blue];

4441

# FloatValue* alpha_wrapper = [protocolor alpha];

4442

# float alpha = 1.0;

4443

# if (alpha_wrapper != nil) {

4444

# alpha = [alpha_wrapper value];

4445

# }

4446

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

4447

# }

4448

#

4449

# static Color* toProto(UIColor* color) {

4450

# CGFloat red, green, blue, alpha;

4451

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

4452

# return nil;

4453

# }

4454

# Color* result = [Color alloc] init];

4455

# [result setRed:red];

4456

# [result setGreen:green];

4457

# [result setBlue:blue];

4458

# if (alpha <= 0.9999) {

4459

# [result setAlpha:floatWrapperWithValue(alpha)];

4460

# }

4461

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

4471

# var redFrac = rgb_color.red || 0.0;

4472

# var greenFrac = rgb_color.green || 0.0;

4473

# var blueFrac = rgb_color.blue || 0.0;

4474

# var red = Math.floor(redFrac * 255);

4475

# var green = Math.floor(greenFrac * 255);

4476

# var blue = Math.floor(blueFrac * 255);

4477

#

4478

# if (!('alpha' in rgb_color)) {

4479

# return rgbToCssColor_(red, green, blue);

4480

# }

4481

#

4482

# var alphaFrac = rgb_color.alpha.value || 0.0;

4483

# var rgbParams = [red, green, blue].join(',');

4484

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

4485

# };

4486

#

4487

# var rgbToCssColor_ = function(red, green, blue) {

4488

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

4489

# var hexString = rgbNumber.toString(16);

4490

# var missingZeros = 6 - hexString.length;

4491

# var resultBuilder = ['#'];

4492

# for (var i = 0; i < missingZeros; i++) {

4493

# resultBuilder.push('0');

4494

# }

4495

# resultBuilder.push(hexString);

4496

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

4501

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

4502

# the final pixel color is defined by the equation:

4503

#

4504

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

4505

#

4506

# This means that a value of 1.0 corresponds to a solid color, whereas

4507

# a value of 0.0 corresponds to a completely transparent color. This

4508

# uses a wrapper message rather than a simple float scalar so that it is

4509

# possible to distinguish between a default value and the value being unset.

4510

# If omitted, this color object is to be rendered as a solid color

4511

# (as if the alpha value had been explicitly given with a value of 1.0).

4512

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

4513

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

4514

},

4515

"bold": True or False, # True if the text is bold.

4516

"strikethrough": True or False, # True if the text has a strikethrough.

4517

"fontFamily": "A String", # The font family.

4518

"fontSize": 42, # The size of the font.

4519

"italic": True or False, # True if the text is italicized.

4520

"underline": True or False, # True if the text is underlined.

4521

},

4522

"title": "A String", # The title of this axis. If set, this overrides any title inferred

4523

# from headers of the data.

},

],

},

"title": "A String", # The title of the chart.

},

},

},

"addConditionalFormatRule": { # Adds a new conditional format rule at the given index. # Adds a new conditional format rule.

4532

# All subsequent rules' indexes are incremented.

4533

"index": 42, # The zero-based index where the rule should be inserted.

4534

"rule": { # A rule describing a conditional format. # The rule to add.

4535

"ranges": [ # The ranges that will be formatted if the condition is true.

4536

# All the ranges must be on the same grid.

4537

{ # A range on a sheet.

4538

# All indexes are zero-based.

4539

# Indexes are half open, e.g the start index is inclusive

4540

# and the end index is exclusive -- [start_index, end_index).

4541

# Missing indexes indicate the range is unbounded on that side.

4542

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4543

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4544

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4545

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4546

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4547

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4548

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4549

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4550

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4551

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4552

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4553

# `Sheet1!A:B == sheet_id: 0,

4554

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4555

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4556

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4557

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4558

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4559

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4560

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4561

#

4562

# The start index must always be less than or equal to the end index.

4563

# If the start index equals the end index, then the range is empty.

4564

# Empty ranges are typically not meaningful and are usually rendered in the

4565

# UI as `#REF!`.

4566

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

4567

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

4568

"sheetId": 42, # The sheet this range is on.

4569

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

4570

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

4571

},

4572

],

4573

"booleanRule": { # A rule that may or may not match, depending on the condition. # The formatting is either "on" or "off" according to the rule.

4574

"condition": { # A condition that can evaluate to true or false. # The condition of the rule. If the condition evaluates to true,

4575

# the format will be applied.

4576

# BooleanConditions are used by conditional formatting,

4577

# data validation, and the criteria in filters.

4578

"type": "A String", # The type of condition.

4579

"values": [ # The values of the condition. The number of supported values depends

4580

# on the condition type. Some support zero values,

4581

# others one or two values,

4582

# and ConditionType.ONE_OF_LIST supports an arbitrary number of values.

4583

{ # The value of the condition.

4584

"relativeDate": "A String", # A relative date (based on the current date).

4585

# Valid only if the type is

4586

# DATE_BEFORE,

4587

# DATE_AFTER,

4588

# DATE_ON_OR_BEFORE or

4589

# DATE_ON_OR_AFTER.

4590

#

4591

# Relative dates are not supported in data validation.

4592

# They are supported only in conditional formatting and

4593

# conditional filters.

4594

"userEnteredValue": "A String", # A value the condition is based on.

4595

# The value will be parsed as if the user typed into a cell.

4596

# Formulas are supported (and must begin with an `=`).

},

],

},

"format": { # The format of a cell. # The format to apply.

4601

# Conditional formatting can only apply a subset of formatting:

# bold, italic,

# strikethrough,

# foreground color &

# background color.

"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4607

"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on

4608

# the user's locale will be used if necessary for the given type.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame^]

4609

# See the [Date and Number Formats guide](/sheets/guides/formats) for more

4610

# information about the supported patterns.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4611

"type": "A String", # The type of the number format.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4612

# When writing, this field must be set.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4613

},

4614

"textDirection": "A String", # The direction of the text in the cell.

4615

"padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.

4616

# When updating padding, every field must be specified.

4617

"top": 42, # The top padding of the cell.

4618

"right": 42, # The right padding of the cell.

4619

"bottom": 42, # The bottom padding of the cell.

4620

"left": 42, # The left padding of the cell.

4621

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4622

"horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4623

"backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.

4624

# for simplicity of conversion to/from color representations in various

4625

# languages over compactness; for example, the fields of this representation

4626

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

4627

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

4628

# method in iOS; and, with just a little work, it can be easily formatted into

4629

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

4634

#

4635

# // ...

4636

# public static java.awt.Color fromProto(Color protocolor) {

4637

# float alpha = protocolor.hasAlpha()

4638

# ? protocolor.getAlpha().getValue()

4639

# : 1.0;

4640

#

4641

# return new java.awt.Color(

4642

# protocolor.getRed(),

4643

# protocolor.getGreen(),

4644

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

4649

# float red = (float) color.getRed();

4650

# float green = (float) color.getGreen();

4651

# float blue = (float) color.getBlue();

4652

# float denominator = 255.0;

4653

# Color.Builder resultBuilder =

4654

# Color

4655

# .newBuilder()

4656

# .setRed(red / denominator)

4657

# .setGreen(green / denominator)

4658

# .setBlue(blue / denominator);

4659

# int alpha = color.getAlpha();

4660

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

4665

# .build());

4666

# }

4667

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

4672

#

4673

# // ...

4674

# static UIColor* fromProto(Color* protocolor) {

4675

# float red = [protocolor red];

4676

# float green = [protocolor green];

4677

# float blue = [protocolor blue];

4678

# FloatValue* alpha_wrapper = [protocolor alpha];

4679

# float alpha = 1.0;

4680

# if (alpha_wrapper != nil) {

4681

# alpha = [alpha_wrapper value];

4682

# }

4683

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

4684

# }

4685

#

4686

# static Color* toProto(UIColor* color) {

4687

# CGFloat red, green, blue, alpha;

4688

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

4689

# return nil;

4690

# }

4691

# Color* result = [Color alloc] init];

4692

# [result setRed:red];

4693

# [result setGreen:green];

4694

# [result setBlue:blue];

4695

# if (alpha <= 0.9999) {

4696

# [result setAlpha:floatWrapperWithValue(alpha)];

4697

# }

4698

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

4708

# var redFrac = rgb_color.red || 0.0;

4709

# var greenFrac = rgb_color.green || 0.0;

4710

# var blueFrac = rgb_color.blue || 0.0;

4711

# var red = Math.floor(redFrac * 255);

4712

# var green = Math.floor(greenFrac * 255);

4713

# var blue = Math.floor(blueFrac * 255);

4714

#

4715

# if (!('alpha' in rgb_color)) {

4716

# return rgbToCssColor_(red, green, blue);

4717

# }

4718

#

4719

# var alphaFrac = rgb_color.alpha.value || 0.0;

4720

# var rgbParams = [red, green, blue].join(',');

4721

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

4722

# };

4723

#

4724

# var rgbToCssColor_ = function(red, green, blue) {

4725

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

4726

# var hexString = rgbNumber.toString(16);

4727

# var missingZeros = 6 - hexString.length;

4728

# var resultBuilder = ['#'];

4729

# for (var i = 0; i < missingZeros; i++) {

4730

# resultBuilder.push('0');

4731

# }

4732

# resultBuilder.push(hexString);

4733

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

4738

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

4739

# the final pixel color is defined by the equation:

4740

#

4741

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

4742

#

4743

# This means that a value of 1.0 corresponds to a solid color, whereas

4744

# a value of 0.0 corresponds to a completely transparent color. This

4745

# uses a wrapper message rather than a simple float scalar so that it is

4746

# possible to distinguish between a default value and the value being unset.

4747

# If omitted, this color object is to be rendered as a solid color

4748

# (as if the alpha value had been explicitly given with a value of 1.0).

4749

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

4750

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

4751

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

4752

"verticalAlignment": "A String", # The vertical alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

4753

"textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).

4754

# Absent values indicate that the field isn't specified.

4755

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

4756

# for simplicity of conversion to/from color representations in various

4757

# languages over compactness; for example, the fields of this representation

4758

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

4759

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

4760

# method in iOS; and, with just a little work, it can be easily formatted into

4761

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

4766

#

4767

# // ...

4768

# public static java.awt.Color fromProto(Color protocolor) {

4769

# float alpha = protocolor.hasAlpha()

4770

# ? protocolor.getAlpha().getValue()

4771

# : 1.0;

4772

#

4773

# return new java.awt.Color(

4774

# protocolor.getRed(),

4775

# protocolor.getGreen(),

4776

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

4781

# float red = (float) color.getRed();

4782

# float green = (float) color.getGreen();

4783

# float blue = (float) color.getBlue();

4784

# float denominator = 255.0;

4785

# Color.Builder resultBuilder =

4786

# Color

4787

# .newBuilder()

4788

# .setRed(red / denominator)

4789

# .setGreen(green / denominator)

4790

# .setBlue(blue / denominator);

4791

# int alpha = color.getAlpha();

4792

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

4797

# .build());

4798

# }

4799

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

4804

#

4805

# // ...

4806

# static UIColor* fromProto(Color* protocolor) {

4807

# float red = [protocolor red];

4808

# float green = [protocolor green];

4809

# float blue = [protocolor blue];

4810

# FloatValue* alpha_wrapper = [protocolor alpha];

4811

# float alpha = 1.0;

4812

# if (alpha_wrapper != nil) {

4813

# alpha = [alpha_wrapper value];

4814

# }

4815

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

4816

# }

4817

#

4818

# static Color* toProto(UIColor* color) {

4819

# CGFloat red, green, blue, alpha;

4820

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

4821

# return nil;

4822

# }

4823

# Color* result = [Color alloc] init];

4824

# [result setRed:red];

4825

# [result setGreen:green];

4826

# [result setBlue:blue];

4827

# if (alpha <= 0.9999) {

4828

# [result setAlpha:floatWrapperWithValue(alpha)];

4829

# }

4830

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

4840

# var redFrac = rgb_color.red || 0.0;

4841

# var greenFrac = rgb_color.green || 0.0;

4842

# var blueFrac = rgb_color.blue || 0.0;

4843

# var red = Math.floor(redFrac * 255);

4844

# var green = Math.floor(greenFrac * 255);

4845

# var blue = Math.floor(blueFrac * 255);

4846

#

4847

# if (!('alpha' in rgb_color)) {

4848

# return rgbToCssColor_(red, green, blue);

4849

# }

4850

#

4851

# var alphaFrac = rgb_color.alpha.value || 0.0;

4852

# var rgbParams = [red, green, blue].join(',');

4853

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

4854

# };

4855

#

4856

# var rgbToCssColor_ = function(red, green, blue) {

4857

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

4858

# var hexString = rgbNumber.toString(16);

4859

# var missingZeros = 6 - hexString.length;

4860

# var resultBuilder = ['#'];

4861

# for (var i = 0; i < missingZeros; i++) {

4862

# resultBuilder.push('0');

4863

# }

4864

# resultBuilder.push(hexString);

4865

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

4870

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

4871

# the final pixel color is defined by the equation:

4872

#

4873

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

4874

#

4875

# This means that a value of 1.0 corresponds to a solid color, whereas

4876

# a value of 0.0 corresponds to a completely transparent color. This

4877

# uses a wrapper message rather than a simple float scalar so that it is

4878

# possible to distinguish between a default value and the value being unset.

4879

# If omitted, this color object is to be rendered as a solid color

4880

# (as if the alpha value had been explicitly given with a value of 1.0).

4881

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

4882

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

4883

},

4884

"bold": True or False, # True if the text is bold.

4885

"strikethrough": True or False, # True if the text has a strikethrough.

4886

"fontFamily": "A String", # The font family.

4887

"fontSize": 42, # The size of the font.

4888

"italic": True or False, # True if the text is italicized.

4889

"underline": True or False, # True if the text is underlined.

4890

},

4891

"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.

4892

"borders": { # The borders of the cell. # The borders of the cell.

4893

"top": { # A border along a cell. # The top border of the cell.

4894

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

4895

# for simplicity of conversion to/from color representations in various

4896

# languages over compactness; for example, the fields of this representation

4897

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

4898

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

4899

# method in iOS; and, with just a little work, it can be easily formatted into

4900

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

4905

#

4906

# // ...

4907

# public static java.awt.Color fromProto(Color protocolor) {

4908

# float alpha = protocolor.hasAlpha()

4909

# ? protocolor.getAlpha().getValue()

4910

# : 1.0;

4911

#

4912

# return new java.awt.Color(

4913

# protocolor.getRed(),

4914

# protocolor.getGreen(),

4915

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

4920

# float red = (float) color.getRed();

4921

# float green = (float) color.getGreen();

4922

# float blue = (float) color.getBlue();

4923

# float denominator = 255.0;

4924

# Color.Builder resultBuilder =

4925

# Color

4926

# .newBuilder()

4927

# .setRed(red / denominator)

4928

# .setGreen(green / denominator)

4929

# .setBlue(blue / denominator);

4930

# int alpha = color.getAlpha();

4931

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

4936

# .build());

4937

# }

4938

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

4943

#

4944

# // ...

4945

# static UIColor* fromProto(Color* protocolor) {

4946

# float red = [protocolor red];

4947

# float green = [protocolor green];

4948

# float blue = [protocolor blue];

4949

# FloatValue* alpha_wrapper = [protocolor alpha];

4950

# float alpha = 1.0;

4951

# if (alpha_wrapper != nil) {

4952

# alpha = [alpha_wrapper value];

4953

# }

4954

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

4955

# }

4956

#

4957

# static Color* toProto(UIColor* color) {

4958

# CGFloat red, green, blue, alpha;

4959

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

4960

# return nil;

4961

# }

4962

# Color* result = [Color alloc] init];

4963

# [result setRed:red];

4964

# [result setGreen:green];

4965

# [result setBlue:blue];

4966

# if (alpha <= 0.9999) {

4967

# [result setAlpha:floatWrapperWithValue(alpha)];

4968

# }

4969

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

4979

# var redFrac = rgb_color.red || 0.0;

4980

# var greenFrac = rgb_color.green || 0.0;

4981

# var blueFrac = rgb_color.blue || 0.0;

4982

# var red = Math.floor(redFrac * 255);

4983

# var green = Math.floor(greenFrac * 255);

4984

# var blue = Math.floor(blueFrac * 255);

4985

#

4986

# if (!('alpha' in rgb_color)) {

4987

# return rgbToCssColor_(red, green, blue);

4988

# }

4989

#

4990

# var alphaFrac = rgb_color.alpha.value || 0.0;

4991

# var rgbParams = [red, green, blue].join(',');

4992

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

4993

# };

4994

#

4995

# var rgbToCssColor_ = function(red, green, blue) {

4996

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

4997

# var hexString = rgbNumber.toString(16);

4998

# var missingZeros = 6 - hexString.length;

4999

# var resultBuilder = ['#'];

5000

# for (var i = 0; i < missingZeros; i++) {

5001

# resultBuilder.push('0');

5002

# }

5003

# resultBuilder.push(hexString);

5004

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

5009

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

5010

# the final pixel color is defined by the equation:

5011

#

5012

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

5013

#

5014

# This means that a value of 1.0 corresponds to a solid color, whereas

5015

# a value of 0.0 corresponds to a completely transparent color. This

5016

# uses a wrapper message rather than a simple float scalar so that it is

5017

# possible to distinguish between a default value and the value being unset.

5018

# If omitted, this color object is to be rendered as a solid color

5019

# (as if the alpha value had been explicitly given with a value of 1.0).

5020

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

5021

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

5022

},

5023

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

5024

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

5025

"style": "A String", # The style of the border.

5026

},

5027

"right": { # A border along a cell. # The right border of the cell.

5028

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

5029

# for simplicity of conversion to/from color representations in various

5030

# languages over compactness; for example, the fields of this representation

5031

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

5032

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

5033

# method in iOS; and, with just a little work, it can be easily formatted into

5034

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

5039

#

5040

# // ...

5041

# public static java.awt.Color fromProto(Color protocolor) {

5042

# float alpha = protocolor.hasAlpha()

5043

# ? protocolor.getAlpha().getValue()

5044

# : 1.0;

5045

#

5046

# return new java.awt.Color(

5047

# protocolor.getRed(),

5048

# protocolor.getGreen(),

5049

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

5054

# float red = (float) color.getRed();

5055

# float green = (float) color.getGreen();

5056

# float blue = (float) color.getBlue();

5057

# float denominator = 255.0;

5058

# Color.Builder resultBuilder =

5059

# Color

5060

# .newBuilder()

5061

# .setRed(red / denominator)

5062

# .setGreen(green / denominator)

5063

# .setBlue(blue / denominator);

5064

# int alpha = color.getAlpha();

5065

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

5070

# .build());

5071

# }

5072

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

5077

#

5078

# // ...

5079

# static UIColor* fromProto(Color* protocolor) {

5080

# float red = [protocolor red];

5081

# float green = [protocolor green];

5082

# float blue = [protocolor blue];

5083

# FloatValue* alpha_wrapper = [protocolor alpha];

5084

# float alpha = 1.0;

5085

# if (alpha_wrapper != nil) {

5086

# alpha = [alpha_wrapper value];

5087

# }

5088

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

5089

# }

5090

#

5091

# static Color* toProto(UIColor* color) {

5092

# CGFloat red, green, blue, alpha;

5093

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

5094

# return nil;

5095

# }

5096

# Color* result = [Color alloc] init];

5097

# [result setRed:red];

5098

# [result setGreen:green];

5099

# [result setBlue:blue];

5100

# if (alpha <= 0.9999) {

5101

# [result setAlpha:floatWrapperWithValue(alpha)];

5102

# }

5103

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

5113

# var redFrac = rgb_color.red || 0.0;

5114

# var greenFrac = rgb_color.green || 0.0;

5115

# var blueFrac = rgb_color.blue || 0.0;

5116

# var red = Math.floor(redFrac * 255);

5117

# var green = Math.floor(greenFrac * 255);

5118

# var blue = Math.floor(blueFrac * 255);

5119

#

5120

# if (!('alpha' in rgb_color)) {

5121

# return rgbToCssColor_(red, green, blue);

5122

# }

5123

#

5124

# var alphaFrac = rgb_color.alpha.value || 0.0;

5125

# var rgbParams = [red, green, blue].join(',');

5126

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

5127

# };

5128

#

5129

# var rgbToCssColor_ = function(red, green, blue) {

5130

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

5131

# var hexString = rgbNumber.toString(16);

5132

# var missingZeros = 6 - hexString.length;

5133

# var resultBuilder = ['#'];

5134

# for (var i = 0; i < missingZeros; i++) {

5135

# resultBuilder.push('0');

5136

# }

5137

# resultBuilder.push(hexString);

5138

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

5143

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

5144

# the final pixel color is defined by the equation:

5145

#

5146

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

5147

#

5148

# This means that a value of 1.0 corresponds to a solid color, whereas

5149

# a value of 0.0 corresponds to a completely transparent color. This

5150

# uses a wrapper message rather than a simple float scalar so that it is

5151

# possible to distinguish between a default value and the value being unset.

5152

# If omitted, this color object is to be rendered as a solid color

5153

# (as if the alpha value had been explicitly given with a value of 1.0).

5154

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

5155

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

5156

},

5157

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

5158

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

5159

"style": "A String", # The style of the border.

5160

},

5161

"bottom": { # A border along a cell. # The bottom border of the cell.

5162

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

5163

# for simplicity of conversion to/from color representations in various

5164

# languages over compactness; for example, the fields of this representation

5165

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

5166

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

5167

# method in iOS; and, with just a little work, it can be easily formatted into

5168

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

5173

#

5174

# // ...

5175

# public static java.awt.Color fromProto(Color protocolor) {

5176

# float alpha = protocolor.hasAlpha()

5177

# ? protocolor.getAlpha().getValue()

5178

# : 1.0;

5179

#

5180

# return new java.awt.Color(

5181

# protocolor.getRed(),

5182

# protocolor.getGreen(),

5183

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

5188

# float red = (float) color.getRed();

5189

# float green = (float) color.getGreen();

5190

# float blue = (float) color.getBlue();

5191

# float denominator = 255.0;

5192

# Color.Builder resultBuilder =

5193

# Color

5194

# .newBuilder()

5195

# .setRed(red / denominator)

5196

# .setGreen(green / denominator)

5197

# .setBlue(blue / denominator);

5198

# int alpha = color.getAlpha();

5199

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

5204

# .build());

5205

# }

5206

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

5211

#

5212

# // ...

5213

# static UIColor* fromProto(Color* protocolor) {

5214

# float red = [protocolor red];

5215

# float green = [protocolor green];

5216

# float blue = [protocolor blue];

5217

# FloatValue* alpha_wrapper = [protocolor alpha];

5218

# float alpha = 1.0;

5219

# if (alpha_wrapper != nil) {

5220

# alpha = [alpha_wrapper value];

5221

# }

5222

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

5223

# }

5224

#

5225

# static Color* toProto(UIColor* color) {

5226

# CGFloat red, green, blue, alpha;

5227

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

5228

# return nil;

5229

# }

5230

# Color* result = [Color alloc] init];

5231

# [result setRed:red];

5232

# [result setGreen:green];

5233

# [result setBlue:blue];

5234

# if (alpha <= 0.9999) {

5235

# [result setAlpha:floatWrapperWithValue(alpha)];

5236

# }

5237

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

5247

# var redFrac = rgb_color.red || 0.0;

5248

# var greenFrac = rgb_color.green || 0.0;

5249

# var blueFrac = rgb_color.blue || 0.0;

5250

# var red = Math.floor(redFrac * 255);

5251

# var green = Math.floor(greenFrac * 255);

5252

# var blue = Math.floor(blueFrac * 255);

5253

#

5254

# if (!('alpha' in rgb_color)) {

5255

# return rgbToCssColor_(red, green, blue);

5256

# }

5257

#

5258

# var alphaFrac = rgb_color.alpha.value || 0.0;

5259

# var rgbParams = [red, green, blue].join(',');

5260

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

5261

# };

5262

#

5263

# var rgbToCssColor_ = function(red, green, blue) {

5264

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

5265

# var hexString = rgbNumber.toString(16);

5266

# var missingZeros = 6 - hexString.length;

5267

# var resultBuilder = ['#'];

5268

# for (var i = 0; i < missingZeros; i++) {

5269

# resultBuilder.push('0');

5270

# }

5271

# resultBuilder.push(hexString);

5272

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

5277

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

5278

# the final pixel color is defined by the equation:

5279

#

5280

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

5281

#

5282

# This means that a value of 1.0 corresponds to a solid color, whereas

5283

# a value of 0.0 corresponds to a completely transparent color. This

5284

# uses a wrapper message rather than a simple float scalar so that it is

5285

# possible to distinguish between a default value and the value being unset.

5286

# If omitted, this color object is to be rendered as a solid color

5287

# (as if the alpha value had been explicitly given with a value of 1.0).

5288

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

5289

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

5290

},

5291

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

5292

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

5293

"style": "A String", # The style of the border.

5294

},

5295

"left": { # A border along a cell. # The left border of the cell.

5296

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

5297

# for simplicity of conversion to/from color representations in various

5298

# languages over compactness; for example, the fields of this representation

5299

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

5300

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

5301

# method in iOS; and, with just a little work, it can be easily formatted into

5302

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

5307

#

5308

# // ...

5309

# public static java.awt.Color fromProto(Color protocolor) {

5310

# float alpha = protocolor.hasAlpha()

5311

# ? protocolor.getAlpha().getValue()

5312

# : 1.0;

5313

#

5314

# return new java.awt.Color(

5315

# protocolor.getRed(),

5316

# protocolor.getGreen(),

5317

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

5322

# float red = (float) color.getRed();

5323

# float green = (float) color.getGreen();

5324

# float blue = (float) color.getBlue();

5325

# float denominator = 255.0;

5326

# Color.Builder resultBuilder =

5327

# Color

5328

# .newBuilder()

5329

# .setRed(red / denominator)

5330

# .setGreen(green / denominator)

5331

# .setBlue(blue / denominator);

5332

# int alpha = color.getAlpha();

5333

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

5338

# .build());

5339

# }

5340

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

5345

#

5346

# // ...

5347

# static UIColor* fromProto(Color* protocolor) {

5348

# float red = [protocolor red];

5349

# float green = [protocolor green];

5350

# float blue = [protocolor blue];

5351

# FloatValue* alpha_wrapper = [protocolor alpha];

5352

# float alpha = 1.0;

5353

# if (alpha_wrapper != nil) {

5354

# alpha = [alpha_wrapper value];

5355

# }

5356

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

5357

# }

5358

#

5359

# static Color* toProto(UIColor* color) {

5360

# CGFloat red, green, blue, alpha;

5361

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

5362

# return nil;

5363

# }

5364

# Color* result = [Color alloc] init];

5365

# [result setRed:red];

5366

# [result setGreen:green];

5367

# [result setBlue:blue];

5368

# if (alpha <= 0.9999) {

5369

# [result setAlpha:floatWrapperWithValue(alpha)];

5370

# }

5371

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

5381

# var redFrac = rgb_color.red || 0.0;

5382

# var greenFrac = rgb_color.green || 0.0;

5383

# var blueFrac = rgb_color.blue || 0.0;

5384

# var red = Math.floor(redFrac * 255);

5385

# var green = Math.floor(greenFrac * 255);

5386

# var blue = Math.floor(blueFrac * 255);

5387

#

5388

# if (!('alpha' in rgb_color)) {

5389

# return rgbToCssColor_(red, green, blue);

5390

# }

5391

#

5392

# var alphaFrac = rgb_color.alpha.value || 0.0;

5393

# var rgbParams = [red, green, blue].join(',');

5394

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

5395

# };

5396

#

5397

# var rgbToCssColor_ = function(red, green, blue) {

5398

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

5399

# var hexString = rgbNumber.toString(16);

5400

# var missingZeros = 6 - hexString.length;

5401

# var resultBuilder = ['#'];

5402

# for (var i = 0; i < missingZeros; i++) {

5403

# resultBuilder.push('0');

5404

# }

5405

# resultBuilder.push(hexString);

5406

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

5411

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

5412

# the final pixel color is defined by the equation:

5413

#

5414

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

5415

#

5416

# This means that a value of 1.0 corresponds to a solid color, whereas

5417

# a value of 0.0 corresponds to a completely transparent color. This

5418

# uses a wrapper message rather than a simple float scalar so that it is

5419

# possible to distinguish between a default value and the value being unset.

5420

# If omitted, this color object is to be rendered as a solid color

5421

# (as if the alpha value had been explicitly given with a value of 1.0).

5422

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

5423

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

5424

},

5425

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

5426

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

5427

"style": "A String", # The style of the border.

5428

},

5429

},

5430

"wrapStrategy": "A String", # The wrap strategy for the value in the cell.

5431

},

5432

},

5433

"gradientRule": { # A rule that applies a gradient color scale format, based on # The formatting will vary based on the gradients in the rule.

5434

# the interpolation points listed. The format of a cell will vary

5435

# based on its contents as compared to the values of the interpolation

5436

# points.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

5437

"maxpoint": { # A single interpolation point on a gradient conditional format. # The final interpolation point.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

5438

# These pin the gradient color scale according to the color,

5439

# type and value chosen.

5440

"color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.

5441

# for simplicity of conversion to/from color representations in various

5442

# languages over compactness; for example, the fields of this representation

5443

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

5444

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

5445

# method in iOS; and, with just a little work, it can be easily formatted into

5446

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

5451

#

5452

# // ...

5453

# public static java.awt.Color fromProto(Color protocolor) {

5454

# float alpha = protocolor.hasAlpha()

5455

# ? protocolor.getAlpha().getValue()

5456

# : 1.0;

5457

#

5458

# return new java.awt.Color(

5459

# protocolor.getRed(),

5460

# protocolor.getGreen(),

5461

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

5466

# float red = (float) color.getRed();

5467

# float green = (float) color.getGreen();

5468

# float blue = (float) color.getBlue();

5469

# float denominator = 255.0;

5470

# Color.Builder resultBuilder =

5471

# Color

5472

# .newBuilder()

5473

# .setRed(red / denominator)

5474

# .setGreen(green / denominator)

5475

# .setBlue(blue / denominator);

5476

# int alpha = color.getAlpha();

5477

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

5482

# .build());

5483

# }

5484

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

5489

#

5490

# // ...

5491

# static UIColor* fromProto(Color* protocolor) {

5492

# float red = [protocolor red];

5493

# float green = [protocolor green];

5494

# float blue = [protocolor blue];

5495

# FloatValue* alpha_wrapper = [protocolor alpha];

5496

# float alpha = 1.0;

5497

# if (alpha_wrapper != nil) {

5498

# alpha = [alpha_wrapper value];

5499

# }

5500

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

5501

# }

5502

#

5503

# static Color* toProto(UIColor* color) {

5504

# CGFloat red, green, blue, alpha;

5505

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

5506

# return nil;

5507

# }

5508

# Color* result = [Color alloc] init];

5509

# [result setRed:red];

5510

# [result setGreen:green];

5511

# [result setBlue:blue];

5512

# if (alpha <= 0.9999) {

5513

# [result setAlpha:floatWrapperWithValue(alpha)];

5514

# }

5515

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

5525

# var redFrac = rgb_color.red || 0.0;

5526

# var greenFrac = rgb_color.green || 0.0;

5527

# var blueFrac = rgb_color.blue || 0.0;

5528

# var red = Math.floor(redFrac * 255);

5529

# var green = Math.floor(greenFrac * 255);

5530

# var blue = Math.floor(blueFrac * 255);

5531

#

5532

# if (!('alpha' in rgb_color)) {

5533

# return rgbToCssColor_(red, green, blue);

5534

# }

5535

#

5536

# var alphaFrac = rgb_color.alpha.value || 0.0;

5537

# var rgbParams = [red, green, blue].join(',');

5538

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

5539

# };

5540

#

5541

# var rgbToCssColor_ = function(red, green, blue) {

5542

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

5543

# var hexString = rgbNumber.toString(16);

5544

# var missingZeros = 6 - hexString.length;

5545

# var resultBuilder = ['#'];

5546

# for (var i = 0; i < missingZeros; i++) {

5547

# resultBuilder.push('0');

5548

# }

5549

# resultBuilder.push(hexString);

5550

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

5555

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

5556

# the final pixel color is defined by the equation:

5557

#

5558

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

5559

#

5560

# This means that a value of 1.0 corresponds to a solid color, whereas

5561

# a value of 0.0 corresponds to a completely transparent color. This

5562

# uses a wrapper message rather than a simple float scalar so that it is

5563

# possible to distinguish between a default value and the value being unset.

5564

# If omitted, this color object is to be rendered as a solid color

5565

# (as if the alpha value had been explicitly given with a value of 1.0).

5566

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

5567

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

5568

},

5569

"type": "A String", # How the value should be interpreted.

5570

"value": "A String", # The value this interpolation point uses. May be a formula.

5571

# Unused if type is MIN or

5572

# MAX.

5573

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

5574

"midpoint": { # A single interpolation point on a gradient conditional format. # An optional midway interpolation point.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

5575

# These pin the gradient color scale according to the color,

5576

# type and value chosen.

5577

"color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.

5578

# for simplicity of conversion to/from color representations in various

5579

# languages over compactness; for example, the fields of this representation

5580

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

5581

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

5582

# method in iOS; and, with just a little work, it can be easily formatted into

5583

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

5588

#

5589

# // ...

5590

# public static java.awt.Color fromProto(Color protocolor) {

5591

# float alpha = protocolor.hasAlpha()

5592

# ? protocolor.getAlpha().getValue()

5593

# : 1.0;

5594

#

5595

# return new java.awt.Color(

5596

# protocolor.getRed(),

5597

# protocolor.getGreen(),

5598

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

5603

# float red = (float) color.getRed();

5604

# float green = (float) color.getGreen();

5605

# float blue = (float) color.getBlue();

5606

# float denominator = 255.0;

5607

# Color.Builder resultBuilder =

5608

# Color

5609

# .newBuilder()

5610

# .setRed(red / denominator)

5611

# .setGreen(green / denominator)

5612

# .setBlue(blue / denominator);

5613

# int alpha = color.getAlpha();

5614

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

5619

# .build());

5620

# }

5621

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

5626

#

5627

# // ...

5628

# static UIColor* fromProto(Color* protocolor) {

5629

# float red = [protocolor red];

5630

# float green = [protocolor green];

5631

# float blue = [protocolor blue];

5632

# FloatValue* alpha_wrapper = [protocolor alpha];

5633

# float alpha = 1.0;

5634

# if (alpha_wrapper != nil) {

5635

# alpha = [alpha_wrapper value];

5636

# }

5637

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

5638

# }

5639

#

5640

# static Color* toProto(UIColor* color) {

5641

# CGFloat red, green, blue, alpha;

5642

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

5643

# return nil;

5644

# }

5645

# Color* result = [Color alloc] init];

5646

# [result setRed:red];

5647

# [result setGreen:green];

5648

# [result setBlue:blue];

5649

# if (alpha <= 0.9999) {

5650

# [result setAlpha:floatWrapperWithValue(alpha)];

5651

# }

5652

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

5662

# var redFrac = rgb_color.red || 0.0;

5663

# var greenFrac = rgb_color.green || 0.0;

5664

# var blueFrac = rgb_color.blue || 0.0;

5665

# var red = Math.floor(redFrac * 255);

5666

# var green = Math.floor(greenFrac * 255);

5667

# var blue = Math.floor(blueFrac * 255);

5668

#

5669

# if (!('alpha' in rgb_color)) {

5670

# return rgbToCssColor_(red, green, blue);

5671

# }

5672

#

5673

# var alphaFrac = rgb_color.alpha.value || 0.0;

5674

# var rgbParams = [red, green, blue].join(',');

5675

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

5676

# };

5677

#

5678

# var rgbToCssColor_ = function(red, green, blue) {

5679

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

5680

# var hexString = rgbNumber.toString(16);

5681

# var missingZeros = 6 - hexString.length;

5682

# var resultBuilder = ['#'];

5683

# for (var i = 0; i < missingZeros; i++) {

5684

# resultBuilder.push('0');

5685

# }

5686

# resultBuilder.push(hexString);

5687

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

5692

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

5693

# the final pixel color is defined by the equation:

5694

#

5695

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

5696

#

5697

# This means that a value of 1.0 corresponds to a solid color, whereas

5698

# a value of 0.0 corresponds to a completely transparent color. This

5699

# uses a wrapper message rather than a simple float scalar so that it is

5700

# possible to distinguish between a default value and the value being unset.

5701

# If omitted, this color object is to be rendered as a solid color

5702

# (as if the alpha value had been explicitly given with a value of 1.0).

5703

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

5704

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

5705

},

5706

"type": "A String", # How the value should be interpreted.

5707

"value": "A String", # The value this interpolation point uses. May be a formula.

5708

# Unused if type is MIN or

5709

# MAX.

5710

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

5711

"minpoint": { # A single interpolation point on a gradient conditional format. # The starting interpolation point.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

5712

# These pin the gradient color scale according to the color,

5713

# type and value chosen.

5714

"color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.

5715

# for simplicity of conversion to/from color representations in various

5716

# languages over compactness; for example, the fields of this representation

5717

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

5718

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

5719

# method in iOS; and, with just a little work, it can be easily formatted into

5720

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

5725

#

5726

# // ...

5727

# public static java.awt.Color fromProto(Color protocolor) {

5728

# float alpha = protocolor.hasAlpha()

5729

# ? protocolor.getAlpha().getValue()

5730

# : 1.0;

5731

#

5732

# return new java.awt.Color(

5733

# protocolor.getRed(),

5734

# protocolor.getGreen(),

5735

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

5740

# float red = (float) color.getRed();

5741

# float green = (float) color.getGreen();

5742

# float blue = (float) color.getBlue();

5743

# float denominator = 255.0;

5744

# Color.Builder resultBuilder =

5745

# Color

5746

# .newBuilder()

5747

# .setRed(red / denominator)

5748

# .setGreen(green / denominator)

5749

# .setBlue(blue / denominator);

5750

# int alpha = color.getAlpha();

5751

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

5756

# .build());

5757

# }

5758

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

5763

#

5764

# // ...

5765

# static UIColor* fromProto(Color* protocolor) {

5766

# float red = [protocolor red];

5767

# float green = [protocolor green];

5768

# float blue = [protocolor blue];

5769

# FloatValue* alpha_wrapper = [protocolor alpha];

5770

# float alpha = 1.0;

5771

# if (alpha_wrapper != nil) {

5772

# alpha = [alpha_wrapper value];

5773

# }

5774

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

5775

# }

5776

#

5777

# static Color* toProto(UIColor* color) {

5778

# CGFloat red, green, blue, alpha;

5779

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

5780

# return nil;

5781

# }

5782

# Color* result = [Color alloc] init];

5783

# [result setRed:red];

5784

# [result setGreen:green];

5785

# [result setBlue:blue];

5786

# if (alpha <= 0.9999) {

5787

# [result setAlpha:floatWrapperWithValue(alpha)];

5788

# }

5789

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

5799

# var redFrac = rgb_color.red || 0.0;

5800

# var greenFrac = rgb_color.green || 0.0;

5801

# var blueFrac = rgb_color.blue || 0.0;

5802

# var red = Math.floor(redFrac * 255);

5803

# var green = Math.floor(greenFrac * 255);

5804

# var blue = Math.floor(blueFrac * 255);

5805

#

5806

# if (!('alpha' in rgb_color)) {

5807

# return rgbToCssColor_(red, green, blue);

5808

# }

5809

#

5810

# var alphaFrac = rgb_color.alpha.value || 0.0;

5811

# var rgbParams = [red, green, blue].join(',');

5812

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

5813

# };

5814

#

5815

# var rgbToCssColor_ = function(red, green, blue) {

5816

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

5817

# var hexString = rgbNumber.toString(16);

5818

# var missingZeros = 6 - hexString.length;

5819

# var resultBuilder = ['#'];

5820

# for (var i = 0; i < missingZeros; i++) {

5821

# resultBuilder.push('0');

5822

# }

5823

# resultBuilder.push(hexString);

5824

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

5829

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

5830

# the final pixel color is defined by the equation:

5831

#

5832

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

5833

#

5834

# This means that a value of 1.0 corresponds to a solid color, whereas

5835

# a value of 0.0 corresponds to a completely transparent color. This

5836

# uses a wrapper message rather than a simple float scalar so that it is

5837

# possible to distinguish between a default value and the value being unset.

5838

# If omitted, this color object is to be rendered as a solid color

5839

# (as if the alpha value had been explicitly given with a value of 1.0).

5840

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

5841

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

5842

},

5843

"type": "A String", # How the value should be interpreted.

5844

"value": "A String", # The value this interpolation point uses. May be a formula.

5845

# Unused if type is MIN or

# MAX.

},

},

},

},

"repeatCell": { # Updates all cells in the range to the values in the given Cell object. # Repeats a single cell across a range.

5852

# Only the fields listed in the fields field are updated; others are

5853

# unchanged.

5854

#

5855

# If writing a cell with a formula, the formula's ranges will automatically

5856

# increment for each field in the range.

5857

# For example, if writing a cell with formula `=A1` into range B2:C4,

5858

# B2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`,

5859

# C2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`.

5860

#

5861

# To keep the formula's ranges static, use the `$` indicator.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

5862

# For example, use the formula `=$A$1` to prevent both the row and the

5863

# column from incrementing.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

5864

"cell": { # Data about a specific cell. # The data to write.

5865

"pivotTable": { # A pivot table. # A pivot table anchored at this cell. The size of pivot table itself

5866

# is computed dynamically based on its data, grouping, filters, values,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

5867

# etc. Only the top-left cell of the pivot table contains the pivot table

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

5868

# definition. The other cells will contain the calculated values of the

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

5869

# results of the pivot in their effective_value fields.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

5870

"valueLayout": "A String", # Whether values should be listed horizontally (as columns)

5871

# or vertically (as rows).

5872

"rows": [ # Each row grouping in the pivot table.

5873

{ # A single grouping (either row or column) in a pivot table.

5874

"showTotals": True or False, # True if the pivot table should include the totals for this grouping.

5875

"valueMetadata": [ # Metadata about values in the grouping.

5876

{ # Metadata about a value in a pivot grouping.

5877

"collapsed": True or False, # True if the data corresponding to the value is collapsed.

5878

"value": { # The kinds of value that a cell in a spreadsheet can have. # The calculated value the metadata corresponds to.

5879

# (Note that formulaValue is not valid,

5880

# because the values will be calculated.)

5881

"numberValue": 3.14, # Represents a double value.

5882

# Note: Dates, Times and DateTimes are represented as doubles in

5883

# "serial number" format.

5884

"boolValue": True or False, # Represents a boolean value.

5885

"formulaValue": "A String", # Represents a formula.

5886

"stringValue": "A String", # Represents a string value.

5887

# Leading single quotes are not included. For example, if the user typed

5888

# `'123` into the UI, this would be represented as a `stringValue` of

5889

# `"123"`.

5890

"errorValue": { # An error in a cell. # Represents an error.

5891

# This field is read-only.

5892

"message": "A String", # A message with more information about the error

5893

# (in the spreadsheet's locale).

5894

"type": "A String", # The type of error.

},

},

},

],

"valueBucket": { # Information about which values in a pivot group should be used for sorting. # The bucket of the opposite pivot group to sort by.

5900

# If not specified, sorting is alphabetical by this group's values.

5901

"buckets": [ # Determines the bucket from which values are chosen to sort.

5902

#

5903

# For example, in a pivot table with one row group & two column groups,

5904

# the row group can list up to two values. The first value corresponds

5905

# to a value within the first column group, and the second value

5906

# corresponds to a value in the second column group. If no values

5907

# are listed, this would indicate that the row should be sorted according

5908

# to the "Grand Total" over the column groups. If a single value is listed,

5909

# this would correspond to using the "Total" of that bucket.

5910

{ # The kinds of value that a cell in a spreadsheet can have.

5911

"numberValue": 3.14, # Represents a double value.

5912

# Note: Dates, Times and DateTimes are represented as doubles in

5913

# "serial number" format.

5914

"boolValue": True or False, # Represents a boolean value.

5915

"formulaValue": "A String", # Represents a formula.

5916

"stringValue": "A String", # Represents a string value.

5917

# Leading single quotes are not included. For example, if the user typed

5918

# `'123` into the UI, this would be represented as a `stringValue` of

5919

# `"123"`.

5920

"errorValue": { # An error in a cell. # Represents an error.

5921

# This field is read-only.

5922

"message": "A String", # A message with more information about the error

5923

# (in the spreadsheet's locale).

5924

"type": "A String", # The type of error.

5925

},

5926

},

5927

],

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

5928

"valuesIndex": 42, # The offset in the PivotTable.values list which the values in this

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

5929

# grouping should be sorted by.

5930

},

5931

"sortOrder": "A String", # The order the values in this group should be sorted.

5932

"sourceColumnOffset": 42, # The column offset of the source range that this grouping is based on.

5933

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

5934

# For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

5935

# means this group refers to column `C`, whereas the offset `1` would refer

# to column `D`.

},

],

"source": { # A range on a sheet. # The range the pivot table is reading data from.

5940

# All indexes are zero-based.

5941

# Indexes are half open, e.g the start index is inclusive

5942

# and the end index is exclusive -- [start_index, end_index).

5943

# Missing indexes indicate the range is unbounded on that side.

5944

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

5945

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

5946

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

5947

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

5948

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

5949

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

5950

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

5951

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

5952

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

5953

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

5954

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

5955

# `Sheet1!A:B == sheet_id: 0,

5956

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

5957

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

5958

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

5959

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

5960

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

5961

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

5962

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

5963

#

5964

# The start index must always be less than or equal to the end index.

5965

# If the start index equals the end index, then the range is empty.

5966

# Empty ranges are typically not meaningful and are usually rendered in the

5967

# UI as `#REF!`.

5968

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

5969

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

5970

"sheetId": 42, # The sheet this range is on.

5971

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

5972

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

5973

},

5974

"values": [ # A list of values to include in the pivot table.

5975

{ # The definition of how a value in a pivot table should be calculated.

5976

"formula": "A String", # A custom formula to calculate the value. The formula must start

5977

# with an `=` character.

5978

"summarizeFunction": "A String", # A function to summarize the value.

5979

# If formula is set, the only supported values are

5980

# SUM and

5981

# CUSTOM.

5982

# If sourceColumnOffset is set, then `CUSTOM`

5983

# is not supported.

5984

"sourceColumnOffset": 42, # The column offset of the source range that this value reads from.

5985

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

5986

# For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

5987

# means this value refers to column `C`, whereas the offset `1` would

5988

# refer to column `D`.

5989

"name": "A String", # A name to use for the value. This is only used if formula was set.

5990

# Otherwise, the column name is used.

5991

},

5992

],

5993

"criteria": { # An optional mapping of filters per source column offset.

5994

#

5995

# The filters will be applied before aggregating data into the pivot table.

5996

# The map's key is the column offset of the source range that you want to

5997

# filter, and the value is the criteria for that column.

5998

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

5999

# For example, if the source was `C10:E15`, a key of `0` will have the filter

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

6000

# for column `C`, whereas the key `1` is for column `D`.

6001

"a_key": { # Criteria for showing/hiding rows in a pivot table.

6002

"visibleValues": [ # Values that should be included. Values not listed here are excluded.

"A String",

],

},

},

"columns": [ # Each column grouping in the pivot table.

6008

{ # A single grouping (either row or column) in a pivot table.

6009

"showTotals": True or False, # True if the pivot table should include the totals for this grouping.

6010

"valueMetadata": [ # Metadata about values in the grouping.

6011

{ # Metadata about a value in a pivot grouping.

6012

"collapsed": True or False, # True if the data corresponding to the value is collapsed.

6013

"value": { # The kinds of value that a cell in a spreadsheet can have. # The calculated value the metadata corresponds to.

6014

# (Note that formulaValue is not valid,

6015

# because the values will be calculated.)

6016

"numberValue": 3.14, # Represents a double value.

6017

# Note: Dates, Times and DateTimes are represented as doubles in

6018

# "serial number" format.

6019

"boolValue": True or False, # Represents a boolean value.

6020

"formulaValue": "A String", # Represents a formula.

6021

"stringValue": "A String", # Represents a string value.

6022

# Leading single quotes are not included. For example, if the user typed

6023

# `'123` into the UI, this would be represented as a `stringValue` of

6024

# `"123"`.

6025

"errorValue": { # An error in a cell. # Represents an error.

6026

# This field is read-only.

6027

"message": "A String", # A message with more information about the error

6028

# (in the spreadsheet's locale).

6029

"type": "A String", # The type of error.

},

},

},

],

"valueBucket": { # Information about which values in a pivot group should be used for sorting. # The bucket of the opposite pivot group to sort by.

6035

# If not specified, sorting is alphabetical by this group's values.

6036

"buckets": [ # Determines the bucket from which values are chosen to sort.

6037

#

6038

# For example, in a pivot table with one row group & two column groups,

6039

# the row group can list up to two values. The first value corresponds

6040

# to a value within the first column group, and the second value

6041

# corresponds to a value in the second column group. If no values

6042

# are listed, this would indicate that the row should be sorted according

6043

# to the "Grand Total" over the column groups. If a single value is listed,

6044

# this would correspond to using the "Total" of that bucket.

6045

{ # The kinds of value that a cell in a spreadsheet can have.

6046

"numberValue": 3.14, # Represents a double value.

6047

# Note: Dates, Times and DateTimes are represented as doubles in

6048

# "serial number" format.

6049

"boolValue": True or False, # Represents a boolean value.

6050

"formulaValue": "A String", # Represents a formula.

6051

"stringValue": "A String", # Represents a string value.

6052

# Leading single quotes are not included. For example, if the user typed

6053

# `'123` into the UI, this would be represented as a `stringValue` of

6054

# `"123"`.

6055

"errorValue": { # An error in a cell. # Represents an error.

6056

# This field is read-only.

6057

"message": "A String", # A message with more information about the error

6058

# (in the spreadsheet's locale).

6059

"type": "A String", # The type of error.

6060

},

6061

},

6062

],

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

6063

"valuesIndex": 42, # The offset in the PivotTable.values list which the values in this

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

6064

# grouping should be sorted by.

6065

},

6066

"sortOrder": "A String", # The order the values in this group should be sorted.

6067

"sourceColumnOffset": 42, # The column offset of the source range that this grouping is based on.

6068

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

6069

# For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

6070

# means this group refers to column `C`, whereas the offset `1` would refer

# to column `D`.

},

],

},

"hyperlink": "A String", # A hyperlink this cell points to, if any.

6076

# This field is read-only. (To set it, use a `=HYPERLINK` formula.)

6077

"effectiveValue": { # The kinds of value that a cell in a spreadsheet can have. # The effective value of the cell. For cells with formulas, this will be

6078

# the calculated value. For cells with literals, this will be

6079

# the same as the user_entered_value.

6080

# This field is read-only.

6081

"numberValue": 3.14, # Represents a double value.

6082

# Note: Dates, Times and DateTimes are represented as doubles in

6083

# "serial number" format.

6084

"boolValue": True or False, # Represents a boolean value.

6085

"formulaValue": "A String", # Represents a formula.

6086

"stringValue": "A String", # Represents a string value.

6087

# Leading single quotes are not included. For example, if the user typed

6088

# `'123` into the UI, this would be represented as a `stringValue` of

6089

# `"123"`.

6090

"errorValue": { # An error in a cell. # Represents an error.

6091

# This field is read-only.

6092

"message": "A String", # A message with more information about the error

6093

# (in the spreadsheet's locale).

6094

"type": "A String", # The type of error.

6095

},

6096

},

6097

"formattedValue": "A String", # The formatted value of the cell.

6098

# This is the value as it's shown to the user.

6099

# This field is read-only.

6100

"userEnteredValue": { # The kinds of value that a cell in a spreadsheet can have. # The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`

6101

# Note: Dates, Times and DateTimes are represented as doubles in

6102

# serial number format.

6103

"numberValue": 3.14, # Represents a double value.

6104

# Note: Dates, Times and DateTimes are represented as doubles in

6105

# "serial number" format.

6106

"boolValue": True or False, # Represents a boolean value.

6107

"formulaValue": "A String", # Represents a formula.

6108

"stringValue": "A String", # Represents a string value.

6109

# Leading single quotes are not included. For example, if the user typed

6110

# `'123` into the UI, this would be represented as a `stringValue` of

6111

# `"123"`.

6112

"errorValue": { # An error in a cell. # Represents an error.

6113

# This field is read-only.

6114

"message": "A String", # A message with more information about the error

6115

# (in the spreadsheet's locale).

6116

"type": "A String", # The type of error.

6117

},

6118

},

6119

"note": "A String", # Any note on the cell.

6120

"effectiveFormat": { # The format of a cell. # The effective format being used by the cell.

6121

# This includes the results of applying any conditional formatting and,

6122

# if the cell contains a formula, the computed number format.

6123

# If the effective format is the default format, effective format will

6124

# not be written.

6125

# This field is read-only.

6126

"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

6127

"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on

6128

# the user's locale will be used if necessary for the given type.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame^]

6129

# See the [Date and Number Formats guide](/sheets/guides/formats) for more

6130

# information about the supported patterns.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

6131

"type": "A String", # The type of the number format.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

6132

# When writing, this field must be set.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

6133

},

6134

"textDirection": "A String", # The direction of the text in the cell.

6135

"padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.

6136

# When updating padding, every field must be specified.

6137

"top": 42, # The top padding of the cell.

6138

"right": 42, # The right padding of the cell.

6139

"bottom": 42, # The bottom padding of the cell.

6140

"left": 42, # The left padding of the cell.

6141

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

6142

"horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

6143

"backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.

6144

# for simplicity of conversion to/from color representations in various

6145

# languages over compactness; for example, the fields of this representation

6146

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

6147

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

6148

# method in iOS; and, with just a little work, it can be easily formatted into

6149

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

6154

#

6155

# // ...

6156

# public static java.awt.Color fromProto(Color protocolor) {

6157

# float alpha = protocolor.hasAlpha()

6158

# ? protocolor.getAlpha().getValue()

6159

# : 1.0;

6160

#

6161

# return new java.awt.Color(

6162

# protocolor.getRed(),

6163

# protocolor.getGreen(),

6164

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

6169

# float red = (float) color.getRed();

6170

# float green = (float) color.getGreen();

6171

# float blue = (float) color.getBlue();

6172

# float denominator = 255.0;

6173

# Color.Builder resultBuilder =

6174

# Color

6175

# .newBuilder()

6176

# .setRed(red / denominator)

6177

# .setGreen(green / denominator)

6178

# .setBlue(blue / denominator);

6179

# int alpha = color.getAlpha();

6180

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

6185

# .build());

6186

# }

6187

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

6192

#

6193

# // ...

6194

# static UIColor* fromProto(Color* protocolor) {

6195

# float red = [protocolor red];

6196

# float green = [protocolor green];

6197

# float blue = [protocolor blue];

6198

# FloatValue* alpha_wrapper = [protocolor alpha];

6199

# float alpha = 1.0;

6200

# if (alpha_wrapper != nil) {

6201

# alpha = [alpha_wrapper value];

6202

# }

6203

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

6204

# }

6205

#

6206

# static Color* toProto(UIColor* color) {

6207

# CGFloat red, green, blue, alpha;

6208

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

6209

# return nil;

6210

# }

6211

# Color* result = [Color alloc] init];

6212

# [result setRed:red];

6213

# [result setGreen:green];

6214

# [result setBlue:blue];

6215

# if (alpha <= 0.9999) {

6216

# [result setAlpha:floatWrapperWithValue(alpha)];

6217

# }

6218

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

6228

# var redFrac = rgb_color.red || 0.0;

6229

# var greenFrac = rgb_color.green || 0.0;

6230

# var blueFrac = rgb_color.blue || 0.0;

6231

# var red = Math.floor(redFrac * 255);

6232

# var green = Math.floor(greenFrac * 255);

6233

# var blue = Math.floor(blueFrac * 255);

6234

#

6235

# if (!('alpha' in rgb_color)) {

6236

# return rgbToCssColor_(red, green, blue);

6237

# }

6238

#

6239

# var alphaFrac = rgb_color.alpha.value || 0.0;

6240

# var rgbParams = [red, green, blue].join(',');

6241

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

6242

# };

6243

#

6244

# var rgbToCssColor_ = function(red, green, blue) {

6245

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

6246

# var hexString = rgbNumber.toString(16);

6247

# var missingZeros = 6 - hexString.length;

6248

# var resultBuilder = ['#'];

6249

# for (var i = 0; i < missingZeros; i++) {

6250

# resultBuilder.push('0');

6251

# }

6252

# resultBuilder.push(hexString);

6253

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

6258

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

6259

# the final pixel color is defined by the equation:

6260

#

6261

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

6262

#

6263

# This means that a value of 1.0 corresponds to a solid color, whereas

6264

# a value of 0.0 corresponds to a completely transparent color. This

6265

# uses a wrapper message rather than a simple float scalar so that it is

6266

# possible to distinguish between a default value and the value being unset.

6267

# If omitted, this color object is to be rendered as a solid color

6268

# (as if the alpha value had been explicitly given with a value of 1.0).

6269

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

6270

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

6271

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

6272

"verticalAlignment": "A String", # The vertical alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

6273

"textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).

6274

# Absent values indicate that the field isn't specified.

6275

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

6276

# for simplicity of conversion to/from color representations in various

6277

# languages over compactness; for example, the fields of this representation

6278

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

6279

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

6280

# method in iOS; and, with just a little work, it can be easily formatted into

6281

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

6286

#

6287

# // ...

6288

# public static java.awt.Color fromProto(Color protocolor) {

6289

# float alpha = protocolor.hasAlpha()

6290

# ? protocolor.getAlpha().getValue()

6291

# : 1.0;

6292

#

6293

# return new java.awt.Color(

6294

# protocolor.getRed(),

6295

# protocolor.getGreen(),

6296

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

6301

# float red = (float) color.getRed();

6302

# float green = (float) color.getGreen();

6303

# float blue = (float) color.getBlue();

6304

# float denominator = 255.0;

6305

# Color.Builder resultBuilder =

6306

# Color

6307

# .newBuilder()

6308

# .setRed(red / denominator)

6309

# .setGreen(green / denominator)

6310

# .setBlue(blue / denominator);

6311

# int alpha = color.getAlpha();

6312

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

6317

# .build());

6318

# }

6319

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

6324

#

6325

# // ...

6326

# static UIColor* fromProto(Color* protocolor) {

6327

# float red = [protocolor red];

6328

# float green = [protocolor green];

6329

# float blue = [protocolor blue];

6330

# FloatValue* alpha_wrapper = [protocolor alpha];

6331

# float alpha = 1.0;

6332

# if (alpha_wrapper != nil) {

6333

# alpha = [alpha_wrapper value];

6334

# }

6335

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

6336

# }

6337

#

6338

# static Color* toProto(UIColor* color) {

6339

# CGFloat red, green, blue, alpha;

6340

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

6341

# return nil;

6342

# }

6343

# Color* result = [Color alloc] init];

6344

# [result setRed:red];

6345

# [result setGreen:green];

6346

# [result setBlue:blue];

6347

# if (alpha <= 0.9999) {

6348

# [result setAlpha:floatWrapperWithValue(alpha)];

6349

# }

6350

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

6360

# var redFrac = rgb_color.red || 0.0;

6361

# var greenFrac = rgb_color.green || 0.0;

6362

# var blueFrac = rgb_color.blue || 0.0;

6363

# var red = Math.floor(redFrac * 255);

6364

# var green = Math.floor(greenFrac * 255);

6365

# var blue = Math.floor(blueFrac * 255);

6366

#

6367

# if (!('alpha' in rgb_color)) {

6368

# return rgbToCssColor_(red, green, blue);

6369

# }

6370

#

6371

# var alphaFrac = rgb_color.alpha.value || 0.0;

6372

# var rgbParams = [red, green, blue].join(',');

6373

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

6374

# };

6375

#

6376

# var rgbToCssColor_ = function(red, green, blue) {

6377

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

6378

# var hexString = rgbNumber.toString(16);

6379

# var missingZeros = 6 - hexString.length;

6380

# var resultBuilder = ['#'];

6381

# for (var i = 0; i < missingZeros; i++) {

6382

# resultBuilder.push('0');

6383

# }

6384

# resultBuilder.push(hexString);

6385

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

6390

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

6391

# the final pixel color is defined by the equation:

6392

#

6393

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

6394

#

6395

# This means that a value of 1.0 corresponds to a solid color, whereas

6396

# a value of 0.0 corresponds to a completely transparent color. This

6397

# uses a wrapper message rather than a simple float scalar so that it is

6398

# possible to distinguish between a default value and the value being unset.

6399

# If omitted, this color object is to be rendered as a solid color

6400

# (as if the alpha value had been explicitly given with a value of 1.0).

6401

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

6402

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

6403

},

6404

"bold": True or False, # True if the text is bold.

6405

"strikethrough": True or False, # True if the text has a strikethrough.

6406

"fontFamily": "A String", # The font family.

6407

"fontSize": 42, # The size of the font.

6408

"italic": True or False, # True if the text is italicized.

6409

"underline": True or False, # True if the text is underlined.

6410

},

6411

"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.

6412

"borders": { # The borders of the cell. # The borders of the cell.

6413

"top": { # A border along a cell. # The top border of the cell.

6414

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

6415

# for simplicity of conversion to/from color representations in various

6416

# languages over compactness; for example, the fields of this representation

6417

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

6418

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

6419

# method in iOS; and, with just a little work, it can be easily formatted into

6420

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

6425

#

6426

# // ...

6427

# public static java.awt.Color fromProto(Color protocolor) {

6428

# float alpha = protocolor.hasAlpha()

6429

# ? protocolor.getAlpha().getValue()

6430

# : 1.0;

6431

#

6432

# return new java.awt.Color(

6433

# protocolor.getRed(),

6434

# protocolor.getGreen(),

6435

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

6440

# float red = (float) color.getRed();

6441

# float green = (float) color.getGreen();

6442

# float blue = (float) color.getBlue();

6443

# float denominator = 255.0;

6444

# Color.Builder resultBuilder =

6445

# Color

6446

# .newBuilder()

6447

# .setRed(red / denominator)

6448

# .setGreen(green / denominator)

6449

# .setBlue(blue / denominator);

6450

# int alpha = color.getAlpha();

6451

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

6456

# .build());

6457

# }

6458

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

6463

#

6464

# // ...

6465

# static UIColor* fromProto(Color* protocolor) {

6466

# float red = [protocolor red];

6467

# float green = [protocolor green];

6468

# float blue = [protocolor blue];

6469

# FloatValue* alpha_wrapper = [protocolor alpha];

6470

# float alpha = 1.0;

6471

# if (alpha_wrapper != nil) {

6472

# alpha = [alpha_wrapper value];

6473

# }

6474

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

6475

# }

6476

#

6477

# static Color* toProto(UIColor* color) {

6478

# CGFloat red, green, blue, alpha;

6479

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

6480

# return nil;

6481

# }

6482

# Color* result = [Color alloc] init];

6483

# [result setRed:red];

6484

# [result setGreen:green];

6485

# [result setBlue:blue];

6486

# if (alpha <= 0.9999) {

6487

# [result setAlpha:floatWrapperWithValue(alpha)];

6488

# }

6489

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

6499

# var redFrac = rgb_color.red || 0.0;

6500

# var greenFrac = rgb_color.green || 0.0;

6501

# var blueFrac = rgb_color.blue || 0.0;

6502

# var red = Math.floor(redFrac * 255);

6503

# var green = Math.floor(greenFrac * 255);

6504

# var blue = Math.floor(blueFrac * 255);

6505

#

6506

# if (!('alpha' in rgb_color)) {

6507

# return rgbToCssColor_(red, green, blue);

6508

# }

6509

#

6510

# var alphaFrac = rgb_color.alpha.value || 0.0;

6511

# var rgbParams = [red, green, blue].join(',');

6512

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

6513

# };

6514

#

6515

# var rgbToCssColor_ = function(red, green, blue) {

6516

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

6517

# var hexString = rgbNumber.toString(16);

6518

# var missingZeros = 6 - hexString.length;

6519

# var resultBuilder = ['#'];

6520

# for (var i = 0; i < missingZeros; i++) {

6521

# resultBuilder.push('0');

6522

# }

6523

# resultBuilder.push(hexString);

6524

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

6529

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

6530

# the final pixel color is defined by the equation:

6531

#

6532

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

6533

#

6534

# This means that a value of 1.0 corresponds to a solid color, whereas

6535

# a value of 0.0 corresponds to a completely transparent color. This

6536

# uses a wrapper message rather than a simple float scalar so that it is

6537

# possible to distinguish between a default value and the value being unset.

6538

# If omitted, this color object is to be rendered as a solid color

6539

# (as if the alpha value had been explicitly given with a value of 1.0).

6540

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

6541

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

6542

},

6543

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

6544

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

6545

"style": "A String", # The style of the border.

6546

},

6547

"right": { # A border along a cell. # The right border of the cell.

6548

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

6549

# for simplicity of conversion to/from color representations in various

6550

# languages over compactness; for example, the fields of this representation

6551

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

6552

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

6553

# method in iOS; and, with just a little work, it can be easily formatted into

6554

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

6559

#

6560

# // ...

6561

# public static java.awt.Color fromProto(Color protocolor) {

6562

# float alpha = protocolor.hasAlpha()

6563

# ? protocolor.getAlpha().getValue()

6564

# : 1.0;

6565

#

6566

# return new java.awt.Color(

6567

# protocolor.getRed(),

6568

# protocolor.getGreen(),

6569

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

6574

# float red = (float) color.getRed();

6575

# float green = (float) color.getGreen();

6576

# float blue = (float) color.getBlue();

6577

# float denominator = 255.0;

6578

# Color.Builder resultBuilder =

6579

# Color

6580

# .newBuilder()

6581

# .setRed(red / denominator)

6582

# .setGreen(green / denominator)

6583

# .setBlue(blue / denominator);

6584

# int alpha = color.getAlpha();

6585

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

6590

# .build());

6591

# }

6592

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

6597

#

6598

# // ...

6599

# static UIColor* fromProto(Color* protocolor) {

6600

# float red = [protocolor red];

6601

# float green = [protocolor green];

6602

# float blue = [protocolor blue];

6603

# FloatValue* alpha_wrapper = [protocolor alpha];

6604

# float alpha = 1.0;

6605

# if (alpha_wrapper != nil) {

6606

# alpha = [alpha_wrapper value];

6607

# }

6608

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

6609

# }

6610

#

6611

# static Color* toProto(UIColor* color) {

6612

# CGFloat red, green, blue, alpha;

6613

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

6614

# return nil;

6615

# }

6616

# Color* result = [Color alloc] init];

6617

# [result setRed:red];

6618

# [result setGreen:green];

6619

# [result setBlue:blue];

6620

# if (alpha <= 0.9999) {

6621

# [result setAlpha:floatWrapperWithValue(alpha)];

6622

# }

6623

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

6633

# var redFrac = rgb_color.red || 0.0;

6634

# var greenFrac = rgb_color.green || 0.0;

6635

# var blueFrac = rgb_color.blue || 0.0;

6636

# var red = Math.floor(redFrac * 255);

6637

# var green = Math.floor(greenFrac * 255);

6638

# var blue = Math.floor(blueFrac * 255);

6639

#

6640

# if (!('alpha' in rgb_color)) {

6641

# return rgbToCssColor_(red, green, blue);

6642

# }

6643

#

6644

# var alphaFrac = rgb_color.alpha.value || 0.0;

6645

# var rgbParams = [red, green, blue].join(',');

6646

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

6647

# };

6648

#

6649

# var rgbToCssColor_ = function(red, green, blue) {

6650

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

6651

# var hexString = rgbNumber.toString(16);

6652

# var missingZeros = 6 - hexString.length;

6653

# var resultBuilder = ['#'];

6654

# for (var i = 0; i < missingZeros; i++) {

6655

# resultBuilder.push('0');

6656

# }

6657

# resultBuilder.push(hexString);

6658

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

6663

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

6664

# the final pixel color is defined by the equation:

6665

#

6666

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

6667

#

6668

# This means that a value of 1.0 corresponds to a solid color, whereas

6669

# a value of 0.0 corresponds to a completely transparent color. This

6670

# uses a wrapper message rather than a simple float scalar so that it is

6671

# possible to distinguish between a default value and the value being unset.

6672

# If omitted, this color object is to be rendered as a solid color

6673

# (as if the alpha value had been explicitly given with a value of 1.0).

6674

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

6675

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

6676

},

6677

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

6678

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

6679

"style": "A String", # The style of the border.

6680

},

6681

"bottom": { # A border along a cell. # The bottom border of the cell.

6682

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

6683

# for simplicity of conversion to/from color representations in various

6684

# languages over compactness; for example, the fields of this representation

6685

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

6686

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

6687

# method in iOS; and, with just a little work, it can be easily formatted into

6688

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

6693

#

6694

# // ...

6695

# public static java.awt.Color fromProto(Color protocolor) {

6696

# float alpha = protocolor.hasAlpha()

6697

# ? protocolor.getAlpha().getValue()

6698

# : 1.0;

6699

#

6700

# return new java.awt.Color(

6701

# protocolor.getRed(),

6702

# protocolor.getGreen(),

6703

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

6708

# float red = (float) color.getRed();

6709

# float green = (float) color.getGreen();

6710

# float blue = (float) color.getBlue();

6711

# float denominator = 255.0;

6712

# Color.Builder resultBuilder =

6713

# Color

6714

# .newBuilder()

6715

# .setRed(red / denominator)

6716

# .setGreen(green / denominator)

6717

# .setBlue(blue / denominator);

6718

# int alpha = color.getAlpha();

6719

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

6724

# .build());

6725

# }

6726

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

6731

#

6732

# // ...

6733

# static UIColor* fromProto(Color* protocolor) {

6734

# float red = [protocolor red];

6735

# float green = [protocolor green];

6736

# float blue = [protocolor blue];

6737

# FloatValue* alpha_wrapper = [protocolor alpha];

6738

# float alpha = 1.0;

6739

# if (alpha_wrapper != nil) {

6740

# alpha = [alpha_wrapper value];

6741

# }

6742

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

6743

# }

6744

#

6745

# static Color* toProto(UIColor* color) {

6746

# CGFloat red, green, blue, alpha;

6747

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

6748

# return nil;

6749

# }

6750

# Color* result = [Color alloc] init];

6751

# [result setRed:red];

6752

# [result setGreen:green];

6753

# [result setBlue:blue];

6754

# if (alpha <= 0.9999) {

6755

# [result setAlpha:floatWrapperWithValue(alpha)];

6756

# }

6757

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

6767

# var redFrac = rgb_color.red || 0.0;

6768

# var greenFrac = rgb_color.green || 0.0;

6769

# var blueFrac = rgb_color.blue || 0.0;

6770

# var red = Math.floor(redFrac * 255);

6771

# var green = Math.floor(greenFrac * 255);

6772

# var blue = Math.floor(blueFrac * 255);

6773

#

6774

# if (!('alpha' in rgb_color)) {

6775

# return rgbToCssColor_(red, green, blue);

6776

# }

6777

#

6778

# var alphaFrac = rgb_color.alpha.value || 0.0;

6779

# var rgbParams = [red, green, blue].join(',');

6780

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

6781

# };

6782

#

6783

# var rgbToCssColor_ = function(red, green, blue) {

6784

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

6785

# var hexString = rgbNumber.toString(16);

6786

# var missingZeros = 6 - hexString.length;

6787

# var resultBuilder = ['#'];

6788

# for (var i = 0; i < missingZeros; i++) {

6789

# resultBuilder.push('0');

6790

# }

6791

# resultBuilder.push(hexString);

6792

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

6797

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

6798

# the final pixel color is defined by the equation:

6799

#

6800

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

6801

#

6802

# This means that a value of 1.0 corresponds to a solid color, whereas

6803

# a value of 0.0 corresponds to a completely transparent color. This

6804

# uses a wrapper message rather than a simple float scalar so that it is

6805

# possible to distinguish between a default value and the value being unset.

6806

# If omitted, this color object is to be rendered as a solid color

6807

# (as if the alpha value had been explicitly given with a value of 1.0).

6808

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

6809

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

6810

},

6811

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

6812

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

6813

"style": "A String", # The style of the border.

6814

},

6815

"left": { # A border along a cell. # The left border of the cell.

6816

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

6817

# for simplicity of conversion to/from color representations in various

6818

# languages over compactness; for example, the fields of this representation

6819

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

6820

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

6821

# method in iOS; and, with just a little work, it can be easily formatted into

6822

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

6827

#

6828

# // ...

6829

# public static java.awt.Color fromProto(Color protocolor) {

6830

# float alpha = protocolor.hasAlpha()

6831

# ? protocolor.getAlpha().getValue()

6832

# : 1.0;

6833

#

6834

# return new java.awt.Color(

6835

# protocolor.getRed(),

6836

# protocolor.getGreen(),

6837

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

6842

# float red = (float) color.getRed();

6843

# float green = (float) color.getGreen();

6844

# float blue = (float) color.getBlue();

6845

# float denominator = 255.0;

6846

# Color.Builder resultBuilder =

6847

# Color

6848

# .newBuilder()

6849

# .setRed(red / denominator)

6850

# .setGreen(green / denominator)

6851

# .setBlue(blue / denominator);

6852

# int alpha = color.getAlpha();

6853

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

6858

# .build());

6859

# }

6860

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

6865

#

6866

# // ...

6867

# static UIColor* fromProto(Color* protocolor) {

6868

# float red = [protocolor red];

6869

# float green = [protocolor green];

6870

# float blue = [protocolor blue];

6871

# FloatValue* alpha_wrapper = [protocolor alpha];

6872

# float alpha = 1.0;

6873

# if (alpha_wrapper != nil) {

6874

# alpha = [alpha_wrapper value];

6875

# }

6876

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

6877

# }

6878

#

6879

# static Color* toProto(UIColor* color) {

6880

# CGFloat red, green, blue, alpha;

6881

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

6882

# return nil;

6883

# }

6884

# Color* result = [Color alloc] init];

6885

# [result setRed:red];

6886

# [result setGreen:green];

6887

# [result setBlue:blue];

6888

# if (alpha <= 0.9999) {

6889

# [result setAlpha:floatWrapperWithValue(alpha)];

6890

# }

6891

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

6901

# var redFrac = rgb_color.red || 0.0;

6902

# var greenFrac = rgb_color.green || 0.0;

6903

# var blueFrac = rgb_color.blue || 0.0;

6904

# var red = Math.floor(redFrac * 255);

6905

# var green = Math.floor(greenFrac * 255);

6906

# var blue = Math.floor(blueFrac * 255);

6907

#

6908

# if (!('alpha' in rgb_color)) {

6909

# return rgbToCssColor_(red, green, blue);

6910

# }

6911

#

6912

# var alphaFrac = rgb_color.alpha.value || 0.0;

6913

# var rgbParams = [red, green, blue].join(',');

6914

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

6915

# };

6916

#

6917

# var rgbToCssColor_ = function(red, green, blue) {

6918

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

6919

# var hexString = rgbNumber.toString(16);

6920

# var missingZeros = 6 - hexString.length;

6921

# var resultBuilder = ['#'];

6922

# for (var i = 0; i < missingZeros; i++) {

6923

# resultBuilder.push('0');

6924

# }

6925

# resultBuilder.push(hexString);

6926

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

6931

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

6932

# the final pixel color is defined by the equation:

6933

#

6934

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

6935

#

6936

# This means that a value of 1.0 corresponds to a solid color, whereas

6937

# a value of 0.0 corresponds to a completely transparent color. This

6938

# uses a wrapper message rather than a simple float scalar so that it is

6939

# possible to distinguish between a default value and the value being unset.

6940

# If omitted, this color object is to be rendered as a solid color

6941

# (as if the alpha value had been explicitly given with a value of 1.0).

6942

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

6943

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

6944

},

6945

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

6946

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

6947

"style": "A String", # The style of the border.

6948

},

6949

},

6950

"wrapStrategy": "A String", # The wrap strategy for the value in the cell.

6951

},

6952

"userEnteredFormat": { # The format of a cell. # The format the user entered for the cell.

6953

#

6954

# When writing, the new format will be merged with the existing format.

6955

"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

6956

"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on

6957

# the user's locale will be used if necessary for the given type.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame^]

6958

# See the [Date and Number Formats guide](/sheets/guides/formats) for more

6959

# information about the supported patterns.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

6960

"type": "A String", # The type of the number format.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

6961

# When writing, this field must be set.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

6962

},

6963

"textDirection": "A String", # The direction of the text in the cell.

6964

"padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.

6965

# When updating padding, every field must be specified.

6966

"top": 42, # The top padding of the cell.

6967

"right": 42, # The right padding of the cell.

6968

"bottom": 42, # The bottom padding of the cell.

6969

"left": 42, # The left padding of the cell.

6970

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

6971

"horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

6972

"backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.

6973

# for simplicity of conversion to/from color representations in various

6974

# languages over compactness; for example, the fields of this representation

6975

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

6976

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

6977

# method in iOS; and, with just a little work, it can be easily formatted into

6978

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

6983

#

6984

# // ...

6985

# public static java.awt.Color fromProto(Color protocolor) {

6986

# float alpha = protocolor.hasAlpha()

6987

# ? protocolor.getAlpha().getValue()

6988

# : 1.0;

6989

#

6990

# return new java.awt.Color(

6991

# protocolor.getRed(),

6992

# protocolor.getGreen(),

6993

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

6998

# float red = (float) color.getRed();

6999

# float green = (float) color.getGreen();

7000

# float blue = (float) color.getBlue();

7001

# float denominator = 255.0;

7002

# Color.Builder resultBuilder =

7003

# Color

7004

# .newBuilder()

7005

# .setRed(red / denominator)

7006

# .setGreen(green / denominator)

7007

# .setBlue(blue / denominator);

7008

# int alpha = color.getAlpha();

7009

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

7014

# .build());

7015

# }

7016

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

7021

#

7022

# // ...

7023

# static UIColor* fromProto(Color* protocolor) {

7024

# float red = [protocolor red];

7025

# float green = [protocolor green];

7026

# float blue = [protocolor blue];

7027

# FloatValue* alpha_wrapper = [protocolor alpha];

7028

# float alpha = 1.0;

7029

# if (alpha_wrapper != nil) {

7030

# alpha = [alpha_wrapper value];

7031

# }

7032

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

7033

# }

7034

#

7035

# static Color* toProto(UIColor* color) {

7036

# CGFloat red, green, blue, alpha;

7037

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

7038

# return nil;

7039

# }

7040

# Color* result = [Color alloc] init];

7041

# [result setRed:red];

7042

# [result setGreen:green];

7043

# [result setBlue:blue];

7044

# if (alpha <= 0.9999) {

7045

# [result setAlpha:floatWrapperWithValue(alpha)];

7046

# }

7047

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

7057

# var redFrac = rgb_color.red || 0.0;

7058

# var greenFrac = rgb_color.green || 0.0;

7059

# var blueFrac = rgb_color.blue || 0.0;

7060

# var red = Math.floor(redFrac * 255);

7061

# var green = Math.floor(greenFrac * 255);

7062

# var blue = Math.floor(blueFrac * 255);

7063

#

7064

# if (!('alpha' in rgb_color)) {

7065

# return rgbToCssColor_(red, green, blue);

7066

# }

7067

#

7068

# var alphaFrac = rgb_color.alpha.value || 0.0;

7069

# var rgbParams = [red, green, blue].join(',');

7070

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

7071

# };

7072

#

7073

# var rgbToCssColor_ = function(red, green, blue) {

7074

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

7075

# var hexString = rgbNumber.toString(16);

7076

# var missingZeros = 6 - hexString.length;

7077

# var resultBuilder = ['#'];

7078

# for (var i = 0; i < missingZeros; i++) {

7079

# resultBuilder.push('0');

7080

# }

7081

# resultBuilder.push(hexString);

7082

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

7087

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

7088

# the final pixel color is defined by the equation:

7089

#

7090

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

7091

#

7092

# This means that a value of 1.0 corresponds to a solid color, whereas

7093

# a value of 0.0 corresponds to a completely transparent color. This

7094

# uses a wrapper message rather than a simple float scalar so that it is

7095

# possible to distinguish between a default value and the value being unset.

7096

# If omitted, this color object is to be rendered as a solid color

7097

# (as if the alpha value had been explicitly given with a value of 1.0).

7098

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

7099

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

7100

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

7101

"verticalAlignment": "A String", # The vertical alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

7102

"textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).

7103

# Absent values indicate that the field isn't specified.

7104

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

7105

# for simplicity of conversion to/from color representations in various

7106

# languages over compactness; for example, the fields of this representation

7107

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

7108

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

7109

# method in iOS; and, with just a little work, it can be easily formatted into

7110

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

7115

#

7116

# // ...

7117

# public static java.awt.Color fromProto(Color protocolor) {

7118

# float alpha = protocolor.hasAlpha()

7119

# ? protocolor.getAlpha().getValue()

7120

# : 1.0;

7121

#

7122

# return new java.awt.Color(

7123

# protocolor.getRed(),

7124

# protocolor.getGreen(),

7125

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

7130

# float red = (float) color.getRed();

7131

# float green = (float) color.getGreen();

7132

# float blue = (float) color.getBlue();

7133

# float denominator = 255.0;

7134

# Color.Builder resultBuilder =

7135

# Color

7136

# .newBuilder()

7137

# .setRed(red / denominator)

7138

# .setGreen(green / denominator)

7139

# .setBlue(blue / denominator);

7140

# int alpha = color.getAlpha();

7141

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

7146

# .build());

7147

# }

7148

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

7153

#

7154

# // ...

7155

# static UIColor* fromProto(Color* protocolor) {

7156

# float red = [protocolor red];

7157

# float green = [protocolor green];

7158

# float blue = [protocolor blue];

7159

# FloatValue* alpha_wrapper = [protocolor alpha];

7160

# float alpha = 1.0;

7161

# if (alpha_wrapper != nil) {

7162

# alpha = [alpha_wrapper value];

7163

# }

7164

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

7165

# }

7166

#

7167

# static Color* toProto(UIColor* color) {

7168

# CGFloat red, green, blue, alpha;

7169

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

7170

# return nil;

7171

# }

7172

# Color* result = [Color alloc] init];

7173

# [result setRed:red];

7174

# [result setGreen:green];

7175

# [result setBlue:blue];

7176

# if (alpha <= 0.9999) {

7177

# [result setAlpha:floatWrapperWithValue(alpha)];

7178

# }

7179

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

7189

# var redFrac = rgb_color.red || 0.0;

7190

# var greenFrac = rgb_color.green || 0.0;

7191

# var blueFrac = rgb_color.blue || 0.0;

7192

# var red = Math.floor(redFrac * 255);

7193

# var green = Math.floor(greenFrac * 255);

7194

# var blue = Math.floor(blueFrac * 255);

7195

#

7196

# if (!('alpha' in rgb_color)) {

7197

# return rgbToCssColor_(red, green, blue);

7198

# }

7199

#

7200

# var alphaFrac = rgb_color.alpha.value || 0.0;

7201

# var rgbParams = [red, green, blue].join(',');

7202

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

7203

# };

7204

#

7205

# var rgbToCssColor_ = function(red, green, blue) {

7206

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

7207

# var hexString = rgbNumber.toString(16);

7208

# var missingZeros = 6 - hexString.length;

7209

# var resultBuilder = ['#'];

7210

# for (var i = 0; i < missingZeros; i++) {

7211

# resultBuilder.push('0');

7212

# }

7213

# resultBuilder.push(hexString);

7214

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

7219

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

7220

# the final pixel color is defined by the equation:

7221

#

7222

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

7223

#

7224

# This means that a value of 1.0 corresponds to a solid color, whereas

7225

# a value of 0.0 corresponds to a completely transparent color. This

7226

# uses a wrapper message rather than a simple float scalar so that it is

7227

# possible to distinguish between a default value and the value being unset.

7228

# If omitted, this color object is to be rendered as a solid color

7229

# (as if the alpha value had been explicitly given with a value of 1.0).

7230

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

7231

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

7232

},

7233

"bold": True or False, # True if the text is bold.

7234

"strikethrough": True or False, # True if the text has a strikethrough.

7235

"fontFamily": "A String", # The font family.

7236

"fontSize": 42, # The size of the font.

7237

"italic": True or False, # True if the text is italicized.

7238

"underline": True or False, # True if the text is underlined.

7239

},

7240

"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.

7241

"borders": { # The borders of the cell. # The borders of the cell.

7242

"top": { # A border along a cell. # The top border of the cell.

7243

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

7244

# for simplicity of conversion to/from color representations in various

7245

# languages over compactness; for example, the fields of this representation

7246

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

7247

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

7248

# method in iOS; and, with just a little work, it can be easily formatted into

7249

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

7254

#

7255

# // ...

7256

# public static java.awt.Color fromProto(Color protocolor) {

7257

# float alpha = protocolor.hasAlpha()

7258

# ? protocolor.getAlpha().getValue()

7259

# : 1.0;

7260

#

7261

# return new java.awt.Color(

7262

# protocolor.getRed(),

7263

# protocolor.getGreen(),

7264

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

7269

# float red = (float) color.getRed();

7270

# float green = (float) color.getGreen();

7271

# float blue = (float) color.getBlue();

7272

# float denominator = 255.0;

7273

# Color.Builder resultBuilder =

7274

# Color

7275

# .newBuilder()

7276

# .setRed(red / denominator)

7277

# .setGreen(green / denominator)

7278

# .setBlue(blue / denominator);

7279

# int alpha = color.getAlpha();

7280

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

7285

# .build());

7286

# }

7287

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

7292

#

7293

# // ...

7294

# static UIColor* fromProto(Color* protocolor) {

7295

# float red = [protocolor red];

7296

# float green = [protocolor green];

7297

# float blue = [protocolor blue];

7298

# FloatValue* alpha_wrapper = [protocolor alpha];

7299

# float alpha = 1.0;

7300

# if (alpha_wrapper != nil) {

7301

# alpha = [alpha_wrapper value];

7302

# }

7303

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

7304

# }

7305

#

7306

# static Color* toProto(UIColor* color) {

7307

# CGFloat red, green, blue, alpha;

7308

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

7309

# return nil;

7310

# }

7311

# Color* result = [Color alloc] init];

7312

# [result setRed:red];

7313

# [result setGreen:green];

7314

# [result setBlue:blue];

7315

# if (alpha <= 0.9999) {

7316

# [result setAlpha:floatWrapperWithValue(alpha)];

7317

# }

7318

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

7328

# var redFrac = rgb_color.red || 0.0;

7329

# var greenFrac = rgb_color.green || 0.0;

7330

# var blueFrac = rgb_color.blue || 0.0;

7331

# var red = Math.floor(redFrac * 255);

7332

# var green = Math.floor(greenFrac * 255);

7333

# var blue = Math.floor(blueFrac * 255);

7334

#

7335

# if (!('alpha' in rgb_color)) {

7336

# return rgbToCssColor_(red, green, blue);

7337

# }

7338

#

7339

# var alphaFrac = rgb_color.alpha.value || 0.0;

7340

# var rgbParams = [red, green, blue].join(',');

7341

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

7342

# };

7343

#

7344

# var rgbToCssColor_ = function(red, green, blue) {

7345

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

7346

# var hexString = rgbNumber.toString(16);

7347

# var missingZeros = 6 - hexString.length;

7348

# var resultBuilder = ['#'];

7349

# for (var i = 0; i < missingZeros; i++) {

7350

# resultBuilder.push('0');

7351

# }

7352

# resultBuilder.push(hexString);

7353

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

7358

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

7359

# the final pixel color is defined by the equation:

7360

#

7361

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

7362

#

7363

# This means that a value of 1.0 corresponds to a solid color, whereas

7364

# a value of 0.0 corresponds to a completely transparent color. This

7365

# uses a wrapper message rather than a simple float scalar so that it is

7366

# possible to distinguish between a default value and the value being unset.

7367

# If omitted, this color object is to be rendered as a solid color

7368

# (as if the alpha value had been explicitly given with a value of 1.0).

7369

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

7370

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

7371

},

7372

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

7373

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

7374

"style": "A String", # The style of the border.

7375

},

7376

"right": { # A border along a cell. # The right border of the cell.

7377

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

7378

# for simplicity of conversion to/from color representations in various

7379

# languages over compactness; for example, the fields of this representation

7380

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

7381

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

7382

# method in iOS; and, with just a little work, it can be easily formatted into

7383

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

7388

#

7389

# // ...

7390

# public static java.awt.Color fromProto(Color protocolor) {

7391

# float alpha = protocolor.hasAlpha()

7392

# ? protocolor.getAlpha().getValue()

7393

# : 1.0;

7394

#

7395

# return new java.awt.Color(

7396

# protocolor.getRed(),

7397

# protocolor.getGreen(),

7398

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

7403

# float red = (float) color.getRed();

7404

# float green = (float) color.getGreen();

7405

# float blue = (float) color.getBlue();

7406

# float denominator = 255.0;

7407

# Color.Builder resultBuilder =

7408

# Color

7409

# .newBuilder()

7410

# .setRed(red / denominator)

7411

# .setGreen(green / denominator)

7412

# .setBlue(blue / denominator);

7413

# int alpha = color.getAlpha();

7414

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

7419

# .build());

7420

# }

7421

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

7426

#

7427

# // ...

7428

# static UIColor* fromProto(Color* protocolor) {

7429

# float red = [protocolor red];

7430

# float green = [protocolor green];

7431

# float blue = [protocolor blue];

7432

# FloatValue* alpha_wrapper = [protocolor alpha];

7433

# float alpha = 1.0;

7434

# if (alpha_wrapper != nil) {

7435

# alpha = [alpha_wrapper value];

7436

# }

7437

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

7438

# }

7439

#

7440

# static Color* toProto(UIColor* color) {

7441

# CGFloat red, green, blue, alpha;

7442

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

7443

# return nil;

7444

# }

7445

# Color* result = [Color alloc] init];

7446

# [result setRed:red];

7447

# [result setGreen:green];

7448

# [result setBlue:blue];

7449

# if (alpha <= 0.9999) {

7450

# [result setAlpha:floatWrapperWithValue(alpha)];

7451

# }

7452

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

7462

# var redFrac = rgb_color.red || 0.0;

7463

# var greenFrac = rgb_color.green || 0.0;

7464

# var blueFrac = rgb_color.blue || 0.0;

7465

# var red = Math.floor(redFrac * 255);

7466

# var green = Math.floor(greenFrac * 255);

7467

# var blue = Math.floor(blueFrac * 255);

7468

#

7469

# if (!('alpha' in rgb_color)) {

7470

# return rgbToCssColor_(red, green, blue);

7471

# }

7472

#

7473

# var alphaFrac = rgb_color.alpha.value || 0.0;

7474

# var rgbParams = [red, green, blue].join(',');

7475

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

7476

# };

7477

#

7478

# var rgbToCssColor_ = function(red, green, blue) {

7479

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

7480

# var hexString = rgbNumber.toString(16);

7481

# var missingZeros = 6 - hexString.length;

7482

# var resultBuilder = ['#'];

7483

# for (var i = 0; i < missingZeros; i++) {

7484

# resultBuilder.push('0');

7485

# }

7486

# resultBuilder.push(hexString);

7487

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

7492

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

7493

# the final pixel color is defined by the equation:

7494

#

7495

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

7496

#

7497

# This means that a value of 1.0 corresponds to a solid color, whereas

7498

# a value of 0.0 corresponds to a completely transparent color. This

7499

# uses a wrapper message rather than a simple float scalar so that it is

7500

# possible to distinguish between a default value and the value being unset.

7501

# If omitted, this color object is to be rendered as a solid color

7502

# (as if the alpha value had been explicitly given with a value of 1.0).

7503

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

7504

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

7505

},

7506

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

7507

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

7508

"style": "A String", # The style of the border.

7509

},

7510

"bottom": { # A border along a cell. # The bottom border of the cell.

7511

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

7512

# for simplicity of conversion to/from color representations in various

7513

# languages over compactness; for example, the fields of this representation

7514

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

7515

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

7516

# method in iOS; and, with just a little work, it can be easily formatted into

7517

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

7522

#

7523

# // ...

7524

# public static java.awt.Color fromProto(Color protocolor) {

7525

# float alpha = protocolor.hasAlpha()

7526

# ? protocolor.getAlpha().getValue()

7527

# : 1.0;

7528

#

7529

# return new java.awt.Color(

7530

# protocolor.getRed(),

7531

# protocolor.getGreen(),

7532

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

7537

# float red = (float) color.getRed();

7538

# float green = (float) color.getGreen();

7539

# float blue = (float) color.getBlue();

7540

# float denominator = 255.0;

7541

# Color.Builder resultBuilder =

7542

# Color

7543

# .newBuilder()

7544

# .setRed(red / denominator)

7545

# .setGreen(green / denominator)

7546

# .setBlue(blue / denominator);

7547

# int alpha = color.getAlpha();

7548

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

7553

# .build());

7554

# }

7555

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

7560

#

7561

# // ...

7562

# static UIColor* fromProto(Color* protocolor) {

7563

# float red = [protocolor red];

7564

# float green = [protocolor green];

7565

# float blue = [protocolor blue];

7566

# FloatValue* alpha_wrapper = [protocolor alpha];

7567

# float alpha = 1.0;

7568

# if (alpha_wrapper != nil) {

7569

# alpha = [alpha_wrapper value];

7570

# }

7571

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

7572

# }

7573

#

7574

# static Color* toProto(UIColor* color) {

7575

# CGFloat red, green, blue, alpha;

7576

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

7577

# return nil;

7578

# }

7579

# Color* result = [Color alloc] init];

7580

# [result setRed:red];

7581

# [result setGreen:green];

7582

# [result setBlue:blue];

7583

# if (alpha <= 0.9999) {

7584

# [result setAlpha:floatWrapperWithValue(alpha)];

7585

# }

7586

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

7596

# var redFrac = rgb_color.red || 0.0;

7597

# var greenFrac = rgb_color.green || 0.0;

7598

# var blueFrac = rgb_color.blue || 0.0;

7599

# var red = Math.floor(redFrac * 255);

7600

# var green = Math.floor(greenFrac * 255);

7601

# var blue = Math.floor(blueFrac * 255);

7602

#

7603

# if (!('alpha' in rgb_color)) {

7604

# return rgbToCssColor_(red, green, blue);

7605

# }

7606

#

7607

# var alphaFrac = rgb_color.alpha.value || 0.0;

7608

# var rgbParams = [red, green, blue].join(',');

7609

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

7610

# };

7611

#

7612

# var rgbToCssColor_ = function(red, green, blue) {

7613

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

7614

# var hexString = rgbNumber.toString(16);

7615

# var missingZeros = 6 - hexString.length;

7616

# var resultBuilder = ['#'];

7617

# for (var i = 0; i < missingZeros; i++) {

7618

# resultBuilder.push('0');

7619

# }

7620

# resultBuilder.push(hexString);

7621

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

7626

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

7627

# the final pixel color is defined by the equation:

7628

#

7629

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

7630

#

7631

# This means that a value of 1.0 corresponds to a solid color, whereas

7632

# a value of 0.0 corresponds to a completely transparent color. This

7633

# uses a wrapper message rather than a simple float scalar so that it is

7634

# possible to distinguish between a default value and the value being unset.

7635

# If omitted, this color object is to be rendered as a solid color

7636

# (as if the alpha value had been explicitly given with a value of 1.0).

7637

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

7638

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

7639

},

7640

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

7641

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

7642

"style": "A String", # The style of the border.

7643

},

7644

"left": { # A border along a cell. # The left border of the cell.

7645

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

7646

# for simplicity of conversion to/from color representations in various

7647

# languages over compactness; for example, the fields of this representation

7648

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

7649

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

7650

# method in iOS; and, with just a little work, it can be easily formatted into

7651

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

7656

#

7657

# // ...

7658

# public static java.awt.Color fromProto(Color protocolor) {

7659

# float alpha = protocolor.hasAlpha()

7660

# ? protocolor.getAlpha().getValue()

7661

# : 1.0;

7662

#

7663

# return new java.awt.Color(

7664

# protocolor.getRed(),

7665

# protocolor.getGreen(),

7666

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

7671

# float red = (float) color.getRed();

7672

# float green = (float) color.getGreen();

7673

# float blue = (float) color.getBlue();

7674

# float denominator = 255.0;

7675

# Color.Builder resultBuilder =

7676

# Color

7677

# .newBuilder()

7678

# .setRed(red / denominator)

7679

# .setGreen(green / denominator)

7680

# .setBlue(blue / denominator);

7681

# int alpha = color.getAlpha();

7682

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

7687

# .build());

7688

# }

7689

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

7694

#

7695

# // ...

7696

# static UIColor* fromProto(Color* protocolor) {

7697

# float red = [protocolor red];

7698

# float green = [protocolor green];

7699

# float blue = [protocolor blue];

7700

# FloatValue* alpha_wrapper = [protocolor alpha];

7701

# float alpha = 1.0;

7702

# if (alpha_wrapper != nil) {

7703

# alpha = [alpha_wrapper value];

7704

# }

7705

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

7706

# }

7707

#

7708

# static Color* toProto(UIColor* color) {

7709

# CGFloat red, green, blue, alpha;

7710

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

7711

# return nil;

7712

# }

7713

# Color* result = [Color alloc] init];

7714

# [result setRed:red];

7715

# [result setGreen:green];

7716

# [result setBlue:blue];

7717

# if (alpha <= 0.9999) {

7718

# [result setAlpha:floatWrapperWithValue(alpha)];

7719

# }

7720

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

7730

# var redFrac = rgb_color.red || 0.0;

7731

# var greenFrac = rgb_color.green || 0.0;

7732

# var blueFrac = rgb_color.blue || 0.0;

7733

# var red = Math.floor(redFrac * 255);

7734

# var green = Math.floor(greenFrac * 255);

7735

# var blue = Math.floor(blueFrac * 255);

7736

#

7737

# if (!('alpha' in rgb_color)) {

7738

# return rgbToCssColor_(red, green, blue);

7739

# }

7740

#

7741

# var alphaFrac = rgb_color.alpha.value || 0.0;

7742

# var rgbParams = [red, green, blue].join(',');

7743

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

7744

# };

7745

#

7746

# var rgbToCssColor_ = function(red, green, blue) {

7747

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

7748

# var hexString = rgbNumber.toString(16);

7749

# var missingZeros = 6 - hexString.length;

7750

# var resultBuilder = ['#'];

7751

# for (var i = 0; i < missingZeros; i++) {

7752

# resultBuilder.push('0');

7753

# }

7754

# resultBuilder.push(hexString);

7755

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

7760

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

7761

# the final pixel color is defined by the equation:

7762

#

7763

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

7764

#

7765

# This means that a value of 1.0 corresponds to a solid color, whereas

7766

# a value of 0.0 corresponds to a completely transparent color. This

7767

# uses a wrapper message rather than a simple float scalar so that it is

7768

# possible to distinguish between a default value and the value being unset.

7769

# If omitted, this color object is to be rendered as a solid color

7770

# (as if the alpha value had been explicitly given with a value of 1.0).

7771

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

7772

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

7773

},

7774

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

7775

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

7776

"style": "A String", # The style of the border.

7777

},

7778

},

7779

"wrapStrategy": "A String", # The wrap strategy for the value in the cell.

7780

},

7781

"dataValidation": { # A data validation rule. # A data validation rule on the cell, if any.

7782

#

7783

# When writing, the new data validation rule will overwrite any prior rule.

7784

"showCustomUi": True or False, # True if the UI should be customized based on the kind of condition.

7785

# If true, "List" conditions will show a dropdown.

7786

"strict": True or False, # True if invalid data should be rejected.

7787

"inputMessage": "A String", # A message to show the user when adding data to the cell.

7788

"condition": { # A condition that can evaluate to true or false. # The condition that data in the cell must match.

7789

# BooleanConditions are used by conditional formatting,

7790

# data validation, and the criteria in filters.

7791

"type": "A String", # The type of condition.

7792

"values": [ # The values of the condition. The number of supported values depends

7793

# on the condition type. Some support zero values,

7794

# others one or two values,

7795

# and ConditionType.ONE_OF_LIST supports an arbitrary number of values.

7796

{ # The value of the condition.

7797

"relativeDate": "A String", # A relative date (based on the current date).

7798

# Valid only if the type is

7799

# DATE_BEFORE,

7800

# DATE_AFTER,

7801

# DATE_ON_OR_BEFORE or

7802

# DATE_ON_OR_AFTER.

7803

#

7804

# Relative dates are not supported in data validation.

7805

# They are supported only in conditional formatting and

7806

# conditional filters.

7807

"userEnteredValue": "A String", # A value the condition is based on.

7808

# The value will be parsed as if the user typed into a cell.

7809

# Formulas are supported (and must begin with an `=`).

},

],

},

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

7814

"textFormatRuns": [ # Runs of rich text applied to subsections of the cell. Runs are only valid

7815

# on user entered strings, not formulas, bools, or numbers.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

7816

# Runs start at specific indexes in the text and continue until the next

7817

# run. Properties of a run will continue unless explicitly changed

7818

# in a subsequent run (and properties of the first run will continue

7819

# the properties of the cell unless explicitly changed).

7820

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

7821

# When writing, the new runs will overwrite any prior runs. When writing a

7822

# new user_entered_value, previous runs will be erased.

7823

{ # A run of a text format. The format of this run continues until the start

7824

# index of the next run.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

7825

# When updating, all fields must be set.

7826

"startIndex": 42, # The character index where this run starts.

7827

"format": { # The format of a run of text in a cell. # The format of this run. Absent values inherit the cell's format.

7828

# Absent values indicate that the field isn't specified.

7829

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

7830

# for simplicity of conversion to/from color representations in various

7831

# languages over compactness; for example, the fields of this representation

7832

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

7833

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

7834

# method in iOS; and, with just a little work, it can be easily formatted into

7835

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

7840

#

7841

# // ...

7842

# public static java.awt.Color fromProto(Color protocolor) {

7843

# float alpha = protocolor.hasAlpha()

7844

# ? protocolor.getAlpha().getValue()

7845

# : 1.0;

7846

#

7847

# return new java.awt.Color(

7848

# protocolor.getRed(),

7849

# protocolor.getGreen(),

7850

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

7855

# float red = (float) color.getRed();

7856

# float green = (float) color.getGreen();

7857

# float blue = (float) color.getBlue();

7858

# float denominator = 255.0;

7859

# Color.Builder resultBuilder =

7860

# Color

7861

# .newBuilder()

7862

# .setRed(red / denominator)

7863

# .setGreen(green / denominator)

7864

# .setBlue(blue / denominator);

7865

# int alpha = color.getAlpha();

7866

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

7871

# .build());

7872

# }

7873

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

7878

#

7879

# // ...

7880

# static UIColor* fromProto(Color* protocolor) {

7881

# float red = [protocolor red];

7882

# float green = [protocolor green];

7883

# float blue = [protocolor blue];

7884

# FloatValue* alpha_wrapper = [protocolor alpha];

7885

# float alpha = 1.0;

7886

# if (alpha_wrapper != nil) {

7887

# alpha = [alpha_wrapper value];

7888

# }

7889

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

7890

# }

7891

#

7892

# static Color* toProto(UIColor* color) {

7893

# CGFloat red, green, blue, alpha;

7894

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

7895

# return nil;

7896

# }

7897

# Color* result = [Color alloc] init];

7898

# [result setRed:red];

7899

# [result setGreen:green];

7900

# [result setBlue:blue];

7901

# if (alpha <= 0.9999) {

7902

# [result setAlpha:floatWrapperWithValue(alpha)];

7903

# }

7904

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

7914

# var redFrac = rgb_color.red || 0.0;

7915

# var greenFrac = rgb_color.green || 0.0;

7916

# var blueFrac = rgb_color.blue || 0.0;

7917

# var red = Math.floor(redFrac * 255);

7918

# var green = Math.floor(greenFrac * 255);

7919

# var blue = Math.floor(blueFrac * 255);

7920

#

7921

# if (!('alpha' in rgb_color)) {

7922

# return rgbToCssColor_(red, green, blue);

7923

# }

7924

#

7925

# var alphaFrac = rgb_color.alpha.value || 0.0;

7926

# var rgbParams = [red, green, blue].join(',');

7927

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

7928

# };

7929

#

7930

# var rgbToCssColor_ = function(red, green, blue) {

7931

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

7932

# var hexString = rgbNumber.toString(16);

7933

# var missingZeros = 6 - hexString.length;

7934

# var resultBuilder = ['#'];

7935

# for (var i = 0; i < missingZeros; i++) {

7936

# resultBuilder.push('0');

7937

# }

7938

# resultBuilder.push(hexString);

7939

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

7944

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

7945

# the final pixel color is defined by the equation:

7946

#

7947

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

7948

#

7949

# This means that a value of 1.0 corresponds to a solid color, whereas

7950

# a value of 0.0 corresponds to a completely transparent color. This

7951

# uses a wrapper message rather than a simple float scalar so that it is

7952

# possible to distinguish between a default value and the value being unset.

7953

# If omitted, this color object is to be rendered as a solid color

7954

# (as if the alpha value had been explicitly given with a value of 1.0).

7955

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

7956

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

7957

},

7958

"bold": True or False, # True if the text is bold.

7959

"strikethrough": True or False, # True if the text has a strikethrough.

7960

"fontFamily": "A String", # The font family.

7961

"fontSize": 42, # The size of the font.

7962

"italic": True or False, # True if the text is italicized.

7963

"underline": True or False, # True if the text is underlined.

},

},

],

},

"fields": "A String", # The fields that should be updated. At least one field must be specified.

7969

# The root `cell` is implied and should not be specified.

7970

# A single `"*"` can be used as short-hand for listing every field.

7971

"range": { # A range on a sheet. # The range to repeat the cell in.

7972

# All indexes are zero-based.

7973

# Indexes are half open, e.g the start index is inclusive

7974

# and the end index is exclusive -- [start_index, end_index).

7975

# Missing indexes indicate the range is unbounded on that side.

7976

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

7977

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

7978

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

7979

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

7980

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

7981

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

7982

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

7983

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

7984

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

7985

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

7986

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

7987

# `Sheet1!A:B == sheet_id: 0,

7988

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

7989

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

7990

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

7991

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

7992

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

7993

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

7994

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

7995

#

7996

# The start index must always be less than or equal to the end index.

7997

# If the start index equals the end index, then the range is empty.

7998

# Empty ranges are typically not meaningful and are usually rendered in the

7999

# UI as `#REF!`.

8000

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

8001

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

8002

"sheetId": 42, # The sheet this range is on.

8003

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

8004

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

8005

},

8006

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8007

"findReplace": { # Finds and replaces data in cells over a range, sheet, or all sheets. # Finds and replaces occurrences of some text with other text.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8008

"includeFormulas": True or False, # True if the search should include cells with formulas.

8009

# False to skip cells with formulas.

8010

"matchEntireCell": True or False, # True if the find value should match the entire cell.

8011

"allSheets": True or False, # True to find/replace over all sheets.

8012

"matchCase": True or False, # True if the search is case sensitive.

8013

"sheetId": 42, # The sheet to find/replace over.

8014

"range": { # A range on a sheet. # The range to find/replace over.

8015

# All indexes are zero-based.

8016

# Indexes are half open, e.g the start index is inclusive

8017

# and the end index is exclusive -- [start_index, end_index).

8018

# Missing indexes indicate the range is unbounded on that side.

8019

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8020

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8021

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8022

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8023

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8024

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8025

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8026

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8027

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8028

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8029

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8030

# `Sheet1!A:B == sheet_id: 0,

8031

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8032

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8033

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8034

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8035

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8036

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8037

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8038

#

8039

# The start index must always be less than or equal to the end index.

8040

# If the start index equals the end index, then the range is empty.

8041

# Empty ranges are typically not meaningful and are usually rendered in the

8042

# UI as `#REF!`.

8043

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

8044

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

8045

"sheetId": 42, # The sheet this range is on.

8046

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

8047

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

8048

},

8049

"searchByRegex": True or False, # True if the find value is a regex.

8050

# The regular expression and replacement should follow Java regex rules

8051

# at https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html.

8052

# The replacement string is allowed to refer to capturing groups.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8053

# For example, if one cell has the contents `"Google Sheets"` and another

8054

# has `"Google Docs"`, then searching for `"o.* (.*)"` with a replacement of

8055

# `"$1 Rocks"` would change the contents of the cells to

8056

# `"GSheets Rocks"` and `"GDocs Rocks"` respectively.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8057

"find": "A String", # The value to search.

8058

"replacement": "A String", # The value to use as the replacement.

8059

},

8060

"setBasicFilter": { # Sets the basic filter associated with a sheet. # Sets the basic filter on a sheet.

8061

"filter": { # The default filter associated with a sheet. # The filter to set.

8062

"range": { # A range on a sheet. # The range the filter covers.

8063

# All indexes are zero-based.

8064

# Indexes are half open, e.g the start index is inclusive

8065

# and the end index is exclusive -- [start_index, end_index).

8066

# Missing indexes indicate the range is unbounded on that side.

8067

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8068

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8069

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8070

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8071

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8072

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8073

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8074

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8075

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8076

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8077

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8078

# `Sheet1!A:B == sheet_id: 0,

8079

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8080

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8081

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8082

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8083

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8084

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8085

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8086

#

8087

# The start index must always be less than or equal to the end index.

8088

# If the start index equals the end index, then the range is empty.

8089

# Empty ranges are typically not meaningful and are usually rendered in the

8090

# UI as `#REF!`.

8091

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

8092

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

8093

"sheetId": 42, # The sheet this range is on.

8094

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

8095

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

8096

},

8097

"sortSpecs": [ # The sort order per column. Later specifications are used when values

8098

# are equal in the earlier specifications.

8099

{ # A sort order associated with a specific column or row.

8100

"sortOrder": "A String", # The order data should be sorted.

8101

"dimensionIndex": 42, # The dimension the sort should be applied to.

8102

},

8103

],

8104

"criteria": { # The criteria for showing/hiding values per column.

8105

# The map's key is the column index, and the value is the criteria for

8106

# that column.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8107

"a_key": { # Criteria for showing/hiding rows in a filter or filter view.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8108

"hiddenValues": [ # Values that should be hidden.

8109

"A String",

8110

],

8111

"condition": { # A condition that can evaluate to true or false. # A condition that must be true for values to be shown.

8112

# (This does not override hiddenValues -- if a value is listed there,

8113

# it will still be hidden.)

8114

# BooleanConditions are used by conditional formatting,

8115

# data validation, and the criteria in filters.

8116

"type": "A String", # The type of condition.

8117

"values": [ # The values of the condition. The number of supported values depends

8118

# on the condition type. Some support zero values,

8119

# others one or two values,

8120

# and ConditionType.ONE_OF_LIST supports an arbitrary number of values.

8121

{ # The value of the condition.

8122

"relativeDate": "A String", # A relative date (based on the current date).

8123

# Valid only if the type is

8124

# DATE_BEFORE,

8125

# DATE_AFTER,

8126

# DATE_ON_OR_BEFORE or

8127

# DATE_ON_OR_AFTER.

8128

#

8129

# Relative dates are not supported in data validation.

8130

# They are supported only in conditional formatting and

8131

# conditional filters.

8132

"userEnteredValue": "A String", # A value the condition is based on.

8133

# The value will be parsed as if the user typed into a cell.

8134

# Formulas are supported (and must begin with an `=`).

},

],

},

},

},

},

},

"updateSpreadsheetProperties": { # Updates properties of a spreadsheet. # Updates the spreadsheet's properties.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8143

"fields": "A String", # The fields that should be updated. At least one field must be specified.

8144

# The root 'properties' is implied and should not be specified.

8145

# A single `"*"` can be used as short-hand for listing every field.

8146

"properties": { # Properties of a spreadsheet. # The properties to update.

8147

"locale": "A String", # The locale of the spreadsheet in one of the following formats:

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8148

#

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8149

# * an ISO 639-1 language code such as `en`

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8150

#

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8151

# * an ISO 639-2 language code such as `fil`, if no 639-1 code exists

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8152

#

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8153

# * a combination of the ISO language code and country code, such as `en_US`

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8154

#

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8155

# Note: when updating this field, not all locales/languages are supported.

8156

"timeZone": "A String", # The time zone of the spreadsheet, in CLDR format such as

8157

# `America/New_York`. If the time zone isn't recognized, this may

8158

# be a custom time zone such as `GMT-07:00`.

8159

"autoRecalc": "A String", # The amount of time to wait before volatile functions are recalculated.

8160

"defaultFormat": { # The format of a cell. # The default format of all cells in the spreadsheet.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8161

# CellData.effectiveFormat will not be set if the

8162

# cell's format is equal to this default format.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8163

# This field is read-only.

8164

"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8165

"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on

8166

# the user's locale will be used if necessary for the given type.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame^]

8167

# See the [Date and Number Formats guide](/sheets/guides/formats) for more

8168

# information about the supported patterns.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8169

"type": "A String", # The type of the number format.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8170

# When writing, this field must be set.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8171

},

8172

"textDirection": "A String", # The direction of the text in the cell.

8173

"padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.

8174

# When updating padding, every field must be specified.

8175

"top": 42, # The top padding of the cell.

8176

"right": 42, # The right padding of the cell.

8177

"bottom": 42, # The bottom padding of the cell.

8178

"left": 42, # The left padding of the cell.

8179

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8180

"horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8181

"backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.

8182

# for simplicity of conversion to/from color representations in various

8183

# languages over compactness; for example, the fields of this representation

8184

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

8185

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

8186

# method in iOS; and, with just a little work, it can be easily formatted into

8187

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

8192

#

8193

# // ...

8194

# public static java.awt.Color fromProto(Color protocolor) {

8195

# float alpha = protocolor.hasAlpha()

8196

# ? protocolor.getAlpha().getValue()

8197

# : 1.0;

8198

#

8199

# return new java.awt.Color(

8200

# protocolor.getRed(),

8201

# protocolor.getGreen(),

8202

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

8207

# float red = (float) color.getRed();

8208

# float green = (float) color.getGreen();

8209

# float blue = (float) color.getBlue();

8210

# float denominator = 255.0;

8211

# Color.Builder resultBuilder =

8212

# Color

8213

# .newBuilder()

8214

# .setRed(red / denominator)

8215

# .setGreen(green / denominator)

8216

# .setBlue(blue / denominator);

8217

# int alpha = color.getAlpha();

8218

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

8223

# .build());

8224

# }

8225

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

8230

#

8231

# // ...

8232

# static UIColor* fromProto(Color* protocolor) {

8233

# float red = [protocolor red];

8234

# float green = [protocolor green];

8235

# float blue = [protocolor blue];

8236

# FloatValue* alpha_wrapper = [protocolor alpha];

8237

# float alpha = 1.0;

8238

# if (alpha_wrapper != nil) {

8239

# alpha = [alpha_wrapper value];

8240

# }

8241

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

8242

# }

8243

#

8244

# static Color* toProto(UIColor* color) {

8245

# CGFloat red, green, blue, alpha;

8246

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

8247

# return nil;

8248

# }

8249

# Color* result = [Color alloc] init];

8250

# [result setRed:red];

8251

# [result setGreen:green];

8252

# [result setBlue:blue];

8253

# if (alpha <= 0.9999) {

8254

# [result setAlpha:floatWrapperWithValue(alpha)];

8255

# }

8256

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

8266

# var redFrac = rgb_color.red || 0.0;

8267

# var greenFrac = rgb_color.green || 0.0;

8268

# var blueFrac = rgb_color.blue || 0.0;

8269

# var red = Math.floor(redFrac * 255);

8270

# var green = Math.floor(greenFrac * 255);

8271

# var blue = Math.floor(blueFrac * 255);

8272

#

8273

# if (!('alpha' in rgb_color)) {

8274

# return rgbToCssColor_(red, green, blue);

8275

# }

8276

#

8277

# var alphaFrac = rgb_color.alpha.value || 0.0;

8278

# var rgbParams = [red, green, blue].join(',');

8279

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

8280

# };

8281

#

8282

# var rgbToCssColor_ = function(red, green, blue) {

8283

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

8284

# var hexString = rgbNumber.toString(16);

8285

# var missingZeros = 6 - hexString.length;

8286

# var resultBuilder = ['#'];

8287

# for (var i = 0; i < missingZeros; i++) {

8288

# resultBuilder.push('0');

8289

# }

8290

# resultBuilder.push(hexString);

8291

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

8296

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

8297

# the final pixel color is defined by the equation:

8298

#

8299

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

8300

#

8301

# This means that a value of 1.0 corresponds to a solid color, whereas

8302

# a value of 0.0 corresponds to a completely transparent color. This

8303

# uses a wrapper message rather than a simple float scalar so that it is

8304

# possible to distinguish between a default value and the value being unset.

8305

# If omitted, this color object is to be rendered as a solid color

8306

# (as if the alpha value had been explicitly given with a value of 1.0).

8307

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

8308

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

8309

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8310

"verticalAlignment": "A String", # The vertical alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8311

"textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).

8312

# Absent values indicate that the field isn't specified.

8313

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

8314

# for simplicity of conversion to/from color representations in various

8315

# languages over compactness; for example, the fields of this representation

8316

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

8317

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

8318

# method in iOS; and, with just a little work, it can be easily formatted into

8319

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

8324

#

8325

# // ...

8326

# public static java.awt.Color fromProto(Color protocolor) {

8327

# float alpha = protocolor.hasAlpha()

8328

# ? protocolor.getAlpha().getValue()

8329

# : 1.0;

8330

#

8331

# return new java.awt.Color(

8332

# protocolor.getRed(),

8333

# protocolor.getGreen(),

8334

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

8339

# float red = (float) color.getRed();

8340

# float green = (float) color.getGreen();

8341

# float blue = (float) color.getBlue();

8342

# float denominator = 255.0;

8343

# Color.Builder resultBuilder =

8344

# Color

8345

# .newBuilder()

8346

# .setRed(red / denominator)

8347

# .setGreen(green / denominator)

8348

# .setBlue(blue / denominator);

8349

# int alpha = color.getAlpha();

8350

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

8355

# .build());

8356

# }

8357

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

8362

#

8363

# // ...

8364

# static UIColor* fromProto(Color* protocolor) {

8365

# float red = [protocolor red];

8366

# float green = [protocolor green];

8367

# float blue = [protocolor blue];

8368

# FloatValue* alpha_wrapper = [protocolor alpha];

8369

# float alpha = 1.0;

8370

# if (alpha_wrapper != nil) {

8371

# alpha = [alpha_wrapper value];

8372

# }

8373

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

8374

# }

8375

#

8376

# static Color* toProto(UIColor* color) {

8377

# CGFloat red, green, blue, alpha;

8378

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

8379

# return nil;

8380

# }

8381

# Color* result = [Color alloc] init];

8382

# [result setRed:red];

8383

# [result setGreen:green];

8384

# [result setBlue:blue];

8385

# if (alpha <= 0.9999) {

8386

# [result setAlpha:floatWrapperWithValue(alpha)];

8387

# }

8388

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

8398

# var redFrac = rgb_color.red || 0.0;

8399

# var greenFrac = rgb_color.green || 0.0;

8400

# var blueFrac = rgb_color.blue || 0.0;

8401

# var red = Math.floor(redFrac * 255);

8402

# var green = Math.floor(greenFrac * 255);

8403

# var blue = Math.floor(blueFrac * 255);

8404

#

8405

# if (!('alpha' in rgb_color)) {

8406

# return rgbToCssColor_(red, green, blue);

8407

# }

8408

#

8409

# var alphaFrac = rgb_color.alpha.value || 0.0;

8410

# var rgbParams = [red, green, blue].join(',');

8411

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

8412

# };

8413

#

8414

# var rgbToCssColor_ = function(red, green, blue) {

8415

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

8416

# var hexString = rgbNumber.toString(16);

8417

# var missingZeros = 6 - hexString.length;

8418

# var resultBuilder = ['#'];

8419

# for (var i = 0; i < missingZeros; i++) {

8420

# resultBuilder.push('0');

8421

# }

8422

# resultBuilder.push(hexString);

8423

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

8428

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

8429

# the final pixel color is defined by the equation:

8430

#

8431

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

8432

#

8433

# This means that a value of 1.0 corresponds to a solid color, whereas

8434

# a value of 0.0 corresponds to a completely transparent color. This

8435

# uses a wrapper message rather than a simple float scalar so that it is

8436

# possible to distinguish between a default value and the value being unset.

8437

# If omitted, this color object is to be rendered as a solid color

8438

# (as if the alpha value had been explicitly given with a value of 1.0).

8439

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

8440

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

8441

},

8442

"bold": True or False, # True if the text is bold.

8443

"strikethrough": True or False, # True if the text has a strikethrough.

8444

"fontFamily": "A String", # The font family.

8445

"fontSize": 42, # The size of the font.

8446

"italic": True or False, # True if the text is italicized.

8447

"underline": True or False, # True if the text is underlined.

8448

},

8449

"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.

8450

"borders": { # The borders of the cell. # The borders of the cell.

8451

"top": { # A border along a cell. # The top border of the cell.

8452

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

8453

# for simplicity of conversion to/from color representations in various

8454

# languages over compactness; for example, the fields of this representation

8455

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

8456

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

8457

# method in iOS; and, with just a little work, it can be easily formatted into

8458

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

8463

#

8464

# // ...

8465

# public static java.awt.Color fromProto(Color protocolor) {

8466

# float alpha = protocolor.hasAlpha()

8467

# ? protocolor.getAlpha().getValue()

8468

# : 1.0;

8469

#

8470

# return new java.awt.Color(

8471

# protocolor.getRed(),

8472

# protocolor.getGreen(),

8473

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

8478

# float red = (float) color.getRed();

8479

# float green = (float) color.getGreen();

8480

# float blue = (float) color.getBlue();

8481

# float denominator = 255.0;

8482

# Color.Builder resultBuilder =

8483

# Color

8484

# .newBuilder()

8485

# .setRed(red / denominator)

8486

# .setGreen(green / denominator)

8487

# .setBlue(blue / denominator);

8488

# int alpha = color.getAlpha();

8489

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

8494

# .build());

8495

# }

8496

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

8501

#

8502

# // ...

8503

# static UIColor* fromProto(Color* protocolor) {

8504

# float red = [protocolor red];

8505

# float green = [protocolor green];

8506

# float blue = [protocolor blue];

8507

# FloatValue* alpha_wrapper = [protocolor alpha];

8508

# float alpha = 1.0;

8509

# if (alpha_wrapper != nil) {

8510

# alpha = [alpha_wrapper value];

8511

# }

8512

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

8513

# }

8514

#

8515

# static Color* toProto(UIColor* color) {

8516

# CGFloat red, green, blue, alpha;

8517

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

8518

# return nil;

8519

# }

8520

# Color* result = [Color alloc] init];

8521

# [result setRed:red];

8522

# [result setGreen:green];

8523

# [result setBlue:blue];

8524

# if (alpha <= 0.9999) {

8525

# [result setAlpha:floatWrapperWithValue(alpha)];

8526

# }

8527

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

8537

# var redFrac = rgb_color.red || 0.0;

8538

# var greenFrac = rgb_color.green || 0.0;

8539

# var blueFrac = rgb_color.blue || 0.0;

8540

# var red = Math.floor(redFrac * 255);

8541

# var green = Math.floor(greenFrac * 255);

8542

# var blue = Math.floor(blueFrac * 255);

8543

#

8544

# if (!('alpha' in rgb_color)) {

8545

# return rgbToCssColor_(red, green, blue);

8546

# }

8547

#

8548

# var alphaFrac = rgb_color.alpha.value || 0.0;

8549

# var rgbParams = [red, green, blue].join(',');

8550

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

8551

# };

8552

#

8553

# var rgbToCssColor_ = function(red, green, blue) {

8554

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

8555

# var hexString = rgbNumber.toString(16);

8556

# var missingZeros = 6 - hexString.length;

8557

# var resultBuilder = ['#'];

8558

# for (var i = 0; i < missingZeros; i++) {

8559

# resultBuilder.push('0');

8560

# }

8561

# resultBuilder.push(hexString);

8562

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

8567

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

8568

# the final pixel color is defined by the equation:

8569

#

8570

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

8571

#

8572

# This means that a value of 1.0 corresponds to a solid color, whereas

8573

# a value of 0.0 corresponds to a completely transparent color. This

8574

# uses a wrapper message rather than a simple float scalar so that it is

8575

# possible to distinguish between a default value and the value being unset.

8576

# If omitted, this color object is to be rendered as a solid color

8577

# (as if the alpha value had been explicitly given with a value of 1.0).

8578

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

8579

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

8580

},

8581

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8582

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8583

"style": "A String", # The style of the border.

8584

},

8585

"right": { # A border along a cell. # The right border of the cell.

8586

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

8587

# for simplicity of conversion to/from color representations in various

8588

# languages over compactness; for example, the fields of this representation

8589

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

8590

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

8591

# method in iOS; and, with just a little work, it can be easily formatted into

8592

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

8597

#

8598

# // ...

8599

# public static java.awt.Color fromProto(Color protocolor) {

8600

# float alpha = protocolor.hasAlpha()

8601

# ? protocolor.getAlpha().getValue()

8602

# : 1.0;

8603

#

8604

# return new java.awt.Color(

8605

# protocolor.getRed(),

8606

# protocolor.getGreen(),

8607

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

8612

# float red = (float) color.getRed();

8613

# float green = (float) color.getGreen();

8614

# float blue = (float) color.getBlue();

8615

# float denominator = 255.0;

8616

# Color.Builder resultBuilder =

8617

# Color

8618

# .newBuilder()

8619

# .setRed(red / denominator)

8620

# .setGreen(green / denominator)

8621

# .setBlue(blue / denominator);

8622

# int alpha = color.getAlpha();

8623

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

8628

# .build());

8629

# }

8630

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

8635

#

8636

# // ...

8637

# static UIColor* fromProto(Color* protocolor) {

8638

# float red = [protocolor red];

8639

# float green = [protocolor green];

8640

# float blue = [protocolor blue];

8641

# FloatValue* alpha_wrapper = [protocolor alpha];

8642

# float alpha = 1.0;

8643

# if (alpha_wrapper != nil) {

8644

# alpha = [alpha_wrapper value];

8645

# }

8646

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

8647

# }

8648

#

8649

# static Color* toProto(UIColor* color) {

8650

# CGFloat red, green, blue, alpha;

8651

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

8652

# return nil;

8653

# }

8654

# Color* result = [Color alloc] init];

8655

# [result setRed:red];

8656

# [result setGreen:green];

8657

# [result setBlue:blue];

8658

# if (alpha <= 0.9999) {

8659

# [result setAlpha:floatWrapperWithValue(alpha)];

8660

# }

8661

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

8671

# var redFrac = rgb_color.red || 0.0;

8672

# var greenFrac = rgb_color.green || 0.0;

8673

# var blueFrac = rgb_color.blue || 0.0;

8674

# var red = Math.floor(redFrac * 255);

8675

# var green = Math.floor(greenFrac * 255);

8676

# var blue = Math.floor(blueFrac * 255);

8677

#

8678

# if (!('alpha' in rgb_color)) {

8679

# return rgbToCssColor_(red, green, blue);

8680

# }

8681

#

8682

# var alphaFrac = rgb_color.alpha.value || 0.0;

8683

# var rgbParams = [red, green, blue].join(',');

8684

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

8685

# };

8686

#

8687

# var rgbToCssColor_ = function(red, green, blue) {

8688

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

8689

# var hexString = rgbNumber.toString(16);

8690

# var missingZeros = 6 - hexString.length;

8691

# var resultBuilder = ['#'];

8692

# for (var i = 0; i < missingZeros; i++) {

8693

# resultBuilder.push('0');

8694

# }

8695

# resultBuilder.push(hexString);

8696

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

8701

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

8702

# the final pixel color is defined by the equation:

8703

#

8704

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

8705

#

8706

# This means that a value of 1.0 corresponds to a solid color, whereas

8707

# a value of 0.0 corresponds to a completely transparent color. This

8708

# uses a wrapper message rather than a simple float scalar so that it is

8709

# possible to distinguish between a default value and the value being unset.

8710

# If omitted, this color object is to be rendered as a solid color

8711

# (as if the alpha value had been explicitly given with a value of 1.0).

8712

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

8713

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

8714

},

8715

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8716

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8717

"style": "A String", # The style of the border.

8718

},

8719

"bottom": { # A border along a cell. # The bottom border of the cell.

8720

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

8721

# for simplicity of conversion to/from color representations in various

8722

# languages over compactness; for example, the fields of this representation

8723

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

8724

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

8725

# method in iOS; and, with just a little work, it can be easily formatted into

8726

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

8731

#

8732

# // ...

8733

# public static java.awt.Color fromProto(Color protocolor) {

8734

# float alpha = protocolor.hasAlpha()

8735

# ? protocolor.getAlpha().getValue()

8736

# : 1.0;

8737

#

8738

# return new java.awt.Color(

8739

# protocolor.getRed(),

8740

# protocolor.getGreen(),

8741

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

8746

# float red = (float) color.getRed();

8747

# float green = (float) color.getGreen();

8748

# float blue = (float) color.getBlue();

8749

# float denominator = 255.0;

8750

# Color.Builder resultBuilder =

8751

# Color

8752

# .newBuilder()

8753

# .setRed(red / denominator)

8754

# .setGreen(green / denominator)

8755

# .setBlue(blue / denominator);

8756

# int alpha = color.getAlpha();

8757

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

8762

# .build());

8763

# }

8764

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

8769

#

8770

# // ...

8771

# static UIColor* fromProto(Color* protocolor) {

8772

# float red = [protocolor red];

8773

# float green = [protocolor green];

8774

# float blue = [protocolor blue];

8775

# FloatValue* alpha_wrapper = [protocolor alpha];

8776

# float alpha = 1.0;

8777

# if (alpha_wrapper != nil) {

8778

# alpha = [alpha_wrapper value];

8779

# }

8780

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

8781

# }

8782

#

8783

# static Color* toProto(UIColor* color) {

8784

# CGFloat red, green, blue, alpha;

8785

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

8786

# return nil;

8787

# }

8788

# Color* result = [Color alloc] init];

8789

# [result setRed:red];

8790

# [result setGreen:green];

8791

# [result setBlue:blue];

8792

# if (alpha <= 0.9999) {

8793

# [result setAlpha:floatWrapperWithValue(alpha)];

8794

# }

8795

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

8805

# var redFrac = rgb_color.red || 0.0;

8806

# var greenFrac = rgb_color.green || 0.0;

8807

# var blueFrac = rgb_color.blue || 0.0;

8808

# var red = Math.floor(redFrac * 255);

8809

# var green = Math.floor(greenFrac * 255);

8810

# var blue = Math.floor(blueFrac * 255);

8811

#

8812

# if (!('alpha' in rgb_color)) {

8813

# return rgbToCssColor_(red, green, blue);

8814

# }

8815

#

8816

# var alphaFrac = rgb_color.alpha.value || 0.0;

8817

# var rgbParams = [red, green, blue].join(',');

8818

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

8819

# };

8820

#

8821

# var rgbToCssColor_ = function(red, green, blue) {

8822

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

8823

# var hexString = rgbNumber.toString(16);

8824

# var missingZeros = 6 - hexString.length;

8825

# var resultBuilder = ['#'];

8826

# for (var i = 0; i < missingZeros; i++) {

8827

# resultBuilder.push('0');

8828

# }

8829

# resultBuilder.push(hexString);

8830

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

8835

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

8836

# the final pixel color is defined by the equation:

8837

#

8838

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

8839

#

8840

# This means that a value of 1.0 corresponds to a solid color, whereas

8841

# a value of 0.0 corresponds to a completely transparent color. This

8842

# uses a wrapper message rather than a simple float scalar so that it is

8843

# possible to distinguish between a default value and the value being unset.

8844

# If omitted, this color object is to be rendered as a solid color

8845

# (as if the alpha value had been explicitly given with a value of 1.0).

8846

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

8847

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

8848

},

8849

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8850

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8851

"style": "A String", # The style of the border.

8852

},

8853

"left": { # A border along a cell. # The left border of the cell.

8854

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

8855

# for simplicity of conversion to/from color representations in various

8856

# languages over compactness; for example, the fields of this representation

8857

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

8858

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

8859

# method in iOS; and, with just a little work, it can be easily formatted into

8860

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

8865

#

8866

# // ...

8867

# public static java.awt.Color fromProto(Color protocolor) {

8868

# float alpha = protocolor.hasAlpha()

8869

# ? protocolor.getAlpha().getValue()

8870

# : 1.0;

8871

#

8872

# return new java.awt.Color(

8873

# protocolor.getRed(),

8874

# protocolor.getGreen(),

8875

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

8880

# float red = (float) color.getRed();

8881

# float green = (float) color.getGreen();

8882

# float blue = (float) color.getBlue();

8883

# float denominator = 255.0;

8884

# Color.Builder resultBuilder =

8885

# Color

8886

# .newBuilder()

8887

# .setRed(red / denominator)

8888

# .setGreen(green / denominator)

8889

# .setBlue(blue / denominator);

8890

# int alpha = color.getAlpha();

8891

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

8896

# .build());

8897

# }

8898

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

8903

#

8904

# // ...

8905

# static UIColor* fromProto(Color* protocolor) {

8906

# float red = [protocolor red];

8907

# float green = [protocolor green];

8908

# float blue = [protocolor blue];

8909

# FloatValue* alpha_wrapper = [protocolor alpha];

8910

# float alpha = 1.0;

8911

# if (alpha_wrapper != nil) {

8912

# alpha = [alpha_wrapper value];

8913

# }

8914

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

8915

# }

8916

#

8917

# static Color* toProto(UIColor* color) {

8918

# CGFloat red, green, blue, alpha;

8919

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

8920

# return nil;

8921

# }

8922

# Color* result = [Color alloc] init];

8923

# [result setRed:red];

8924

# [result setGreen:green];

8925

# [result setBlue:blue];

8926

# if (alpha <= 0.9999) {

8927

# [result setAlpha:floatWrapperWithValue(alpha)];

8928

# }

8929

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

8939

# var redFrac = rgb_color.red || 0.0;

8940

# var greenFrac = rgb_color.green || 0.0;

8941

# var blueFrac = rgb_color.blue || 0.0;

8942

# var red = Math.floor(redFrac * 255);

8943

# var green = Math.floor(greenFrac * 255);

8944

# var blue = Math.floor(blueFrac * 255);

8945

#

8946

# if (!('alpha' in rgb_color)) {

8947

# return rgbToCssColor_(red, green, blue);

8948

# }

8949

#

8950

# var alphaFrac = rgb_color.alpha.value || 0.0;

8951

# var rgbParams = [red, green, blue].join(',');

8952

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

8953

# };

8954

#

8955

# var rgbToCssColor_ = function(red, green, blue) {

8956

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

8957

# var hexString = rgbNumber.toString(16);

8958

# var missingZeros = 6 - hexString.length;

8959

# var resultBuilder = ['#'];

8960

# for (var i = 0; i < missingZeros; i++) {

8961

# resultBuilder.push('0');

8962

# }

8963

# resultBuilder.push(hexString);

8964

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

8969

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

8970

# the final pixel color is defined by the equation:

8971

#

8972

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

8973

#

8974

# This means that a value of 1.0 corresponds to a solid color, whereas

8975

# a value of 0.0 corresponds to a completely transparent color. This

8976

# uses a wrapper message rather than a simple float scalar so that it is

8977

# possible to distinguish between a default value and the value being unset.

8978

# If omitted, this color object is to be rendered as a solid color

8979

# (as if the alpha value had been explicitly given with a value of 1.0).

8980

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

8981

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

8982

},

8983

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

8984

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

8985

"style": "A String", # The style of the border.

8986

},

8987

},

8988

"wrapStrategy": "A String", # The wrap strategy for the value in the cell.

8989

},

8990

"title": "A String", # The title of the spreadsheet.

8991

},

8992

},

8993

"updateCells": { # Updates all cells in a range with new data. # Updates many cells at once.

8994

"fields": "A String", # The fields of CellData that should be updated.

8995

# At least one field must be specified.

8996

# The root is the CellData; 'row.values.' should not be specified.

8997

# A single `"*"` can be used as short-hand for listing every field.

8998

"range": { # A range on a sheet. # The range to write data to.

8999

#

9000

# If the data in rows does not cover the entire requested range,

9001

# the fields matching those set in fields will be cleared.

9002

# All indexes are zero-based.

9003

# Indexes are half open, e.g the start index is inclusive

9004

# and the end index is exclusive -- [start_index, end_index).

9005

# Missing indexes indicate the range is unbounded on that side.

9006

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9007

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9008

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9009

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9010

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9011

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9012

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9013

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9014

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9015

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9016

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9017

# `Sheet1!A:B == sheet_id: 0,

9018

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9019

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9020

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9021

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9022

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9023

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9024

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9025

#

9026

# The start index must always be less than or equal to the end index.

9027

# If the start index equals the end index, then the range is empty.

9028

# Empty ranges are typically not meaningful and are usually rendered in the

9029

# UI as `#REF!`.

9030

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

9031

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

9032

"sheetId": 42, # The sheet this range is on.

9033

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

9034

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

9035

},

9036

"rows": [ # The data to write.

9037

{ # Data about each cell in a row.

9038

"values": [ # The values in the row, one per column.

9039

{ # Data about a specific cell.

9040

"pivotTable": { # A pivot table. # A pivot table anchored at this cell. The size of pivot table itself

9041

# is computed dynamically based on its data, grouping, filters, values,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9042

# etc. Only the top-left cell of the pivot table contains the pivot table

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9043

# definition. The other cells will contain the calculated values of the

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9044

# results of the pivot in their effective_value fields.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9045

"valueLayout": "A String", # Whether values should be listed horizontally (as columns)

9046

# or vertically (as rows).

9047

"rows": [ # Each row grouping in the pivot table.

9048

{ # A single grouping (either row or column) in a pivot table.

9049

"showTotals": True or False, # True if the pivot table should include the totals for this grouping.

9050

"valueMetadata": [ # Metadata about values in the grouping.

9051

{ # Metadata about a value in a pivot grouping.

9052

"collapsed": True or False, # True if the data corresponding to the value is collapsed.

9053

"value": { # The kinds of value that a cell in a spreadsheet can have. # The calculated value the metadata corresponds to.

9054

# (Note that formulaValue is not valid,

9055

# because the values will be calculated.)

9056

"numberValue": 3.14, # Represents a double value.

9057

# Note: Dates, Times and DateTimes are represented as doubles in

9058

# "serial number" format.

9059

"boolValue": True or False, # Represents a boolean value.

9060

"formulaValue": "A String", # Represents a formula.

9061

"stringValue": "A String", # Represents a string value.

9062

# Leading single quotes are not included. For example, if the user typed

9063

# `'123` into the UI, this would be represented as a `stringValue` of

9064

# `"123"`.

9065

"errorValue": { # An error in a cell. # Represents an error.

9066

# This field is read-only.

9067

"message": "A String", # A message with more information about the error

9068

# (in the spreadsheet's locale).

9069

"type": "A String", # The type of error.

},

},

},

],

"valueBucket": { # Information about which values in a pivot group should be used for sorting. # The bucket of the opposite pivot group to sort by.

9075

# If not specified, sorting is alphabetical by this group's values.

9076

"buckets": [ # Determines the bucket from which values are chosen to sort.

9077

#

9078

# For example, in a pivot table with one row group & two column groups,

9079

# the row group can list up to two values. The first value corresponds

9080

# to a value within the first column group, and the second value

9081

# corresponds to a value in the second column group. If no values

9082

# are listed, this would indicate that the row should be sorted according

9083

# to the "Grand Total" over the column groups. If a single value is listed,

9084

# this would correspond to using the "Total" of that bucket.

9085

{ # The kinds of value that a cell in a spreadsheet can have.

9086

"numberValue": 3.14, # Represents a double value.

9087

# Note: Dates, Times and DateTimes are represented as doubles in

9088

# "serial number" format.

9089

"boolValue": True or False, # Represents a boolean value.

9090

"formulaValue": "A String", # Represents a formula.

9091

"stringValue": "A String", # Represents a string value.

9092

# Leading single quotes are not included. For example, if the user typed

9093

# `'123` into the UI, this would be represented as a `stringValue` of

9094

# `"123"`.

9095

"errorValue": { # An error in a cell. # Represents an error.

9096

# This field is read-only.

9097

"message": "A String", # A message with more information about the error

9098

# (in the spreadsheet's locale).

9099

"type": "A String", # The type of error.

9100

},

9101

},

9102

],

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9103

"valuesIndex": 42, # The offset in the PivotTable.values list which the values in this

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9104

# grouping should be sorted by.

9105

},

9106

"sortOrder": "A String", # The order the values in this group should be sorted.

9107

"sourceColumnOffset": 42, # The column offset of the source range that this grouping is based on.

9108

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9109

# For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9110

# means this group refers to column `C`, whereas the offset `1` would refer

# to column `D`.

},

],

"source": { # A range on a sheet. # The range the pivot table is reading data from.

9115

# All indexes are zero-based.

9116

# Indexes are half open, e.g the start index is inclusive

9117

# and the end index is exclusive -- [start_index, end_index).

9118

# Missing indexes indicate the range is unbounded on that side.

9119

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9120

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9121

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9122

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9123

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9124

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9125

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9126

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9127

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9128

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9129

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9130

# `Sheet1!A:B == sheet_id: 0,

9131

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9132

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9133

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9134

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9135

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9136

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9137

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9138

#

9139

# The start index must always be less than or equal to the end index.

9140

# If the start index equals the end index, then the range is empty.

9141

# Empty ranges are typically not meaningful and are usually rendered in the

9142

# UI as `#REF!`.

9143

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

9144

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

9145

"sheetId": 42, # The sheet this range is on.

9146

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

9147

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

9148

},

9149

"values": [ # A list of values to include in the pivot table.

9150

{ # The definition of how a value in a pivot table should be calculated.

9151

"formula": "A String", # A custom formula to calculate the value. The formula must start

9152

# with an `=` character.

9153

"summarizeFunction": "A String", # A function to summarize the value.

9154

# If formula is set, the only supported values are

9155

# SUM and

9156

# CUSTOM.

9157

# If sourceColumnOffset is set, then `CUSTOM`

9158

# is not supported.

9159

"sourceColumnOffset": 42, # The column offset of the source range that this value reads from.

9160

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9161

# For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9162

# means this value refers to column `C`, whereas the offset `1` would

9163

# refer to column `D`.

9164

"name": "A String", # A name to use for the value. This is only used if formula was set.

9165

# Otherwise, the column name is used.

9166

},

9167

],

9168

"criteria": { # An optional mapping of filters per source column offset.

9169

#

9170

# The filters will be applied before aggregating data into the pivot table.

9171

# The map's key is the column offset of the source range that you want to

9172

# filter, and the value is the criteria for that column.

9173

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9174

# For example, if the source was `C10:E15`, a key of `0` will have the filter

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9175

# for column `C`, whereas the key `1` is for column `D`.

9176

"a_key": { # Criteria for showing/hiding rows in a pivot table.

9177

"visibleValues": [ # Values that should be included. Values not listed here are excluded.

"A String",

],

},

},

"columns": [ # Each column grouping in the pivot table.

9183

{ # A single grouping (either row or column) in a pivot table.

9184

"showTotals": True or False, # True if the pivot table should include the totals for this grouping.

9185

"valueMetadata": [ # Metadata about values in the grouping.

9186

{ # Metadata about a value in a pivot grouping.

9187

"collapsed": True or False, # True if the data corresponding to the value is collapsed.

9188

"value": { # The kinds of value that a cell in a spreadsheet can have. # The calculated value the metadata corresponds to.

9189

# (Note that formulaValue is not valid,

9190

# because the values will be calculated.)

9191

"numberValue": 3.14, # Represents a double value.

9192

# Note: Dates, Times and DateTimes are represented as doubles in

9193

# "serial number" format.

9194

"boolValue": True or False, # Represents a boolean value.

9195

"formulaValue": "A String", # Represents a formula.

9196

"stringValue": "A String", # Represents a string value.

9197

# Leading single quotes are not included. For example, if the user typed

9198

# `'123` into the UI, this would be represented as a `stringValue` of

9199

# `"123"`.

9200

"errorValue": { # An error in a cell. # Represents an error.

9201

# This field is read-only.

9202

"message": "A String", # A message with more information about the error

9203

# (in the spreadsheet's locale).

9204

"type": "A String", # The type of error.

},

},

},

],

"valueBucket": { # Information about which values in a pivot group should be used for sorting. # The bucket of the opposite pivot group to sort by.

9210

# If not specified, sorting is alphabetical by this group's values.

9211

"buckets": [ # Determines the bucket from which values are chosen to sort.

9212

#

9213

# For example, in a pivot table with one row group & two column groups,

9214

# the row group can list up to two values. The first value corresponds

9215

# to a value within the first column group, and the second value

9216

# corresponds to a value in the second column group. If no values

9217

# are listed, this would indicate that the row should be sorted according

9218

# to the "Grand Total" over the column groups. If a single value is listed,

9219

# this would correspond to using the "Total" of that bucket.

9220

{ # The kinds of value that a cell in a spreadsheet can have.

9221

"numberValue": 3.14, # Represents a double value.

9222

# Note: Dates, Times and DateTimes are represented as doubles in

9223

# "serial number" format.

9224

"boolValue": True or False, # Represents a boolean value.

9225

"formulaValue": "A String", # Represents a formula.

9226

"stringValue": "A String", # Represents a string value.

9227

# Leading single quotes are not included. For example, if the user typed

9228

# `'123` into the UI, this would be represented as a `stringValue` of

9229

# `"123"`.

9230

"errorValue": { # An error in a cell. # Represents an error.

9231

# This field is read-only.

9232

"message": "A String", # A message with more information about the error

9233

# (in the spreadsheet's locale).

9234

"type": "A String", # The type of error.

9235

},

9236

},

9237

],

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9238

"valuesIndex": 42, # The offset in the PivotTable.values list which the values in this

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9239

# grouping should be sorted by.

9240

},

9241

"sortOrder": "A String", # The order the values in this group should be sorted.

9242

"sourceColumnOffset": 42, # The column offset of the source range that this grouping is based on.

9243

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9244

# For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9245

# means this group refers to column `C`, whereas the offset `1` would refer

# to column `D`.

},

],

},

"hyperlink": "A String", # A hyperlink this cell points to, if any.

9251

# This field is read-only. (To set it, use a `=HYPERLINK` formula.)

9252

"effectiveValue": { # The kinds of value that a cell in a spreadsheet can have. # The effective value of the cell. For cells with formulas, this will be

9253

# the calculated value. For cells with literals, this will be

9254

# the same as the user_entered_value.

9255

# This field is read-only.

9256

"numberValue": 3.14, # Represents a double value.

9257

# Note: Dates, Times and DateTimes are represented as doubles in

9258

# "serial number" format.

9259

"boolValue": True or False, # Represents a boolean value.

9260

"formulaValue": "A String", # Represents a formula.

9261

"stringValue": "A String", # Represents a string value.

9262

# Leading single quotes are not included. For example, if the user typed

9263

# `'123` into the UI, this would be represented as a `stringValue` of

9264

# `"123"`.

9265

"errorValue": { # An error in a cell. # Represents an error.

9266

# This field is read-only.

9267

"message": "A String", # A message with more information about the error

9268

# (in the spreadsheet's locale).

9269

"type": "A String", # The type of error.

9270

},

9271

},

9272

"formattedValue": "A String", # The formatted value of the cell.

9273

# This is the value as it's shown to the user.

9274

# This field is read-only.

9275

"userEnteredValue": { # The kinds of value that a cell in a spreadsheet can have. # The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`

9276

# Note: Dates, Times and DateTimes are represented as doubles in

9277

# serial number format.

9278

"numberValue": 3.14, # Represents a double value.

9279

# Note: Dates, Times and DateTimes are represented as doubles in

9280

# "serial number" format.

9281

"boolValue": True or False, # Represents a boolean value.

9282

"formulaValue": "A String", # Represents a formula.

9283

"stringValue": "A String", # Represents a string value.

9284

# Leading single quotes are not included. For example, if the user typed

9285

# `'123` into the UI, this would be represented as a `stringValue` of

9286

# `"123"`.

9287

"errorValue": { # An error in a cell. # Represents an error.

9288

# This field is read-only.

9289

"message": "A String", # A message with more information about the error

9290

# (in the spreadsheet's locale).

9291

"type": "A String", # The type of error.

9292

},

9293

},

9294

"note": "A String", # Any note on the cell.

9295

"effectiveFormat": { # The format of a cell. # The effective format being used by the cell.

9296

# This includes the results of applying any conditional formatting and,

9297

# if the cell contains a formula, the computed number format.

9298

# If the effective format is the default format, effective format will

9299

# not be written.

9300

# This field is read-only.

9301

"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9302

"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on

9303

# the user's locale will be used if necessary for the given type.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame^]

9304

# See the [Date and Number Formats guide](/sheets/guides/formats) for more

9305

# information about the supported patterns.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9306

"type": "A String", # The type of the number format.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9307

# When writing, this field must be set.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9308

},

9309

"textDirection": "A String", # The direction of the text in the cell.

9310

"padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.

9311

# When updating padding, every field must be specified.

9312

"top": 42, # The top padding of the cell.

9313

"right": 42, # The right padding of the cell.

9314

"bottom": 42, # The bottom padding of the cell.

9315

"left": 42, # The left padding of the cell.

9316

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9317

"horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9318

"backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.

9319

# for simplicity of conversion to/from color representations in various

9320

# languages over compactness; for example, the fields of this representation

9321

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

9322

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

9323

# method in iOS; and, with just a little work, it can be easily formatted into

9324

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

9329

#

9330

# // ...

9331

# public static java.awt.Color fromProto(Color protocolor) {

9332

# float alpha = protocolor.hasAlpha()

9333

# ? protocolor.getAlpha().getValue()

9334

# : 1.0;

9335

#

9336

# return new java.awt.Color(

9337

# protocolor.getRed(),

9338

# protocolor.getGreen(),

9339

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

9344

# float red = (float) color.getRed();

9345

# float green = (float) color.getGreen();

9346

# float blue = (float) color.getBlue();

9347

# float denominator = 255.0;

9348

# Color.Builder resultBuilder =

9349

# Color

9350

# .newBuilder()

9351

# .setRed(red / denominator)

9352

# .setGreen(green / denominator)

9353

# .setBlue(blue / denominator);

9354

# int alpha = color.getAlpha();

9355

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

9360

# .build());

9361

# }

9362

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

9367

#

9368

# // ...

9369

# static UIColor* fromProto(Color* protocolor) {

9370

# float red = [protocolor red];

9371

# float green = [protocolor green];

9372

# float blue = [protocolor blue];

9373

# FloatValue* alpha_wrapper = [protocolor alpha];

9374

# float alpha = 1.0;

9375

# if (alpha_wrapper != nil) {

9376

# alpha = [alpha_wrapper value];

9377

# }

9378

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

9379

# }

9380

#

9381

# static Color* toProto(UIColor* color) {

9382

# CGFloat red, green, blue, alpha;

9383

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

9384

# return nil;

9385

# }

9386

# Color* result = [Color alloc] init];

9387

# [result setRed:red];

9388

# [result setGreen:green];

9389

# [result setBlue:blue];

9390

# if (alpha <= 0.9999) {

9391

# [result setAlpha:floatWrapperWithValue(alpha)];

9392

# }

9393

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

9403

# var redFrac = rgb_color.red || 0.0;

9404

# var greenFrac = rgb_color.green || 0.0;

9405

# var blueFrac = rgb_color.blue || 0.0;

9406

# var red = Math.floor(redFrac * 255);

9407

# var green = Math.floor(greenFrac * 255);

9408

# var blue = Math.floor(blueFrac * 255);

9409

#

9410

# if (!('alpha' in rgb_color)) {

9411

# return rgbToCssColor_(red, green, blue);

9412

# }

9413

#

9414

# var alphaFrac = rgb_color.alpha.value || 0.0;

9415

# var rgbParams = [red, green, blue].join(',');

9416

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

9417

# };

9418

#

9419

# var rgbToCssColor_ = function(red, green, blue) {

9420

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

9421

# var hexString = rgbNumber.toString(16);

9422

# var missingZeros = 6 - hexString.length;

9423

# var resultBuilder = ['#'];

9424

# for (var i = 0; i < missingZeros; i++) {

9425

# resultBuilder.push('0');

9426

# }

9427

# resultBuilder.push(hexString);

9428

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

9433

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

9434

# the final pixel color is defined by the equation:

9435

#

9436

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

9437

#

9438

# This means that a value of 1.0 corresponds to a solid color, whereas

9439

# a value of 0.0 corresponds to a completely transparent color. This

9440

# uses a wrapper message rather than a simple float scalar so that it is

9441

# possible to distinguish between a default value and the value being unset.

9442

# If omitted, this color object is to be rendered as a solid color

9443

# (as if the alpha value had been explicitly given with a value of 1.0).

9444

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

9445

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

9446

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9447

"verticalAlignment": "A String", # The vertical alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9448

"textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).

9449

# Absent values indicate that the field isn't specified.

9450

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

9451

# for simplicity of conversion to/from color representations in various

9452

# languages over compactness; for example, the fields of this representation

9453

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

9454

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

9455

# method in iOS; and, with just a little work, it can be easily formatted into

9456

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

9461

#

9462

# // ...

9463

# public static java.awt.Color fromProto(Color protocolor) {

9464

# float alpha = protocolor.hasAlpha()

9465

# ? protocolor.getAlpha().getValue()

9466

# : 1.0;

9467

#

9468

# return new java.awt.Color(

9469

# protocolor.getRed(),

9470

# protocolor.getGreen(),

9471

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

9476

# float red = (float) color.getRed();

9477

# float green = (float) color.getGreen();

9478

# float blue = (float) color.getBlue();

9479

# float denominator = 255.0;

9480

# Color.Builder resultBuilder =

9481

# Color

9482

# .newBuilder()

9483

# .setRed(red / denominator)

9484

# .setGreen(green / denominator)

9485

# .setBlue(blue / denominator);

9486

# int alpha = color.getAlpha();

9487

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

9492

# .build());

9493

# }

9494

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

9499

#

9500

# // ...

9501

# static UIColor* fromProto(Color* protocolor) {

9502

# float red = [protocolor red];

9503

# float green = [protocolor green];

9504

# float blue = [protocolor blue];

9505

# FloatValue* alpha_wrapper = [protocolor alpha];

9506

# float alpha = 1.0;

9507

# if (alpha_wrapper != nil) {

9508

# alpha = [alpha_wrapper value];

9509

# }

9510

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

9511

# }

9512

#

9513

# static Color* toProto(UIColor* color) {

9514

# CGFloat red, green, blue, alpha;

9515

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

9516

# return nil;

9517

# }

9518

# Color* result = [Color alloc] init];

9519

# [result setRed:red];

9520

# [result setGreen:green];

9521

# [result setBlue:blue];

9522

# if (alpha <= 0.9999) {

9523

# [result setAlpha:floatWrapperWithValue(alpha)];

9524

# }

9525

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

9535

# var redFrac = rgb_color.red || 0.0;

9536

# var greenFrac = rgb_color.green || 0.0;

9537

# var blueFrac = rgb_color.blue || 0.0;

9538

# var red = Math.floor(redFrac * 255);

9539

# var green = Math.floor(greenFrac * 255);

9540

# var blue = Math.floor(blueFrac * 255);

9541

#

9542

# if (!('alpha' in rgb_color)) {

9543

# return rgbToCssColor_(red, green, blue);

9544

# }

9545

#

9546

# var alphaFrac = rgb_color.alpha.value || 0.0;

9547

# var rgbParams = [red, green, blue].join(',');

9548

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

9549

# };

9550

#

9551

# var rgbToCssColor_ = function(red, green, blue) {

9552

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

9553

# var hexString = rgbNumber.toString(16);

9554

# var missingZeros = 6 - hexString.length;

9555

# var resultBuilder = ['#'];

9556

# for (var i = 0; i < missingZeros; i++) {

9557

# resultBuilder.push('0');

9558

# }

9559

# resultBuilder.push(hexString);

9560

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

9565

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

9566

# the final pixel color is defined by the equation:

9567

#

9568

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

9569

#

9570

# This means that a value of 1.0 corresponds to a solid color, whereas

9571

# a value of 0.0 corresponds to a completely transparent color. This

9572

# uses a wrapper message rather than a simple float scalar so that it is

9573

# possible to distinguish between a default value and the value being unset.

9574

# If omitted, this color object is to be rendered as a solid color

9575

# (as if the alpha value had been explicitly given with a value of 1.0).

9576

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

9577

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

9578

},

9579

"bold": True or False, # True if the text is bold.

9580

"strikethrough": True or False, # True if the text has a strikethrough.

9581

"fontFamily": "A String", # The font family.

9582

"fontSize": 42, # The size of the font.

9583

"italic": True or False, # True if the text is italicized.

9584

"underline": True or False, # True if the text is underlined.

9585

},

9586

"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.

9587

"borders": { # The borders of the cell. # The borders of the cell.

9588

"top": { # A border along a cell. # The top border of the cell.

9589

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

9590

# for simplicity of conversion to/from color representations in various

9591

# languages over compactness; for example, the fields of this representation

9592

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

9593

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

9594

# method in iOS; and, with just a little work, it can be easily formatted into

9595

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

9600

#

9601

# // ...

9602

# public static java.awt.Color fromProto(Color protocolor) {

9603

# float alpha = protocolor.hasAlpha()

9604

# ? protocolor.getAlpha().getValue()

9605

# : 1.0;

9606

#

9607

# return new java.awt.Color(

9608

# protocolor.getRed(),

9609

# protocolor.getGreen(),

9610

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

9615

# float red = (float) color.getRed();

9616

# float green = (float) color.getGreen();

9617

# float blue = (float) color.getBlue();

9618

# float denominator = 255.0;

9619

# Color.Builder resultBuilder =

9620

# Color

9621

# .newBuilder()

9622

# .setRed(red / denominator)

9623

# .setGreen(green / denominator)

9624

# .setBlue(blue / denominator);

9625

# int alpha = color.getAlpha();

9626

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

9631

# .build());

9632

# }

9633

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

9638

#

9639

# // ...

9640

# static UIColor* fromProto(Color* protocolor) {

9641

# float red = [protocolor red];

9642

# float green = [protocolor green];

9643

# float blue = [protocolor blue];

9644

# FloatValue* alpha_wrapper = [protocolor alpha];

9645

# float alpha = 1.0;

9646

# if (alpha_wrapper != nil) {

9647

# alpha = [alpha_wrapper value];

9648

# }

9649

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

9650

# }

9651

#

9652

# static Color* toProto(UIColor* color) {

9653

# CGFloat red, green, blue, alpha;

9654

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

9655

# return nil;

9656

# }

9657

# Color* result = [Color alloc] init];

9658

# [result setRed:red];

9659

# [result setGreen:green];

9660

# [result setBlue:blue];

9661

# if (alpha <= 0.9999) {

9662

# [result setAlpha:floatWrapperWithValue(alpha)];

9663

# }

9664

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

9674

# var redFrac = rgb_color.red || 0.0;

9675

# var greenFrac = rgb_color.green || 0.0;

9676

# var blueFrac = rgb_color.blue || 0.0;

9677

# var red = Math.floor(redFrac * 255);

9678

# var green = Math.floor(greenFrac * 255);

9679

# var blue = Math.floor(blueFrac * 255);

9680

#

9681

# if (!('alpha' in rgb_color)) {

9682

# return rgbToCssColor_(red, green, blue);

9683

# }

9684

#

9685

# var alphaFrac = rgb_color.alpha.value || 0.0;

9686

# var rgbParams = [red, green, blue].join(',');

9687

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

9688

# };

9689

#

9690

# var rgbToCssColor_ = function(red, green, blue) {

9691

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

9692

# var hexString = rgbNumber.toString(16);

9693

# var missingZeros = 6 - hexString.length;

9694

# var resultBuilder = ['#'];

9695

# for (var i = 0; i < missingZeros; i++) {

9696

# resultBuilder.push('0');

9697

# }

9698

# resultBuilder.push(hexString);

9699

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

9704

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

9705

# the final pixel color is defined by the equation:

9706

#

9707

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

9708

#

9709

# This means that a value of 1.0 corresponds to a solid color, whereas

9710

# a value of 0.0 corresponds to a completely transparent color. This

9711

# uses a wrapper message rather than a simple float scalar so that it is

9712

# possible to distinguish between a default value and the value being unset.

9713

# If omitted, this color object is to be rendered as a solid color

9714

# (as if the alpha value had been explicitly given with a value of 1.0).

9715

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

9716

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

9717

},

9718

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9719

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9720

"style": "A String", # The style of the border.

9721

},

9722

"right": { # A border along a cell. # The right border of the cell.

9723

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

9724

# for simplicity of conversion to/from color representations in various

9725

# languages over compactness; for example, the fields of this representation

9726

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

9727

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

9728

# method in iOS; and, with just a little work, it can be easily formatted into

9729

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

9734

#

9735

# // ...

9736

# public static java.awt.Color fromProto(Color protocolor) {

9737

# float alpha = protocolor.hasAlpha()

9738

# ? protocolor.getAlpha().getValue()

9739

# : 1.0;

9740

#

9741

# return new java.awt.Color(

9742

# protocolor.getRed(),

9743

# protocolor.getGreen(),

9744

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

9749

# float red = (float) color.getRed();

9750

# float green = (float) color.getGreen();

9751

# float blue = (float) color.getBlue();

9752

# float denominator = 255.0;

9753

# Color.Builder resultBuilder =

9754

# Color

9755

# .newBuilder()

9756

# .setRed(red / denominator)

9757

# .setGreen(green / denominator)

9758

# .setBlue(blue / denominator);

9759

# int alpha = color.getAlpha();

9760

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

9765

# .build());

9766

# }

9767

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

9772

#

9773

# // ...

9774

# static UIColor* fromProto(Color* protocolor) {

9775

# float red = [protocolor red];

9776

# float green = [protocolor green];

9777

# float blue = [protocolor blue];

9778

# FloatValue* alpha_wrapper = [protocolor alpha];

9779

# float alpha = 1.0;

9780

# if (alpha_wrapper != nil) {

9781

# alpha = [alpha_wrapper value];

9782

# }

9783

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

9784

# }

9785

#

9786

# static Color* toProto(UIColor* color) {

9787

# CGFloat red, green, blue, alpha;

9788

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

9789

# return nil;

9790

# }

9791

# Color* result = [Color alloc] init];

9792

# [result setRed:red];

9793

# [result setGreen:green];

9794

# [result setBlue:blue];

9795

# if (alpha <= 0.9999) {

9796

# [result setAlpha:floatWrapperWithValue(alpha)];

9797

# }

9798

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

9808

# var redFrac = rgb_color.red || 0.0;

9809

# var greenFrac = rgb_color.green || 0.0;

9810

# var blueFrac = rgb_color.blue || 0.0;

9811

# var red = Math.floor(redFrac * 255);

9812

# var green = Math.floor(greenFrac * 255);

9813

# var blue = Math.floor(blueFrac * 255);

9814

#

9815

# if (!('alpha' in rgb_color)) {

9816

# return rgbToCssColor_(red, green, blue);

9817

# }

9818

#

9819

# var alphaFrac = rgb_color.alpha.value || 0.0;

9820

# var rgbParams = [red, green, blue].join(',');

9821

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

9822

# };

9823

#

9824

# var rgbToCssColor_ = function(red, green, blue) {

9825

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

9826

# var hexString = rgbNumber.toString(16);

9827

# var missingZeros = 6 - hexString.length;

9828

# var resultBuilder = ['#'];

9829

# for (var i = 0; i < missingZeros; i++) {

9830

# resultBuilder.push('0');

9831

# }

9832

# resultBuilder.push(hexString);

9833

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

9838

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

9839

# the final pixel color is defined by the equation:

9840

#

9841

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

9842

#

9843

# This means that a value of 1.0 corresponds to a solid color, whereas

9844

# a value of 0.0 corresponds to a completely transparent color. This

9845

# uses a wrapper message rather than a simple float scalar so that it is

9846

# possible to distinguish between a default value and the value being unset.

9847

# If omitted, this color object is to be rendered as a solid color

9848

# (as if the alpha value had been explicitly given with a value of 1.0).

9849

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

9850

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

9851

},

9852

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9853

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9854

"style": "A String", # The style of the border.

9855

},

9856

"bottom": { # A border along a cell. # The bottom border of the cell.

9857

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

9858

# for simplicity of conversion to/from color representations in various

9859

# languages over compactness; for example, the fields of this representation

9860

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

9861

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

9862

# method in iOS; and, with just a little work, it can be easily formatted into

9863

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

9868

#

9869

# // ...

9870

# public static java.awt.Color fromProto(Color protocolor) {

9871

# float alpha = protocolor.hasAlpha()

9872

# ? protocolor.getAlpha().getValue()

9873

# : 1.0;

9874

#

9875

# return new java.awt.Color(

9876

# protocolor.getRed(),

9877

# protocolor.getGreen(),

9878

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

9883

# float red = (float) color.getRed();

9884

# float green = (float) color.getGreen();

9885

# float blue = (float) color.getBlue();

9886

# float denominator = 255.0;

9887

# Color.Builder resultBuilder =

9888

# Color

9889

# .newBuilder()

9890

# .setRed(red / denominator)

9891

# .setGreen(green / denominator)

9892

# .setBlue(blue / denominator);

9893

# int alpha = color.getAlpha();

9894

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

9899

# .build());

9900

# }

9901

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

9906

#

9907

# // ...

9908

# static UIColor* fromProto(Color* protocolor) {

9909

# float red = [protocolor red];

9910

# float green = [protocolor green];

9911

# float blue = [protocolor blue];

9912

# FloatValue* alpha_wrapper = [protocolor alpha];

9913

# float alpha = 1.0;

9914

# if (alpha_wrapper != nil) {

9915

# alpha = [alpha_wrapper value];

9916

# }

9917

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

9918

# }

9919

#

9920

# static Color* toProto(UIColor* color) {

9921

# CGFloat red, green, blue, alpha;

9922

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

9923

# return nil;

9924

# }

9925

# Color* result = [Color alloc] init];

9926

# [result setRed:red];

9927

# [result setGreen:green];

9928

# [result setBlue:blue];

9929

# if (alpha <= 0.9999) {

9930

# [result setAlpha:floatWrapperWithValue(alpha)];

9931

# }

9932

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

9942

# var redFrac = rgb_color.red || 0.0;

9943

# var greenFrac = rgb_color.green || 0.0;

9944

# var blueFrac = rgb_color.blue || 0.0;

9945

# var red = Math.floor(redFrac * 255);

9946

# var green = Math.floor(greenFrac * 255);

9947

# var blue = Math.floor(blueFrac * 255);

9948

#

9949

# if (!('alpha' in rgb_color)) {

9950

# return rgbToCssColor_(red, green, blue);

9951

# }

9952

#

9953

# var alphaFrac = rgb_color.alpha.value || 0.0;

9954

# var rgbParams = [red, green, blue].join(',');

9955

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

9956

# };

9957

#

9958

# var rgbToCssColor_ = function(red, green, blue) {

9959

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

9960

# var hexString = rgbNumber.toString(16);

9961

# var missingZeros = 6 - hexString.length;

9962

# var resultBuilder = ['#'];

9963

# for (var i = 0; i < missingZeros; i++) {

9964

# resultBuilder.push('0');

9965

# }

9966

# resultBuilder.push(hexString);

9967

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

9972

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

9973

# the final pixel color is defined by the equation:

9974

#

9975

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

9976

#

9977

# This means that a value of 1.0 corresponds to a solid color, whereas

9978

# a value of 0.0 corresponds to a completely transparent color. This

9979

# uses a wrapper message rather than a simple float scalar so that it is

9980

# possible to distinguish between a default value and the value being unset.

9981

# If omitted, this color object is to be rendered as a solid color

9982

# (as if the alpha value had been explicitly given with a value of 1.0).

9983

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

9984

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

9985

},

9986

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

9987

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

9988

"style": "A String", # The style of the border.

9989

},

9990

"left": { # A border along a cell. # The left border of the cell.

9991

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

9992

# for simplicity of conversion to/from color representations in various

9993

# languages over compactness; for example, the fields of this representation

9994

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

9995

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

9996

# method in iOS; and, with just a little work, it can be easily formatted into

9997

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

10002

#

10003

# // ...

10004

# public static java.awt.Color fromProto(Color protocolor) {

10005

# float alpha = protocolor.hasAlpha()

10006

# ? protocolor.getAlpha().getValue()

10007

# : 1.0;

10008

#

10009

# return new java.awt.Color(

10010

# protocolor.getRed(),

10011

# protocolor.getGreen(),

10012

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

10017

# float red = (float) color.getRed();

10018

# float green = (float) color.getGreen();

10019

# float blue = (float) color.getBlue();

10020

# float denominator = 255.0;

10021

# Color.Builder resultBuilder =

10022

# Color

10023

# .newBuilder()

10024

# .setRed(red / denominator)

10025

# .setGreen(green / denominator)

10026

# .setBlue(blue / denominator);

10027

# int alpha = color.getAlpha();

10028

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

10033

# .build());

10034

# }

10035

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

10040

#

10041

# // ...

10042

# static UIColor* fromProto(Color* protocolor) {

10043

# float red = [protocolor red];

10044

# float green = [protocolor green];

10045

# float blue = [protocolor blue];

10046

# FloatValue* alpha_wrapper = [protocolor alpha];

10047

# float alpha = 1.0;

10048

# if (alpha_wrapper != nil) {

10049

# alpha = [alpha_wrapper value];

10050

# }

10051

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

10052

# }

10053

#

10054

# static Color* toProto(UIColor* color) {

10055

# CGFloat red, green, blue, alpha;

10056

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

10057

# return nil;

10058

# }

10059

# Color* result = [Color alloc] init];

10060

# [result setRed:red];

10061

# [result setGreen:green];

10062

# [result setBlue:blue];

10063

# if (alpha <= 0.9999) {

10064

# [result setAlpha:floatWrapperWithValue(alpha)];

10065

# }

10066

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

10076

# var redFrac = rgb_color.red || 0.0;

10077

# var greenFrac = rgb_color.green || 0.0;

10078

# var blueFrac = rgb_color.blue || 0.0;

10079

# var red = Math.floor(redFrac * 255);

10080

# var green = Math.floor(greenFrac * 255);

10081

# var blue = Math.floor(blueFrac * 255);

10082

#

10083

# if (!('alpha' in rgb_color)) {

10084

# return rgbToCssColor_(red, green, blue);

10085

# }

10086

#

10087

# var alphaFrac = rgb_color.alpha.value || 0.0;

10088

# var rgbParams = [red, green, blue].join(',');

10089

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

10090

# };

10091

#

10092

# var rgbToCssColor_ = function(red, green, blue) {

10093

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

10094

# var hexString = rgbNumber.toString(16);

10095

# var missingZeros = 6 - hexString.length;

10096

# var resultBuilder = ['#'];

10097

# for (var i = 0; i < missingZeros; i++) {

10098

# resultBuilder.push('0');

10099

# }

10100

# resultBuilder.push(hexString);

10101

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

10106

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

10107

# the final pixel color is defined by the equation:

10108

#

10109

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

10110

#

10111

# This means that a value of 1.0 corresponds to a solid color, whereas

10112

# a value of 0.0 corresponds to a completely transparent color. This

10113

# uses a wrapper message rather than a simple float scalar so that it is

10114

# possible to distinguish between a default value and the value being unset.

10115

# If omitted, this color object is to be rendered as a solid color

10116

# (as if the alpha value had been explicitly given with a value of 1.0).

10117

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

10118

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

10119

},

10120

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

10121

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

10122

"style": "A String", # The style of the border.

10123

},

10124

},

10125

"wrapStrategy": "A String", # The wrap strategy for the value in the cell.

10126

},

10127

"userEnteredFormat": { # The format of a cell. # The format the user entered for the cell.

10128

#

10129

# When writing, the new format will be merged with the existing format.

10130

"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

10131

"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on

10132

# the user's locale will be used if necessary for the given type.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame^]

10133

# See the [Date and Number Formats guide](/sheets/guides/formats) for more

10134

# information about the supported patterns.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

10135

"type": "A String", # The type of the number format.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

10136

# When writing, this field must be set.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

10137

},

10138

"textDirection": "A String", # The direction of the text in the cell.

10139

"padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.

10140

# When updating padding, every field must be specified.

10141

"top": 42, # The top padding of the cell.

10142

"right": 42, # The right padding of the cell.

10143

"bottom": 42, # The bottom padding of the cell.

10144

"left": 42, # The left padding of the cell.

10145

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

10146

"horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

10147

"backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.

10148

# for simplicity of conversion to/from color representations in various

10149

# languages over compactness; for example, the fields of this representation

10150

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

10151

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

10152

# method in iOS; and, with just a little work, it can be easily formatted into

10153

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

10158

#

10159

# // ...

10160

# public static java.awt.Color fromProto(Color protocolor) {

10161

# float alpha = protocolor.hasAlpha()

10162

# ? protocolor.getAlpha().getValue()

10163

# : 1.0;

10164

#

10165

# return new java.awt.Color(

10166

# protocolor.getRed(),

10167

# protocolor.getGreen(),

10168

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

10173

# float red = (float) color.getRed();

10174

# float green = (float) color.getGreen();

10175

# float blue = (float) color.getBlue();

10176

# float denominator = 255.0;

10177

# Color.Builder resultBuilder =

10178

# Color

10179

# .newBuilder()

10180

# .setRed(red / denominator)

10181

# .setGreen(green / denominator)

10182

# .setBlue(blue / denominator);

10183

# int alpha = color.getAlpha();

10184

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

10189

# .build());

10190

# }

10191

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

10196

#

10197

# // ...

10198

# static UIColor* fromProto(Color* protocolor) {

10199

# float red = [protocolor red];

10200

# float green = [protocolor green];

10201

# float blue = [protocolor blue];

10202

# FloatValue* alpha_wrapper = [protocolor alpha];

10203

# float alpha = 1.0;

10204

# if (alpha_wrapper != nil) {

10205

# alpha = [alpha_wrapper value];

10206

# }

10207

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

10208

# }

10209

#

10210

# static Color* toProto(UIColor* color) {

10211

# CGFloat red, green, blue, alpha;

10212

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

10213

# return nil;

10214

# }

10215

# Color* result = [Color alloc] init];

10216

# [result setRed:red];

10217

# [result setGreen:green];

10218

# [result setBlue:blue];

10219

# if (alpha <= 0.9999) {

10220

# [result setAlpha:floatWrapperWithValue(alpha)];

10221

# }

10222

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

10232

# var redFrac = rgb_color.red || 0.0;

10233

# var greenFrac = rgb_color.green || 0.0;

10234

# var blueFrac = rgb_color.blue || 0.0;

10235

# var red = Math.floor(redFrac * 255);

10236

# var green = Math.floor(greenFrac * 255);

10237

# var blue = Math.floor(blueFrac * 255);

10238

#

10239

# if (!('alpha' in rgb_color)) {

10240

# return rgbToCssColor_(red, green, blue);

10241

# }

10242

#

10243

# var alphaFrac = rgb_color.alpha.value || 0.0;

10244

# var rgbParams = [red, green, blue].join(',');

10245

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

10246

# };

10247

#

10248

# var rgbToCssColor_ = function(red, green, blue) {

10249

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

10250

# var hexString = rgbNumber.toString(16);

10251

# var missingZeros = 6 - hexString.length;

10252

# var resultBuilder = ['#'];

10253

# for (var i = 0; i < missingZeros; i++) {

10254

# resultBuilder.push('0');

10255

# }

10256

# resultBuilder.push(hexString);

10257

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

10262

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

10263

# the final pixel color is defined by the equation:

10264

#

10265

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

10266

#

10267

# This means that a value of 1.0 corresponds to a solid color, whereas

10268

# a value of 0.0 corresponds to a completely transparent color. This

10269

# uses a wrapper message rather than a simple float scalar so that it is

10270

# possible to distinguish between a default value and the value being unset.

10271

# If omitted, this color object is to be rendered as a solid color

10272

# (as if the alpha value had been explicitly given with a value of 1.0).

10273

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

10274

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

10275

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

10276

"verticalAlignment": "A String", # The vertical alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

10277

"textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).

10278

# Absent values indicate that the field isn't specified.

10279

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

10280

# for simplicity of conversion to/from color representations in various

10281

# languages over compactness; for example, the fields of this representation

10282

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

10283

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

10284

# method in iOS; and, with just a little work, it can be easily formatted into

10285

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

10290

#

10291

# // ...

10292

# public static java.awt.Color fromProto(Color protocolor) {

10293

# float alpha = protocolor.hasAlpha()

10294

# ? protocolor.getAlpha().getValue()

10295

# : 1.0;

10296

#

10297

# return new java.awt.Color(

10298

# protocolor.getRed(),

10299

# protocolor.getGreen(),

10300

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

10305

# float red = (float) color.getRed();

10306

# float green = (float) color.getGreen();

10307

# float blue = (float) color.getBlue();

10308

# float denominator = 255.0;

10309

# Color.Builder resultBuilder =

10310

# Color

10311

# .newBuilder()

10312

# .setRed(red / denominator)

10313

# .setGreen(green / denominator)

10314

# .setBlue(blue / denominator);

10315

# int alpha = color.getAlpha();

10316

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

10321

# .build());

10322

# }

10323

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

10328

#

10329

# // ...

10330

# static UIColor* fromProto(Color* protocolor) {

10331

# float red = [protocolor red];

10332

# float green = [protocolor green];

10333

# float blue = [protocolor blue];

10334

# FloatValue* alpha_wrapper = [protocolor alpha];

10335

# float alpha = 1.0;

10336

# if (alpha_wrapper != nil) {

10337

# alpha = [alpha_wrapper value];

10338

# }

10339

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

10340

# }

10341

#

10342

# static Color* toProto(UIColor* color) {

10343

# CGFloat red, green, blue, alpha;

10344

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

10345

# return nil;

10346

# }

10347

# Color* result = [Color alloc] init];

10348

# [result setRed:red];

10349

# [result setGreen:green];

10350

# [result setBlue:blue];

10351

# if (alpha <= 0.9999) {

10352

# [result setAlpha:floatWrapperWithValue(alpha)];

10353

# }

10354

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

10364

# var redFrac = rgb_color.red || 0.0;

10365

# var greenFrac = rgb_color.green || 0.0;

10366

# var blueFrac = rgb_color.blue || 0.0;

10367

# var red = Math.floor(redFrac * 255);

10368

# var green = Math.floor(greenFrac * 255);

10369

# var blue = Math.floor(blueFrac * 255);

10370

#

10371

# if (!('alpha' in rgb_color)) {

10372

# return rgbToCssColor_(red, green, blue);

10373

# }

10374

#

10375

# var alphaFrac = rgb_color.alpha.value || 0.0;

10376

# var rgbParams = [red, green, blue].join(',');

10377

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

10378

# };

10379

#

10380

# var rgbToCssColor_ = function(red, green, blue) {

10381

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

10382

# var hexString = rgbNumber.toString(16);

10383

# var missingZeros = 6 - hexString.length;

10384

# var resultBuilder = ['#'];

10385

# for (var i = 0; i < missingZeros; i++) {

10386

# resultBuilder.push('0');

10387

# }

10388

# resultBuilder.push(hexString);

10389

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

10394

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

10395

# the final pixel color is defined by the equation:

10396

#

10397

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

10398

#

10399

# This means that a value of 1.0 corresponds to a solid color, whereas

10400

# a value of 0.0 corresponds to a completely transparent color. This

10401

# uses a wrapper message rather than a simple float scalar so that it is

10402

# possible to distinguish between a default value and the value being unset.

10403

# If omitted, this color object is to be rendered as a solid color

10404

# (as if the alpha value had been explicitly given with a value of 1.0).

10405

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

10406

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

10407

},

10408

"bold": True or False, # True if the text is bold.

10409

"strikethrough": True or False, # True if the text has a strikethrough.

10410

"fontFamily": "A String", # The font family.

10411

"fontSize": 42, # The size of the font.

10412

"italic": True or False, # True if the text is italicized.

10413

"underline": True or False, # True if the text is underlined.

10414

},

10415

"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.

10416

"borders": { # The borders of the cell. # The borders of the cell.

10417

"top": { # A border along a cell. # The top border of the cell.

10418

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

10419

# for simplicity of conversion to/from color representations in various

10420

# languages over compactness; for example, the fields of this representation

10421

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

10422

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

10423

# method in iOS; and, with just a little work, it can be easily formatted into

10424

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

10429

#

10430

# // ...

10431

# public static java.awt.Color fromProto(Color protocolor) {

10432

# float alpha = protocolor.hasAlpha()

10433

# ? protocolor.getAlpha().getValue()

10434

# : 1.0;

10435

#

10436

# return new java.awt.Color(

10437

# protocolor.getRed(),

10438

# protocolor.getGreen(),

10439

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

10444

# float red = (float) color.getRed();

10445

# float green = (float) color.getGreen();

10446

# float blue = (float) color.getBlue();

10447

# float denominator = 255.0;

10448

# Color.Builder resultBuilder =

10449

# Color

10450

# .newBuilder()

10451

# .setRed(red / denominator)

10452

# .setGreen(green / denominator)

10453

# .setBlue(blue / denominator);

10454

# int alpha = color.getAlpha();

10455

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

10460

# .build());

10461

# }

10462

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

10467

#

10468

# // ...

10469

# static UIColor* fromProto(Color* protocolor) {

10470

# float red = [protocolor red];

10471

# float green = [protocolor green];

10472

# float blue = [protocolor blue];

10473

# FloatValue* alpha_wrapper = [protocolor alpha];

10474

# float alpha = 1.0;

10475

# if (alpha_wrapper != nil) {

10476

# alpha = [alpha_wrapper value];

10477

# }

10478

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

10479

# }

10480

#

10481

# static Color* toProto(UIColor* color) {

10482

# CGFloat red, green, blue, alpha;

10483

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

10484

# return nil;

10485

# }

10486

# Color* result = [Color alloc] init];

10487

# [result setRed:red];

10488

# [result setGreen:green];

10489

# [result setBlue:blue];

10490

# if (alpha <= 0.9999) {

10491

# [result setAlpha:floatWrapperWithValue(alpha)];

10492

# }

10493

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

10503

# var redFrac = rgb_color.red || 0.0;

10504

# var greenFrac = rgb_color.green || 0.0;

10505

# var blueFrac = rgb_color.blue || 0.0;

10506

# var red = Math.floor(redFrac * 255);

10507

# var green = Math.floor(greenFrac * 255);

10508

# var blue = Math.floor(blueFrac * 255);

10509

#

10510

# if (!('alpha' in rgb_color)) {

10511

# return rgbToCssColor_(red, green, blue);

10512

# }

10513

#

10514

# var alphaFrac = rgb_color.alpha.value || 0.0;

10515

# var rgbParams = [red, green, blue].join(',');

10516

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

10517

# };

10518

#

10519

# var rgbToCssColor_ = function(red, green, blue) {

10520

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

10521

# var hexString = rgbNumber.toString(16);

10522

# var missingZeros = 6 - hexString.length;

10523

# var resultBuilder = ['#'];

10524

# for (var i = 0; i < missingZeros; i++) {

10525

# resultBuilder.push('0');

10526

# }

10527

# resultBuilder.push(hexString);

10528

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

10533

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

10534

# the final pixel color is defined by the equation:

10535

#

10536

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

10537

#

10538

# This means that a value of 1.0 corresponds to a solid color, whereas

10539

# a value of 0.0 corresponds to a completely transparent color. This

10540

# uses a wrapper message rather than a simple float scalar so that it is

10541

# possible to distinguish between a default value and the value being unset.

10542

# If omitted, this color object is to be rendered as a solid color

10543

# (as if the alpha value had been explicitly given with a value of 1.0).

10544

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

10545

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

10546

},

10547

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

10548

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

10549

"style": "A String", # The style of the border.

10550

},

10551

"right": { # A border along a cell. # The right border of the cell.

10552

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

10553

# for simplicity of conversion to/from color representations in various

10554

# languages over compactness; for example, the fields of this representation

10555

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

10556

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

10557

# method in iOS; and, with just a little work, it can be easily formatted into

10558

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

10563

#

10564

# // ...

10565

# public static java.awt.Color fromProto(Color protocolor) {

10566

# float alpha = protocolor.hasAlpha()

10567

# ? protocolor.getAlpha().getValue()

10568

# : 1.0;

10569

#

10570

# return new java.awt.Color(

10571

# protocolor.getRed(),

10572

# protocolor.getGreen(),

10573

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

10578

# float red = (float) color.getRed();

10579

# float green = (float) color.getGreen();

10580

# float blue = (float) color.getBlue();

10581

# float denominator = 255.0;

10582

# Color.Builder resultBuilder =

10583

# Color

10584

# .newBuilder()

10585

# .setRed(red / denominator)

10586

# .setGreen(green / denominator)

10587

# .setBlue(blue / denominator);

10588

# int alpha = color.getAlpha();

10589

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

10594

# .build());

10595

# }

10596

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

10601

#

10602

# // ...

10603

# static UIColor* fromProto(Color* protocolor) {

10604

# float red = [protocolor red];

10605

# float green = [protocolor green];

10606

# float blue = [protocolor blue];

10607

# FloatValue* alpha_wrapper = [protocolor alpha];

10608

# float alpha = 1.0;

10609

# if (alpha_wrapper != nil) {

10610

# alpha = [alpha_wrapper value];

10611

# }

10612

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

10613

# }

10614

#

10615

# static Color* toProto(UIColor* color) {

10616

# CGFloat red, green, blue, alpha;

10617

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

10618

# return nil;

10619

# }

10620

# Color* result = [Color alloc] init];

10621

# [result setRed:red];

10622

# [result setGreen:green];

10623

# [result setBlue:blue];

10624

# if (alpha <= 0.9999) {

10625

# [result setAlpha:floatWrapperWithValue(alpha)];

10626

# }

10627

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

10637

# var redFrac = rgb_color.red || 0.0;

10638

# var greenFrac = rgb_color.green || 0.0;

10639

# var blueFrac = rgb_color.blue || 0.0;

10640

# var red = Math.floor(redFrac * 255);

10641

# var green = Math.floor(greenFrac * 255);

10642

# var blue = Math.floor(blueFrac * 255);

10643

#

10644

# if (!('alpha' in rgb_color)) {

10645

# return rgbToCssColor_(red, green, blue);

10646

# }

10647

#

10648

# var alphaFrac = rgb_color.alpha.value || 0.0;

10649

# var rgbParams = [red, green, blue].join(',');

10650

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

10651

# };

10652

#

10653

# var rgbToCssColor_ = function(red, green, blue) {

10654

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

10655

# var hexString = rgbNumber.toString(16);

10656

# var missingZeros = 6 - hexString.length;

10657

# var resultBuilder = ['#'];

10658

# for (var i = 0; i < missingZeros; i++) {

10659

# resultBuilder.push('0');

10660

# }

10661

# resultBuilder.push(hexString);

10662

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

10667

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

10668

# the final pixel color is defined by the equation:

10669

#

10670

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

10671

#

10672

# This means that a value of 1.0 corresponds to a solid color, whereas

10673

# a value of 0.0 corresponds to a completely transparent color. This

10674

# uses a wrapper message rather than a simple float scalar so that it is

10675

# possible to distinguish between a default value and the value being unset.

10676

# If omitted, this color object is to be rendered as a solid color

10677

# (as if the alpha value had been explicitly given with a value of 1.0).

10678

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

10679

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

10680

},

10681

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

10682

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

10683

"style": "A String", # The style of the border.

10684

},

10685

"bottom": { # A border along a cell. # The bottom border of the cell.

10686

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

10687

# for simplicity of conversion to/from color representations in various

10688

# languages over compactness; for example, the fields of this representation

10689

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

10690

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

10691

# method in iOS; and, with just a little work, it can be easily formatted into

10692

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

10697

#

10698

# // ...

10699

# public static java.awt.Color fromProto(Color protocolor) {

10700

# float alpha = protocolor.hasAlpha()

10701

# ? protocolor.getAlpha().getValue()

10702

# : 1.0;

10703

#

10704

# return new java.awt.Color(

10705

# protocolor.getRed(),

10706

# protocolor.getGreen(),

10707

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

10712

# float red = (float) color.getRed();

10713

# float green = (float) color.getGreen();

10714

# float blue = (float) color.getBlue();

10715

# float denominator = 255.0;

10716

# Color.Builder resultBuilder =

10717

# Color

10718

# .newBuilder()

10719

# .setRed(red / denominator)

10720

# .setGreen(green / denominator)

10721

# .setBlue(blue / denominator);

10722

# int alpha = color.getAlpha();

10723

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

10728

# .build());

10729

# }

10730

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

10735

#

10736

# // ...

10737

# static UIColor* fromProto(Color* protocolor) {

10738

# float red = [protocolor red];

10739

# float green = [protocolor green];

10740

# float blue = [protocolor blue];

10741

# FloatValue* alpha_wrapper = [protocolor alpha];

10742

# float alpha = 1.0;

10743

# if (alpha_wrapper != nil) {

10744

# alpha = [alpha_wrapper value];

10745

# }

10746

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

10747

# }

10748

#

10749

# static Color* toProto(UIColor* color) {

10750

# CGFloat red, green, blue, alpha;

10751

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

10752

# return nil;

10753

# }

10754

# Color* result = [Color alloc] init];

10755

# [result setRed:red];

10756

# [result setGreen:green];

10757

# [result setBlue:blue];

10758

# if (alpha <= 0.9999) {

10759

# [result setAlpha:floatWrapperWithValue(alpha)];

10760

# }

10761

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

10771

# var redFrac = rgb_color.red || 0.0;

10772

# var greenFrac = rgb_color.green || 0.0;

10773

# var blueFrac = rgb_color.blue || 0.0;

10774

# var red = Math.floor(redFrac * 255);

10775

# var green = Math.floor(greenFrac * 255);

10776

# var blue = Math.floor(blueFrac * 255);

10777

#

10778

# if (!('alpha' in rgb_color)) {

10779

# return rgbToCssColor_(red, green, blue);

10780

# }

10781

#

10782

# var alphaFrac = rgb_color.alpha.value || 0.0;

10783

# var rgbParams = [red, green, blue].join(',');

10784

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

10785

# };

10786

#

10787

# var rgbToCssColor_ = function(red, green, blue) {

10788

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

10789

# var hexString = rgbNumber.toString(16);

10790

# var missingZeros = 6 - hexString.length;

10791

# var resultBuilder = ['#'];

10792

# for (var i = 0; i < missingZeros; i++) {

10793

# resultBuilder.push('0');

10794

# }

10795

# resultBuilder.push(hexString);

10796

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

10801

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

10802

# the final pixel color is defined by the equation:

10803

#

10804

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

10805

#

10806

# This means that a value of 1.0 corresponds to a solid color, whereas

10807

# a value of 0.0 corresponds to a completely transparent color. This

10808

# uses a wrapper message rather than a simple float scalar so that it is

10809

# possible to distinguish between a default value and the value being unset.

10810

# If omitted, this color object is to be rendered as a solid color

10811

# (as if the alpha value had been explicitly given with a value of 1.0).

10812

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

10813

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

10814

},

10815

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

10816

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

10817

"style": "A String", # The style of the border.

10818

},

10819

"left": { # A border along a cell. # The left border of the cell.

10820

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

10821

# for simplicity of conversion to/from color representations in various

10822

# languages over compactness; for example, the fields of this representation

10823

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

10824

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

10825

# method in iOS; and, with just a little work, it can be easily formatted into

10826

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

10831

#

10832

# // ...

10833

# public static java.awt.Color fromProto(Color protocolor) {

10834

# float alpha = protocolor.hasAlpha()

10835

# ? protocolor.getAlpha().getValue()

10836

# : 1.0;

10837

#

10838

# return new java.awt.Color(

10839

# protocolor.getRed(),

10840

# protocolor.getGreen(),

10841

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

10846

# float red = (float) color.getRed();

10847

# float green = (float) color.getGreen();

10848

# float blue = (float) color.getBlue();

10849

# float denominator = 255.0;

10850

# Color.Builder resultBuilder =

10851

# Color

10852

# .newBuilder()

10853

# .setRed(red / denominator)

10854

# .setGreen(green / denominator)

10855

# .setBlue(blue / denominator);

10856

# int alpha = color.getAlpha();

10857

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

10862

# .build());

10863

# }

10864

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

10869

#

10870

# // ...

10871

# static UIColor* fromProto(Color* protocolor) {

10872

# float red = [protocolor red];

10873

# float green = [protocolor green];

10874

# float blue = [protocolor blue];

10875

# FloatValue* alpha_wrapper = [protocolor alpha];

10876

# float alpha = 1.0;

10877

# if (alpha_wrapper != nil) {

10878

# alpha = [alpha_wrapper value];

10879

# }

10880

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

10881

# }

10882

#

10883

# static Color* toProto(UIColor* color) {

10884

# CGFloat red, green, blue, alpha;

10885

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

10886

# return nil;

10887

# }

10888

# Color* result = [Color alloc] init];

10889

# [result setRed:red];

10890

# [result setGreen:green];

10891

# [result setBlue:blue];

10892

# if (alpha <= 0.9999) {

10893

# [result setAlpha:floatWrapperWithValue(alpha)];

10894

# }

10895

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

10905

# var redFrac = rgb_color.red || 0.0;

10906

# var greenFrac = rgb_color.green || 0.0;

10907

# var blueFrac = rgb_color.blue || 0.0;

10908

# var red = Math.floor(redFrac * 255);

10909

# var green = Math.floor(greenFrac * 255);

10910

# var blue = Math.floor(blueFrac * 255);

10911

#

10912

# if (!('alpha' in rgb_color)) {

10913

# return rgbToCssColor_(red, green, blue);

10914

# }

10915

#

10916

# var alphaFrac = rgb_color.alpha.value || 0.0;

10917

# var rgbParams = [red, green, blue].join(',');

10918

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

10919

# };

10920

#

10921

# var rgbToCssColor_ = function(red, green, blue) {

10922

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

10923

# var hexString = rgbNumber.toString(16);

10924

# var missingZeros = 6 - hexString.length;

10925

# var resultBuilder = ['#'];

10926

# for (var i = 0; i < missingZeros; i++) {

10927

# resultBuilder.push('0');

10928

# }

10929

# resultBuilder.push(hexString);

10930

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

10935

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

10936

# the final pixel color is defined by the equation:

10937

#

10938

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

10939

#

10940

# This means that a value of 1.0 corresponds to a solid color, whereas

10941

# a value of 0.0 corresponds to a completely transparent color. This

10942

# uses a wrapper message rather than a simple float scalar so that it is

10943

# possible to distinguish between a default value and the value being unset.

10944

# If omitted, this color object is to be rendered as a solid color

10945

# (as if the alpha value had been explicitly given with a value of 1.0).

10946

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

10947

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

10948

},

10949

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

10950

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

10951

"style": "A String", # The style of the border.

10952

},

10953

},

10954

"wrapStrategy": "A String", # The wrap strategy for the value in the cell.

10955

},

10956

"dataValidation": { # A data validation rule. # A data validation rule on the cell, if any.

10957

#

10958

# When writing, the new data validation rule will overwrite any prior rule.

10959

"showCustomUi": True or False, # True if the UI should be customized based on the kind of condition.

10960

# If true, "List" conditions will show a dropdown.

10961

"strict": True or False, # True if invalid data should be rejected.

10962

"inputMessage": "A String", # A message to show the user when adding data to the cell.

10963

"condition": { # A condition that can evaluate to true or false. # The condition that data in the cell must match.

10964

# BooleanConditions are used by conditional formatting,

10965

# data validation, and the criteria in filters.

10966

"type": "A String", # The type of condition.

10967

"values": [ # The values of the condition. The number of supported values depends

10968

# on the condition type. Some support zero values,

10969

# others one or two values,

10970

# and ConditionType.ONE_OF_LIST supports an arbitrary number of values.

10971

{ # The value of the condition.

10972

"relativeDate": "A String", # A relative date (based on the current date).

10973

# Valid only if the type is

10974

# DATE_BEFORE,

10975

# DATE_AFTER,

10976

# DATE_ON_OR_BEFORE or

10977

# DATE_ON_OR_AFTER.

10978

#

10979

# Relative dates are not supported in data validation.

10980

# They are supported only in conditional formatting and

10981

# conditional filters.

10982

"userEnteredValue": "A String", # A value the condition is based on.

10983

# The value will be parsed as if the user typed into a cell.

10984

# Formulas are supported (and must begin with an `=`).

},

],

},

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

10989

"textFormatRuns": [ # Runs of rich text applied to subsections of the cell. Runs are only valid

10990

# on user entered strings, not formulas, bools, or numbers.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

10991

# Runs start at specific indexes in the text and continue until the next

10992

# run. Properties of a run will continue unless explicitly changed

10993

# in a subsequent run (and properties of the first run will continue

10994

# the properties of the cell unless explicitly changed).

10995

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

10996

# When writing, the new runs will overwrite any prior runs. When writing a

10997

# new user_entered_value, previous runs will be erased.

10998

{ # A run of a text format. The format of this run continues until the start

10999

# index of the next run.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11000

# When updating, all fields must be set.

11001

"startIndex": 42, # The character index where this run starts.

11002

"format": { # The format of a run of text in a cell. # The format of this run. Absent values inherit the cell's format.

11003

# Absent values indicate that the field isn't specified.

11004

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

11005

# for simplicity of conversion to/from color representations in various

11006

# languages over compactness; for example, the fields of this representation

11007

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

11008

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

11009

# method in iOS; and, with just a little work, it can be easily formatted into

11010

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

11015

#

11016

# // ...

11017

# public static java.awt.Color fromProto(Color protocolor) {

11018

# float alpha = protocolor.hasAlpha()

11019

# ? protocolor.getAlpha().getValue()

11020

# : 1.0;

11021

#

11022

# return new java.awt.Color(

11023

# protocolor.getRed(),

11024

# protocolor.getGreen(),

11025

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

11030

# float red = (float) color.getRed();

11031

# float green = (float) color.getGreen();

11032

# float blue = (float) color.getBlue();

11033

# float denominator = 255.0;

11034

# Color.Builder resultBuilder =

11035

# Color

11036

# .newBuilder()

11037

# .setRed(red / denominator)

11038

# .setGreen(green / denominator)

11039

# .setBlue(blue / denominator);

11040

# int alpha = color.getAlpha();

11041

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

11046

# .build());

11047

# }

11048

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

11053

#

11054

# // ...

11055

# static UIColor* fromProto(Color* protocolor) {

11056

# float red = [protocolor red];

11057

# float green = [protocolor green];

11058

# float blue = [protocolor blue];

11059

# FloatValue* alpha_wrapper = [protocolor alpha];

11060

# float alpha = 1.0;

11061

# if (alpha_wrapper != nil) {

11062

# alpha = [alpha_wrapper value];

11063

# }

11064

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

11065

# }

11066

#

11067

# static Color* toProto(UIColor* color) {

11068

# CGFloat red, green, blue, alpha;

11069

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

11070

# return nil;

11071

# }

11072

# Color* result = [Color alloc] init];

11073

# [result setRed:red];

11074

# [result setGreen:green];

11075

# [result setBlue:blue];

11076

# if (alpha <= 0.9999) {

11077

# [result setAlpha:floatWrapperWithValue(alpha)];

11078

# }

11079

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

11089

# var redFrac = rgb_color.red || 0.0;

11090

# var greenFrac = rgb_color.green || 0.0;

11091

# var blueFrac = rgb_color.blue || 0.0;

11092

# var red = Math.floor(redFrac * 255);

11093

# var green = Math.floor(greenFrac * 255);

11094

# var blue = Math.floor(blueFrac * 255);

11095

#

11096

# if (!('alpha' in rgb_color)) {

11097

# return rgbToCssColor_(red, green, blue);

11098

# }

11099

#

11100

# var alphaFrac = rgb_color.alpha.value || 0.0;

11101

# var rgbParams = [red, green, blue].join(',');

11102

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

11103

# };

11104

#

11105

# var rgbToCssColor_ = function(red, green, blue) {

11106

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

11107

# var hexString = rgbNumber.toString(16);

11108

# var missingZeros = 6 - hexString.length;

11109

# var resultBuilder = ['#'];

11110

# for (var i = 0; i < missingZeros; i++) {

11111

# resultBuilder.push('0');

11112

# }

11113

# resultBuilder.push(hexString);

11114

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

11119

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

11120

# the final pixel color is defined by the equation:

11121

#

11122

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

11123

#

11124

# This means that a value of 1.0 corresponds to a solid color, whereas

11125

# a value of 0.0 corresponds to a completely transparent color. This

11126

# uses a wrapper message rather than a simple float scalar so that it is

11127

# possible to distinguish between a default value and the value being unset.

11128

# If omitted, this color object is to be rendered as a solid color

11129

# (as if the alpha value had been explicitly given with a value of 1.0).

11130

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

11131

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

11132

},

11133

"bold": True or False, # True if the text is bold.

11134

"strikethrough": True or False, # True if the text has a strikethrough.

11135

"fontFamily": "A String", # The font family.

11136

"fontSize": 42, # The size of the font.

11137

"italic": True or False, # True if the text is italicized.

11138

"underline": True or False, # True if the text is underlined.

},

},

],

},

],

},

],

"start": { # A coordinate in a sheet. # The coordinate to start writing data at.

11147

# Any number of rows and columns (including a different number of

11148

# columns per row) may be written.

11149

# All indexes are zero-based.

11150

"rowIndex": 42, # The row index of the coordinate.

11151

"columnIndex": 42, # The column index of the coordinate.

11152

"sheetId": 42, # The sheet this coordinate is on.

11153

},

11154

},

11155

"autoFill": { # Fills in more data based on existing data. # Automatically fills in more data based on existing data.

11156

"useAlternateSeries": True or False, # True if we should generate data with the "alternate" series.

11157

# This differs based on the type and amount of source data.

11158

"range": { # A range on a sheet. # The range to autofill. This will examine the range and detect

11159

# the location that has data and automatically fill that data

11160

# in to the rest of the range.

11161

# All indexes are zero-based.

11162

# Indexes are half open, e.g the start index is inclusive

11163

# and the end index is exclusive -- [start_index, end_index).

11164

# Missing indexes indicate the range is unbounded on that side.

11165

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11166

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11167

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11168

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11169

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11170

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11171

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11172

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11173

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11174

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11175

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11176

# `Sheet1!A:B == sheet_id: 0,

11177

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11178

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11179

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11180

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11181

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11182

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11183

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11184

#

11185

# The start index must always be less than or equal to the end index.

11186

# If the start index equals the end index, then the range is empty.

11187

# Empty ranges are typically not meaningful and are usually rendered in the

11188

# UI as `#REF!`.

11189

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

11190

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

11191

"sheetId": 42, # The sheet this range is on.

11192

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

11193

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

11194

},

11195

"sourceAndDestination": { # A combination of a source range and how to extend that source. # The source and destination areas to autofill.

11196

# This explicitly lists the source of the autofill and where to

11197

# extend that data.

11198

"source": { # A range on a sheet. # The location of the data to use as the source of the autofill.

11199

# All indexes are zero-based.

11200

# Indexes are half open, e.g the start index is inclusive

11201

# and the end index is exclusive -- [start_index, end_index).

11202

# Missing indexes indicate the range is unbounded on that side.

11203

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11204

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11205

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11206

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11207

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11208

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11209

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11210

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11211

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11212

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11213

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11214

# `Sheet1!A:B == sheet_id: 0,

11215

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11216

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11217

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11218

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11219

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11220

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11221

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11222

#

11223

# The start index must always be less than or equal to the end index.

11224

# If the start index equals the end index, then the range is empty.

11225

# Empty ranges are typically not meaningful and are usually rendered in the

11226

# UI as `#REF!`.

11227

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

11228

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

11229

"sheetId": 42, # The sheet this range is on.

11230

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

11231

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

11232

},

11233

"dimension": "A String", # The dimension that data should be filled into.

11234

"fillLength": 42, # The number of rows or columns that data should be filled into.

11235

# Positive numbers expand beyond the last row or last column

11236

# of the source. Negative numbers expand before the first row

11237

# or first column of the source.

11238

},

11239

},

11240

"appendDimension": { # Appends rows or columns to the end of a sheet. # Appends dimensions to the end of a sheet.

11241

"length": 42, # The number of rows or columns to append.

11242

"sheetId": 42, # The sheet to append rows or columns to.

11243

"dimension": "A String", # Whether rows or columns should be appended.

11244

},

11245

"autoResizeDimensions": { # Automatically resizes one or more dimensions based on the contents # Automatically resizes one or more dimensions based on the contents

11246

# of the cells in that dimension.

11247

# of the cells in that dimension.

11248

"dimensions": { # A range along a single dimension on a sheet. # The dimensions to automatically resize.

11249

# Only COLUMNS are supported.

11250

# All indexes are zero-based.

11251

# Indexes are half open: the start index is inclusive

11252

# and the end index is exclusive.

11253

# Missing indexes indicate the range is unbounded on that side.

11254

"endIndex": 42, # The end (exclusive) of the span, or not set if unbounded.

11255

"startIndex": 42, # The start (inclusive) of the span, or not set if unbounded.

11256

"sheetId": 42, # The sheet this span is on.

11257

"dimension": "A String", # The dimension of the span.

11258

},

11259

},

11260

"updateDimensionProperties": { # Updates properties of dimensions within the specified range. # Updates dimensions' properties.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11261

"fields": "A String", # The fields that should be updated. At least one field must be specified.

11262

# The root `properties` is implied and should not be specified.

11263

# A single `"*"` can be used as short-hand for listing every field.

11264

"range": { # A range along a single dimension on a sheet. # The rows or columns to update.

11265

# All indexes are zero-based.

11266

# Indexes are half open: the start index is inclusive

11267

# and the end index is exclusive.

11268

# Missing indexes indicate the range is unbounded on that side.

11269

"endIndex": 42, # The end (exclusive) of the span, or not set if unbounded.

11270

"startIndex": 42, # The start (inclusive) of the span, or not set if unbounded.

11271

"sheetId": 42, # The sheet this span is on.

11272

"dimension": "A String", # The dimension of the span.

11273

},

11274

"properties": { # Properties about a dimension. # Properties to update.

11275

"pixelSize": 42, # The height (if a row) or width (if a column) of the dimension in pixels.

11276

"hiddenByUser": True or False, # True if this dimension is explicitly hidden.

11277

"hiddenByFilter": True or False, # True if this dimension is being filtered.

11278

# This field is read-only.

11279

},

11280

},

11281

"unmergeCells": { # Unmerges cells in the given range. # Unmerges merged cells.

11282

"range": { # A range on a sheet. # The range within which all cells should be unmerged.

11283

# If the range spans multiple merges, all will be unmerged.

11284

# The range must not partially span any merge.

11285

# All indexes are zero-based.

11286

# Indexes are half open, e.g the start index is inclusive

11287

# and the end index is exclusive -- [start_index, end_index).

11288

# Missing indexes indicate the range is unbounded on that side.

11289

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11290

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11291

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11292

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11293

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11294

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11295

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11296

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11297

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11298

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11299

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11300

# `Sheet1!A:B == sheet_id: 0,

11301

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11302

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11303

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11304

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11305

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11306

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11307

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11308

#

11309

# The start index must always be less than or equal to the end index.

11310

# If the start index equals the end index, then the range is empty.

11311

# Empty ranges are typically not meaningful and are usually rendered in the

11312

# UI as `#REF!`.

11313

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

11314

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

11315

"sheetId": 42, # The sheet this range is on.

11316

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

11317

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

11318

},

11319

},

11320

"setDataValidation": { # Sets a data validation rule to every cell in the range. # Sets data validation for one or more cells.

11321

# To clear validation in a range, call this with no rule specified.

11322

"range": { # A range on a sheet. # The range the data validation rule should apply to.

11323

# All indexes are zero-based.

11324

# Indexes are half open, e.g the start index is inclusive

11325

# and the end index is exclusive -- [start_index, end_index).

11326

# Missing indexes indicate the range is unbounded on that side.

11327

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11328

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11329

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11330

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11331

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11332

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11333

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11334

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11335

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11336

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11337

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11338

# `Sheet1!A:B == sheet_id: 0,

11339

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11340

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11341

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11342

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11343

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11344

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11345

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11346

#

11347

# The start index must always be less than or equal to the end index.

11348

# If the start index equals the end index, then the range is empty.

11349

# Empty ranges are typically not meaningful and are usually rendered in the

11350

# UI as `#REF!`.

11351

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

11352

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

11353

"sheetId": 42, # The sheet this range is on.

11354

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

11355

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

11356

},

11357

"rule": { # A data validation rule. # The data validation rule to set on each cell in the range,

11358

# or empty to clear the data validation in the range.

11359

"showCustomUi": True or False, # True if the UI should be customized based on the kind of condition.

11360

# If true, "List" conditions will show a dropdown.

11361

"strict": True or False, # True if invalid data should be rejected.

11362

"inputMessage": "A String", # A message to show the user when adding data to the cell.

11363

"condition": { # A condition that can evaluate to true or false. # The condition that data in the cell must match.

11364

# BooleanConditions are used by conditional formatting,

11365

# data validation, and the criteria in filters.

11366

"type": "A String", # The type of condition.

11367

"values": [ # The values of the condition. The number of supported values depends

11368

# on the condition type. Some support zero values,

11369

# others one or two values,

11370

# and ConditionType.ONE_OF_LIST supports an arbitrary number of values.

11371

{ # The value of the condition.

11372

"relativeDate": "A String", # A relative date (based on the current date).

11373

# Valid only if the type is

11374

# DATE_BEFORE,

11375

# DATE_AFTER,

11376

# DATE_ON_OR_BEFORE or

11377

# DATE_ON_OR_AFTER.

11378

#

11379

# Relative dates are not supported in data validation.

11380

# They are supported only in conditional formatting and

11381

# conditional filters.

11382

"userEnteredValue": "A String", # A value the condition is based on.

11383

# The value will be parsed as if the user typed into a cell.

11384

# Formulas are supported (and must begin with an `=`).

},

],

},

},

},

"clearBasicFilter": { # Clears the basic filter, if any exists on the sheet. # Clears the basic filter on a sheet.

11391

"sheetId": 42, # The sheet ID on which the basic filter should be cleared.

11392

},

11393

"addNamedRange": { # Adds a named range to the spreadsheet. # Adds a named range.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11394

"namedRange": { # A named range. # The named range to add. The namedRangeId

11395

# field is optional; if one is not set, an id will be randomly generated. (It

11396

# is an error to specify the ID of a range that already exists.)

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11397

"namedRangeId": "A String", # The ID of the named range.

11398

"range": { # A range on a sheet. # The range this represents.

11399

# All indexes are zero-based.

11400

# Indexes are half open, e.g the start index is inclusive

11401

# and the end index is exclusive -- [start_index, end_index).

11402

# Missing indexes indicate the range is unbounded on that side.

11403

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11404

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11405

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11406

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11407

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11408

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11409

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11410

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11411

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11412

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11413

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11414

# `Sheet1!A:B == sheet_id: 0,

11415

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11416

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11417

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11418

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11419

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11420

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11421

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11422

#

11423

# The start index must always be less than or equal to the end index.

11424

# If the start index equals the end index, then the range is empty.

11425

# Empty ranges are typically not meaningful and are usually rendered in the

11426

# UI as `#REF!`.

11427

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

11428

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

11429

"sheetId": 42, # The sheet this range is on.

11430

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

11431

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

11432

},

11433

"name": "A String", # The name of the named range.

11434

},

11435

},

11436

"updateChartSpec": { # Updates a chart's specifications. # Updates a chart's specifications.

11437

# (This does not move or resize a chart. To move or resize a chart, use

11438

# UpdateEmbeddedObjectPositionRequest.)

11439

"chartId": 42, # The ID of the chart to update.

11440

"spec": { # The specifications of a chart. # The specification to apply to the chart.

11441

"hiddenDimensionStrategy": "A String", # Determines how the charts will use hidden rows or columns.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11442

"pieChart": { # A <a href="/chart/interactive/docs/gallery/piechart">pie chart</a>. # A pie chart specification.

11443

"series": { # The data included in a domain or series. # The data that covers the one and only series of the pie chart.

11444

"sourceRange": { # Source ranges for a chart. # The source ranges of the data.

11445

"sources": [ # The ranges of data for a series or domain.

11446

# Exactly one dimension must have a length of 1,

11447

# and all sources in the list must have the same dimension

11448

# with length 1.

11449

# The domain (if it exists) & all series must have the same number

11450

# of source ranges. If using more than one source range, then the source

11451

# range at a given offset must be contiguous across the domain and series.

11452

#

11453

# For example, these are valid configurations:

11454

#

11455

# domain sources: A1:A5

11456

# series1 sources: B1:B5

11457

# series2 sources: D6:D10

11458

#

11459

# domain sources: A1:A5, C10:C12

11460

# series1 sources: B1:B5, D10:D12

11461

# series2 sources: C1:C5, E10:E12

11462

{ # A range on a sheet.

11463

# All indexes are zero-based.

11464

# Indexes are half open, e.g the start index is inclusive

11465

# and the end index is exclusive -- [start_index, end_index).

11466

# Missing indexes indicate the range is unbounded on that side.

11467

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11468

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11469

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11470

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11471

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11472

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11473

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11474

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11475

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11476

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11477

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11478

# `Sheet1!A:B == sheet_id: 0,

11479

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11480

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11481

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11482

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11483

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11484

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11485

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11486

#

11487

# The start index must always be less than or equal to the end index.

11488

# If the start index equals the end index, then the range is empty.

11489

# Empty ranges are typically not meaningful and are usually rendered in the

11490

# UI as `#REF!`.

11491

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

11492

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

11493

"sheetId": 42, # The sheet this range is on.

11494

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

11495

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

],

},

},

"domain": { # The data included in a domain or series. # The data that covers the domain of the pie chart.

11501

"sourceRange": { # Source ranges for a chart. # The source ranges of the data.

11502

"sources": [ # The ranges of data for a series or domain.

11503

# Exactly one dimension must have a length of 1,

11504

# and all sources in the list must have the same dimension

11505

# with length 1.

11506

# The domain (if it exists) & all series must have the same number

11507

# of source ranges. If using more than one source range, then the source

11508

# range at a given offset must be contiguous across the domain and series.

11509

#

11510

# For example, these are valid configurations:

11511

#

11512

# domain sources: A1:A5

11513

# series1 sources: B1:B5

11514

# series2 sources: D6:D10

11515

#

11516

# domain sources: A1:A5, C10:C12

11517

# series1 sources: B1:B5, D10:D12

11518

# series2 sources: C1:C5, E10:E12

11519

{ # A range on a sheet.

11520

# All indexes are zero-based.

11521

# Indexes are half open, e.g the start index is inclusive

11522

# and the end index is exclusive -- [start_index, end_index).

11523

# Missing indexes indicate the range is unbounded on that side.

11524

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11525

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11526

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11527

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11528

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11529

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11530

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11531

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11532

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11533

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11534

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11535

# `Sheet1!A:B == sheet_id: 0,

11536

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11537

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11538

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11539

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11540

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11541

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11542

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11543

#

11544

# The start index must always be less than or equal to the end index.

11545

# If the start index equals the end index, then the range is empty.

11546

# Empty ranges are typically not meaningful and are usually rendered in the

11547

# UI as `#REF!`.

11548

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

11549

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

11550

"sheetId": 42, # The sheet this range is on.

11551

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

11552

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

],

},

},

"threeDimensional": True or False, # True if the pie is three dimensional.

11558

"legendPosition": "A String", # Where the legend of the pie chart should be drawn.

11559

"pieHole": 3.14, # The size of the hole in the pie chart.

11560

},

11561

"basicChart": { # The specification for a basic chart. See BasicChartType for the list # A basic chart specification, can be one of many kinds of charts.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11562

# See BasicChartType for the list of all

11563

# charts this supports.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11564

# of charts this supports.

11565

"headerCount": 42, # The number of rows or columns in the data that are "headers".

11566

# If not set, Google Sheets will guess how many rows are headers based

11567

# on the data.

11568

#

11569

# (Note that BasicChartAxis.title may override the axis title

11570

# inferred from the header values.)

11571

"series": [ # The data this chart is visualizing.

11572

{ # A single series of data in a chart.

11573

# For example, if charting stock prices over time, multiple series may exist,

11574

# one for the "Open Price", "High Price", "Low Price" and "Close Price".

11575

"series": { # The data included in a domain or series. # The data being visualized in this chart series.

11576

"sourceRange": { # Source ranges for a chart. # The source ranges of the data.

11577

"sources": [ # The ranges of data for a series or domain.

11578

# Exactly one dimension must have a length of 1,

11579

# and all sources in the list must have the same dimension

11580

# with length 1.

11581

# The domain (if it exists) & all series must have the same number

11582

# of source ranges. If using more than one source range, then the source

11583

# range at a given offset must be contiguous across the domain and series.

11584

#

11585

# For example, these are valid configurations:

11586

#

11587

# domain sources: A1:A5

11588

# series1 sources: B1:B5

11589

# series2 sources: D6:D10

11590

#

11591

# domain sources: A1:A5, C10:C12

11592

# series1 sources: B1:B5, D10:D12

11593

# series2 sources: C1:C5, E10:E12

11594

{ # A range on a sheet.

11595

# All indexes are zero-based.

11596

# Indexes are half open, e.g the start index is inclusive

11597

# and the end index is exclusive -- [start_index, end_index).

11598

# Missing indexes indicate the range is unbounded on that side.

11599

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11600

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11601

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11602

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11603

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11604

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11605

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11606

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11607

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11608

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11609

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11610

# `Sheet1!A:B == sheet_id: 0,

11611

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11612

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11613

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11614

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11615

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11616

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11617

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11618

#

11619

# The start index must always be less than or equal to the end index.

11620

# If the start index equals the end index, then the range is empty.

11621

# Empty ranges are typically not meaningful and are usually rendered in the

11622

# UI as `#REF!`.

11623

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

11624

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

11625

"sheetId": 42, # The sheet this range is on.

11626

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

11627

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

],

},

},

"targetAxis": "A String", # The minor axis that will specify the range of values for this series.

11633

# For example, if charting stocks over time, the "Volume" series

11634

# may want to be pinned to the right with the prices pinned to the left,

11635

# because the scale of trading volume is different than the scale of

11636

# prices.

11637

# It is an error to specify an axis that isn't a valid minor axis

11638

# for the chart's type.

11639

"type": "A String", # The type of this series. Valid only if the

11640

# chartType is

11641

# COMBO.

11642

# Different types will change the way the series is visualized.

11643

# Only LINE, AREA,

11644

# and COLUMN are supported.

11645

},

11646

],

11647

"legendPosition": "A String", # The position of the chart legend.

11648

"domains": [ # The domain of data this is charting.

11649

# Only a single domain is currently supported.

11650

{ # The domain of a chart.

11651

# For example, if charting stock prices over time, this would be the date.

11652

"domain": { # The data included in a domain or series. # The data of the domain. For example, if charting stock prices over time,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11653

# this is the data representing the dates.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11654

"sourceRange": { # Source ranges for a chart. # The source ranges of the data.

11655

"sources": [ # The ranges of data for a series or domain.

11656

# Exactly one dimension must have a length of 1,

11657

# and all sources in the list must have the same dimension

11658

# with length 1.

11659

# The domain (if it exists) & all series must have the same number

11660

# of source ranges. If using more than one source range, then the source

11661

# range at a given offset must be contiguous across the domain and series.

11662

#

11663

# For example, these are valid configurations:

11664

#

11665

# domain sources: A1:A5

11666

# series1 sources: B1:B5

11667

# series2 sources: D6:D10

11668

#

11669

# domain sources: A1:A5, C10:C12

11670

# series1 sources: B1:B5, D10:D12

11671

# series2 sources: C1:C5, E10:E12

11672

{ # A range on a sheet.

11673

# All indexes are zero-based.

11674

# Indexes are half open, e.g the start index is inclusive

11675

# and the end index is exclusive -- [start_index, end_index).

11676

# Missing indexes indicate the range is unbounded on that side.

11677

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11678

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11679

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11680

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11681

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11682

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11683

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11684

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11685

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11686

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11687

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11688

# `Sheet1!A:B == sheet_id: 0,

11689

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11690

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11691

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11692

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11693

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11694

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11695

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11696

#

11697

# The start index must always be less than or equal to the end index.

11698

# If the start index equals the end index, then the range is empty.

11699

# Empty ranges are typically not meaningful and are usually rendered in the

11700

# UI as `#REF!`.

11701

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

11702

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

11703

"sheetId": 42, # The sheet this range is on.

11704

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

11705

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

],

},

},

},

],

"chartType": "A String", # The type of the chart.

11713

"axis": [ # The axis on the chart.

11714

{ # An axis of the chart.

11715

# A chart may not have more than one axis per

11716

# axis position.

11717

"position": "A String", # The position of this axis.

11718

"format": { # The format of a run of text in a cell. # The format of the title.

11719

# Only valid if the axis is not associated with the domain.

11720

# Absent values indicate that the field isn't specified.

11721

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

11722

# for simplicity of conversion to/from color representations in various

11723

# languages over compactness; for example, the fields of this representation

11724

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

11725

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

11726

# method in iOS; and, with just a little work, it can be easily formatted into

11727

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

11732

#

11733

# // ...

11734

# public static java.awt.Color fromProto(Color protocolor) {

11735

# float alpha = protocolor.hasAlpha()

11736

# ? protocolor.getAlpha().getValue()

11737

# : 1.0;

11738

#

11739

# return new java.awt.Color(

11740

# protocolor.getRed(),

11741

# protocolor.getGreen(),

11742

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

11747

# float red = (float) color.getRed();

11748

# float green = (float) color.getGreen();

11749

# float blue = (float) color.getBlue();

11750

# float denominator = 255.0;

11751

# Color.Builder resultBuilder =

11752

# Color

11753

# .newBuilder()

11754

# .setRed(red / denominator)

11755

# .setGreen(green / denominator)

11756

# .setBlue(blue / denominator);

11757

# int alpha = color.getAlpha();

11758

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

11763

# .build());

11764

# }

11765

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

11770

#

11771

# // ...

11772

# static UIColor* fromProto(Color* protocolor) {

11773

# float red = [protocolor red];

11774

# float green = [protocolor green];

11775

# float blue = [protocolor blue];

11776

# FloatValue* alpha_wrapper = [protocolor alpha];

11777

# float alpha = 1.0;

11778

# if (alpha_wrapper != nil) {

11779

# alpha = [alpha_wrapper value];

11780

# }

11781

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

11782

# }

11783

#

11784

# static Color* toProto(UIColor* color) {

11785

# CGFloat red, green, blue, alpha;

11786

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

11787

# return nil;

11788

# }

11789

# Color* result = [Color alloc] init];

11790

# [result setRed:red];

11791

# [result setGreen:green];

11792

# [result setBlue:blue];

11793

# if (alpha <= 0.9999) {

11794

# [result setAlpha:floatWrapperWithValue(alpha)];

11795

# }

11796

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

11806

# var redFrac = rgb_color.red || 0.0;

11807

# var greenFrac = rgb_color.green || 0.0;

11808

# var blueFrac = rgb_color.blue || 0.0;

11809

# var red = Math.floor(redFrac * 255);

11810

# var green = Math.floor(greenFrac * 255);

11811

# var blue = Math.floor(blueFrac * 255);

11812

#

11813

# if (!('alpha' in rgb_color)) {

11814

# return rgbToCssColor_(red, green, blue);

11815

# }

11816

#

11817

# var alphaFrac = rgb_color.alpha.value || 0.0;

11818

# var rgbParams = [red, green, blue].join(',');

11819

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

11820

# };

11821

#

11822

# var rgbToCssColor_ = function(red, green, blue) {

11823

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

11824

# var hexString = rgbNumber.toString(16);

11825

# var missingZeros = 6 - hexString.length;

11826

# var resultBuilder = ['#'];

11827

# for (var i = 0; i < missingZeros; i++) {

11828

# resultBuilder.push('0');

11829

# }

11830

# resultBuilder.push(hexString);

11831

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

11836

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

11837

# the final pixel color is defined by the equation:

11838

#

11839

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

11840

#

11841

# This means that a value of 1.0 corresponds to a solid color, whereas

11842

# a value of 0.0 corresponds to a completely transparent color. This

11843

# uses a wrapper message rather than a simple float scalar so that it is

11844

# possible to distinguish between a default value and the value being unset.

11845

# If omitted, this color object is to be rendered as a solid color

11846

# (as if the alpha value had been explicitly given with a value of 1.0).

11847

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

11848

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

11849

},

11850

"bold": True or False, # True if the text is bold.

11851

"strikethrough": True or False, # True if the text has a strikethrough.

11852

"fontFamily": "A String", # The font family.

11853

"fontSize": 42, # The size of the font.

11854

"italic": True or False, # True if the text is italicized.

11855

"underline": True or False, # True if the text is underlined.

11856

},

11857

"title": "A String", # The title of this axis. If set, this overrides any title inferred

11858

# from headers of the data.

},

],

},

"title": "A String", # The title of the chart.

11863

},

11864

},

11865

"moveDimension": { # Moves one or more rows or columns. # Moves rows or columns to another location in a sheet.

11866

"source": { # A range along a single dimension on a sheet. # The source dimensions to move.

11867

# All indexes are zero-based.

11868

# Indexes are half open: the start index is inclusive

11869

# and the end index is exclusive.

11870

# Missing indexes indicate the range is unbounded on that side.

11871

"endIndex": 42, # The end (exclusive) of the span, or not set if unbounded.

11872

"startIndex": 42, # The start (inclusive) of the span, or not set if unbounded.

11873

"sheetId": 42, # The sheet this span is on.

11874

"dimension": "A String", # The dimension of the span.

11875

},

11876

"destinationIndex": 42, # The zero-based start index of where to move the source data to,

11877

# based on the coordinates *before* the source data is removed

11878

# from the grid. Existing data will be shifted down or right

11879

# (depending on the dimension) to make room for the moved dimensions.

11880

# The source dimensions are removed from the grid, so the

11881

# the data may end up in a different index than specified.

11882

#

11883

# For example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11884

# `"1"` and `"2"` to between `"3"` and `"4"`, the source would be

11885

# `ROWS [1..3)`,and the destination index would be `"4"`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11886

# (the zero-based index of row 5).

11887

# The end result would be `A1..A5` of `0, 3, 1, 2, 4`.

11888

},

11889

"textToColumns": { # Splits a column of text into multiple columns, # Converts a column of text into many columns of text.

11890

# based on a delimiter in each cell.

11891

"source": { # A range on a sheet. # The source data range. This must span exactly one column.

11892

# All indexes are zero-based.

11893

# Indexes are half open, e.g the start index is inclusive

11894

# and the end index is exclusive -- [start_index, end_index).

11895

# Missing indexes indicate the range is unbounded on that side.

11896

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11897

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11898

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11899

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11900

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11901

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11902

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11903

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11904

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11905

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11906

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11907

# `Sheet1!A:B == sheet_id: 0,

11908

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11909

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11910

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11911

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11912

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11913

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11914

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11915

#

11916

# The start index must always be less than or equal to the end index.

11917

# If the start index equals the end index, then the range is empty.

11918

# Empty ranges are typically not meaningful and are usually rendered in the

11919

# UI as `#REF!`.

11920

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

11921

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

11922

"sheetId": 42, # The sheet this range is on.

11923

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

11924

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

11925

},

11926

"delimiter": "A String", # The delimiter to use. Used only if delimiterType is

11927

# CUSTOM.

11928

"delimiterType": "A String", # The delimiter type to use.

11929

},

11930

"deleteFilterView": { # Deletes a particular filter view. # Deletes a filter view from a sheet.

11931

"filterId": 42, # The ID of the filter to delete.

11932

},

11933

"mergeCells": { # Merges all cells in the range. # Merges cells together.

11934

"range": { # A range on a sheet. # The range of cells to merge.

11935

# All indexes are zero-based.

11936

# Indexes are half open, e.g the start index is inclusive

11937

# and the end index is exclusive -- [start_index, end_index).

11938

# Missing indexes indicate the range is unbounded on that side.

11939

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11940

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11941

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11942

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11943

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11944

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11945

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11946

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11947

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11948

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11949

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11950

# `Sheet1!A:B == sheet_id: 0,

11951

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11952

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11953

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11954

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11955

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11956

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11957

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11958

#

11959

# The start index must always be less than or equal to the end index.

11960

# If the start index equals the end index, then the range is empty.

11961

# Empty ranges are typically not meaningful and are usually rendered in the

11962

# UI as `#REF!`.

11963

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

11964

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

11965

"sheetId": 42, # The sheet this range is on.

11966

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

11967

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

11968

},

11969

"mergeType": "A String", # How the cells should be merged.

11970

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11971

"deleteProtectedRange": { # Deletes the protected range with the given ID. # Deletes a protected range.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11972

"protectedRangeId": 42, # The ID of the protected range to delete.

11973

},

11974

"addFilterView": { # Adds a filter view. # Adds a filter view.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11975

"filter": { # A filter view. # The filter to add. The filterViewId

11976

# field is optional; if one is not set, an id will be randomly generated. (It

11977

# is an error to specify the ID of a filter that already exists.)

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11978

"title": "A String", # The name of the filter view.

11979

"namedRangeId": "A String", # The named range this filter view is backed by, if any.

11980

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11981

# When writing, only one of range or named_range_id

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11982

# may be set.

11983

"filterViewId": 42, # The ID of the filter view.

11984

"range": { # A range on a sheet. # The range this filter view covers.

11985

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11986

# When writing, only one of range or named_range_id

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11987

# may be set.

11988

# All indexes are zero-based.

11989

# Indexes are half open, e.g the start index is inclusive

11990

# and the end index is exclusive -- [start_index, end_index).

11991

# Missing indexes indicate the range is unbounded on that side.

11992

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11993

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11994

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11995

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11996

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11997

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

11998

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

11999

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12000

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12001

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12002

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12003

# `Sheet1!A:B == sheet_id: 0,

12004

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12005

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12006

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12007

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12008

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12009

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12010

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12011

#

12012

# The start index must always be less than or equal to the end index.

12013

# If the start index equals the end index, then the range is empty.

12014

# Empty ranges are typically not meaningful and are usually rendered in the

12015

# UI as `#REF!`.

12016

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

12017

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

12018

"sheetId": 42, # The sheet this range is on.

12019

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

12020

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

12021

},

12022

"sortSpecs": [ # The sort order per column. Later specifications are used when values

12023

# are equal in the earlier specifications.

12024

{ # A sort order associated with a specific column or row.

12025

"sortOrder": "A String", # The order data should be sorted.

12026

"dimensionIndex": 42, # The dimension the sort should be applied to.

12027

},

12028

],

12029

"criteria": { # The criteria for showing/hiding values per column.

12030

# The map's key is the column index, and the value is the criteria for

12031

# that column.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12032

"a_key": { # Criteria for showing/hiding rows in a filter or filter view.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12033

"hiddenValues": [ # Values that should be hidden.

12034

"A String",

12035

],

12036

"condition": { # A condition that can evaluate to true or false. # A condition that must be true for values to be shown.

12037

# (This does not override hiddenValues -- if a value is listed there,

12038

# it will still be hidden.)

12039

# BooleanConditions are used by conditional formatting,

12040

# data validation, and the criteria in filters.

12041

"type": "A String", # The type of condition.

12042

"values": [ # The values of the condition. The number of supported values depends

12043

# on the condition type. Some support zero values,

12044

# others one or two values,

12045

# and ConditionType.ONE_OF_LIST supports an arbitrary number of values.

12046

{ # The value of the condition.

12047

"relativeDate": "A String", # A relative date (based on the current date).

12048

# Valid only if the type is

12049

# DATE_BEFORE,

12050

# DATE_AFTER,

12051

# DATE_ON_OR_BEFORE or

12052

# DATE_ON_OR_AFTER.

12053

#

12054

# Relative dates are not supported in data validation.

12055

# They are supported only in conditional formatting and

12056

# conditional filters.

12057

"userEnteredValue": "A String", # A value the condition is based on.

12058

# The value will be parsed as if the user typed into a cell.

12059

# Formulas are supported (and must begin with an `=`).

},

],

},

},

},

},

},

"deleteSheet": { # Deletes the requested sheet. # Deletes a sheet.

12068

"sheetId": 42, # The ID of the sheet to delete.

12069

},

12070

"updateBorders": { # Updates the borders of a range. # Updates the borders in a range of cells.

12071

# If a field is not set in the request, that means the border remains as-is.

12072

# For example, with two subsequent UpdateBordersRequest:

12073

#

12074

# 1. range: A1:A5 `{ top: RED, bottom: WHITE }`

12075

# 2. range: A1:A5 `{ left: BLUE }`

12076

#

12077

# That would result in A1:A5 having a borders of

12078

# `{ top: RED, bottom: WHITE, left: BLUE }`.

12079

# If you want to clear a border, explicitly set the style to

12080

# NONE.

12081

"right": { # A border along a cell. # The border to put at the right of the range.

12082

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

12083

# for simplicity of conversion to/from color representations in various

12084

# languages over compactness; for example, the fields of this representation

12085

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

12086

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

12087

# method in iOS; and, with just a little work, it can be easily formatted into

12088

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

12093

#

12094

# // ...

12095

# public static java.awt.Color fromProto(Color protocolor) {

12096

# float alpha = protocolor.hasAlpha()

12097

# ? protocolor.getAlpha().getValue()

12098

# : 1.0;

12099

#

12100

# return new java.awt.Color(

12101

# protocolor.getRed(),

12102

# protocolor.getGreen(),

12103

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

12108

# float red = (float) color.getRed();

12109

# float green = (float) color.getGreen();

12110

# float blue = (float) color.getBlue();

12111

# float denominator = 255.0;

12112

# Color.Builder resultBuilder =

12113

# Color

12114

# .newBuilder()

12115

# .setRed(red / denominator)

12116

# .setGreen(green / denominator)

12117

# .setBlue(blue / denominator);

12118

# int alpha = color.getAlpha();

12119

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

12124

# .build());

12125

# }

12126

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

12131

#

12132

# // ...

12133

# static UIColor* fromProto(Color* protocolor) {

12134

# float red = [protocolor red];

12135

# float green = [protocolor green];

12136

# float blue = [protocolor blue];

12137

# FloatValue* alpha_wrapper = [protocolor alpha];

12138

# float alpha = 1.0;

12139

# if (alpha_wrapper != nil) {

12140

# alpha = [alpha_wrapper value];

12141

# }

12142

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

12143

# }

12144

#

12145

# static Color* toProto(UIColor* color) {

12146

# CGFloat red, green, blue, alpha;

12147

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

12148

# return nil;

12149

# }

12150

# Color* result = [Color alloc] init];

12151

# [result setRed:red];

12152

# [result setGreen:green];

12153

# [result setBlue:blue];

12154

# if (alpha <= 0.9999) {

12155

# [result setAlpha:floatWrapperWithValue(alpha)];

12156

# }

12157

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

12167

# var redFrac = rgb_color.red || 0.0;

12168

# var greenFrac = rgb_color.green || 0.0;

12169

# var blueFrac = rgb_color.blue || 0.0;

12170

# var red = Math.floor(redFrac * 255);

12171

# var green = Math.floor(greenFrac * 255);

12172

# var blue = Math.floor(blueFrac * 255);

12173

#

12174

# if (!('alpha' in rgb_color)) {

12175

# return rgbToCssColor_(red, green, blue);

12176

# }

12177

#

12178

# var alphaFrac = rgb_color.alpha.value || 0.0;

12179

# var rgbParams = [red, green, blue].join(',');

12180

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

12181

# };

12182

#

12183

# var rgbToCssColor_ = function(red, green, blue) {

12184

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

12185

# var hexString = rgbNumber.toString(16);

12186

# var missingZeros = 6 - hexString.length;

12187

# var resultBuilder = ['#'];

12188

# for (var i = 0; i < missingZeros; i++) {

12189

# resultBuilder.push('0');

12190

# }

12191

# resultBuilder.push(hexString);

12192

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

12197

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

12198

# the final pixel color is defined by the equation:

12199

#

12200

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

12201

#

12202

# This means that a value of 1.0 corresponds to a solid color, whereas

12203

# a value of 0.0 corresponds to a completely transparent color. This

12204

# uses a wrapper message rather than a simple float scalar so that it is

12205

# possible to distinguish between a default value and the value being unset.

12206

# If omitted, this color object is to be rendered as a solid color

12207

# (as if the alpha value had been explicitly given with a value of 1.0).

12208

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

12209

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

12210

},

12211

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12212

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12213

"style": "A String", # The style of the border.

12214

},

12215

"bottom": { # A border along a cell. # The border to put at the bottom of the range.

12216

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

12217

# for simplicity of conversion to/from color representations in various

12218

# languages over compactness; for example, the fields of this representation

12219

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

12220

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

12221

# method in iOS; and, with just a little work, it can be easily formatted into

12222

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

12227

#

12228

# // ...

12229

# public static java.awt.Color fromProto(Color protocolor) {

12230

# float alpha = protocolor.hasAlpha()

12231

# ? protocolor.getAlpha().getValue()

12232

# : 1.0;

12233

#

12234

# return new java.awt.Color(

12235

# protocolor.getRed(),

12236

# protocolor.getGreen(),

12237

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

12242

# float red = (float) color.getRed();

12243

# float green = (float) color.getGreen();

12244

# float blue = (float) color.getBlue();

12245

# float denominator = 255.0;

12246

# Color.Builder resultBuilder =

12247

# Color

12248

# .newBuilder()

12249

# .setRed(red / denominator)

12250

# .setGreen(green / denominator)

12251

# .setBlue(blue / denominator);

12252

# int alpha = color.getAlpha();

12253

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

12258

# .build());

12259

# }

12260

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

12265

#

12266

# // ...

12267

# static UIColor* fromProto(Color* protocolor) {

12268

# float red = [protocolor red];

12269

# float green = [protocolor green];

12270

# float blue = [protocolor blue];

12271

# FloatValue* alpha_wrapper = [protocolor alpha];

12272

# float alpha = 1.0;

12273

# if (alpha_wrapper != nil) {

12274

# alpha = [alpha_wrapper value];

12275

# }

12276

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

12277

# }

12278

#

12279

# static Color* toProto(UIColor* color) {

12280

# CGFloat red, green, blue, alpha;

12281

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

12282

# return nil;

12283

# }

12284

# Color* result = [Color alloc] init];

12285

# [result setRed:red];

12286

# [result setGreen:green];

12287

# [result setBlue:blue];

12288

# if (alpha <= 0.9999) {

12289

# [result setAlpha:floatWrapperWithValue(alpha)];

12290

# }

12291

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

12301

# var redFrac = rgb_color.red || 0.0;

12302

# var greenFrac = rgb_color.green || 0.0;

12303

# var blueFrac = rgb_color.blue || 0.0;

12304

# var red = Math.floor(redFrac * 255);

12305

# var green = Math.floor(greenFrac * 255);

12306

# var blue = Math.floor(blueFrac * 255);

12307

#

12308

# if (!('alpha' in rgb_color)) {

12309

# return rgbToCssColor_(red, green, blue);

12310

# }

12311

#

12312

# var alphaFrac = rgb_color.alpha.value || 0.0;

12313

# var rgbParams = [red, green, blue].join(',');

12314

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

12315

# };

12316

#

12317

# var rgbToCssColor_ = function(red, green, blue) {

12318

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

12319

# var hexString = rgbNumber.toString(16);

12320

# var missingZeros = 6 - hexString.length;

12321

# var resultBuilder = ['#'];

12322

# for (var i = 0; i < missingZeros; i++) {

12323

# resultBuilder.push('0');

12324

# }

12325

# resultBuilder.push(hexString);

12326

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

12331

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

12332

# the final pixel color is defined by the equation:

12333

#

12334

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

12335

#

12336

# This means that a value of 1.0 corresponds to a solid color, whereas

12337

# a value of 0.0 corresponds to a completely transparent color. This

12338

# uses a wrapper message rather than a simple float scalar so that it is

12339

# possible to distinguish between a default value and the value being unset.

12340

# If omitted, this color object is to be rendered as a solid color

12341

# (as if the alpha value had been explicitly given with a value of 1.0).

12342

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

12343

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

12344

},

12345

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12346

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12347

"style": "A String", # The style of the border.

12348

},

12349

"top": { # A border along a cell. # The border to put at the top of the range.

12350

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

12351

# for simplicity of conversion to/from color representations in various

12352

# languages over compactness; for example, the fields of this representation

12353

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

12354

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

12355

# method in iOS; and, with just a little work, it can be easily formatted into

12356

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

12361

#

12362

# // ...

12363

# public static java.awt.Color fromProto(Color protocolor) {

12364

# float alpha = protocolor.hasAlpha()

12365

# ? protocolor.getAlpha().getValue()

12366

# : 1.0;

12367

#

12368

# return new java.awt.Color(

12369

# protocolor.getRed(),

12370

# protocolor.getGreen(),

12371

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

12376

# float red = (float) color.getRed();

12377

# float green = (float) color.getGreen();

12378

# float blue = (float) color.getBlue();

12379

# float denominator = 255.0;

12380

# Color.Builder resultBuilder =

12381

# Color

12382

# .newBuilder()

12383

# .setRed(red / denominator)

12384

# .setGreen(green / denominator)

12385

# .setBlue(blue / denominator);

12386

# int alpha = color.getAlpha();

12387

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

12392

# .build());

12393

# }

12394

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

12399

#

12400

# // ...

12401

# static UIColor* fromProto(Color* protocolor) {

12402

# float red = [protocolor red];

12403

# float green = [protocolor green];

12404

# float blue = [protocolor blue];

12405

# FloatValue* alpha_wrapper = [protocolor alpha];

12406

# float alpha = 1.0;

12407

# if (alpha_wrapper != nil) {

12408

# alpha = [alpha_wrapper value];

12409

# }

12410

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

12411

# }

12412

#

12413

# static Color* toProto(UIColor* color) {

12414

# CGFloat red, green, blue, alpha;

12415

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

12416

# return nil;

12417

# }

12418

# Color* result = [Color alloc] init];

12419

# [result setRed:red];

12420

# [result setGreen:green];

12421

# [result setBlue:blue];

12422

# if (alpha <= 0.9999) {

12423

# [result setAlpha:floatWrapperWithValue(alpha)];

12424

# }

12425

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

12435

# var redFrac = rgb_color.red || 0.0;

12436

# var greenFrac = rgb_color.green || 0.0;

12437

# var blueFrac = rgb_color.blue || 0.0;

12438

# var red = Math.floor(redFrac * 255);

12439

# var green = Math.floor(greenFrac * 255);

12440

# var blue = Math.floor(blueFrac * 255);

12441

#

12442

# if (!('alpha' in rgb_color)) {

12443

# return rgbToCssColor_(red, green, blue);

12444

# }

12445

#

12446

# var alphaFrac = rgb_color.alpha.value || 0.0;

12447

# var rgbParams = [red, green, blue].join(',');

12448

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

12449

# };

12450

#

12451

# var rgbToCssColor_ = function(red, green, blue) {

12452

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

12453

# var hexString = rgbNumber.toString(16);

12454

# var missingZeros = 6 - hexString.length;

12455

# var resultBuilder = ['#'];

12456

# for (var i = 0; i < missingZeros; i++) {

12457

# resultBuilder.push('0');

12458

# }

12459

# resultBuilder.push(hexString);

12460

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

12465

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

12466

# the final pixel color is defined by the equation:

12467

#

12468

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

12469

#

12470

# This means that a value of 1.0 corresponds to a solid color, whereas

12471

# a value of 0.0 corresponds to a completely transparent color. This

12472

# uses a wrapper message rather than a simple float scalar so that it is

12473

# possible to distinguish between a default value and the value being unset.

12474

# If omitted, this color object is to be rendered as a solid color

12475

# (as if the alpha value had been explicitly given with a value of 1.0).

12476

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

12477

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

12478

},

12479

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12480

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12481

"style": "A String", # The style of the border.

12482

},

12483

"innerHorizontal": { # A border along a cell. # The horizontal border to put within the range.

12484

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

12485

# for simplicity of conversion to/from color representations in various

12486

# languages over compactness; for example, the fields of this representation

12487

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

12488

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

12489

# method in iOS; and, with just a little work, it can be easily formatted into

12490

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

12495

#

12496

# // ...

12497

# public static java.awt.Color fromProto(Color protocolor) {

12498

# float alpha = protocolor.hasAlpha()

12499

# ? protocolor.getAlpha().getValue()

12500

# : 1.0;

12501

#

12502

# return new java.awt.Color(

12503

# protocolor.getRed(),

12504

# protocolor.getGreen(),

12505

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

12510

# float red = (float) color.getRed();

12511

# float green = (float) color.getGreen();

12512

# float blue = (float) color.getBlue();

12513

# float denominator = 255.0;

12514

# Color.Builder resultBuilder =

12515

# Color

12516

# .newBuilder()

12517

# .setRed(red / denominator)

12518

# .setGreen(green / denominator)

12519

# .setBlue(blue / denominator);

12520

# int alpha = color.getAlpha();

12521

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

12526

# .build());

12527

# }

12528

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

12533

#

12534

# // ...

12535

# static UIColor* fromProto(Color* protocolor) {

12536

# float red = [protocolor red];

12537

# float green = [protocolor green];

12538

# float blue = [protocolor blue];

12539

# FloatValue* alpha_wrapper = [protocolor alpha];

12540

# float alpha = 1.0;

12541

# if (alpha_wrapper != nil) {

12542

# alpha = [alpha_wrapper value];

12543

# }

12544

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

12545

# }

12546

#

12547

# static Color* toProto(UIColor* color) {

12548

# CGFloat red, green, blue, alpha;

12549

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

12550

# return nil;

12551

# }

12552

# Color* result = [Color alloc] init];

12553

# [result setRed:red];

12554

# [result setGreen:green];

12555

# [result setBlue:blue];

12556

# if (alpha <= 0.9999) {

12557

# [result setAlpha:floatWrapperWithValue(alpha)];

12558

# }

12559

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

12569

# var redFrac = rgb_color.red || 0.0;

12570

# var greenFrac = rgb_color.green || 0.0;

12571

# var blueFrac = rgb_color.blue || 0.0;

12572

# var red = Math.floor(redFrac * 255);

12573

# var green = Math.floor(greenFrac * 255);

12574

# var blue = Math.floor(blueFrac * 255);

12575

#

12576

# if (!('alpha' in rgb_color)) {

12577

# return rgbToCssColor_(red, green, blue);

12578

# }

12579

#

12580

# var alphaFrac = rgb_color.alpha.value || 0.0;

12581

# var rgbParams = [red, green, blue].join(',');

12582

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

12583

# };

12584

#

12585

# var rgbToCssColor_ = function(red, green, blue) {

12586

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

12587

# var hexString = rgbNumber.toString(16);

12588

# var missingZeros = 6 - hexString.length;

12589

# var resultBuilder = ['#'];

12590

# for (var i = 0; i < missingZeros; i++) {

12591

# resultBuilder.push('0');

12592

# }

12593

# resultBuilder.push(hexString);

12594

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

12599

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

12600

# the final pixel color is defined by the equation:

12601

#

12602

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

12603

#

12604

# This means that a value of 1.0 corresponds to a solid color, whereas

12605

# a value of 0.0 corresponds to a completely transparent color. This

12606

# uses a wrapper message rather than a simple float scalar so that it is

12607

# possible to distinguish between a default value and the value being unset.

12608

# If omitted, this color object is to be rendered as a solid color

12609

# (as if the alpha value had been explicitly given with a value of 1.0).

12610

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

12611

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

12612

},

12613

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12614

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12615

"style": "A String", # The style of the border.

12616

},

12617

"range": { # A range on a sheet. # The range whose borders should be updated.

12618

# All indexes are zero-based.

12619

# Indexes are half open, e.g the start index is inclusive

12620

# and the end index is exclusive -- [start_index, end_index).

12621

# Missing indexes indicate the range is unbounded on that side.

12622

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12623

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12624

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12625

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12626

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12627

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12628

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12629

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12630

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12631

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12632

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12633

# `Sheet1!A:B == sheet_id: 0,

12634

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12635

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12636

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12637

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12638

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12639

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12640

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12641

#

12642

# The start index must always be less than or equal to the end index.

12643

# If the start index equals the end index, then the range is empty.

12644

# Empty ranges are typically not meaningful and are usually rendered in the

12645

# UI as `#REF!`.

12646

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

12647

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

12648

"sheetId": 42, # The sheet this range is on.

12649

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

12650

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

12651

},

12652

"innerVertical": { # A border along a cell. # The vertical border to put within the range.

12653

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

12654

# for simplicity of conversion to/from color representations in various

12655

# languages over compactness; for example, the fields of this representation

12656

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

12657

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

12658

# method in iOS; and, with just a little work, it can be easily formatted into

12659

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

12664

#

12665

# // ...

12666

# public static java.awt.Color fromProto(Color protocolor) {

12667

# float alpha = protocolor.hasAlpha()

12668

# ? protocolor.getAlpha().getValue()

12669

# : 1.0;

12670

#

12671

# return new java.awt.Color(

12672

# protocolor.getRed(),

12673

# protocolor.getGreen(),

12674

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

12679

# float red = (float) color.getRed();

12680

# float green = (float) color.getGreen();

12681

# float blue = (float) color.getBlue();

12682

# float denominator = 255.0;

12683

# Color.Builder resultBuilder =

12684

# Color

12685

# .newBuilder()

12686

# .setRed(red / denominator)

12687

# .setGreen(green / denominator)

12688

# .setBlue(blue / denominator);

12689

# int alpha = color.getAlpha();

12690

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

12695

# .build());

12696

# }

12697

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

12702

#

12703

# // ...

12704

# static UIColor* fromProto(Color* protocolor) {

12705

# float red = [protocolor red];

12706

# float green = [protocolor green];

12707

# float blue = [protocolor blue];

12708

# FloatValue* alpha_wrapper = [protocolor alpha];

12709

# float alpha = 1.0;

12710

# if (alpha_wrapper != nil) {

12711

# alpha = [alpha_wrapper value];

12712

# }

12713

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

12714

# }

12715

#

12716

# static Color* toProto(UIColor* color) {

12717

# CGFloat red, green, blue, alpha;

12718

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

12719

# return nil;

12720

# }

12721

# Color* result = [Color alloc] init];

12722

# [result setRed:red];

12723

# [result setGreen:green];

12724

# [result setBlue:blue];

12725

# if (alpha <= 0.9999) {

12726

# [result setAlpha:floatWrapperWithValue(alpha)];

12727

# }

12728

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

12738

# var redFrac = rgb_color.red || 0.0;

12739

# var greenFrac = rgb_color.green || 0.0;

12740

# var blueFrac = rgb_color.blue || 0.0;

12741

# var red = Math.floor(redFrac * 255);

12742

# var green = Math.floor(greenFrac * 255);

12743

# var blue = Math.floor(blueFrac * 255);

12744

#

12745

# if (!('alpha' in rgb_color)) {

12746

# return rgbToCssColor_(red, green, blue);

12747

# }

12748

#

12749

# var alphaFrac = rgb_color.alpha.value || 0.0;

12750

# var rgbParams = [red, green, blue].join(',');

12751

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

12752

# };

12753

#

12754

# var rgbToCssColor_ = function(red, green, blue) {

12755

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

12756

# var hexString = rgbNumber.toString(16);

12757

# var missingZeros = 6 - hexString.length;

12758

# var resultBuilder = ['#'];

12759

# for (var i = 0; i < missingZeros; i++) {

12760

# resultBuilder.push('0');

12761

# }

12762

# resultBuilder.push(hexString);

12763

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

12768

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

12769

# the final pixel color is defined by the equation:

12770

#

12771

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

12772

#

12773

# This means that a value of 1.0 corresponds to a solid color, whereas

12774

# a value of 0.0 corresponds to a completely transparent color. This

12775

# uses a wrapper message rather than a simple float scalar so that it is

12776

# possible to distinguish between a default value and the value being unset.

12777

# If omitted, this color object is to be rendered as a solid color

12778

# (as if the alpha value had been explicitly given with a value of 1.0).

12779

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

12780

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

12781

},

12782

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12783

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12784

"style": "A String", # The style of the border.

12785

},

12786

"left": { # A border along a cell. # The border to put at the left of the range.

12787

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

12788

# for simplicity of conversion to/from color representations in various

12789

# languages over compactness; for example, the fields of this representation

12790

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

12791

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

12792

# method in iOS; and, with just a little work, it can be easily formatted into

12793

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

12798

#

12799

# // ...

12800

# public static java.awt.Color fromProto(Color protocolor) {

12801

# float alpha = protocolor.hasAlpha()

12802

# ? protocolor.getAlpha().getValue()

12803

# : 1.0;

12804

#

12805

# return new java.awt.Color(

12806

# protocolor.getRed(),

12807

# protocolor.getGreen(),

12808

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

12813

# float red = (float) color.getRed();

12814

# float green = (float) color.getGreen();

12815

# float blue = (float) color.getBlue();

12816

# float denominator = 255.0;

12817

# Color.Builder resultBuilder =

12818

# Color

12819

# .newBuilder()

12820

# .setRed(red / denominator)

12821

# .setGreen(green / denominator)

12822

# .setBlue(blue / denominator);

12823

# int alpha = color.getAlpha();

12824

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

12829

# .build());

12830

# }

12831

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

12836

#

12837

# // ...

12838

# static UIColor* fromProto(Color* protocolor) {

12839

# float red = [protocolor red];

12840

# float green = [protocolor green];

12841

# float blue = [protocolor blue];

12842

# FloatValue* alpha_wrapper = [protocolor alpha];

12843

# float alpha = 1.0;

12844

# if (alpha_wrapper != nil) {

12845

# alpha = [alpha_wrapper value];

12846

# }

12847

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

12848

# }

12849

#

12850

# static Color* toProto(UIColor* color) {

12851

# CGFloat red, green, blue, alpha;

12852

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

12853

# return nil;

12854

# }

12855

# Color* result = [Color alloc] init];

12856

# [result setRed:red];

12857

# [result setGreen:green];

12858

# [result setBlue:blue];

12859

# if (alpha <= 0.9999) {

12860

# [result setAlpha:floatWrapperWithValue(alpha)];

12861

# }

12862

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

12872

# var redFrac = rgb_color.red || 0.0;

12873

# var greenFrac = rgb_color.green || 0.0;

12874

# var blueFrac = rgb_color.blue || 0.0;

12875

# var red = Math.floor(redFrac * 255);

12876

# var green = Math.floor(greenFrac * 255);

12877

# var blue = Math.floor(blueFrac * 255);

12878

#

12879

# if (!('alpha' in rgb_color)) {

12880

# return rgbToCssColor_(red, green, blue);

12881

# }

12882

#

12883

# var alphaFrac = rgb_color.alpha.value || 0.0;

12884

# var rgbParams = [red, green, blue].join(',');

12885

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

12886

# };

12887

#

12888

# var rgbToCssColor_ = function(red, green, blue) {

12889

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

12890

# var hexString = rgbNumber.toString(16);

12891

# var missingZeros = 6 - hexString.length;

12892

# var resultBuilder = ['#'];

12893

# for (var i = 0; i < missingZeros; i++) {

12894

# resultBuilder.push('0');

12895

# }

12896

# resultBuilder.push(hexString);

12897

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

12902

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

12903

# the final pixel color is defined by the equation:

12904

#

12905

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

12906

#

12907

# This means that a value of 1.0 corresponds to a solid color, whereas

12908

# a value of 0.0 corresponds to a completely transparent color. This

12909

# uses a wrapper message rather than a simple float scalar so that it is

12910

# possible to distinguish between a default value and the value being unset.

12911

# If omitted, this color object is to be rendered as a solid color

12912

# (as if the alpha value had been explicitly given with a value of 1.0).

12913

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

12914

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

12915

},

12916

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12917

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12918

"style": "A String", # The style of the border.

12919

},

12920

},

12921

"cutPaste": { # Moves data from the source to the destination. # Cuts data from one area and pastes it to another.

12922

"pasteType": "A String", # What kind of data to paste. All the source data will be cut, regardless

12923

# of what is pasted.

12924

"source": { # A range on a sheet. # The source data to cut.

12925

# All indexes are zero-based.

12926

# Indexes are half open, e.g the start index is inclusive

12927

# and the end index is exclusive -- [start_index, end_index).

12928

# Missing indexes indicate the range is unbounded on that side.

12929

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12930

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12931

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12932

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12933

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12934

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12935

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12936

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12937

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12938

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12939

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12940

# `Sheet1!A:B == sheet_id: 0,

12941

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12942

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12943

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12944

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12945

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12946

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12947

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12948

#

12949

# The start index must always be less than or equal to the end index.

12950

# If the start index equals the end index, then the range is empty.

12951

# Empty ranges are typically not meaningful and are usually rendered in the

12952

# UI as `#REF!`.

12953

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

12954

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

12955

"sheetId": 42, # The sheet this range is on.

12956

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

12957

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

12958

},

12959

"destination": { # A coordinate in a sheet. # The top-left coordinate where the data should be pasted.

12960

# All indexes are zero-based.

12961

"rowIndex": 42, # The row index of the coordinate.

12962

"columnIndex": 42, # The column index of the coordinate.

12963

"sheetId": 42, # The sheet this coordinate is on.

12964

},

12965

},

12966

"copyPaste": { # Copies data from the source to the destination. # Copies data from one area and pastes it to another.

12967

"pasteType": "A String", # What kind of data to paste.

12968

"source": { # A range on a sheet. # The source range to copy.

12969

# All indexes are zero-based.

12970

# Indexes are half open, e.g the start index is inclusive

12971

# and the end index is exclusive -- [start_index, end_index).

12972

# Missing indexes indicate the range is unbounded on that side.

12973

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12974

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12975

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12976

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12977

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12978

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12979

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12980

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12981

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12982

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12983

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12984

# `Sheet1!A:B == sheet_id: 0,

12985

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12986

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12987

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12988

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12989

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12990

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

12991

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

12992

#

12993

# The start index must always be less than or equal to the end index.

12994

# If the start index equals the end index, then the range is empty.

12995

# Empty ranges are typically not meaningful and are usually rendered in the

12996

# UI as `#REF!`.

12997

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

12998

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

12999

"sheetId": 42, # The sheet this range is on.

13000

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

13001

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

13002

},

13003

"destination": { # A range on a sheet. # The location to paste to. If the range covers a span that's

13004

# a multiple of the source's height or width, then the

13005

# data will be repeated to fill in the destination range.

13006

# If the range is smaller than the source range, the entire

13007

# source data will still be copied (beyond the end of the destination range).

13008

# All indexes are zero-based.

13009

# Indexes are half open, e.g the start index is inclusive

13010

# and the end index is exclusive -- [start_index, end_index).

13011

# Missing indexes indicate the range is unbounded on that side.

13012

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13013

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13014

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13015

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13016

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13017

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13018

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13019

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13020

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13021

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13022

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13023

# `Sheet1!A:B == sheet_id: 0,

13024

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13025

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13026

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13027

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13028

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13029

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13030

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13031

#

13032

# The start index must always be less than or equal to the end index.

13033

# If the start index equals the end index, then the range is empty.

13034

# Empty ranges are typically not meaningful and are usually rendered in the

13035

# UI as `#REF!`.

13036

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

13037

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

13038

"sheetId": 42, # The sheet this range is on.

13039

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

13040

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

13041

},

13042

"pasteOrientation": "A String", # How that data should be oriented when pasting.

13043

},

13044

"addSheet": { # Adds a new sheet. # Adds a sheet.

13045

# When a sheet is added at a given index,

13046

# all subsequent sheets' indexes are incremented.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13047

# To add an object sheet, use AddChartRequest instead and specify

13048

# EmbeddedObjectPosition.sheetId or

13049

# EmbeddedObjectPosition.newSheet.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13050

"properties": { # Properties of a sheet. # The properties the new sheet should have.

13051

# All properties are optional.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13052

# The sheetId field is optional; if one is not

13053

# set, an id will be randomly generated. (It is an error to specify the ID

13054

# of a sheet that already exists.)

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13055

"sheetType": "A String", # The type of sheet. Defaults to GRID.

13056

# This field cannot be changed once set.

13057

"index": 42, # The index of the sheet within the spreadsheet.

13058

# When adding or updating sheet properties, if this field

13059

# is excluded then the sheet will be added or moved to the end

13060

# of the sheet list.

13061

"title": "A String", # The name of the sheet.

13062

"gridProperties": { # Properties of a grid. # Additional properties of the sheet if this sheet is a grid.

13063

# (If the sheet is an object sheet, containing a chart or image, then

13064

# this field will be absent.)

13065

# When writing it is an error to set any grid properties on non-grid sheets.

13066

"columnCount": 42, # The number of columns in the grid.

13067

"rowCount": 42, # The number of rows in the grid.

13068

"frozenColumnCount": 42, # The number of columns that are frozen in the grid.

13069

"hideGridlines": True or False, # True if the grid isn't showing gridlines in the UI.

13070

"frozenRowCount": 42, # The number of rows that are frozen in the grid.

13071

},

13072

"rightToLeft": True or False, # True if the sheet is an RTL sheet instead of an LTR sheet.

13073

"tabColor": { # Represents a color in the RGBA color space. This representation is designed # The color of the tab in the UI.

13074

# for simplicity of conversion to/from color representations in various

13075

# languages over compactness; for example, the fields of this representation

13076

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

13077

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

13078

# method in iOS; and, with just a little work, it can be easily formatted into

13079

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

13084

#

13085

# // ...

13086

# public static java.awt.Color fromProto(Color protocolor) {

13087

# float alpha = protocolor.hasAlpha()

13088

# ? protocolor.getAlpha().getValue()

13089

# : 1.0;

13090

#

13091

# return new java.awt.Color(

13092

# protocolor.getRed(),

13093

# protocolor.getGreen(),

13094

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

13099

# float red = (float) color.getRed();

13100

# float green = (float) color.getGreen();

13101

# float blue = (float) color.getBlue();

13102

# float denominator = 255.0;

13103

# Color.Builder resultBuilder =

13104

# Color

13105

# .newBuilder()

13106

# .setRed(red / denominator)

13107

# .setGreen(green / denominator)

13108

# .setBlue(blue / denominator);

13109

# int alpha = color.getAlpha();

13110

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

13115

# .build());

13116

# }

13117

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

13122

#

13123

# // ...

13124

# static UIColor* fromProto(Color* protocolor) {

13125

# float red = [protocolor red];

13126

# float green = [protocolor green];

13127

# float blue = [protocolor blue];

13128

# FloatValue* alpha_wrapper = [protocolor alpha];

13129

# float alpha = 1.0;

13130

# if (alpha_wrapper != nil) {

13131

# alpha = [alpha_wrapper value];

13132

# }

13133

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

13134

# }

13135

#

13136

# static Color* toProto(UIColor* color) {

13137

# CGFloat red, green, blue, alpha;

13138

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

13139

# return nil;

13140

# }

13141

# Color* result = [Color alloc] init];

13142

# [result setRed:red];

13143

# [result setGreen:green];

13144

# [result setBlue:blue];

13145

# if (alpha <= 0.9999) {

13146

# [result setAlpha:floatWrapperWithValue(alpha)];

13147

# }

13148

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

13158

# var redFrac = rgb_color.red || 0.0;

13159

# var greenFrac = rgb_color.green || 0.0;

13160

# var blueFrac = rgb_color.blue || 0.0;

13161

# var red = Math.floor(redFrac * 255);

13162

# var green = Math.floor(greenFrac * 255);

13163

# var blue = Math.floor(blueFrac * 255);

13164

#

13165

# if (!('alpha' in rgb_color)) {

13166

# return rgbToCssColor_(red, green, blue);

13167

# }

13168

#

13169

# var alphaFrac = rgb_color.alpha.value || 0.0;

13170

# var rgbParams = [red, green, blue].join(',');

13171

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

13172

# };

13173

#

13174

# var rgbToCssColor_ = function(red, green, blue) {

13175

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

13176

# var hexString = rgbNumber.toString(16);

13177

# var missingZeros = 6 - hexString.length;

13178

# var resultBuilder = ['#'];

13179

# for (var i = 0; i < missingZeros; i++) {

13180

# resultBuilder.push('0');

13181

# }

13182

# resultBuilder.push(hexString);

13183

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

13188

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

13189

# the final pixel color is defined by the equation:

13190

#

13191

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

13192

#

13193

# This means that a value of 1.0 corresponds to a solid color, whereas

13194

# a value of 0.0 corresponds to a completely transparent color. This

13195

# uses a wrapper message rather than a simple float scalar so that it is

13196

# possible to distinguish between a default value and the value being unset.

13197

# If omitted, this color object is to be rendered as a solid color

13198

# (as if the alpha value had been explicitly given with a value of 1.0).

13199

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

13200

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

13201

},

13202

"hidden": True or False, # True if the sheet is hidden in the UI, false if it's visible.

13203

"sheetId": 42, # The ID of the sheet. Must be non-negative.

13204

# This field cannot be changed once set.

13205

},

13206

},

13207

"deleteNamedRange": { # Removes the named range with the given ID from the spreadsheet. # Deletes a named range.

13208

"namedRangeId": "A String", # The ID of the named range to delete.

13209

},

13210

"updateNamedRange": { # Updates properties of the named range with the specified # Updates a named range.

13211

# namedRangeId.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13212

"fields": "A String", # The fields that should be updated. At least one field must be specified.

13213

# The root `namedRange` is implied and should not be specified.

13214

# A single `"*"` can be used as short-hand for listing every field.

13215

"namedRange": { # A named range. # The named range to update with the new properties.

13216

"namedRangeId": "A String", # The ID of the named range.

13217

"range": { # A range on a sheet. # The range this represents.

13218

# All indexes are zero-based.

13219

# Indexes are half open, e.g the start index is inclusive

13220

# and the end index is exclusive -- [start_index, end_index).

13221

# Missing indexes indicate the range is unbounded on that side.

13222

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13223

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13224

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13225

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13226

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13227

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13228

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13229

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13230

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13231

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13232

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13233

# `Sheet1!A:B == sheet_id: 0,

13234

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13235

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13236

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13237

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13238

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13239

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13240

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13241

#

13242

# The start index must always be less than or equal to the end index.

13243

# If the start index equals the end index, then the range is empty.

13244

# Empty ranges are typically not meaningful and are usually rendered in the

13245

# UI as `#REF!`.

13246

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

13247

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

13248

"sheetId": 42, # The sheet this range is on.

13249

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

13250

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

13251

},

13252

"name": "A String", # The name of the named range.

13253

},

13254

},

13255

"insertDimension": { # Inserts rows or columns in a sheet at a particular index. # Inserts new rows or columns in a sheet.

13256

"inheritFromBefore": True or False, # Whether dimension properties should be extended from the dimensions

13257

# before or after the newly inserted dimensions.

13258

# True to inherit from the dimensions before (in which case the start

13259

# index must be greater than 0), and false to inherit from the dimensions

13260

# after.

13261

#

13262

# For example, if row index 0 has red background and row index 1

13263

# has a green background, then inserting 2 rows at index 1 can inherit

13264

# either the green or red background. If `inheritFromBefore` is true,

13265

# the two new rows will be red (because the row before the insertion point

13266

# was red), whereas if `inheritFromBefore` is false, the two new rows will

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13267

# be green (because the row after the insertion point was green).

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13268

"range": { # A range along a single dimension on a sheet. # The dimensions to insert. Both the start and end indexes must be bounded.

13269

# All indexes are zero-based.

13270

# Indexes are half open: the start index is inclusive

13271

# and the end index is exclusive.

13272

# Missing indexes indicate the range is unbounded on that side.

13273

"endIndex": 42, # The end (exclusive) of the span, or not set if unbounded.

13274

"startIndex": 42, # The start (inclusive) of the span, or not set if unbounded.

13275

"sheetId": 42, # The sheet this span is on.

13276

"dimension": "A String", # The dimension of the span.

13277

},

13278

},

13279

"updateFilterView": { # Updates properties of the filter view. # Updates the properties of a filter view.

13280

"filter": { # A filter view. # The new properties of the filter view.

13281

"title": "A String", # The name of the filter view.

13282

"namedRangeId": "A String", # The named range this filter view is backed by, if any.

13283

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13284

# When writing, only one of range or named_range_id

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13285

# may be set.

13286

"filterViewId": 42, # The ID of the filter view.

13287

"range": { # A range on a sheet. # The range this filter view covers.

13288

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13289

# When writing, only one of range or named_range_id

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13290

# may be set.

13291

# All indexes are zero-based.

13292

# Indexes are half open, e.g the start index is inclusive

13293

# and the end index is exclusive -- [start_index, end_index).

13294

# Missing indexes indicate the range is unbounded on that side.

13295

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13296

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13297

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13298

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13299

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13300

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13301

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13302

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13303

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13304

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13305

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13306

# `Sheet1!A:B == sheet_id: 0,

13307

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13308

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13309

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13310

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13311

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13312

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13313

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13314

#

13315

# The start index must always be less than or equal to the end index.

13316

# If the start index equals the end index, then the range is empty.

13317

# Empty ranges are typically not meaningful and are usually rendered in the

13318

# UI as `#REF!`.

13319

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

13320

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

13321

"sheetId": 42, # The sheet this range is on.

13322

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

13323

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

13324

},

13325

"sortSpecs": [ # The sort order per column. Later specifications are used when values

13326

# are equal in the earlier specifications.

13327

{ # A sort order associated with a specific column or row.

13328

"sortOrder": "A String", # The order data should be sorted.

13329

"dimensionIndex": 42, # The dimension the sort should be applied to.

13330

},

13331

],

13332

"criteria": { # The criteria for showing/hiding values per column.

13333

# The map's key is the column index, and the value is the criteria for

13334

# that column.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13335

"a_key": { # Criteria for showing/hiding rows in a filter or filter view.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13336

"hiddenValues": [ # Values that should be hidden.

13337

"A String",

13338

],

13339

"condition": { # A condition that can evaluate to true or false. # A condition that must be true for values to be shown.

13340

# (This does not override hiddenValues -- if a value is listed there,

13341

# it will still be hidden.)

13342

# BooleanConditions are used by conditional formatting,

13343

# data validation, and the criteria in filters.

13344

"type": "A String", # The type of condition.

13345

"values": [ # The values of the condition. The number of supported values depends

13346

# on the condition type. Some support zero values,

13347

# others one or two values,

13348

# and ConditionType.ONE_OF_LIST supports an arbitrary number of values.

13349

{ # The value of the condition.

13350

"relativeDate": "A String", # A relative date (based on the current date).

13351

# Valid only if the type is

13352

# DATE_BEFORE,

13353

# DATE_AFTER,

13354

# DATE_ON_OR_BEFORE or

13355

# DATE_ON_OR_AFTER.

13356

#

13357

# Relative dates are not supported in data validation.

13358

# They are supported only in conditional formatting and

13359

# conditional filters.

13360

"userEnteredValue": "A String", # A value the condition is based on.

13361

# The value will be parsed as if the user typed into a cell.

13362

# Formulas are supported (and must begin with an `=`).

},

],

},

},

},

},

"fields": "A String", # The fields that should be updated. At least one field must be specified.

13370

# The root `filter` is implied and should not be specified.

13371

# A single `"*"` can be used as short-hand for listing every field.

13372

},

13373

"deleteConditionalFormatRule": { # Deletes a conditional format rule at the given index. # Deletes an existing conditional format rule.

13374

# All subsequent rules' indexes are decremented.

13375

"index": 42, # The zero-based index of the rule to be deleted.

13376

"sheetId": 42, # The sheet the rule is being deleted from.

},

},

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

13389

13390

{ # The reply for batch updating a spreadsheet.

13391

"spreadsheetId": "A String", # The spreadsheet the updates were applied to.

13392

"replies": [ # The reply of the updates. This maps 1:1 with the updates, although

13393

# replies to some requests may be empty.

13394

{ # A single response from an update.

13395

"duplicateFilterView": { # The result of a filter view being duplicated. # A reply from duplicating a filter view.

13396

"filter": { # A filter view. # The newly created filter.

13397

"title": "A String", # The name of the filter view.

13398

"namedRangeId": "A String", # The named range this filter view is backed by, if any.

13399

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13400

# When writing, only one of range or named_range_id

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13401

# may be set.

13402

"filterViewId": 42, # The ID of the filter view.

13403

"range": { # A range on a sheet. # The range this filter view covers.

13404

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13405

# When writing, only one of range or named_range_id

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13406

# may be set.

13407

# All indexes are zero-based.

13408

# Indexes are half open, e.g the start index is inclusive

13409

# and the end index is exclusive -- [start_index, end_index).

13410

# Missing indexes indicate the range is unbounded on that side.

13411

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13412

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13413

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13414

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13415

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13416

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13417

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13418

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13419

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13420

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13421

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13422

# `Sheet1!A:B == sheet_id: 0,

13423

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13424

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13425

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13426

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13427

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13428

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13429

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13430

#

13431

# The start index must always be less than or equal to the end index.

13432

# If the start index equals the end index, then the range is empty.

13433

# Empty ranges are typically not meaningful and are usually rendered in the

13434

# UI as `#REF!`.

13435

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

13436

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

13437

"sheetId": 42, # The sheet this range is on.

13438

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

13439

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

13440

},

13441

"sortSpecs": [ # The sort order per column. Later specifications are used when values

13442

# are equal in the earlier specifications.

13443

{ # A sort order associated with a specific column or row.

13444

"sortOrder": "A String", # The order data should be sorted.

13445

"dimensionIndex": 42, # The dimension the sort should be applied to.

13446

},

13447

],

13448

"criteria": { # The criteria for showing/hiding values per column.

13449

# The map's key is the column index, and the value is the criteria for

13450

# that column.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13451

"a_key": { # Criteria for showing/hiding rows in a filter or filter view.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13452

"hiddenValues": [ # Values that should be hidden.

13453

"A String",

13454

],

13455

"condition": { # A condition that can evaluate to true or false. # A condition that must be true for values to be shown.

13456

# (This does not override hiddenValues -- if a value is listed there,

13457

# it will still be hidden.)

13458

# BooleanConditions are used by conditional formatting,

13459

# data validation, and the criteria in filters.

13460

"type": "A String", # The type of condition.

13461

"values": [ # The values of the condition. The number of supported values depends

13462

# on the condition type. Some support zero values,

13463

# others one or two values,

13464

# and ConditionType.ONE_OF_LIST supports an arbitrary number of values.

13465

{ # The value of the condition.

13466

"relativeDate": "A String", # A relative date (based on the current date).

13467

# Valid only if the type is

13468

# DATE_BEFORE,

13469

# DATE_AFTER,

13470

# DATE_ON_OR_BEFORE or

13471

# DATE_ON_OR_AFTER.

13472

#

13473

# Relative dates are not supported in data validation.

13474

# They are supported only in conditional formatting and

13475

# conditional filters.

13476

"userEnteredValue": "A String", # A value the condition is based on.

13477

# The value will be parsed as if the user typed into a cell.

13478

# Formulas are supported (and must begin with an `=`).

},

],

},

},

},

},

},

"duplicateSheet": { # The result of duplicating a sheet. # A reply from duplicating a sheet.

13487

"properties": { # Properties of a sheet. # The properties of the duplicate sheet.

13488

"sheetType": "A String", # The type of sheet. Defaults to GRID.

13489

# This field cannot be changed once set.

13490

"index": 42, # The index of the sheet within the spreadsheet.

13491

# When adding or updating sheet properties, if this field

13492

# is excluded then the sheet will be added or moved to the end

13493

# of the sheet list.

13494

"title": "A String", # The name of the sheet.

13495

"gridProperties": { # Properties of a grid. # Additional properties of the sheet if this sheet is a grid.

13496

# (If the sheet is an object sheet, containing a chart or image, then

13497

# this field will be absent.)

13498

# When writing it is an error to set any grid properties on non-grid sheets.

13499

"columnCount": 42, # The number of columns in the grid.

13500

"rowCount": 42, # The number of rows in the grid.

13501

"frozenColumnCount": 42, # The number of columns that are frozen in the grid.

13502

"hideGridlines": True or False, # True if the grid isn't showing gridlines in the UI.

13503

"frozenRowCount": 42, # The number of rows that are frozen in the grid.

13504

},

13505

"rightToLeft": True or False, # True if the sheet is an RTL sheet instead of an LTR sheet.

13506

"tabColor": { # Represents a color in the RGBA color space. This representation is designed # The color of the tab in the UI.

13507

# for simplicity of conversion to/from color representations in various

13508

# languages over compactness; for example, the fields of this representation

13509

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

13510

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

13511

# method in iOS; and, with just a little work, it can be easily formatted into

13512

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

13517

#

13518

# // ...

13519

# public static java.awt.Color fromProto(Color protocolor) {

13520

# float alpha = protocolor.hasAlpha()

13521

# ? protocolor.getAlpha().getValue()

13522

# : 1.0;

13523

#

13524

# return new java.awt.Color(

13525

# protocolor.getRed(),

13526

# protocolor.getGreen(),

13527

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

13532

# float red = (float) color.getRed();

13533

# float green = (float) color.getGreen();

13534

# float blue = (float) color.getBlue();

13535

# float denominator = 255.0;

13536

# Color.Builder resultBuilder =

13537

# Color

13538

# .newBuilder()

13539

# .setRed(red / denominator)

13540

# .setGreen(green / denominator)

13541

# .setBlue(blue / denominator);

13542

# int alpha = color.getAlpha();

13543

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

13548

# .build());

13549

# }

13550

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

13555

#

13556

# // ...

13557

# static UIColor* fromProto(Color* protocolor) {

13558

# float red = [protocolor red];

13559

# float green = [protocolor green];

13560

# float blue = [protocolor blue];

13561

# FloatValue* alpha_wrapper = [protocolor alpha];

13562

# float alpha = 1.0;

13563

# if (alpha_wrapper != nil) {

13564

# alpha = [alpha_wrapper value];

13565

# }

13566

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

13567

# }

13568

#

13569

# static Color* toProto(UIColor* color) {

13570

# CGFloat red, green, blue, alpha;

13571

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

13572

# return nil;

13573

# }

13574

# Color* result = [Color alloc] init];

13575

# [result setRed:red];

13576

# [result setGreen:green];

13577

# [result setBlue:blue];

13578

# if (alpha <= 0.9999) {

13579

# [result setAlpha:floatWrapperWithValue(alpha)];

13580

# }

13581

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

13591

# var redFrac = rgb_color.red || 0.0;

13592

# var greenFrac = rgb_color.green || 0.0;

13593

# var blueFrac = rgb_color.blue || 0.0;

13594

# var red = Math.floor(redFrac * 255);

13595

# var green = Math.floor(greenFrac * 255);

13596

# var blue = Math.floor(blueFrac * 255);

13597

#

13598

# if (!('alpha' in rgb_color)) {

13599

# return rgbToCssColor_(red, green, blue);

13600

# }

13601

#

13602

# var alphaFrac = rgb_color.alpha.value || 0.0;

13603

# var rgbParams = [red, green, blue].join(',');

13604

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

13605

# };

13606

#

13607

# var rgbToCssColor_ = function(red, green, blue) {

13608

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

13609

# var hexString = rgbNumber.toString(16);

13610

# var missingZeros = 6 - hexString.length;

13611

# var resultBuilder = ['#'];

13612

# for (var i = 0; i < missingZeros; i++) {

13613

# resultBuilder.push('0');

13614

# }

13615

# resultBuilder.push(hexString);

13616

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

13621

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

13622

# the final pixel color is defined by the equation:

13623

#

13624

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

13625

#

13626

# This means that a value of 1.0 corresponds to a solid color, whereas

13627

# a value of 0.0 corresponds to a completely transparent color. This

13628

# uses a wrapper message rather than a simple float scalar so that it is

13629

# possible to distinguish between a default value and the value being unset.

13630

# If omitted, this color object is to be rendered as a solid color

13631

# (as if the alpha value had been explicitly given with a value of 1.0).

13632

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

13633

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

13634

},

13635

"hidden": True or False, # True if the sheet is hidden in the UI, false if it's visible.

13636

"sheetId": 42, # The ID of the sheet. Must be non-negative.

13637

# This field cannot be changed once set.

13638

},

13639

},

13640

"updateEmbeddedObjectPosition": { # The result of updating an embedded object's position. # A reply from updating an embedded object's position.

13641

"position": { # The position of an embedded object such as a chart. # The new position of the embedded object.

13642

"newSheet": True or False, # If true, the embedded object will be put on a new sheet whose ID

13643

# is chosen for you. Used only when writing.

13644

"sheetId": 42, # The sheet this is on. Set only if the embedded object

13645

# is on its own sheet. Must be non-negative.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13646

"overlayPosition": { # The location an object is overlaid on top of a grid. # The position at which the object is overlaid on top of a grid.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13647

"anchorCell": { # A coordinate in a sheet. # The cell the object is anchored to.

13648

# All indexes are zero-based.

13649

"rowIndex": 42, # The row index of the coordinate.

13650

"columnIndex": 42, # The column index of the coordinate.

13651

"sheetId": 42, # The sheet this coordinate is on.

13652

},

13653

"offsetYPixels": 42, # The vertical offset, in pixels, that the object is offset

13654

# from the anchor cell.

13655

"widthPixels": 42, # The width of the object, in pixels. Defaults to 600.

13656

"offsetXPixels": 42, # The horizontal offset, in pixels, that the object is offset

13657

# from the anchor cell.

13658

"heightPixels": 42, # The height of the object, in pixels. Defaults to 371.

},

},

},

"addChart": { # The result of adding a chart to a spreadsheet. # A reply from adding a chart.

13663

"chart": { # A chart embedded in a sheet. # The newly added chart.

13664

"chartId": 42, # The ID of the chart.

13665

"position": { # The position of an embedded object such as a chart. # The position of the chart.

13666

"newSheet": True or False, # If true, the embedded object will be put on a new sheet whose ID

13667

# is chosen for you. Used only when writing.

13668

"sheetId": 42, # The sheet this is on. Set only if the embedded object

13669

# is on its own sheet. Must be non-negative.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13670

"overlayPosition": { # The location an object is overlaid on top of a grid. # The position at which the object is overlaid on top of a grid.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13671

"anchorCell": { # A coordinate in a sheet. # The cell the object is anchored to.

13672

# All indexes are zero-based.

13673

"rowIndex": 42, # The row index of the coordinate.

13674

"columnIndex": 42, # The column index of the coordinate.

13675

"sheetId": 42, # The sheet this coordinate is on.

13676

},

13677

"offsetYPixels": 42, # The vertical offset, in pixels, that the object is offset

13678

# from the anchor cell.

13679

"widthPixels": 42, # The width of the object, in pixels. Defaults to 600.

13680

"offsetXPixels": 42, # The horizontal offset, in pixels, that the object is offset

13681

# from the anchor cell.

13682

"heightPixels": 42, # The height of the object, in pixels. Defaults to 371.

13683

},

13684

},

13685

"spec": { # The specifications of a chart. # The specification of the chart.

13686

"hiddenDimensionStrategy": "A String", # Determines how the charts will use hidden rows or columns.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13687

"pieChart": { # A <a href="/chart/interactive/docs/gallery/piechart">pie chart</a>. # A pie chart specification.

13688

"series": { # The data included in a domain or series. # The data that covers the one and only series of the pie chart.

13689

"sourceRange": { # Source ranges for a chart. # The source ranges of the data.

13690

"sources": [ # The ranges of data for a series or domain.

13691

# Exactly one dimension must have a length of 1,

13692

# and all sources in the list must have the same dimension

13693

# with length 1.

13694

# The domain (if it exists) & all series must have the same number

13695

# of source ranges. If using more than one source range, then the source

13696

# range at a given offset must be contiguous across the domain and series.

13697

#

13698

# For example, these are valid configurations:

13699

#

13700

# domain sources: A1:A5

13701

# series1 sources: B1:B5

13702

# series2 sources: D6:D10

13703

#

13704

# domain sources: A1:A5, C10:C12

13705

# series1 sources: B1:B5, D10:D12

13706

# series2 sources: C1:C5, E10:E12

13707

{ # A range on a sheet.

13708

# All indexes are zero-based.

13709

# Indexes are half open, e.g the start index is inclusive

13710

# and the end index is exclusive -- [start_index, end_index).

13711

# Missing indexes indicate the range is unbounded on that side.

13712

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13713

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13714

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13715

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13716

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13717

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13718

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13719

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13720

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13721

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13722

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13723

# `Sheet1!A:B == sheet_id: 0,

13724

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13725

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13726

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13727

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13728

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13729

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13730

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13731

#

13732

# The start index must always be less than or equal to the end index.

13733

# If the start index equals the end index, then the range is empty.

13734

# Empty ranges are typically not meaningful and are usually rendered in the

13735

# UI as `#REF!`.

13736

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

13737

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

13738

"sheetId": 42, # The sheet this range is on.

13739

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

13740

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

],

},

},

"domain": { # The data included in a domain or series. # The data that covers the domain of the pie chart.

13746

"sourceRange": { # Source ranges for a chart. # The source ranges of the data.

13747

"sources": [ # The ranges of data for a series or domain.

13748

# Exactly one dimension must have a length of 1,

13749

# and all sources in the list must have the same dimension

13750

# with length 1.

13751

# The domain (if it exists) & all series must have the same number

13752

# of source ranges. If using more than one source range, then the source

13753

# range at a given offset must be contiguous across the domain and series.

13754

#

13755

# For example, these are valid configurations:

13756

#

13757

# domain sources: A1:A5

13758

# series1 sources: B1:B5

13759

# series2 sources: D6:D10

13760

#

13761

# domain sources: A1:A5, C10:C12

13762

# series1 sources: B1:B5, D10:D12

13763

# series2 sources: C1:C5, E10:E12

13764

{ # A range on a sheet.

13765

# All indexes are zero-based.

13766

# Indexes are half open, e.g the start index is inclusive

13767

# and the end index is exclusive -- [start_index, end_index).

13768

# Missing indexes indicate the range is unbounded on that side.

13769

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13770

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13771

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13772

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13773

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13774

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13775

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13776

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13777

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13778

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13779

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13780

# `Sheet1!A:B == sheet_id: 0,

13781

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13782

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13783

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13784

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13785

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13786

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13787

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13788

#

13789

# The start index must always be less than or equal to the end index.

13790

# If the start index equals the end index, then the range is empty.

13791

# Empty ranges are typically not meaningful and are usually rendered in the

13792

# UI as `#REF!`.

13793

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

13794

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

13795

"sheetId": 42, # The sheet this range is on.

13796

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

13797

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

],

},

},

"threeDimensional": True or False, # True if the pie is three dimensional.

13803

"legendPosition": "A String", # Where the legend of the pie chart should be drawn.

13804

"pieHole": 3.14, # The size of the hole in the pie chart.

13805

},

13806

"basicChart": { # The specification for a basic chart. See BasicChartType for the list # A basic chart specification, can be one of many kinds of charts.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13807

# See BasicChartType for the list of all

13808

# charts this supports.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13809

# of charts this supports.

13810

"headerCount": 42, # The number of rows or columns in the data that are "headers".

13811

# If not set, Google Sheets will guess how many rows are headers based

13812

# on the data.

13813

#

13814

# (Note that BasicChartAxis.title may override the axis title

13815

# inferred from the header values.)

13816

"series": [ # The data this chart is visualizing.

13817

{ # A single series of data in a chart.

13818

# For example, if charting stock prices over time, multiple series may exist,

13819

# one for the "Open Price", "High Price", "Low Price" and "Close Price".

13820

"series": { # The data included in a domain or series. # The data being visualized in this chart series.

13821

"sourceRange": { # Source ranges for a chart. # The source ranges of the data.

13822

"sources": [ # The ranges of data for a series or domain.

13823

# Exactly one dimension must have a length of 1,

13824

# and all sources in the list must have the same dimension

13825

# with length 1.

13826

# The domain (if it exists) & all series must have the same number

13827

# of source ranges. If using more than one source range, then the source

13828

# range at a given offset must be contiguous across the domain and series.

13829

#

13830

# For example, these are valid configurations:

13831

#

13832

# domain sources: A1:A5

13833

# series1 sources: B1:B5

13834

# series2 sources: D6:D10

13835

#

13836

# domain sources: A1:A5, C10:C12

13837

# series1 sources: B1:B5, D10:D12

13838

# series2 sources: C1:C5, E10:E12

13839

{ # A range on a sheet.

13840

# All indexes are zero-based.

13841

# Indexes are half open, e.g the start index is inclusive

13842

# and the end index is exclusive -- [start_index, end_index).

13843

# Missing indexes indicate the range is unbounded on that side.

13844

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13845

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13846

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13847

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13848

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13849

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13850

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13851

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13852

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13853

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13854

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13855

# `Sheet1!A:B == sheet_id: 0,

13856

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13857

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13858

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13859

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13860

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13861

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13862

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13863

#

13864

# The start index must always be less than or equal to the end index.

13865

# If the start index equals the end index, then the range is empty.

13866

# Empty ranges are typically not meaningful and are usually rendered in the

13867

# UI as `#REF!`.

13868

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

13869

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

13870

"sheetId": 42, # The sheet this range is on.

13871

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

13872

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

],

},

},

"targetAxis": "A String", # The minor axis that will specify the range of values for this series.

13878

# For example, if charting stocks over time, the "Volume" series

13879

# may want to be pinned to the right with the prices pinned to the left,

13880

# because the scale of trading volume is different than the scale of

13881

# prices.

13882

# It is an error to specify an axis that isn't a valid minor axis

13883

# for the chart's type.

13884

"type": "A String", # The type of this series. Valid only if the

13885

# chartType is

13886

# COMBO.

13887

# Different types will change the way the series is visualized.

13888

# Only LINE, AREA,

13889

# and COLUMN are supported.

13890

},

13891

],

13892

"legendPosition": "A String", # The position of the chart legend.

13893

"domains": [ # The domain of data this is charting.

13894

# Only a single domain is currently supported.

13895

{ # The domain of a chart.

13896

# For example, if charting stock prices over time, this would be the date.

13897

"domain": { # The data included in a domain or series. # The data of the domain. For example, if charting stock prices over time,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13898

# this is the data representing the dates.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13899

"sourceRange": { # Source ranges for a chart. # The source ranges of the data.

13900

"sources": [ # The ranges of data for a series or domain.

13901

# Exactly one dimension must have a length of 1,

13902

# and all sources in the list must have the same dimension

13903

# with length 1.

13904

# The domain (if it exists) & all series must have the same number

13905

# of source ranges. If using more than one source range, then the source

13906

# range at a given offset must be contiguous across the domain and series.

13907

#

13908

# For example, these are valid configurations:

13909

#

13910

# domain sources: A1:A5

13911

# series1 sources: B1:B5

13912

# series2 sources: D6:D10

13913

#

13914

# domain sources: A1:A5, C10:C12

13915

# series1 sources: B1:B5, D10:D12

13916

# series2 sources: C1:C5, E10:E12

13917

{ # A range on a sheet.

13918

# All indexes are zero-based.

13919

# Indexes are half open, e.g the start index is inclusive

13920

# and the end index is exclusive -- [start_index, end_index).

13921

# Missing indexes indicate the range is unbounded on that side.

13922

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13923

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13924

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13925

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13926

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13927

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13928

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13929

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13930

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13931

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13932

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13933

# `Sheet1!A:B == sheet_id: 0,

13934

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13935

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13936

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13937

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13938

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13939

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

13940

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

13941

#

13942

# The start index must always be less than or equal to the end index.

13943

# If the start index equals the end index, then the range is empty.

13944

# Empty ranges are typically not meaningful and are usually rendered in the

13945

# UI as `#REF!`.

13946

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

13947

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

13948

"sheetId": 42, # The sheet this range is on.

13949

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

13950

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

],

},

},

},

],

"chartType": "A String", # The type of the chart.

13958

"axis": [ # The axis on the chart.

13959

{ # An axis of the chart.

13960

# A chart may not have more than one axis per

13961

# axis position.

13962

"position": "A String", # The position of this axis.

13963

"format": { # The format of a run of text in a cell. # The format of the title.

13964

# Only valid if the axis is not associated with the domain.

13965

# Absent values indicate that the field isn't specified.

13966

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

13967

# for simplicity of conversion to/from color representations in various

13968

# languages over compactness; for example, the fields of this representation

13969

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

13970

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

13971

# method in iOS; and, with just a little work, it can be easily formatted into

13972

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

13977

#

13978

# // ...

13979

# public static java.awt.Color fromProto(Color protocolor) {

13980

# float alpha = protocolor.hasAlpha()

13981

# ? protocolor.getAlpha().getValue()

13982

# : 1.0;

13983

#

13984

# return new java.awt.Color(

13985

# protocolor.getRed(),

13986

# protocolor.getGreen(),

13987

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

13992

# float red = (float) color.getRed();

13993

# float green = (float) color.getGreen();

13994

# float blue = (float) color.getBlue();

13995

# float denominator = 255.0;

13996

# Color.Builder resultBuilder =

13997

# Color

13998

# .newBuilder()

13999

# .setRed(red / denominator)

14000

# .setGreen(green / denominator)

14001

# .setBlue(blue / denominator);

14002

# int alpha = color.getAlpha();

14003

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

14008

# .build());

14009

# }

14010

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

14015

#

14016

# // ...

14017

# static UIColor* fromProto(Color* protocolor) {

14018

# float red = [protocolor red];

14019

# float green = [protocolor green];

14020

# float blue = [protocolor blue];

14021

# FloatValue* alpha_wrapper = [protocolor alpha];

14022

# float alpha = 1.0;

14023

# if (alpha_wrapper != nil) {

14024

# alpha = [alpha_wrapper value];

14025

# }

14026

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

14027

# }

14028

#

14029

# static Color* toProto(UIColor* color) {

14030

# CGFloat red, green, blue, alpha;

14031

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

14032

# return nil;

14033

# }

14034

# Color* result = [Color alloc] init];

14035

# [result setRed:red];

14036

# [result setGreen:green];

14037

# [result setBlue:blue];

14038

# if (alpha <= 0.9999) {

14039

# [result setAlpha:floatWrapperWithValue(alpha)];

14040

# }

14041

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

14051

# var redFrac = rgb_color.red || 0.0;

14052

# var greenFrac = rgb_color.green || 0.0;

14053

# var blueFrac = rgb_color.blue || 0.0;

14054

# var red = Math.floor(redFrac * 255);

14055

# var green = Math.floor(greenFrac * 255);

14056

# var blue = Math.floor(blueFrac * 255);

14057

#

14058

# if (!('alpha' in rgb_color)) {

14059

# return rgbToCssColor_(red, green, blue);

14060

# }

14061

#

14062

# var alphaFrac = rgb_color.alpha.value || 0.0;

14063

# var rgbParams = [red, green, blue].join(',');

14064

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

14065

# };

14066

#

14067

# var rgbToCssColor_ = function(red, green, blue) {

14068

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

14069

# var hexString = rgbNumber.toString(16);

14070

# var missingZeros = 6 - hexString.length;

14071

# var resultBuilder = ['#'];

14072

# for (var i = 0; i < missingZeros; i++) {

14073

# resultBuilder.push('0');

14074

# }

14075

# resultBuilder.push(hexString);

14076

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

14081

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

14082

# the final pixel color is defined by the equation:

14083

#

14084

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

14085

#

14086

# This means that a value of 1.0 corresponds to a solid color, whereas

14087

# a value of 0.0 corresponds to a completely transparent color. This

14088

# uses a wrapper message rather than a simple float scalar so that it is

14089

# possible to distinguish between a default value and the value being unset.

14090

# If omitted, this color object is to be rendered as a solid color

14091

# (as if the alpha value had been explicitly given with a value of 1.0).

14092

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

14093

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

14094

},

14095

"bold": True or False, # True if the text is bold.

14096

"strikethrough": True or False, # True if the text has a strikethrough.

14097

"fontFamily": "A String", # The font family.

14098

"fontSize": 42, # The size of the font.

14099

"italic": True or False, # True if the text is italicized.

14100

"underline": True or False, # True if the text is underlined.

14101

},

14102

"title": "A String", # The title of this axis. If set, this overrides any title inferred

14103

# from headers of the data.

},

],

},

"title": "A String", # The title of the chart.

},

},

},

"updateConditionalFormatRule": { # The result of updating a conditional format rule. # A reply from updating a conditional format rule.

14112

"oldIndex": 42, # The old index of the rule. Not set if a rule was replaced

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

14113

# (because it is the same as new_index).

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

14114

"newIndex": 42, # The index of the new rule.

14115

"oldRule": { # A rule describing a conditional format. # The old (deleted) rule. Not set if a rule was moved

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

14116

# (because it is the same as new_rule).

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

14117

"ranges": [ # The ranges that will be formatted if the condition is true.

14118

# All the ranges must be on the same grid.

14119

{ # A range on a sheet.

14120

# All indexes are zero-based.

14121

# Indexes are half open, e.g the start index is inclusive

14122

# and the end index is exclusive -- [start_index, end_index).

14123

# Missing indexes indicate the range is unbounded on that side.

14124

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

14125

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

14126

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

14127

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

14128

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

14129

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

14130

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

14131

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

14132

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

14133

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

14134

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

14135

# `Sheet1!A:B == sheet_id: 0,

14136

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

14137

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

14138

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

14139

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

14140

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

14141

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

14142

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

14143

#

14144

# The start index must always be less than or equal to the end index.

14145

# If the start index equals the end index, then the range is empty.

14146

# Empty ranges are typically not meaningful and are usually rendered in the

14147

# UI as `#REF!`.

14148

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

14149

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

14150

"sheetId": 42, # The sheet this range is on.

14151

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

14152

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

14153

},

14154

],

14155

"booleanRule": { # A rule that may or may not match, depending on the condition. # The formatting is either "on" or "off" according to the rule.

14156

"condition": { # A condition that can evaluate to true or false. # The condition of the rule. If the condition evaluates to true,

14157

# the format will be applied.

14158

# BooleanConditions are used by conditional formatting,

14159

# data validation, and the criteria in filters.

14160

"type": "A String", # The type of condition.

14161

"values": [ # The values of the condition. The number of supported values depends

14162

# on the condition type. Some support zero values,

14163

# others one or two values,

14164

# and ConditionType.ONE_OF_LIST supports an arbitrary number of values.

14165

{ # The value of the condition.

14166

"relativeDate": "A String", # A relative date (based on the current date).

14167

# Valid only if the type is

14168

# DATE_BEFORE,

14169

# DATE_AFTER,

14170

# DATE_ON_OR_BEFORE or

14171

# DATE_ON_OR_AFTER.

14172

#

14173

# Relative dates are not supported in data validation.

14174

# They are supported only in conditional formatting and

14175

# conditional filters.

14176

"userEnteredValue": "A String", # A value the condition is based on.

14177

# The value will be parsed as if the user typed into a cell.

14178

# Formulas are supported (and must begin with an `=`).

},

],

},

"format": { # The format of a cell. # The format to apply.

14183

# Conditional formatting can only apply a subset of formatting:

# bold, italic,

# strikethrough,

# foreground color &

# background color.

"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

14189

"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on

14190

# the user's locale will be used if necessary for the given type.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame^]

14191

# See the [Date and Number Formats guide](/sheets/guides/formats) for more

14192

# information about the supported patterns.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

14193

"type": "A String", # The type of the number format.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

14194

# When writing, this field must be set.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

14195

},

14196

"textDirection": "A String", # The direction of the text in the cell.

14197

"padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.

14198

# When updating padding, every field must be specified.

14199

"top": 42, # The top padding of the cell.

14200

"right": 42, # The right padding of the cell.

14201

"bottom": 42, # The bottom padding of the cell.

14202

"left": 42, # The left padding of the cell.

14203

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

14204

"horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

14205

"backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.

14206

# for simplicity of conversion to/from color representations in various

14207

# languages over compactness; for example, the fields of this representation

14208

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

14209

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

14210

# method in iOS; and, with just a little work, it can be easily formatted into

14211

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

14216

#

14217

# // ...

14218

# public static java.awt.Color fromProto(Color protocolor) {

14219

# float alpha = protocolor.hasAlpha()

14220

# ? protocolor.getAlpha().getValue()

14221

# : 1.0;

14222

#

14223

# return new java.awt.Color(

14224

# protocolor.getRed(),

14225

# protocolor.getGreen(),

14226

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

14231

# float red = (float) color.getRed();

14232

# float green = (float) color.getGreen();

14233

# float blue = (float) color.getBlue();

14234

# float denominator = 255.0;

14235

# Color.Builder resultBuilder =

14236

# Color

14237

# .newBuilder()

14238

# .setRed(red / denominator)

14239

# .setGreen(green / denominator)

14240

# .setBlue(blue / denominator);

14241

# int alpha = color.getAlpha();

14242

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

14247

# .build());

14248

# }

14249

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

14254

#

14255

# // ...

14256

# static UIColor* fromProto(Color* protocolor) {

14257

# float red = [protocolor red];

14258

# float green = [protocolor green];

14259

# float blue = [protocolor blue];

14260

# FloatValue* alpha_wrapper = [protocolor alpha];

14261

# float alpha = 1.0;

14262

# if (alpha_wrapper != nil) {

14263

# alpha = [alpha_wrapper value];

14264

# }

14265

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

14266

# }

14267

#

14268

# static Color* toProto(UIColor* color) {

14269

# CGFloat red, green, blue, alpha;

14270

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

14271

# return nil;

14272

# }

14273

# Color* result = [Color alloc] init];

14274

# [result setRed:red];

14275

# [result setGreen:green];

14276

# [result setBlue:blue];

14277

# if (alpha <= 0.9999) {

14278

# [result setAlpha:floatWrapperWithValue(alpha)];

14279

# }

14280

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

14290

# var redFrac = rgb_color.red || 0.0;

14291

# var greenFrac = rgb_color.green || 0.0;

14292

# var blueFrac = rgb_color.blue || 0.0;

14293

# var red = Math.floor(redFrac * 255);

14294

# var green = Math.floor(greenFrac * 255);

14295

# var blue = Math.floor(blueFrac * 255);

14296

#

14297

# if (!('alpha' in rgb_color)) {

14298

# return rgbToCssColor_(red, green, blue);

14299

# }

14300

#

14301

# var alphaFrac = rgb_color.alpha.value || 0.0;

14302

# var rgbParams = [red, green, blue].join(',');

14303

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

14304

# };

14305

#

14306

# var rgbToCssColor_ = function(red, green, blue) {

14307

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

14308

# var hexString = rgbNumber.toString(16);

14309

# var missingZeros = 6 - hexString.length;

14310

# var resultBuilder = ['#'];

14311

# for (var i = 0; i < missingZeros; i++) {

14312

# resultBuilder.push('0');

14313

# }

14314

# resultBuilder.push(hexString);

14315

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

14320

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

14321

# the final pixel color is defined by the equation:

14322

#

14323

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

14324

#

14325

# This means that a value of 1.0 corresponds to a solid color, whereas

14326

# a value of 0.0 corresponds to a completely transparent color. This

14327

# uses a wrapper message rather than a simple float scalar so that it is

14328

# possible to distinguish between a default value and the value being unset.

14329

# If omitted, this color object is to be rendered as a solid color

14330

# (as if the alpha value had been explicitly given with a value of 1.0).

14331

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

14332

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

14333

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

14334

"verticalAlignment": "A String", # The vertical alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

14335

"textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).

14336

# Absent values indicate that the field isn't specified.

14337

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

14338

# for simplicity of conversion to/from color representations in various

14339

# languages over compactness; for example, the fields of this representation

14340

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

14341

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

14342

# method in iOS; and, with just a little work, it can be easily formatted into

14343

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

14348

#

14349

# // ...

14350

# public static java.awt.Color fromProto(Color protocolor) {

14351

# float alpha = protocolor.hasAlpha()

14352

# ? protocolor.getAlpha().getValue()

14353

# : 1.0;

14354

#

14355

# return new java.awt.Color(

14356

# protocolor.getRed(),

14357

# protocolor.getGreen(),

14358

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

14363

# float red = (float) color.getRed();

14364

# float green = (float) color.getGreen();

14365

# float blue = (float) color.getBlue();

14366

# float denominator = 255.0;

14367

# Color.Builder resultBuilder =

14368

# Color

14369

# .newBuilder()

14370

# .setRed(red / denominator)

14371

# .setGreen(green / denominator)

14372

# .setBlue(blue / denominator);

14373

# int alpha = color.getAlpha();

14374

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

14379

# .build());

14380

# }

14381

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

14386

#

14387

# // ...

14388

# static UIColor* fromProto(Color* protocolor) {

14389

# float red = [protocolor red];

14390

# float green = [protocolor green];

14391

# float blue = [protocolor blue];

14392

# FloatValue* alpha_wrapper = [protocolor alpha];

14393

# float alpha = 1.0;

14394

# if (alpha_wrapper != nil) {

14395

# alpha = [alpha_wrapper value];

14396

# }

14397

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

14398

# }

14399

#

14400

# static Color* toProto(UIColor* color) {

14401

# CGFloat red, green, blue, alpha;

14402

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

14403

# return nil;

14404

# }

14405

# Color* result = [Color alloc] init];

14406

# [result setRed:red];

14407

# [result setGreen:green];

14408

# [result setBlue:blue];

14409

# if (alpha <= 0.9999) {

14410

# [result setAlpha:floatWrapperWithValue(alpha)];

14411

# }

14412

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

14422

# var redFrac = rgb_color.red || 0.0;

14423

# var greenFrac = rgb_color.green || 0.0;

14424

# var blueFrac = rgb_color.blue || 0.0;

14425

# var red = Math.floor(redFrac * 255);

14426

# var green = Math.floor(greenFrac * 255);

14427

# var blue = Math.floor(blueFrac * 255);

14428

#

14429

# if (!('alpha' in rgb_color)) {

14430

# return rgbToCssColor_(red, green, blue);

14431

# }

14432

#

14433

# var alphaFrac = rgb_color.alpha.value || 0.0;

14434

# var rgbParams = [red, green, blue].join(',');

14435

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

14436

# };

14437

#

14438

# var rgbToCssColor_ = function(red, green, blue) {

14439

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

14440

# var hexString = rgbNumber.toString(16);

14441

# var missingZeros = 6 - hexString.length;

14442

# var resultBuilder = ['#'];

14443

# for (var i = 0; i < missingZeros; i++) {

14444

# resultBuilder.push('0');

14445

# }

14446

# resultBuilder.push(hexString);

14447

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

14452

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

14453

# the final pixel color is defined by the equation:

14454

#

14455

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

14456

#

14457

# This means that a value of 1.0 corresponds to a solid color, whereas

14458

# a value of 0.0 corresponds to a completely transparent color. This

14459

# uses a wrapper message rather than a simple float scalar so that it is

14460

# possible to distinguish between a default value and the value being unset.

14461

# If omitted, this color object is to be rendered as a solid color

14462

# (as if the alpha value had been explicitly given with a value of 1.0).

14463

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

14464

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

14465

},

14466

"bold": True or False, # True if the text is bold.

14467

"strikethrough": True or False, # True if the text has a strikethrough.

14468

"fontFamily": "A String", # The font family.

14469

"fontSize": 42, # The size of the font.

14470

"italic": True or False, # True if the text is italicized.

14471

"underline": True or False, # True if the text is underlined.

14472

},

14473

"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.

14474

"borders": { # The borders of the cell. # The borders of the cell.

14475

"top": { # A border along a cell. # The top border of the cell.

14476

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

14477

# for simplicity of conversion to/from color representations in various

14478

# languages over compactness; for example, the fields of this representation

14479

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

14480

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

14481

# method in iOS; and, with just a little work, it can be easily formatted into

14482

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

14487

#

14488

# // ...

14489

# public static java.awt.Color fromProto(Color protocolor) {

14490

# float alpha = protocolor.hasAlpha()

14491

# ? protocolor.getAlpha().getValue()

14492

# : 1.0;

14493

#

14494

# return new java.awt.Color(

14495

# protocolor.getRed(),

14496

# protocolor.getGreen(),

14497

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

14502

# float red = (float) color.getRed();

14503

# float green = (float) color.getGreen();

14504

# float blue = (float) color.getBlue();

14505

# float denominator = 255.0;

14506

# Color.Builder resultBuilder =

14507

# Color

14508

# .newBuilder()

14509

# .setRed(red / denominator)

14510

# .setGreen(green / denominator)

14511

# .setBlue(blue / denominator);

14512

# int alpha = color.getAlpha();

14513

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

14518

# .build());

14519

# }

14520

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

14525

#

14526

# // ...

14527

# static UIColor* fromProto(Color* protocolor) {

14528

# float red = [protocolor red];

14529

# float green = [protocolor green];

14530

# float blue = [protocolor blue];

14531

# FloatValue* alpha_wrapper = [protocolor alpha];

14532

# float alpha = 1.0;

14533

# if (alpha_wrapper != nil) {

14534

# alpha = [alpha_wrapper value];

14535

# }

14536

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

14537

# }

14538

#

14539

# static Color* toProto(UIColor* color) {

14540

# CGFloat red, green, blue, alpha;

14541

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

14542

# return nil;

14543

# }

14544

# Color* result = [Color alloc] init];

14545

# [result setRed:red];

14546

# [result setGreen:green];

14547

# [result setBlue:blue];

14548

# if (alpha <= 0.9999) {

14549

# [result setAlpha:floatWrapperWithValue(alpha)];

14550

# }

14551

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

14561

# var redFrac = rgb_color.red || 0.0;

14562

# var greenFrac = rgb_color.green || 0.0;

14563

# var blueFrac = rgb_color.blue || 0.0;

14564

# var red = Math.floor(redFrac * 255);

14565

# var green = Math.floor(greenFrac * 255);

14566

# var blue = Math.floor(blueFrac * 255);

14567

#

14568

# if (!('alpha' in rgb_color)) {

14569

# return rgbToCssColor_(red, green, blue);

14570

# }

14571

#

14572

# var alphaFrac = rgb_color.alpha.value || 0.0;

14573

# var rgbParams = [red, green, blue].join(',');

14574

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

14575

# };

14576

#

14577

# var rgbToCssColor_ = function(red, green, blue) {

14578

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

14579

# var hexString = rgbNumber.toString(16);

14580

# var missingZeros = 6 - hexString.length;

14581

# var resultBuilder = ['#'];

14582

# for (var i = 0; i < missingZeros; i++) {

14583

# resultBuilder.push('0');

14584

# }

14585

# resultBuilder.push(hexString);

14586

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

14591

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

14592

# the final pixel color is defined by the equation:

14593

#

14594

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

14595

#

14596

# This means that a value of 1.0 corresponds to a solid color, whereas

14597

# a value of 0.0 corresponds to a completely transparent color. This

14598

# uses a wrapper message rather than a simple float scalar so that it is

14599

# possible to distinguish between a default value and the value being unset.

14600

# If omitted, this color object is to be rendered as a solid color

14601

# (as if the alpha value had been explicitly given with a value of 1.0).

14602

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

14603

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

14604

},

14605

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

14606

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

14607

"style": "A String", # The style of the border.

14608

},

14609

"right": { # A border along a cell. # The right border of the cell.

14610

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

14611

# for simplicity of conversion to/from color representations in various

14612

# languages over compactness; for example, the fields of this representation

14613

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

14614

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

14615

# method in iOS; and, with just a little work, it can be easily formatted into

14616

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

14621

#

14622

# // ...

14623

# public static java.awt.Color fromProto(Color protocolor) {

14624

# float alpha = protocolor.hasAlpha()

14625

# ? protocolor.getAlpha().getValue()

14626

# : 1.0;

14627

#

14628

# return new java.awt.Color(

14629

# protocolor.getRed(),

14630

# protocolor.getGreen(),

14631

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

14636

# float red = (float) color.getRed();

14637

# float green = (float) color.getGreen();

14638

# float blue = (float) color.getBlue();

14639

# float denominator = 255.0;

14640

# Color.Builder resultBuilder =

14641

# Color

14642

# .newBuilder()

14643

# .setRed(red / denominator)

14644

# .setGreen(green / denominator)

14645

# .setBlue(blue / denominator);

14646

# int alpha = color.getAlpha();

14647

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

14652

# .build());

14653

# }

14654

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

14659

#

14660

# // ...

14661

# static UIColor* fromProto(Color* protocolor) {

14662

# float red = [protocolor red];

14663

# float green = [protocolor green];

14664

# float blue = [protocolor blue];

14665

# FloatValue* alpha_wrapper = [protocolor alpha];

14666

# float alpha = 1.0;

14667

# if (alpha_wrapper != nil) {

14668

# alpha = [alpha_wrapper value];

14669

# }

14670

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

14671

# }

14672

#

14673

# static Color* toProto(UIColor* color) {

14674

# CGFloat red, green, blue, alpha;

14675

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

14676

# return nil;

14677

# }

14678

# Color* result = [Color alloc] init];

14679

# [result setRed:red];

14680

# [result setGreen:green];

14681

# [result setBlue:blue];

14682

# if (alpha <= 0.9999) {

14683

# [result setAlpha:floatWrapperWithValue(alpha)];

14684

# }

14685

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

14695

# var redFrac = rgb_color.red || 0.0;

14696

# var greenFrac = rgb_color.green || 0.0;

14697

# var blueFrac = rgb_color.blue || 0.0;

14698

# var red = Math.floor(redFrac * 255);

14699

# var green = Math.floor(greenFrac * 255);

14700

# var blue = Math.floor(blueFrac * 255);

14701

#

14702

# if (!('alpha' in rgb_color)) {

14703

# return rgbToCssColor_(red, green, blue);

14704

# }

14705

#

14706

# var alphaFrac = rgb_color.alpha.value || 0.0;

14707

# var rgbParams = [red, green, blue].join(',');

14708

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

14709

# };

14710

#

14711

# var rgbToCssColor_ = function(red, green, blue) {

14712

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

14713

# var hexString = rgbNumber.toString(16);

14714

# var missingZeros = 6 - hexString.length;

14715

# var resultBuilder = ['#'];

14716

# for (var i = 0; i < missingZeros; i++) {

14717

# resultBuilder.push('0');

14718

# }

14719

# resultBuilder.push(hexString);

14720

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

14725

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

14726

# the final pixel color is defined by the equation:

14727

#

14728

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

14729

#

14730

# This means that a value of 1.0 corresponds to a solid color, whereas

14731

# a value of 0.0 corresponds to a completely transparent color. This

14732

# uses a wrapper message rather than a simple float scalar so that it is

14733

# possible to distinguish between a default value and the value being unset.

14734

# If omitted, this color object is to be rendered as a solid color

14735

# (as if the alpha value had been explicitly given with a value of 1.0).

14736

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

14737

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

14738

},

14739

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

14740

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

14741

"style": "A String", # The style of the border.

14742

},

14743

"bottom": { # A border along a cell. # The bottom border of the cell.

14744

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

14745

# for simplicity of conversion to/from color representations in various

14746

# languages over compactness; for example, the fields of this representation

14747

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

14748

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

14749

# method in iOS; and, with just a little work, it can be easily formatted into

14750

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

14755

#

14756

# // ...

14757

# public static java.awt.Color fromProto(Color protocolor) {

14758

# float alpha = protocolor.hasAlpha()

14759

# ? protocolor.getAlpha().getValue()

14760

# : 1.0;

14761

#

14762

# return new java.awt.Color(

14763

# protocolor.getRed(),

14764

# protocolor.getGreen(),

14765

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

14770

# float red = (float) color.getRed();

14771

# float green = (float) color.getGreen();

14772

# float blue = (float) color.getBlue();

14773

# float denominator = 255.0;

14774

# Color.Builder resultBuilder =

14775

# Color

14776

# .newBuilder()

14777

# .setRed(red / denominator)

14778

# .setGreen(green / denominator)

14779

# .setBlue(blue / denominator);

14780

# int alpha = color.getAlpha();

14781

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

14786

# .build());

14787

# }

14788

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

14793

#

14794

# // ...

14795

# static UIColor* fromProto(Color* protocolor) {

14796

# float red = [protocolor red];

14797

# float green = [protocolor green];

14798

# float blue = [protocolor blue];

14799

# FloatValue* alpha_wrapper = [protocolor alpha];

14800

# float alpha = 1.0;

14801

# if (alpha_wrapper != nil) {

14802

# alpha = [alpha_wrapper value];

14803

# }

14804

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

14805

# }

14806

#

14807

# static Color* toProto(UIColor* color) {

14808

# CGFloat red, green, blue, alpha;

14809

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

14810

# return nil;

14811

# }

14812

# Color* result = [Color alloc] init];

14813

# [result setRed:red];

14814

# [result setGreen:green];

14815

# [result setBlue:blue];

14816

# if (alpha <= 0.9999) {

14817

# [result setAlpha:floatWrapperWithValue(alpha)];

14818

# }

14819

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

14829

# var redFrac = rgb_color.red || 0.0;

14830

# var greenFrac = rgb_color.green || 0.0;

14831

# var blueFrac = rgb_color.blue || 0.0;

14832

# var red = Math.floor(redFrac * 255);

14833

# var green = Math.floor(greenFrac * 255);

14834

# var blue = Math.floor(blueFrac * 255);

14835

#

14836

# if (!('alpha' in rgb_color)) {

14837

# return rgbToCssColor_(red, green, blue);

14838

# }

14839

#

14840

# var alphaFrac = rgb_color.alpha.value || 0.0;

14841

# var rgbParams = [red, green, blue].join(',');

14842

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

14843

# };

14844

#

14845

# var rgbToCssColor_ = function(red, green, blue) {

14846

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

14847

# var hexString = rgbNumber.toString(16);

14848

# var missingZeros = 6 - hexString.length;

14849

# var resultBuilder = ['#'];

14850

# for (var i = 0; i < missingZeros; i++) {

14851

# resultBuilder.push('0');

14852

# }

14853

# resultBuilder.push(hexString);

14854

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

14859

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

14860

# the final pixel color is defined by the equation:

14861

#

14862

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

14863

#

14864

# This means that a value of 1.0 corresponds to a solid color, whereas

14865

# a value of 0.0 corresponds to a completely transparent color. This

14866

# uses a wrapper message rather than a simple float scalar so that it is

14867

# possible to distinguish between a default value and the value being unset.

14868

# If omitted, this color object is to be rendered as a solid color

14869

# (as if the alpha value had been explicitly given with a value of 1.0).

14870

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

14871

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

14872

},

14873

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

14874

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

14875

"style": "A String", # The style of the border.

14876

},

14877

"left": { # A border along a cell. # The left border of the cell.

14878

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

14879

# for simplicity of conversion to/from color representations in various

14880

# languages over compactness; for example, the fields of this representation

14881

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

14882

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

14883

# method in iOS; and, with just a little work, it can be easily formatted into

14884

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

14889

#

14890

# // ...

14891

# public static java.awt.Color fromProto(Color protocolor) {

14892

# float alpha = protocolor.hasAlpha()

14893

# ? protocolor.getAlpha().getValue()

14894

# : 1.0;

14895

#

14896

# return new java.awt.Color(

14897

# protocolor.getRed(),

14898

# protocolor.getGreen(),

14899

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

14904

# float red = (float) color.getRed();

14905

# float green = (float) color.getGreen();

14906

# float blue = (float) color.getBlue();

14907

# float denominator = 255.0;

14908

# Color.Builder resultBuilder =

14909

# Color

14910

# .newBuilder()

14911

# .setRed(red / denominator)

14912

# .setGreen(green / denominator)

14913

# .setBlue(blue / denominator);

14914

# int alpha = color.getAlpha();

14915

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

14920

# .build());

14921

# }

14922

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

14927

#

14928

# // ...

14929

# static UIColor* fromProto(Color* protocolor) {

14930

# float red = [protocolor red];

14931

# float green = [protocolor green];

14932

# float blue = [protocolor blue];

14933

# FloatValue* alpha_wrapper = [protocolor alpha];

14934

# float alpha = 1.0;

14935

# if (alpha_wrapper != nil) {

14936

# alpha = [alpha_wrapper value];

14937

# }

14938

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

14939

# }

14940

#

14941

# static Color* toProto(UIColor* color) {

14942

# CGFloat red, green, blue, alpha;

14943

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

14944

# return nil;

14945

# }

14946

# Color* result = [Color alloc] init];

14947

# [result setRed:red];

14948

# [result setGreen:green];

14949

# [result setBlue:blue];

14950

# if (alpha <= 0.9999) {

14951

# [result setAlpha:floatWrapperWithValue(alpha)];

14952

# }

14953

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

14963

# var redFrac = rgb_color.red || 0.0;

14964

# var greenFrac = rgb_color.green || 0.0;

14965

# var blueFrac = rgb_color.blue || 0.0;

14966

# var red = Math.floor(redFrac * 255);

14967

# var green = Math.floor(greenFrac * 255);

14968

# var blue = Math.floor(blueFrac * 255);

14969

#

14970

# if (!('alpha' in rgb_color)) {

14971

# return rgbToCssColor_(red, green, blue);

14972

# }

14973

#

14974

# var alphaFrac = rgb_color.alpha.value || 0.0;

14975

# var rgbParams = [red, green, blue].join(',');

14976

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

14977

# };

14978

#

14979

# var rgbToCssColor_ = function(red, green, blue) {

14980

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

14981

# var hexString = rgbNumber.toString(16);

14982

# var missingZeros = 6 - hexString.length;

14983

# var resultBuilder = ['#'];

14984

# for (var i = 0; i < missingZeros; i++) {

14985

# resultBuilder.push('0');

14986

# }

14987

# resultBuilder.push(hexString);

14988

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

14993

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

14994

# the final pixel color is defined by the equation:

14995

#

14996

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

14997

#

14998

# This means that a value of 1.0 corresponds to a solid color, whereas

14999

# a value of 0.0 corresponds to a completely transparent color. This

15000

# uses a wrapper message rather than a simple float scalar so that it is

15001

# possible to distinguish between a default value and the value being unset.

15002

# If omitted, this color object is to be rendered as a solid color

15003

# (as if the alpha value had been explicitly given with a value of 1.0).

15004

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

15005

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

15006

},

15007

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

15008

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

15009

"style": "A String", # The style of the border.

15010

},

15011

},

15012

"wrapStrategy": "A String", # The wrap strategy for the value in the cell.

15013

},

15014

},

15015

"gradientRule": { # A rule that applies a gradient color scale format, based on # The formatting will vary based on the gradients in the rule.

15016

# the interpolation points listed. The format of a cell will vary

15017

# based on its contents as compared to the values of the interpolation

15018

# points.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

15019

"maxpoint": { # A single interpolation point on a gradient conditional format. # The final interpolation point.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

15020

# These pin the gradient color scale according to the color,

15021

# type and value chosen.

15022

"color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.

15023

# for simplicity of conversion to/from color representations in various

15024

# languages over compactness; for example, the fields of this representation

15025

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

15026

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

15027

# method in iOS; and, with just a little work, it can be easily formatted into

15028

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

15033

#

15034

# // ...

15035

# public static java.awt.Color fromProto(Color protocolor) {

15036

# float alpha = protocolor.hasAlpha()

15037

# ? protocolor.getAlpha().getValue()

15038

# : 1.0;

15039

#

15040

# return new java.awt.Color(

15041

# protocolor.getRed(),

15042

# protocolor.getGreen(),

15043

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

15048

# float red = (float) color.getRed();

15049

# float green = (float) color.getGreen();

15050

# float blue = (float) color.getBlue();

15051

# float denominator = 255.0;

15052

# Color.Builder resultBuilder =

15053

# Color

15054

# .newBuilder()

15055

# .setRed(red / denominator)

15056

# .setGreen(green / denominator)

15057

# .setBlue(blue / denominator);

15058

# int alpha = color.getAlpha();

15059

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

15064

# .build());

15065

# }

15066

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

15071

#

15072

# // ...

15073

# static UIColor* fromProto(Color* protocolor) {

15074

# float red = [protocolor red];

15075

# float green = [protocolor green];

15076

# float blue = [protocolor blue];

15077

# FloatValue* alpha_wrapper = [protocolor alpha];

15078

# float alpha = 1.0;

15079

# if (alpha_wrapper != nil) {

15080

# alpha = [alpha_wrapper value];

15081

# }

15082

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

15083

# }

15084

#

15085

# static Color* toProto(UIColor* color) {

15086

# CGFloat red, green, blue, alpha;

15087

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

15088

# return nil;

15089

# }

15090

# Color* result = [Color alloc] init];

15091

# [result setRed:red];

15092

# [result setGreen:green];

15093

# [result setBlue:blue];

15094

# if (alpha <= 0.9999) {

15095

# [result setAlpha:floatWrapperWithValue(alpha)];

15096

# }

15097

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

15107

# var redFrac = rgb_color.red || 0.0;

15108

# var greenFrac = rgb_color.green || 0.0;

15109

# var blueFrac = rgb_color.blue || 0.0;

15110

# var red = Math.floor(redFrac * 255);

15111

# var green = Math.floor(greenFrac * 255);

15112

# var blue = Math.floor(blueFrac * 255);

15113

#

15114

# if (!('alpha' in rgb_color)) {

15115

# return rgbToCssColor_(red, green, blue);

15116

# }

15117

#

15118

# var alphaFrac = rgb_color.alpha.value || 0.0;

15119

# var rgbParams = [red, green, blue].join(',');

15120

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

15121

# };

15122

#

15123

# var rgbToCssColor_ = function(red, green, blue) {

15124

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

15125

# var hexString = rgbNumber.toString(16);

15126

# var missingZeros = 6 - hexString.length;

15127

# var resultBuilder = ['#'];

15128

# for (var i = 0; i < missingZeros; i++) {

15129

# resultBuilder.push('0');

15130

# }

15131

# resultBuilder.push(hexString);

15132

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

15137

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

15138

# the final pixel color is defined by the equation:

15139

#

15140

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

15141

#

15142

# This means that a value of 1.0 corresponds to a solid color, whereas

15143

# a value of 0.0 corresponds to a completely transparent color. This

15144

# uses a wrapper message rather than a simple float scalar so that it is

15145

# possible to distinguish between a default value and the value being unset.

15146

# If omitted, this color object is to be rendered as a solid color

15147

# (as if the alpha value had been explicitly given with a value of 1.0).

15148

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

15149

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

15150

},

15151

"type": "A String", # How the value should be interpreted.

15152

"value": "A String", # The value this interpolation point uses. May be a formula.

15153

# Unused if type is MIN or

15154

# MAX.

15155

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

15156

"midpoint": { # A single interpolation point on a gradient conditional format. # An optional midway interpolation point.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

15157

# These pin the gradient color scale according to the color,

15158

# type and value chosen.

15159

"color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.

15160

# for simplicity of conversion to/from color representations in various

15161

# languages over compactness; for example, the fields of this representation

15162

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

15163

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

15164

# method in iOS; and, with just a little work, it can be easily formatted into

15165

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

15170

#

15171

# // ...

15172

# public static java.awt.Color fromProto(Color protocolor) {

15173

# float alpha = protocolor.hasAlpha()

15174

# ? protocolor.getAlpha().getValue()

15175

# : 1.0;

15176

#

15177

# return new java.awt.Color(

15178

# protocolor.getRed(),

15179

# protocolor.getGreen(),

15180

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

15185

# float red = (float) color.getRed();

15186

# float green = (float) color.getGreen();

15187

# float blue = (float) color.getBlue();

15188

# float denominator = 255.0;

15189

# Color.Builder resultBuilder =

15190

# Color

15191

# .newBuilder()

15192

# .setRed(red / denominator)

15193

# .setGreen(green / denominator)

15194

# .setBlue(blue / denominator);

15195

# int alpha = color.getAlpha();

15196

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

15201

# .build());

15202

# }

15203

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

15208

#

15209

# // ...

15210

# static UIColor* fromProto(Color* protocolor) {

15211

# float red = [protocolor red];

15212

# float green = [protocolor green];

15213

# float blue = [protocolor blue];

15214

# FloatValue* alpha_wrapper = [protocolor alpha];

15215

# float alpha = 1.0;

15216

# if (alpha_wrapper != nil) {

15217

# alpha = [alpha_wrapper value];

15218

# }

15219

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

15220

# }

15221

#

15222

# static Color* toProto(UIColor* color) {

15223

# CGFloat red, green, blue, alpha;

15224

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

15225

# return nil;

15226

# }

15227

# Color* result = [Color alloc] init];

15228

# [result setRed:red];

15229

# [result setGreen:green];

15230

# [result setBlue:blue];

15231

# if (alpha <= 0.9999) {

15232

# [result setAlpha:floatWrapperWithValue(alpha)];

15233

# }

15234

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

15244

# var redFrac = rgb_color.red || 0.0;

15245

# var greenFrac = rgb_color.green || 0.0;

15246

# var blueFrac = rgb_color.blue || 0.0;

15247

# var red = Math.floor(redFrac * 255);

15248

# var green = Math.floor(greenFrac * 255);

15249

# var blue = Math.floor(blueFrac * 255);

15250

#

15251

# if (!('alpha' in rgb_color)) {

15252

# return rgbToCssColor_(red, green, blue);

15253

# }

15254

#

15255

# var alphaFrac = rgb_color.alpha.value || 0.0;

15256

# var rgbParams = [red, green, blue].join(',');

15257

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

15258

# };

15259

#

15260

# var rgbToCssColor_ = function(red, green, blue) {

15261

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

15262

# var hexString = rgbNumber.toString(16);

15263

# var missingZeros = 6 - hexString.length;

15264

# var resultBuilder = ['#'];

15265

# for (var i = 0; i < missingZeros; i++) {

15266

# resultBuilder.push('0');

15267

# }

15268

# resultBuilder.push(hexString);

15269

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

15274

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

15275

# the final pixel color is defined by the equation:

15276

#

15277

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

15278

#

15279

# This means that a value of 1.0 corresponds to a solid color, whereas

15280

# a value of 0.0 corresponds to a completely transparent color. This

15281

# uses a wrapper message rather than a simple float scalar so that it is

15282

# possible to distinguish between a default value and the value being unset.

15283

# If omitted, this color object is to be rendered as a solid color

15284

# (as if the alpha value had been explicitly given with a value of 1.0).

15285

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

15286

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

15287

},

15288

"type": "A String", # How the value should be interpreted.

15289

"value": "A String", # The value this interpolation point uses. May be a formula.

15290

# Unused if type is MIN or

15291

# MAX.

15292

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

15293

"minpoint": { # A single interpolation point on a gradient conditional format. # The starting interpolation point.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

15294

# These pin the gradient color scale according to the color,

15295

# type and value chosen.

15296

"color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.

15297

# for simplicity of conversion to/from color representations in various

15298

# languages over compactness; for example, the fields of this representation

15299

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

15300

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

15301

# method in iOS; and, with just a little work, it can be easily formatted into

15302

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

15307

#

15308

# // ...

15309

# public static java.awt.Color fromProto(Color protocolor) {

15310

# float alpha = protocolor.hasAlpha()

15311

# ? protocolor.getAlpha().getValue()

15312

# : 1.0;

15313

#

15314

# return new java.awt.Color(

15315

# protocolor.getRed(),

15316

# protocolor.getGreen(),

15317

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

15322

# float red = (float) color.getRed();

15323

# float green = (float) color.getGreen();

15324

# float blue = (float) color.getBlue();

15325

# float denominator = 255.0;

15326

# Color.Builder resultBuilder =

15327

# Color

15328

# .newBuilder()

15329

# .setRed(red / denominator)

15330

# .setGreen(green / denominator)

15331

# .setBlue(blue / denominator);

15332

# int alpha = color.getAlpha();

15333

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

15338

# .build());

15339

# }

15340

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

15345

#

15346

# // ...

15347

# static UIColor* fromProto(Color* protocolor) {

15348

# float red = [protocolor red];

15349

# float green = [protocolor green];

15350

# float blue = [protocolor blue];

15351

# FloatValue* alpha_wrapper = [protocolor alpha];

15352

# float alpha = 1.0;

15353

# if (alpha_wrapper != nil) {

15354

# alpha = [alpha_wrapper value];

15355

# }

15356

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

15357

# }

15358

#

15359

# static Color* toProto(UIColor* color) {

15360

# CGFloat red, green, blue, alpha;

15361

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

15362

# return nil;

15363

# }

15364

# Color* result = [Color alloc] init];

15365

# [result setRed:red];

15366

# [result setGreen:green];

15367

# [result setBlue:blue];

15368

# if (alpha <= 0.9999) {

15369

# [result setAlpha:floatWrapperWithValue(alpha)];

15370

# }

15371

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

15381

# var redFrac = rgb_color.red || 0.0;

15382

# var greenFrac = rgb_color.green || 0.0;

15383

# var blueFrac = rgb_color.blue || 0.0;

15384

# var red = Math.floor(redFrac * 255);

15385

# var green = Math.floor(greenFrac * 255);

15386

# var blue = Math.floor(blueFrac * 255);

15387

#

15388

# if (!('alpha' in rgb_color)) {

15389

# return rgbToCssColor_(red, green, blue);

15390

# }

15391

#

15392

# var alphaFrac = rgb_color.alpha.value || 0.0;

15393

# var rgbParams = [red, green, blue].join(',');

15394

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

15395

# };

15396

#

15397

# var rgbToCssColor_ = function(red, green, blue) {

15398

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

15399

# var hexString = rgbNumber.toString(16);

15400

# var missingZeros = 6 - hexString.length;

15401

# var resultBuilder = ['#'];

15402

# for (var i = 0; i < missingZeros; i++) {

15403

# resultBuilder.push('0');

15404

# }

15405

# resultBuilder.push(hexString);

15406

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

15411

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

15412

# the final pixel color is defined by the equation:

15413

#

15414

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

15415

#

15416

# This means that a value of 1.0 corresponds to a solid color, whereas

15417

# a value of 0.0 corresponds to a completely transparent color. This

15418

# uses a wrapper message rather than a simple float scalar so that it is

15419

# possible to distinguish between a default value and the value being unset.

15420

# If omitted, this color object is to be rendered as a solid color

15421

# (as if the alpha value had been explicitly given with a value of 1.0).

15422

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

15423

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

15424

},

15425

"type": "A String", # How the value should be interpreted.

15426

"value": "A String", # The value this interpolation point uses. May be a formula.

15427

# Unused if type is MIN or

# MAX.

},

},

},

"newRule": { # A rule describing a conditional format. # The new rule that replaced the old rule (if replacing),

15433

# or the rule that was moved (if moved)

15434

"ranges": [ # The ranges that will be formatted if the condition is true.

15435

# All the ranges must be on the same grid.

15436

{ # A range on a sheet.

15437

# All indexes are zero-based.

15438

# Indexes are half open, e.g the start index is inclusive

15439

# and the end index is exclusive -- [start_index, end_index).

15440

# Missing indexes indicate the range is unbounded on that side.

15441

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

15442

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

15443

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

15444

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

15445

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

15446

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

15447

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

15448

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

15449

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

15450

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

15451

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

15452

# `Sheet1!A:B == sheet_id: 0,

15453

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

15454

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

15455

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

15456

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

15457

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

15458

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

15459

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

15460

#

15461

# The start index must always be less than or equal to the end index.

15462

# If the start index equals the end index, then the range is empty.

15463

# Empty ranges are typically not meaningful and are usually rendered in the

15464

# UI as `#REF!`.

15465

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

15466

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

15467

"sheetId": 42, # The sheet this range is on.

15468

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

15469

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

15470

},

15471

],

15472

"booleanRule": { # A rule that may or may not match, depending on the condition. # The formatting is either "on" or "off" according to the rule.

15473

"condition": { # A condition that can evaluate to true or false. # The condition of the rule. If the condition evaluates to true,

15474

# the format will be applied.

15475

# BooleanConditions are used by conditional formatting,

15476

# data validation, and the criteria in filters.

15477

"type": "A String", # The type of condition.

15478

"values": [ # The values of the condition. The number of supported values depends

15479

# on the condition type. Some support zero values,

15480

# others one or two values,

15481

# and ConditionType.ONE_OF_LIST supports an arbitrary number of values.

15482

{ # The value of the condition.

15483

"relativeDate": "A String", # A relative date (based on the current date).

15484

# Valid only if the type is

15485

# DATE_BEFORE,

15486

# DATE_AFTER,

15487

# DATE_ON_OR_BEFORE or

15488

# DATE_ON_OR_AFTER.

15489

#

15490

# Relative dates are not supported in data validation.

15491

# They are supported only in conditional formatting and

15492

# conditional filters.

15493

"userEnteredValue": "A String", # A value the condition is based on.

15494

# The value will be parsed as if the user typed into a cell.

15495

# Formulas are supported (and must begin with an `=`).

},

],

},

"format": { # The format of a cell. # The format to apply.

15500

# Conditional formatting can only apply a subset of formatting:

# bold, italic,

# strikethrough,

# foreground color &

# background color.

"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

15506

"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on

15507

# the user's locale will be used if necessary for the given type.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame^]

15508

# See the [Date and Number Formats guide](/sheets/guides/formats) for more

15509

# information about the supported patterns.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

15510

"type": "A String", # The type of the number format.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

15511

# When writing, this field must be set.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

15512

},

15513

"textDirection": "A String", # The direction of the text in the cell.

15514

"padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.

15515

# When updating padding, every field must be specified.

15516

"top": 42, # The top padding of the cell.

15517

"right": 42, # The right padding of the cell.

15518

"bottom": 42, # The bottom padding of the cell.

15519

"left": 42, # The left padding of the cell.

15520

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

15521

"horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

15522

"backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.

15523

# for simplicity of conversion to/from color representations in various

15524

# languages over compactness; for example, the fields of this representation

15525

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

15526

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

15527

# method in iOS; and, with just a little work, it can be easily formatted into

15528

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

15533

#

15534

# // ...

15535

# public static java.awt.Color fromProto(Color protocolor) {

15536

# float alpha = protocolor.hasAlpha()

15537

# ? protocolor.getAlpha().getValue()

15538

# : 1.0;

15539

#

15540

# return new java.awt.Color(

15541

# protocolor.getRed(),

15542

# protocolor.getGreen(),

15543

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

15548

# float red = (float) color.getRed();

15549

# float green = (float) color.getGreen();

15550

# float blue = (float) color.getBlue();

15551

# float denominator = 255.0;

15552

# Color.Builder resultBuilder =

15553

# Color

15554

# .newBuilder()

15555

# .setRed(red / denominator)

15556

# .setGreen(green / denominator)

15557

# .setBlue(blue / denominator);

15558

# int alpha = color.getAlpha();

15559

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

15564

# .build());

15565

# }

15566

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

15571

#

15572

# // ...

15573

# static UIColor* fromProto(Color* protocolor) {

15574

# float red = [protocolor red];

15575

# float green = [protocolor green];

15576

# float blue = [protocolor blue];

15577

# FloatValue* alpha_wrapper = [protocolor alpha];

15578

# float alpha = 1.0;

15579

# if (alpha_wrapper != nil) {

15580

# alpha = [alpha_wrapper value];

15581

# }

15582

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

15583

# }

15584

#

15585

# static Color* toProto(UIColor* color) {

15586

# CGFloat red, green, blue, alpha;

15587

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

15588

# return nil;

15589

# }

15590

# Color* result = [Color alloc] init];

15591

# [result setRed:red];

15592

# [result setGreen:green];

15593

# [result setBlue:blue];

15594

# if (alpha <= 0.9999) {

15595

# [result setAlpha:floatWrapperWithValue(alpha)];

15596

# }

15597

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

15607

# var redFrac = rgb_color.red || 0.0;

15608

# var greenFrac = rgb_color.green || 0.0;

15609

# var blueFrac = rgb_color.blue || 0.0;

15610

# var red = Math.floor(redFrac * 255);

15611

# var green = Math.floor(greenFrac * 255);

15612

# var blue = Math.floor(blueFrac * 255);

15613

#

15614

# if (!('alpha' in rgb_color)) {

15615

# return rgbToCssColor_(red, green, blue);

15616

# }

15617

#

15618

# var alphaFrac = rgb_color.alpha.value || 0.0;

15619

# var rgbParams = [red, green, blue].join(',');

15620

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

15621

# };

15622

#

15623

# var rgbToCssColor_ = function(red, green, blue) {

15624

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

15625

# var hexString = rgbNumber.toString(16);

15626

# var missingZeros = 6 - hexString.length;

15627

# var resultBuilder = ['#'];

15628

# for (var i = 0; i < missingZeros; i++) {

15629

# resultBuilder.push('0');

15630

# }

15631

# resultBuilder.push(hexString);

15632

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

15637

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

15638

# the final pixel color is defined by the equation:

15639

#

15640

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

15641

#

15642

# This means that a value of 1.0 corresponds to a solid color, whereas

15643

# a value of 0.0 corresponds to a completely transparent color. This

15644

# uses a wrapper message rather than a simple float scalar so that it is

15645

# possible to distinguish between a default value and the value being unset.

15646

# If omitted, this color object is to be rendered as a solid color

15647

# (as if the alpha value had been explicitly given with a value of 1.0).

15648

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

15649

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

15650

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

15651

"verticalAlignment": "A String", # The vertical alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

15652

"textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).

15653

# Absent values indicate that the field isn't specified.

15654

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

15655

# for simplicity of conversion to/from color representations in various

15656

# languages over compactness; for example, the fields of this representation

15657

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

15658

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

15659

# method in iOS; and, with just a little work, it can be easily formatted into

15660

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

15665

#

15666

# // ...

15667

# public static java.awt.Color fromProto(Color protocolor) {

15668

# float alpha = protocolor.hasAlpha()

15669

# ? protocolor.getAlpha().getValue()

15670

# : 1.0;

15671

#

15672

# return new java.awt.Color(

15673

# protocolor.getRed(),

15674

# protocolor.getGreen(),

15675

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

15680

# float red = (float) color.getRed();

15681

# float green = (float) color.getGreen();

15682

# float blue = (float) color.getBlue();

15683

# float denominator = 255.0;

15684

# Color.Builder resultBuilder =

15685

# Color

15686

# .newBuilder()

15687

# .setRed(red / denominator)

15688

# .setGreen(green / denominator)

15689

# .setBlue(blue / denominator);

15690

# int alpha = color.getAlpha();

15691

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

15696

# .build());

15697

# }

15698

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

15703

#

15704

# // ...

15705

# static UIColor* fromProto(Color* protocolor) {

15706

# float red = [protocolor red];

15707

# float green = [protocolor green];

15708

# float blue = [protocolor blue];

15709

# FloatValue* alpha_wrapper = [protocolor alpha];

15710

# float alpha = 1.0;

15711

# if (alpha_wrapper != nil) {

15712

# alpha = [alpha_wrapper value];

15713

# }

15714

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

15715

# }

15716

#

15717

# static Color* toProto(UIColor* color) {

15718

# CGFloat red, green, blue, alpha;

15719

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

15720

# return nil;

15721

# }

15722

# Color* result = [Color alloc] init];

15723

# [result setRed:red];

15724

# [result setGreen:green];

15725

# [result setBlue:blue];

15726

# if (alpha <= 0.9999) {

15727

# [result setAlpha:floatWrapperWithValue(alpha)];

15728

# }

15729

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

15739

# var redFrac = rgb_color.red || 0.0;

15740

# var greenFrac = rgb_color.green || 0.0;

15741

# var blueFrac = rgb_color.blue || 0.0;

15742

# var red = Math.floor(redFrac * 255);

15743

# var green = Math.floor(greenFrac * 255);

15744

# var blue = Math.floor(blueFrac * 255);

15745

#

15746

# if (!('alpha' in rgb_color)) {

15747

# return rgbToCssColor_(red, green, blue);

15748

# }

15749

#

15750

# var alphaFrac = rgb_color.alpha.value || 0.0;

15751

# var rgbParams = [red, green, blue].join(',');

15752

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

15753

# };

15754

#

15755

# var rgbToCssColor_ = function(red, green, blue) {

15756

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

15757

# var hexString = rgbNumber.toString(16);

15758

# var missingZeros = 6 - hexString.length;

15759

# var resultBuilder = ['#'];

15760

# for (var i = 0; i < missingZeros; i++) {

15761

# resultBuilder.push('0');

15762

# }

15763

# resultBuilder.push(hexString);

15764

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

15769

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

15770

# the final pixel color is defined by the equation:

15771

#

15772

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

15773

#

15774

# This means that a value of 1.0 corresponds to a solid color, whereas

15775

# a value of 0.0 corresponds to a completely transparent color. This

15776

# uses a wrapper message rather than a simple float scalar so that it is

15777

# possible to distinguish between a default value and the value being unset.

15778

# If omitted, this color object is to be rendered as a solid color

15779

# (as if the alpha value had been explicitly given with a value of 1.0).

15780

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

15781

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

15782

},

15783

"bold": True or False, # True if the text is bold.

15784

"strikethrough": True or False, # True if the text has a strikethrough.

15785

"fontFamily": "A String", # The font family.

15786

"fontSize": 42, # The size of the font.

15787

"italic": True or False, # True if the text is italicized.

15788

"underline": True or False, # True if the text is underlined.

15789

},

15790

"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.

15791

"borders": { # The borders of the cell. # The borders of the cell.

15792

"top": { # A border along a cell. # The top border of the cell.

15793

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

15794

# for simplicity of conversion to/from color representations in various

15795

# languages over compactness; for example, the fields of this representation

15796

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

15797

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

15798

# method in iOS; and, with just a little work, it can be easily formatted into

15799

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

15804

#

15805

# // ...

15806

# public static java.awt.Color fromProto(Color protocolor) {

15807

# float alpha = protocolor.hasAlpha()

15808

# ? protocolor.getAlpha().getValue()

15809

# : 1.0;

15810

#

15811

# return new java.awt.Color(

15812

# protocolor.getRed(),

15813

# protocolor.getGreen(),

15814

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

15819

# float red = (float) color.getRed();

15820

# float green = (float) color.getGreen();

15821

# float blue = (float) color.getBlue();

15822

# float denominator = 255.0;

15823

# Color.Builder resultBuilder =

15824

# Color

15825

# .newBuilder()

15826

# .setRed(red / denominator)

15827

# .setGreen(green / denominator)

15828

# .setBlue(blue / denominator);

15829

# int alpha = color.getAlpha();

15830

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

15835

# .build());

15836

# }

15837

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

15842

#

15843

# // ...

15844

# static UIColor* fromProto(Color* protocolor) {

15845

# float red = [protocolor red];

15846

# float green = [protocolor green];

15847

# float blue = [protocolor blue];

15848

# FloatValue* alpha_wrapper = [protocolor alpha];

15849

# float alpha = 1.0;

15850

# if (alpha_wrapper != nil) {

15851

# alpha = [alpha_wrapper value];

15852

# }

15853

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

15854

# }

15855

#

15856

# static Color* toProto(UIColor* color) {

15857

# CGFloat red, green, blue, alpha;

15858

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

15859

# return nil;

15860

# }

15861

# Color* result = [Color alloc] init];

15862

# [result setRed:red];

15863

# [result setGreen:green];

15864

# [result setBlue:blue];

15865

# if (alpha <= 0.9999) {

15866

# [result setAlpha:floatWrapperWithValue(alpha)];

15867

# }

15868

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

15878

# var redFrac = rgb_color.red || 0.0;

15879

# var greenFrac = rgb_color.green || 0.0;

15880

# var blueFrac = rgb_color.blue || 0.0;

15881

# var red = Math.floor(redFrac * 255);

15882

# var green = Math.floor(greenFrac * 255);

15883

# var blue = Math.floor(blueFrac * 255);

15884

#

15885

# if (!('alpha' in rgb_color)) {

15886

# return rgbToCssColor_(red, green, blue);

15887

# }

15888

#

15889

# var alphaFrac = rgb_color.alpha.value || 0.0;

15890

# var rgbParams = [red, green, blue].join(',');

15891

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

15892

# };

15893

#

15894

# var rgbToCssColor_ = function(red, green, blue) {

15895

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

15896

# var hexString = rgbNumber.toString(16);

15897

# var missingZeros = 6 - hexString.length;

15898

# var resultBuilder = ['#'];

15899

# for (var i = 0; i < missingZeros; i++) {

15900

# resultBuilder.push('0');

15901

# }

15902

# resultBuilder.push(hexString);

15903

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

15908

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

15909

# the final pixel color is defined by the equation:

15910

#

15911

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

15912

#

15913

# This means that a value of 1.0 corresponds to a solid color, whereas

15914

# a value of 0.0 corresponds to a completely transparent color. This

15915

# uses a wrapper message rather than a simple float scalar so that it is

15916

# possible to distinguish between a default value and the value being unset.

15917

# If omitted, this color object is to be rendered as a solid color

15918

# (as if the alpha value had been explicitly given with a value of 1.0).

15919

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

15920

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

15921

},

15922

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

15923

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

15924

"style": "A String", # The style of the border.

15925

},

15926

"right": { # A border along a cell. # The right border of the cell.

15927

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

15928

# for simplicity of conversion to/from color representations in various

15929

# languages over compactness; for example, the fields of this representation

15930

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

15931

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

15932

# method in iOS; and, with just a little work, it can be easily formatted into

15933

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

15938

#

15939

# // ...

15940

# public static java.awt.Color fromProto(Color protocolor) {

15941

# float alpha = protocolor.hasAlpha()

15942

# ? protocolor.getAlpha().getValue()

15943

# : 1.0;

15944

#

15945

# return new java.awt.Color(

15946

# protocolor.getRed(),

15947

# protocolor.getGreen(),

15948

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

15953

# float red = (float) color.getRed();

15954

# float green = (float) color.getGreen();

15955

# float blue = (float) color.getBlue();

15956

# float denominator = 255.0;

15957

# Color.Builder resultBuilder =

15958

# Color

15959

# .newBuilder()

15960

# .setRed(red / denominator)

15961

# .setGreen(green / denominator)

15962

# .setBlue(blue / denominator);

15963

# int alpha = color.getAlpha();

15964

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

15969

# .build());

15970

# }

15971

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

15976

#

15977

# // ...

15978

# static UIColor* fromProto(Color* protocolor) {

15979

# float red = [protocolor red];

15980

# float green = [protocolor green];

15981

# float blue = [protocolor blue];

15982

# FloatValue* alpha_wrapper = [protocolor alpha];

15983

# float alpha = 1.0;

15984

# if (alpha_wrapper != nil) {

15985

# alpha = [alpha_wrapper value];

15986

# }

15987

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

15988

# }

15989

#

15990

# static Color* toProto(UIColor* color) {

15991

# CGFloat red, green, blue, alpha;

15992

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

15993

# return nil;

15994

# }

15995

# Color* result = [Color alloc] init];

15996

# [result setRed:red];

15997

# [result setGreen:green];

15998

# [result setBlue:blue];

15999

# if (alpha <= 0.9999) {

16000

# [result setAlpha:floatWrapperWithValue(alpha)];

16001

# }

16002

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

16012

# var redFrac = rgb_color.red || 0.0;

16013

# var greenFrac = rgb_color.green || 0.0;

16014

# var blueFrac = rgb_color.blue || 0.0;

16015

# var red = Math.floor(redFrac * 255);

16016

# var green = Math.floor(greenFrac * 255);

16017

# var blue = Math.floor(blueFrac * 255);

16018

#

16019

# if (!('alpha' in rgb_color)) {

16020

# return rgbToCssColor_(red, green, blue);

16021

# }

16022

#

16023

# var alphaFrac = rgb_color.alpha.value || 0.0;

16024

# var rgbParams = [red, green, blue].join(',');

16025

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

16026

# };

16027

#

16028

# var rgbToCssColor_ = function(red, green, blue) {

16029

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

16030

# var hexString = rgbNumber.toString(16);

16031

# var missingZeros = 6 - hexString.length;

16032

# var resultBuilder = ['#'];

16033

# for (var i = 0; i < missingZeros; i++) {

16034

# resultBuilder.push('0');

16035

# }

16036

# resultBuilder.push(hexString);

16037

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

16042

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

16043

# the final pixel color is defined by the equation:

16044

#

16045

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

16046

#

16047

# This means that a value of 1.0 corresponds to a solid color, whereas

16048

# a value of 0.0 corresponds to a completely transparent color. This

16049

# uses a wrapper message rather than a simple float scalar so that it is

16050

# possible to distinguish between a default value and the value being unset.

16051

# If omitted, this color object is to be rendered as a solid color

16052

# (as if the alpha value had been explicitly given with a value of 1.0).

16053

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

16054

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

16055

},

16056

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

16057

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

16058

"style": "A String", # The style of the border.

16059

},

16060

"bottom": { # A border along a cell. # The bottom border of the cell.

16061

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

16062

# for simplicity of conversion to/from color representations in various

16063

# languages over compactness; for example, the fields of this representation

16064

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

16065

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

16066

# method in iOS; and, with just a little work, it can be easily formatted into

16067

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

16072

#

16073

# // ...

16074

# public static java.awt.Color fromProto(Color protocolor) {

16075

# float alpha = protocolor.hasAlpha()

16076

# ? protocolor.getAlpha().getValue()

16077

# : 1.0;

16078

#

16079

# return new java.awt.Color(

16080

# protocolor.getRed(),

16081

# protocolor.getGreen(),

16082

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

16087

# float red = (float) color.getRed();

16088

# float green = (float) color.getGreen();

16089

# float blue = (float) color.getBlue();

16090

# float denominator = 255.0;

16091

# Color.Builder resultBuilder =

16092

# Color

16093

# .newBuilder()

16094

# .setRed(red / denominator)

16095

# .setGreen(green / denominator)

16096

# .setBlue(blue / denominator);

16097

# int alpha = color.getAlpha();

16098

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

16103

# .build());

16104

# }

16105

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

16110

#

16111

# // ...

16112

# static UIColor* fromProto(Color* protocolor) {

16113

# float red = [protocolor red];

16114

# float green = [protocolor green];

16115

# float blue = [protocolor blue];

16116

# FloatValue* alpha_wrapper = [protocolor alpha];

16117

# float alpha = 1.0;

16118

# if (alpha_wrapper != nil) {

16119

# alpha = [alpha_wrapper value];

16120

# }

16121

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

16122

# }

16123

#

16124

# static Color* toProto(UIColor* color) {

16125

# CGFloat red, green, blue, alpha;

16126

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

16127

# return nil;

16128

# }

16129

# Color* result = [Color alloc] init];

16130

# [result setRed:red];

16131

# [result setGreen:green];

16132

# [result setBlue:blue];

16133

# if (alpha <= 0.9999) {

16134

# [result setAlpha:floatWrapperWithValue(alpha)];

16135

# }

16136

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

16146

# var redFrac = rgb_color.red || 0.0;

16147

# var greenFrac = rgb_color.green || 0.0;

16148

# var blueFrac = rgb_color.blue || 0.0;

16149

# var red = Math.floor(redFrac * 255);

16150

# var green = Math.floor(greenFrac * 255);

16151

# var blue = Math.floor(blueFrac * 255);

16152

#

16153

# if (!('alpha' in rgb_color)) {

16154

# return rgbToCssColor_(red, green, blue);

16155

# }

16156

#

16157

# var alphaFrac = rgb_color.alpha.value || 0.0;

16158

# var rgbParams = [red, green, blue].join(',');

16159

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

16160

# };

16161

#

16162

# var rgbToCssColor_ = function(red, green, blue) {

16163

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

16164

# var hexString = rgbNumber.toString(16);

16165

# var missingZeros = 6 - hexString.length;

16166

# var resultBuilder = ['#'];

16167

# for (var i = 0; i < missingZeros; i++) {

16168

# resultBuilder.push('0');

16169

# }

16170

# resultBuilder.push(hexString);

16171

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

16176

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

16177

# the final pixel color is defined by the equation:

16178

#

16179

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

16180

#

16181

# This means that a value of 1.0 corresponds to a solid color, whereas

16182

# a value of 0.0 corresponds to a completely transparent color. This

16183

# uses a wrapper message rather than a simple float scalar so that it is

16184

# possible to distinguish between a default value and the value being unset.

16185

# If omitted, this color object is to be rendered as a solid color

16186

# (as if the alpha value had been explicitly given with a value of 1.0).

16187

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

16188

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

16189

},

16190

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

16191

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

16192

"style": "A String", # The style of the border.

16193

},

16194

"left": { # A border along a cell. # The left border of the cell.

16195

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

16196

# for simplicity of conversion to/from color representations in various

16197

# languages over compactness; for example, the fields of this representation

16198

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

16199

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

16200

# method in iOS; and, with just a little work, it can be easily formatted into

16201

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

16206

#

16207

# // ...

16208

# public static java.awt.Color fromProto(Color protocolor) {

16209

# float alpha = protocolor.hasAlpha()

16210

# ? protocolor.getAlpha().getValue()

16211

# : 1.0;

16212

#

16213

# return new java.awt.Color(

16214

# protocolor.getRed(),

16215

# protocolor.getGreen(),

16216

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

16221

# float red = (float) color.getRed();

16222

# float green = (float) color.getGreen();

16223

# float blue = (float) color.getBlue();

16224

# float denominator = 255.0;

16225

# Color.Builder resultBuilder =

16226

# Color

16227

# .newBuilder()

16228

# .setRed(red / denominator)

16229

# .setGreen(green / denominator)

16230

# .setBlue(blue / denominator);

16231

# int alpha = color.getAlpha();

16232

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

16237

# .build());

16238

# }

16239

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

16244

#

16245

# // ...

16246

# static UIColor* fromProto(Color* protocolor) {

16247

# float red = [protocolor red];

16248

# float green = [protocolor green];

16249

# float blue = [protocolor blue];

16250

# FloatValue* alpha_wrapper = [protocolor alpha];

16251

# float alpha = 1.0;

16252

# if (alpha_wrapper != nil) {

16253

# alpha = [alpha_wrapper value];

16254

# }

16255

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

16256

# }

16257

#

16258

# static Color* toProto(UIColor* color) {

16259

# CGFloat red, green, blue, alpha;

16260

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

16261

# return nil;

16262

# }

16263

# Color* result = [Color alloc] init];

16264

# [result setRed:red];

16265

# [result setGreen:green];

16266

# [result setBlue:blue];

16267

# if (alpha <= 0.9999) {

16268

# [result setAlpha:floatWrapperWithValue(alpha)];

16269

# }

16270

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

16280

# var redFrac = rgb_color.red || 0.0;

16281

# var greenFrac = rgb_color.green || 0.0;

16282

# var blueFrac = rgb_color.blue || 0.0;

16283

# var red = Math.floor(redFrac * 255);

16284

# var green = Math.floor(greenFrac * 255);

16285

# var blue = Math.floor(blueFrac * 255);

16286

#

16287

# if (!('alpha' in rgb_color)) {

16288

# return rgbToCssColor_(red, green, blue);

16289

# }

16290

#

16291

# var alphaFrac = rgb_color.alpha.value || 0.0;

16292

# var rgbParams = [red, green, blue].join(',');

16293

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

16294

# };

16295

#

16296

# var rgbToCssColor_ = function(red, green, blue) {

16297

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

16298

# var hexString = rgbNumber.toString(16);

16299

# var missingZeros = 6 - hexString.length;

16300

# var resultBuilder = ['#'];

16301

# for (var i = 0; i < missingZeros; i++) {

16302

# resultBuilder.push('0');

16303

# }

16304

# resultBuilder.push(hexString);

16305

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

16310

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

16311

# the final pixel color is defined by the equation:

16312

#

16313

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

16314

#

16315

# This means that a value of 1.0 corresponds to a solid color, whereas

16316

# a value of 0.0 corresponds to a completely transparent color. This

16317

# uses a wrapper message rather than a simple float scalar so that it is

16318

# possible to distinguish between a default value and the value being unset.

16319

# If omitted, this color object is to be rendered as a solid color

16320

# (as if the alpha value had been explicitly given with a value of 1.0).

16321

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

16322

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

16323

},

16324

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

16325

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

16326

"style": "A String", # The style of the border.

16327

},

16328

},

16329

"wrapStrategy": "A String", # The wrap strategy for the value in the cell.

16330

},

16331

},

16332

"gradientRule": { # A rule that applies a gradient color scale format, based on # The formatting will vary based on the gradients in the rule.

16333

# the interpolation points listed. The format of a cell will vary

16334

# based on its contents as compared to the values of the interpolation

16335

# points.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

16336

"maxpoint": { # A single interpolation point on a gradient conditional format. # The final interpolation point.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

16337

# These pin the gradient color scale according to the color,

16338

# type and value chosen.

16339

"color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.

16340

# for simplicity of conversion to/from color representations in various

16341

# languages over compactness; for example, the fields of this representation

16342

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

16343

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

16344

# method in iOS; and, with just a little work, it can be easily formatted into

16345

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

16350

#

16351

# // ...

16352

# public static java.awt.Color fromProto(Color protocolor) {

16353

# float alpha = protocolor.hasAlpha()

16354

# ? protocolor.getAlpha().getValue()

16355

# : 1.0;

16356

#

16357

# return new java.awt.Color(

16358

# protocolor.getRed(),

16359

# protocolor.getGreen(),

16360

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

16365

# float red = (float) color.getRed();

16366

# float green = (float) color.getGreen();

16367

# float blue = (float) color.getBlue();

16368

# float denominator = 255.0;

16369

# Color.Builder resultBuilder =

16370

# Color

16371

# .newBuilder()

16372

# .setRed(red / denominator)

16373

# .setGreen(green / denominator)

16374

# .setBlue(blue / denominator);

16375

# int alpha = color.getAlpha();

16376

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

16381

# .build());

16382

# }

16383

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

16388

#

16389

# // ...

16390

# static UIColor* fromProto(Color* protocolor) {

16391

# float red = [protocolor red];

16392

# float green = [protocolor green];

16393

# float blue = [protocolor blue];

16394

# FloatValue* alpha_wrapper = [protocolor alpha];

16395

# float alpha = 1.0;

16396

# if (alpha_wrapper != nil) {

16397

# alpha = [alpha_wrapper value];

16398

# }

16399

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

16400

# }

16401

#

16402

# static Color* toProto(UIColor* color) {

16403

# CGFloat red, green, blue, alpha;

16404

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

16405

# return nil;

16406

# }

16407

# Color* result = [Color alloc] init];

16408

# [result setRed:red];

16409

# [result setGreen:green];

16410

# [result setBlue:blue];

16411

# if (alpha <= 0.9999) {

16412

# [result setAlpha:floatWrapperWithValue(alpha)];

16413

# }

16414

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

16424

# var redFrac = rgb_color.red || 0.0;

16425

# var greenFrac = rgb_color.green || 0.0;

16426

# var blueFrac = rgb_color.blue || 0.0;

16427

# var red = Math.floor(redFrac * 255);

16428

# var green = Math.floor(greenFrac * 255);

16429

# var blue = Math.floor(blueFrac * 255);

16430

#

16431

# if (!('alpha' in rgb_color)) {

16432

# return rgbToCssColor_(red, green, blue);

16433

# }

16434

#

16435

# var alphaFrac = rgb_color.alpha.value || 0.0;

16436

# var rgbParams = [red, green, blue].join(',');

16437

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

16438

# };

16439

#

16440

# var rgbToCssColor_ = function(red, green, blue) {

16441

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

16442

# var hexString = rgbNumber.toString(16);

16443

# var missingZeros = 6 - hexString.length;

16444

# var resultBuilder = ['#'];

16445

# for (var i = 0; i < missingZeros; i++) {

16446

# resultBuilder.push('0');

16447

# }

16448

# resultBuilder.push(hexString);

16449

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

16454

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

16455

# the final pixel color is defined by the equation:

16456

#

16457

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

16458

#

16459

# This means that a value of 1.0 corresponds to a solid color, whereas

16460

# a value of 0.0 corresponds to a completely transparent color. This

16461

# uses a wrapper message rather than a simple float scalar so that it is

16462

# possible to distinguish between a default value and the value being unset.

16463

# If omitted, this color object is to be rendered as a solid color

16464

# (as if the alpha value had been explicitly given with a value of 1.0).

16465

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

16466

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

16467

},

16468

"type": "A String", # How the value should be interpreted.

16469

"value": "A String", # The value this interpolation point uses. May be a formula.

16470

# Unused if type is MIN or

16471

# MAX.

16472

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

16473

"midpoint": { # A single interpolation point on a gradient conditional format. # An optional midway interpolation point.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

16474

# These pin the gradient color scale according to the color,

16475

# type and value chosen.

16476

"color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.

16477

# for simplicity of conversion to/from color representations in various

16478

# languages over compactness; for example, the fields of this representation

16479

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

16480

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

16481

# method in iOS; and, with just a little work, it can be easily formatted into

16482

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

16487

#

16488

# // ...

16489

# public static java.awt.Color fromProto(Color protocolor) {

16490

# float alpha = protocolor.hasAlpha()

16491

# ? protocolor.getAlpha().getValue()

16492

# : 1.0;

16493

#

16494

# return new java.awt.Color(

16495

# protocolor.getRed(),

16496

# protocolor.getGreen(),

16497

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

16502

# float red = (float) color.getRed();

16503

# float green = (float) color.getGreen();

16504

# float blue = (float) color.getBlue();

16505

# float denominator = 255.0;

16506

# Color.Builder resultBuilder =

16507

# Color

16508

# .newBuilder()

16509

# .setRed(red / denominator)

16510

# .setGreen(green / denominator)

16511

# .setBlue(blue / denominator);

16512

# int alpha = color.getAlpha();

16513

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

16518

# .build());

16519

# }

16520

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

16525

#

16526

# // ...

16527

# static UIColor* fromProto(Color* protocolor) {

16528

# float red = [protocolor red];

16529

# float green = [protocolor green];

16530

# float blue = [protocolor blue];

16531

# FloatValue* alpha_wrapper = [protocolor alpha];

16532

# float alpha = 1.0;

16533

# if (alpha_wrapper != nil) {

16534

# alpha = [alpha_wrapper value];

16535

# }

16536

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

16537

# }

16538

#

16539

# static Color* toProto(UIColor* color) {

16540

# CGFloat red, green, blue, alpha;

16541

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

16542

# return nil;

16543

# }

16544

# Color* result = [Color alloc] init];

16545

# [result setRed:red];

16546

# [result setGreen:green];

16547

# [result setBlue:blue];

16548

# if (alpha <= 0.9999) {

16549

# [result setAlpha:floatWrapperWithValue(alpha)];

16550

# }

16551

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

16561

# var redFrac = rgb_color.red || 0.0;

16562

# var greenFrac = rgb_color.green || 0.0;

16563

# var blueFrac = rgb_color.blue || 0.0;

16564

# var red = Math.floor(redFrac * 255);

16565

# var green = Math.floor(greenFrac * 255);

16566

# var blue = Math.floor(blueFrac * 255);

16567

#

16568

# if (!('alpha' in rgb_color)) {

16569

# return rgbToCssColor_(red, green, blue);

16570

# }

16571

#

16572

# var alphaFrac = rgb_color.alpha.value || 0.0;

16573

# var rgbParams = [red, green, blue].join(',');

16574

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

16575

# };

16576

#

16577

# var rgbToCssColor_ = function(red, green, blue) {

16578

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

16579

# var hexString = rgbNumber.toString(16);

16580

# var missingZeros = 6 - hexString.length;

16581

# var resultBuilder = ['#'];

16582

# for (var i = 0; i < missingZeros; i++) {

16583

# resultBuilder.push('0');

16584

# }

16585

# resultBuilder.push(hexString);

16586

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

16591

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

16592

# the final pixel color is defined by the equation:

16593

#

16594

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

16595

#

16596

# This means that a value of 1.0 corresponds to a solid color, whereas

16597

# a value of 0.0 corresponds to a completely transparent color. This

16598

# uses a wrapper message rather than a simple float scalar so that it is

16599

# possible to distinguish between a default value and the value being unset.

16600

# If omitted, this color object is to be rendered as a solid color

16601

# (as if the alpha value had been explicitly given with a value of 1.0).

16602

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

16603

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

16604

},

16605

"type": "A String", # How the value should be interpreted.

16606

"value": "A String", # The value this interpolation point uses. May be a formula.

16607

# Unused if type is MIN or

16608

# MAX.

16609

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

16610

"minpoint": { # A single interpolation point on a gradient conditional format. # The starting interpolation point.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

16611

# These pin the gradient color scale according to the color,

16612

# type and value chosen.

16613

"color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.

16614

# for simplicity of conversion to/from color representations in various

16615

# languages over compactness; for example, the fields of this representation

16616

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

16617

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

16618

# method in iOS; and, with just a little work, it can be easily formatted into

16619

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

16624

#

16625

# // ...

16626

# public static java.awt.Color fromProto(Color protocolor) {

16627

# float alpha = protocolor.hasAlpha()

16628

# ? protocolor.getAlpha().getValue()

16629

# : 1.0;

16630

#

16631

# return new java.awt.Color(

16632

# protocolor.getRed(),

16633

# protocolor.getGreen(),

16634

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

16639

# float red = (float) color.getRed();

16640

# float green = (float) color.getGreen();

16641

# float blue = (float) color.getBlue();

16642

# float denominator = 255.0;

16643

# Color.Builder resultBuilder =

16644

# Color

16645

# .newBuilder()

16646

# .setRed(red / denominator)

16647

# .setGreen(green / denominator)

16648

# .setBlue(blue / denominator);

16649

# int alpha = color.getAlpha();

16650

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

16655

# .build());

16656

# }

16657

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

16662

#

16663

# // ...

16664

# static UIColor* fromProto(Color* protocolor) {

16665

# float red = [protocolor red];

16666

# float green = [protocolor green];

16667

# float blue = [protocolor blue];

16668

# FloatValue* alpha_wrapper = [protocolor alpha];

16669

# float alpha = 1.0;

16670

# if (alpha_wrapper != nil) {

16671

# alpha = [alpha_wrapper value];

16672

# }

16673

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

16674

# }

16675

#

16676

# static Color* toProto(UIColor* color) {

16677

# CGFloat red, green, blue, alpha;

16678

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

16679

# return nil;

16680

# }

16681

# Color* result = [Color alloc] init];

16682

# [result setRed:red];

16683

# [result setGreen:green];

16684

# [result setBlue:blue];

16685

# if (alpha <= 0.9999) {

16686

# [result setAlpha:floatWrapperWithValue(alpha)];

16687

# }

16688

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

16698

# var redFrac = rgb_color.red || 0.0;

16699

# var greenFrac = rgb_color.green || 0.0;

16700

# var blueFrac = rgb_color.blue || 0.0;

16701

# var red = Math.floor(redFrac * 255);

16702

# var green = Math.floor(greenFrac * 255);

16703

# var blue = Math.floor(blueFrac * 255);

16704

#

16705

# if (!('alpha' in rgb_color)) {

16706

# return rgbToCssColor_(red, green, blue);

16707

# }

16708

#

16709

# var alphaFrac = rgb_color.alpha.value || 0.0;

16710

# var rgbParams = [red, green, blue].join(',');

16711

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

16712

# };

16713

#

16714

# var rgbToCssColor_ = function(red, green, blue) {

16715

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

16716

# var hexString = rgbNumber.toString(16);

16717

# var missingZeros = 6 - hexString.length;

16718

# var resultBuilder = ['#'];

16719

# for (var i = 0; i < missingZeros; i++) {

16720

# resultBuilder.push('0');

16721

# }

16722

# resultBuilder.push(hexString);

16723

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

16728

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

16729

# the final pixel color is defined by the equation:

16730

#

16731

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

16732

#

16733

# This means that a value of 1.0 corresponds to a solid color, whereas

16734

# a value of 0.0 corresponds to a completely transparent color. This

16735

# uses a wrapper message rather than a simple float scalar so that it is

16736

# possible to distinguish between a default value and the value being unset.

16737

# If omitted, this color object is to be rendered as a solid color

16738

# (as if the alpha value had been explicitly given with a value of 1.0).

16739

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

16740

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

16741

},

16742

"type": "A String", # How the value should be interpreted.

16743

"value": "A String", # The value this interpolation point uses. May be a formula.

16744

# Unused if type is MIN or

# MAX.

},

},

},

},

"addSheet": { # The result of adding a sheet. # A reply from adding a sheet.

16751

"properties": { # Properties of a sheet. # The properties of the newly added sheet.

16752

"sheetType": "A String", # The type of sheet. Defaults to GRID.

16753

# This field cannot be changed once set.

16754

"index": 42, # The index of the sheet within the spreadsheet.

16755

# When adding or updating sheet properties, if this field

16756

# is excluded then the sheet will be added or moved to the end

16757

# of the sheet list.

16758

"title": "A String", # The name of the sheet.

16759

"gridProperties": { # Properties of a grid. # Additional properties of the sheet if this sheet is a grid.

16760

# (If the sheet is an object sheet, containing a chart or image, then

16761

# this field will be absent.)

16762

# When writing it is an error to set any grid properties on non-grid sheets.

16763

"columnCount": 42, # The number of columns in the grid.

16764

"rowCount": 42, # The number of rows in the grid.

16765

"frozenColumnCount": 42, # The number of columns that are frozen in the grid.

16766

"hideGridlines": True or False, # True if the grid isn't showing gridlines in the UI.

16767

"frozenRowCount": 42, # The number of rows that are frozen in the grid.

16768

},

16769

"rightToLeft": True or False, # True if the sheet is an RTL sheet instead of an LTR sheet.

16770

"tabColor": { # Represents a color in the RGBA color space. This representation is designed # The color of the tab in the UI.

16771

# for simplicity of conversion to/from color representations in various

16772

# languages over compactness; for example, the fields of this representation

16773

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

16774

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

16775

# method in iOS; and, with just a little work, it can be easily formatted into

16776

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

16781

#

16782

# // ...

16783

# public static java.awt.Color fromProto(Color protocolor) {

16784

# float alpha = protocolor.hasAlpha()

16785

# ? protocolor.getAlpha().getValue()

16786

# : 1.0;

16787

#

16788

# return new java.awt.Color(

16789

# protocolor.getRed(),

16790

# protocolor.getGreen(),

16791

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

16796

# float red = (float) color.getRed();

16797

# float green = (float) color.getGreen();

16798

# float blue = (float) color.getBlue();

16799

# float denominator = 255.0;

16800

# Color.Builder resultBuilder =

16801

# Color

16802

# .newBuilder()

16803

# .setRed(red / denominator)

16804

# .setGreen(green / denominator)

16805

# .setBlue(blue / denominator);

16806

# int alpha = color.getAlpha();

16807

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

16812

# .build());

16813

# }

16814

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

16819

#

16820

# // ...

16821

# static UIColor* fromProto(Color* protocolor) {

16822

# float red = [protocolor red];

16823

# float green = [protocolor green];

16824

# float blue = [protocolor blue];

16825

# FloatValue* alpha_wrapper = [protocolor alpha];

16826

# float alpha = 1.0;

16827

# if (alpha_wrapper != nil) {

16828

# alpha = [alpha_wrapper value];

16829

# }

16830

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

16831

# }

16832

#

16833

# static Color* toProto(UIColor* color) {

16834

# CGFloat red, green, blue, alpha;

16835

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

16836

# return nil;

16837

# }

16838

# Color* result = [Color alloc] init];

16839

# [result setRed:red];

16840

# [result setGreen:green];

16841

# [result setBlue:blue];

16842

# if (alpha <= 0.9999) {

16843

# [result setAlpha:floatWrapperWithValue(alpha)];

16844

# }

16845

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

16855

# var redFrac = rgb_color.red || 0.0;

16856

# var greenFrac = rgb_color.green || 0.0;

16857

# var blueFrac = rgb_color.blue || 0.0;

16858

# var red = Math.floor(redFrac * 255);

16859

# var green = Math.floor(greenFrac * 255);

16860

# var blue = Math.floor(blueFrac * 255);

16861

#

16862

# if (!('alpha' in rgb_color)) {

16863

# return rgbToCssColor_(red, green, blue);

16864

# }

16865

#

16866

# var alphaFrac = rgb_color.alpha.value || 0.0;

16867

# var rgbParams = [red, green, blue].join(',');

16868

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

16869

# };

16870

#

16871

# var rgbToCssColor_ = function(red, green, blue) {

16872

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

16873

# var hexString = rgbNumber.toString(16);

16874

# var missingZeros = 6 - hexString.length;

16875

# var resultBuilder = ['#'];

16876

# for (var i = 0; i < missingZeros; i++) {

16877

# resultBuilder.push('0');

16878

# }

16879

# resultBuilder.push(hexString);

16880

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

16885

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

16886

# the final pixel color is defined by the equation:

16887

#

16888

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

16889

#

16890

# This means that a value of 1.0 corresponds to a solid color, whereas

16891

# a value of 0.0 corresponds to a completely transparent color. This

16892

# uses a wrapper message rather than a simple float scalar so that it is

16893

# possible to distinguish between a default value and the value being unset.

16894

# If omitted, this color object is to be rendered as a solid color

16895

# (as if the alpha value had been explicitly given with a value of 1.0).

16896

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

16897

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

16898

},

16899

"hidden": True or False, # True if the sheet is hidden in the UI, false if it's visible.

16900

"sheetId": 42, # The ID of the sheet. Must be non-negative.

16901

# This field cannot be changed once set.

16902

},

16903

},

16904

"findReplace": { # The result of the find/replace. # A reply from doing a find/replace.

16905

"occurrencesChanged": 42, # The number of occurrences (possibly multiple within a cell) changed.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

16906

# For example, if replacing `"e"` with `"o"` in `"Google Sheets"`, this would

16907

# be `"3"` because `"Google Sheets"` -> `"Googlo Shoots"`.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

16908

"sheetsChanged": 42, # The number of sheets changed.

16909

"rowsChanged": 42, # The number of rows changed.

16910

"valuesChanged": 42, # The number of non-formula cells changed.

16911

"formulasChanged": 42, # The number of formula cells changed.

16912

},

16913

"addNamedRange": { # The result of adding a named range. # A reply from adding a named range.

16914

"namedRange": { # A named range. # The named range to add.

16915

"namedRangeId": "A String", # The ID of the named range.

16916

"range": { # A range on a sheet. # The range this represents.

16917

# All indexes are zero-based.

16918

# Indexes are half open, e.g the start index is inclusive

16919

# and the end index is exclusive -- [start_index, end_index).

16920

# Missing indexes indicate the range is unbounded on that side.

16921

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

16922

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

16923

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

16924

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

16925

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

16926

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

16927

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

16928

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

16929

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

16930

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

16931

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

16932

# `Sheet1!A:B == sheet_id: 0,

16933

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

16934

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

16935

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

16936

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

16937

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

16938

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

16939

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

16940

#

16941

# The start index must always be less than or equal to the end index.

16942

# If the start index equals the end index, then the range is empty.

16943

# Empty ranges are typically not meaningful and are usually rendered in the

16944

# UI as `#REF!`.

16945

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

16946

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

16947

"sheetId": 42, # The sheet this range is on.

16948

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

16949

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

16950

},

16951

"name": "A String", # The name of the named range.

16952

},

16953

},

16954

"addProtectedRange": { # The result of adding a new protected range. # A reply from adding a protected range.

16955

"protectedRange": { # A protected range. # The newly added protected range.

16956

"unprotectedRanges": [ # The list of unprotected ranges within a protected sheet.

16957

# Unprotected ranges are only supported on protected sheets.

16958

{ # A range on a sheet.

16959

# All indexes are zero-based.

16960

# Indexes are half open, e.g the start index is inclusive

16961

# and the end index is exclusive -- [start_index, end_index).

16962

# Missing indexes indicate the range is unbounded on that side.

16963

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

16964

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

16965

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

16966

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

16967

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

16968

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

16969

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

16970

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

16971

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

16972

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

16973

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

16974

# `Sheet1!A:B == sheet_id: 0,

16975

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

16976

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

16977

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

16978

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

16979

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

16980

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

16981

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

16982

#

16983

# The start index must always be less than or equal to the end index.

16984

# If the start index equals the end index, then the range is empty.

16985

# Empty ranges are typically not meaningful and are usually rendered in the

16986

# UI as `#REF!`.

16987

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

16988

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

16989

"sheetId": 42, # The sheet this range is on.

16990

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

16991

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

16992

},

16993

],

16994

"requestingUserCanEdit": True or False, # True if the user who requested this protected range can edit the

16995

# protected area.

16996

# This field is read-only.

16997

"description": "A String", # The description of this protected range.

16998

"namedRangeId": "A String", # The named range this protected range is backed by, if any.

16999

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17000

# When writing, only one of range or named_range_id

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17001

# may be set.

17002

"editors": { # The editors of a protected range. # The users and groups with edit access to the protected range.

17003

# This field is only visible to users with edit access to the protected

17004

# range and the document.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17005

# Editors are not supported with warning_only protection.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17006

"domainUsersCanEdit": True or False, # True if anyone in the document's domain has edit access to the protected

17007

# range. Domain protection is only supported on documents within a domain.

17008

"users": [ # The email addresses of users with edit access to the protected range.

17009

"A String",

17010

],

17011

"groups": [ # The email addresses of groups with edit access to the protected range.

"A String",

],

},

"protectedRangeId": 42, # The ID of the protected range.

17016

# This field is read-only.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17017

"warningOnly": True or False, # True if this protected range will show a warning when editing.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17018

# Warning-based protection means that every user can edit data in the

17019

# protected range, except editing will prompt a warning asking the user

17020

# to confirm the edit.

17021

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17022

# When writing: if this field is true, then editors is ignored.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17023

# Additionally, if this field is changed from true to false and the

17024

# `editors` field is not set (nor included in the field mask), then

17025

# the editors will be set to all the editors in the document.

17026

"range": { # A range on a sheet. # The range that is being protected.

17027

# The range may be fully unbounded, in which case this is considered

17028

# a protected sheet.

17029

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17030

# When writing, only one of range or named_range_id

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17031

# may be set.

17032

# All indexes are zero-based.

17033

# Indexes are half open, e.g the start index is inclusive

17034

# and the end index is exclusive -- [start_index, end_index).

17035

# Missing indexes indicate the range is unbounded on that side.

17036

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17037

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17038

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17039

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17040

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17041

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17042

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17043

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17044

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17045

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17046

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17047

# `Sheet1!A:B == sheet_id: 0,

17048

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17049

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17050

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17051

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17052

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17053

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17054

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17055

#

17056

# The start index must always be less than or equal to the end index.

17057

# If the start index equals the end index, then the range is empty.

17058

# Empty ranges are typically not meaningful and are usually rendered in the

17059

# UI as `#REF!`.

17060

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

17061

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

17062

"sheetId": 42, # The sheet this range is on.

17063

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

17064

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

},

},

"deleteConditionalFormatRule": { # The result of deleting a conditional format rule. # A reply from deleting a conditional format rule.

17069

"rule": { # A rule describing a conditional format. # The rule that was deleted.

17070

"ranges": [ # The ranges that will be formatted if the condition is true.

17071

# All the ranges must be on the same grid.

17072

{ # A range on a sheet.

17073

# All indexes are zero-based.

17074

# Indexes are half open, e.g the start index is inclusive

17075

# and the end index is exclusive -- [start_index, end_index).

17076

# Missing indexes indicate the range is unbounded on that side.

17077

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17078

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17079

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17080

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17081

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17082

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17083

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17084

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17085

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17086

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17087

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17088

# `Sheet1!A:B == sheet_id: 0,

17089

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17090

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17091

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17092

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17093

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17094

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17095

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17096

#

17097

# The start index must always be less than or equal to the end index.

17098

# If the start index equals the end index, then the range is empty.

17099

# Empty ranges are typically not meaningful and are usually rendered in the

17100

# UI as `#REF!`.

17101

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

17102

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

17103

"sheetId": 42, # The sheet this range is on.

17104

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

17105

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

17106

},

17107

],

17108

"booleanRule": { # A rule that may or may not match, depending on the condition. # The formatting is either "on" or "off" according to the rule.

17109

"condition": { # A condition that can evaluate to true or false. # The condition of the rule. If the condition evaluates to true,

17110

# the format will be applied.

17111

# BooleanConditions are used by conditional formatting,

17112

# data validation, and the criteria in filters.

17113

"type": "A String", # The type of condition.

17114

"values": [ # The values of the condition. The number of supported values depends

17115

# on the condition type. Some support zero values,

17116

# others one or two values,

17117

# and ConditionType.ONE_OF_LIST supports an arbitrary number of values.

17118

{ # The value of the condition.

17119

"relativeDate": "A String", # A relative date (based on the current date).

17120

# Valid only if the type is

17121

# DATE_BEFORE,

17122

# DATE_AFTER,

17123

# DATE_ON_OR_BEFORE or

17124

# DATE_ON_OR_AFTER.

17125

#

17126

# Relative dates are not supported in data validation.

17127

# They are supported only in conditional formatting and

17128

# conditional filters.

17129

"userEnteredValue": "A String", # A value the condition is based on.

17130

# The value will be parsed as if the user typed into a cell.

17131

# Formulas are supported (and must begin with an `=`).

},

],

},

"format": { # The format of a cell. # The format to apply.

17136

# Conditional formatting can only apply a subset of formatting:

# bold, italic,

# strikethrough,

# foreground color &

# background color.

"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17142

"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on

17143

# the user's locale will be used if necessary for the given type.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame^]

17144

# See the [Date and Number Formats guide](/sheets/guides/formats) for more

17145

# information about the supported patterns.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17146

"type": "A String", # The type of the number format.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17147

# When writing, this field must be set.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17148

},

17149

"textDirection": "A String", # The direction of the text in the cell.

17150

"padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.

17151

# When updating padding, every field must be specified.

17152

"top": 42, # The top padding of the cell.

17153

"right": 42, # The right padding of the cell.

17154

"bottom": 42, # The bottom padding of the cell.

17155

"left": 42, # The left padding of the cell.

17156

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17157

"horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17158

"backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.

17159

# for simplicity of conversion to/from color representations in various

17160

# languages over compactness; for example, the fields of this representation

17161

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

17162

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

17163

# method in iOS; and, with just a little work, it can be easily formatted into

17164

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

17169

#

17170

# // ...

17171

# public static java.awt.Color fromProto(Color protocolor) {

17172

# float alpha = protocolor.hasAlpha()

17173

# ? protocolor.getAlpha().getValue()

17174

# : 1.0;

17175

#

17176

# return new java.awt.Color(

17177

# protocolor.getRed(),

17178

# protocolor.getGreen(),

17179

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

17184

# float red = (float) color.getRed();

17185

# float green = (float) color.getGreen();

17186

# float blue = (float) color.getBlue();

17187

# float denominator = 255.0;

17188

# Color.Builder resultBuilder =

17189

# Color

17190

# .newBuilder()

17191

# .setRed(red / denominator)

17192

# .setGreen(green / denominator)

17193

# .setBlue(blue / denominator);

17194

# int alpha = color.getAlpha();

17195

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

17200

# .build());

17201

# }

17202

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

17207

#

17208

# // ...

17209

# static UIColor* fromProto(Color* protocolor) {

17210

# float red = [protocolor red];

17211

# float green = [protocolor green];

17212

# float blue = [protocolor blue];

17213

# FloatValue* alpha_wrapper = [protocolor alpha];

17214

# float alpha = 1.0;

17215

# if (alpha_wrapper != nil) {

17216

# alpha = [alpha_wrapper value];

17217

# }

17218

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

17219

# }

17220

#

17221

# static Color* toProto(UIColor* color) {

17222

# CGFloat red, green, blue, alpha;

17223

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

17224

# return nil;

17225

# }

17226

# Color* result = [Color alloc] init];

17227

# [result setRed:red];

17228

# [result setGreen:green];

17229

# [result setBlue:blue];

17230

# if (alpha <= 0.9999) {

17231

# [result setAlpha:floatWrapperWithValue(alpha)];

17232

# }

17233

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

17243

# var redFrac = rgb_color.red || 0.0;

17244

# var greenFrac = rgb_color.green || 0.0;

17245

# var blueFrac = rgb_color.blue || 0.0;

17246

# var red = Math.floor(redFrac * 255);

17247

# var green = Math.floor(greenFrac * 255);

17248

# var blue = Math.floor(blueFrac * 255);

17249

#

17250

# if (!('alpha' in rgb_color)) {

17251

# return rgbToCssColor_(red, green, blue);

17252

# }

17253

#

17254

# var alphaFrac = rgb_color.alpha.value || 0.0;

17255

# var rgbParams = [red, green, blue].join(',');

17256

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

17257

# };

17258

#

17259

# var rgbToCssColor_ = function(red, green, blue) {

17260

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

17261

# var hexString = rgbNumber.toString(16);

17262

# var missingZeros = 6 - hexString.length;

17263

# var resultBuilder = ['#'];

17264

# for (var i = 0; i < missingZeros; i++) {

17265

# resultBuilder.push('0');

17266

# }

17267

# resultBuilder.push(hexString);

17268

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

17273

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

17274

# the final pixel color is defined by the equation:

17275

#

17276

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

17277

#

17278

# This means that a value of 1.0 corresponds to a solid color, whereas

17279

# a value of 0.0 corresponds to a completely transparent color. This

17280

# uses a wrapper message rather than a simple float scalar so that it is

17281

# possible to distinguish between a default value and the value being unset.

17282

# If omitted, this color object is to be rendered as a solid color

17283

# (as if the alpha value had been explicitly given with a value of 1.0).

17284

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

17285

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

17286

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17287

"verticalAlignment": "A String", # The vertical alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17288

"textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).

17289

# Absent values indicate that the field isn't specified.

17290

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

17291

# for simplicity of conversion to/from color representations in various

17292

# languages over compactness; for example, the fields of this representation

17293

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

17294

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

17295

# method in iOS; and, with just a little work, it can be easily formatted into

17296

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

17301

#

17302

# // ...

17303

# public static java.awt.Color fromProto(Color protocolor) {

17304

# float alpha = protocolor.hasAlpha()

17305

# ? protocolor.getAlpha().getValue()

17306

# : 1.0;

17307

#

17308

# return new java.awt.Color(

17309

# protocolor.getRed(),

17310

# protocolor.getGreen(),

17311

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

17316

# float red = (float) color.getRed();

17317

# float green = (float) color.getGreen();

17318

# float blue = (float) color.getBlue();

17319

# float denominator = 255.0;

17320

# Color.Builder resultBuilder =

17321

# Color

17322

# .newBuilder()

17323

# .setRed(red / denominator)

17324

# .setGreen(green / denominator)

17325

# .setBlue(blue / denominator);

17326

# int alpha = color.getAlpha();

17327

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

17332

# .build());

17333

# }

17334

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

17339

#

17340

# // ...

17341

# static UIColor* fromProto(Color* protocolor) {

17342

# float red = [protocolor red];

17343

# float green = [protocolor green];

17344

# float blue = [protocolor blue];

17345

# FloatValue* alpha_wrapper = [protocolor alpha];

17346

# float alpha = 1.0;

17347

# if (alpha_wrapper != nil) {

17348

# alpha = [alpha_wrapper value];

17349

# }

17350

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

17351

# }

17352

#

17353

# static Color* toProto(UIColor* color) {

17354

# CGFloat red, green, blue, alpha;

17355

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

17356

# return nil;

17357

# }

17358

# Color* result = [Color alloc] init];

17359

# [result setRed:red];

17360

# [result setGreen:green];

17361

# [result setBlue:blue];

17362

# if (alpha <= 0.9999) {

17363

# [result setAlpha:floatWrapperWithValue(alpha)];

17364

# }

17365

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

17375

# var redFrac = rgb_color.red || 0.0;

17376

# var greenFrac = rgb_color.green || 0.0;

17377

# var blueFrac = rgb_color.blue || 0.0;

17378

# var red = Math.floor(redFrac * 255);

17379

# var green = Math.floor(greenFrac * 255);

17380

# var blue = Math.floor(blueFrac * 255);

17381

#

17382

# if (!('alpha' in rgb_color)) {

17383

# return rgbToCssColor_(red, green, blue);

17384

# }

17385

#

17386

# var alphaFrac = rgb_color.alpha.value || 0.0;

17387

# var rgbParams = [red, green, blue].join(',');

17388

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

17389

# };

17390

#

17391

# var rgbToCssColor_ = function(red, green, blue) {

17392

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

17393

# var hexString = rgbNumber.toString(16);

17394

# var missingZeros = 6 - hexString.length;

17395

# var resultBuilder = ['#'];

17396

# for (var i = 0; i < missingZeros; i++) {

17397

# resultBuilder.push('0');

17398

# }

17399

# resultBuilder.push(hexString);

17400

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

17405

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

17406

# the final pixel color is defined by the equation:

17407

#

17408

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

17409

#

17410

# This means that a value of 1.0 corresponds to a solid color, whereas

17411

# a value of 0.0 corresponds to a completely transparent color. This

17412

# uses a wrapper message rather than a simple float scalar so that it is

17413

# possible to distinguish between a default value and the value being unset.

17414

# If omitted, this color object is to be rendered as a solid color

17415

# (as if the alpha value had been explicitly given with a value of 1.0).

17416

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

17417

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

17418

},

17419

"bold": True or False, # True if the text is bold.

17420

"strikethrough": True or False, # True if the text has a strikethrough.

17421

"fontFamily": "A String", # The font family.

17422

"fontSize": 42, # The size of the font.

17423

"italic": True or False, # True if the text is italicized.

17424

"underline": True or False, # True if the text is underlined.

17425

},

17426

"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.

17427

"borders": { # The borders of the cell. # The borders of the cell.

17428

"top": { # A border along a cell. # The top border of the cell.

17429

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

17430

# for simplicity of conversion to/from color representations in various

17431

# languages over compactness; for example, the fields of this representation

17432

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

17433

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

17434

# method in iOS; and, with just a little work, it can be easily formatted into

17435

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

17440

#

17441

# // ...

17442

# public static java.awt.Color fromProto(Color protocolor) {

17443

# float alpha = protocolor.hasAlpha()

17444

# ? protocolor.getAlpha().getValue()

17445

# : 1.0;

17446

#

17447

# return new java.awt.Color(

17448

# protocolor.getRed(),

17449

# protocolor.getGreen(),

17450

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

17455

# float red = (float) color.getRed();

17456

# float green = (float) color.getGreen();

17457

# float blue = (float) color.getBlue();

17458

# float denominator = 255.0;

17459

# Color.Builder resultBuilder =

17460

# Color

17461

# .newBuilder()

17462

# .setRed(red / denominator)

17463

# .setGreen(green / denominator)

17464

# .setBlue(blue / denominator);

17465

# int alpha = color.getAlpha();

17466

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

17471

# .build());

17472

# }

17473

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

17478

#

17479

# // ...

17480

# static UIColor* fromProto(Color* protocolor) {

17481

# float red = [protocolor red];

17482

# float green = [protocolor green];

17483

# float blue = [protocolor blue];

17484

# FloatValue* alpha_wrapper = [protocolor alpha];

17485

# float alpha = 1.0;

17486

# if (alpha_wrapper != nil) {

17487

# alpha = [alpha_wrapper value];

17488

# }

17489

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

17490

# }

17491

#

17492

# static Color* toProto(UIColor* color) {

17493

# CGFloat red, green, blue, alpha;

17494

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

17495

# return nil;

17496

# }

17497

# Color* result = [Color alloc] init];

17498

# [result setRed:red];

17499

# [result setGreen:green];

17500

# [result setBlue:blue];

17501

# if (alpha <= 0.9999) {

17502

# [result setAlpha:floatWrapperWithValue(alpha)];

17503

# }

17504

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

17514

# var redFrac = rgb_color.red || 0.0;

17515

# var greenFrac = rgb_color.green || 0.0;

17516

# var blueFrac = rgb_color.blue || 0.0;

17517

# var red = Math.floor(redFrac * 255);

17518

# var green = Math.floor(greenFrac * 255);

17519

# var blue = Math.floor(blueFrac * 255);

17520

#

17521

# if (!('alpha' in rgb_color)) {

17522

# return rgbToCssColor_(red, green, blue);

17523

# }

17524

#

17525

# var alphaFrac = rgb_color.alpha.value || 0.0;

17526

# var rgbParams = [red, green, blue].join(',');

17527

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

17528

# };

17529

#

17530

# var rgbToCssColor_ = function(red, green, blue) {

17531

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

17532

# var hexString = rgbNumber.toString(16);

17533

# var missingZeros = 6 - hexString.length;

17534

# var resultBuilder = ['#'];

17535

# for (var i = 0; i < missingZeros; i++) {

17536

# resultBuilder.push('0');

17537

# }

17538

# resultBuilder.push(hexString);

17539

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

17544

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

17545

# the final pixel color is defined by the equation:

17546

#

17547

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

17548

#

17549

# This means that a value of 1.0 corresponds to a solid color, whereas

17550

# a value of 0.0 corresponds to a completely transparent color. This

17551

# uses a wrapper message rather than a simple float scalar so that it is

17552

# possible to distinguish between a default value and the value being unset.

17553

# If omitted, this color object is to be rendered as a solid color

17554

# (as if the alpha value had been explicitly given with a value of 1.0).

17555

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

17556

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

17557

},

17558

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17559

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17560

"style": "A String", # The style of the border.

17561

},

17562

"right": { # A border along a cell. # The right border of the cell.

17563

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

17564

# for simplicity of conversion to/from color representations in various

17565

# languages over compactness; for example, the fields of this representation

17566

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

17567

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

17568

# method in iOS; and, with just a little work, it can be easily formatted into

17569

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

17574

#

17575

# // ...

17576

# public static java.awt.Color fromProto(Color protocolor) {

17577

# float alpha = protocolor.hasAlpha()

17578

# ? protocolor.getAlpha().getValue()

17579

# : 1.0;

17580

#

17581

# return new java.awt.Color(

17582

# protocolor.getRed(),

17583

# protocolor.getGreen(),

17584

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

17589

# float red = (float) color.getRed();

17590

# float green = (float) color.getGreen();

17591

# float blue = (float) color.getBlue();

17592

# float denominator = 255.0;

17593

# Color.Builder resultBuilder =

17594

# Color

17595

# .newBuilder()

17596

# .setRed(red / denominator)

17597

# .setGreen(green / denominator)

17598

# .setBlue(blue / denominator);

17599

# int alpha = color.getAlpha();

17600

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

17605

# .build());

17606

# }

17607

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

17612

#

17613

# // ...

17614

# static UIColor* fromProto(Color* protocolor) {

17615

# float red = [protocolor red];

17616

# float green = [protocolor green];

17617

# float blue = [protocolor blue];

17618

# FloatValue* alpha_wrapper = [protocolor alpha];

17619

# float alpha = 1.0;

17620

# if (alpha_wrapper != nil) {

17621

# alpha = [alpha_wrapper value];

17622

# }

17623

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

17624

# }

17625

#

17626

# static Color* toProto(UIColor* color) {

17627

# CGFloat red, green, blue, alpha;

17628

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

17629

# return nil;

17630

# }

17631

# Color* result = [Color alloc] init];

17632

# [result setRed:red];

17633

# [result setGreen:green];

17634

# [result setBlue:blue];

17635

# if (alpha <= 0.9999) {

17636

# [result setAlpha:floatWrapperWithValue(alpha)];

17637

# }

17638

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

17648

# var redFrac = rgb_color.red || 0.0;

17649

# var greenFrac = rgb_color.green || 0.0;

17650

# var blueFrac = rgb_color.blue || 0.0;

17651

# var red = Math.floor(redFrac * 255);

17652

# var green = Math.floor(greenFrac * 255);

17653

# var blue = Math.floor(blueFrac * 255);

17654

#

17655

# if (!('alpha' in rgb_color)) {

17656

# return rgbToCssColor_(red, green, blue);

17657

# }

17658

#

17659

# var alphaFrac = rgb_color.alpha.value || 0.0;

17660

# var rgbParams = [red, green, blue].join(',');

17661

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

17662

# };

17663

#

17664

# var rgbToCssColor_ = function(red, green, blue) {

17665

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

17666

# var hexString = rgbNumber.toString(16);

17667

# var missingZeros = 6 - hexString.length;

17668

# var resultBuilder = ['#'];

17669

# for (var i = 0; i < missingZeros; i++) {

17670

# resultBuilder.push('0');

17671

# }

17672

# resultBuilder.push(hexString);

17673

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

17678

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

17679

# the final pixel color is defined by the equation:

17680

#

17681

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

17682

#

17683

# This means that a value of 1.0 corresponds to a solid color, whereas

17684

# a value of 0.0 corresponds to a completely transparent color. This

17685

# uses a wrapper message rather than a simple float scalar so that it is

17686

# possible to distinguish between a default value and the value being unset.

17687

# If omitted, this color object is to be rendered as a solid color

17688

# (as if the alpha value had been explicitly given with a value of 1.0).

17689

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

17690

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

17691

},

17692

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17693

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17694

"style": "A String", # The style of the border.

17695

},

17696

"bottom": { # A border along a cell. # The bottom border of the cell.

17697

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

17698

# for simplicity of conversion to/from color representations in various

17699

# languages over compactness; for example, the fields of this representation

17700

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

17701

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

17702

# method in iOS; and, with just a little work, it can be easily formatted into

17703

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

17708

#

17709

# // ...

17710

# public static java.awt.Color fromProto(Color protocolor) {

17711

# float alpha = protocolor.hasAlpha()

17712

# ? protocolor.getAlpha().getValue()

17713

# : 1.0;

17714

#

17715

# return new java.awt.Color(

17716

# protocolor.getRed(),

17717

# protocolor.getGreen(),

17718

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

17723

# float red = (float) color.getRed();

17724

# float green = (float) color.getGreen();

17725

# float blue = (float) color.getBlue();

17726

# float denominator = 255.0;

17727

# Color.Builder resultBuilder =

17728

# Color

17729

# .newBuilder()

17730

# .setRed(red / denominator)

17731

# .setGreen(green / denominator)

17732

# .setBlue(blue / denominator);

17733

# int alpha = color.getAlpha();

17734

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

17739

# .build());

17740

# }

17741

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

17746

#

17747

# // ...

17748

# static UIColor* fromProto(Color* protocolor) {

17749

# float red = [protocolor red];

17750

# float green = [protocolor green];

17751

# float blue = [protocolor blue];

17752

# FloatValue* alpha_wrapper = [protocolor alpha];

17753

# float alpha = 1.0;

17754

# if (alpha_wrapper != nil) {

17755

# alpha = [alpha_wrapper value];

17756

# }

17757

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

17758

# }

17759

#

17760

# static Color* toProto(UIColor* color) {

17761

# CGFloat red, green, blue, alpha;

17762

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

17763

# return nil;

17764

# }

17765

# Color* result = [Color alloc] init];

17766

# [result setRed:red];

17767

# [result setGreen:green];

17768

# [result setBlue:blue];

17769

# if (alpha <= 0.9999) {

17770

# [result setAlpha:floatWrapperWithValue(alpha)];

17771

# }

17772

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

17782

# var redFrac = rgb_color.red || 0.0;

17783

# var greenFrac = rgb_color.green || 0.0;

17784

# var blueFrac = rgb_color.blue || 0.0;

17785

# var red = Math.floor(redFrac * 255);

17786

# var green = Math.floor(greenFrac * 255);

17787

# var blue = Math.floor(blueFrac * 255);

17788

#

17789

# if (!('alpha' in rgb_color)) {

17790

# return rgbToCssColor_(red, green, blue);

17791

# }

17792

#

17793

# var alphaFrac = rgb_color.alpha.value || 0.0;

17794

# var rgbParams = [red, green, blue].join(',');

17795

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

17796

# };

17797

#

17798

# var rgbToCssColor_ = function(red, green, blue) {

17799

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

17800

# var hexString = rgbNumber.toString(16);

17801

# var missingZeros = 6 - hexString.length;

17802

# var resultBuilder = ['#'];

17803

# for (var i = 0; i < missingZeros; i++) {

17804

# resultBuilder.push('0');

17805

# }

17806

# resultBuilder.push(hexString);

17807

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

17812

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

17813

# the final pixel color is defined by the equation:

17814

#

17815

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

17816

#

17817

# This means that a value of 1.0 corresponds to a solid color, whereas

17818

# a value of 0.0 corresponds to a completely transparent color. This

17819

# uses a wrapper message rather than a simple float scalar so that it is

17820

# possible to distinguish between a default value and the value being unset.

17821

# If omitted, this color object is to be rendered as a solid color

17822

# (as if the alpha value had been explicitly given with a value of 1.0).

17823

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

17824

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

17825

},

17826

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17827

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17828

"style": "A String", # The style of the border.

17829

},

17830

"left": { # A border along a cell. # The left border of the cell.

17831

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

17832

# for simplicity of conversion to/from color representations in various

17833

# languages over compactness; for example, the fields of this representation

17834

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

17835

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

17836

# method in iOS; and, with just a little work, it can be easily formatted into

17837

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

17842

#

17843

# // ...

17844

# public static java.awt.Color fromProto(Color protocolor) {

17845

# float alpha = protocolor.hasAlpha()

17846

# ? protocolor.getAlpha().getValue()

17847

# : 1.0;

17848

#

17849

# return new java.awt.Color(

17850

# protocolor.getRed(),

17851

# protocolor.getGreen(),

17852

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

17857

# float red = (float) color.getRed();

17858

# float green = (float) color.getGreen();

17859

# float blue = (float) color.getBlue();

17860

# float denominator = 255.0;

17861

# Color.Builder resultBuilder =

17862

# Color

17863

# .newBuilder()

17864

# .setRed(red / denominator)

17865

# .setGreen(green / denominator)

17866

# .setBlue(blue / denominator);

17867

# int alpha = color.getAlpha();

17868

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

17873

# .build());

17874

# }

17875

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

17880

#

17881

# // ...

17882

# static UIColor* fromProto(Color* protocolor) {

17883

# float red = [protocolor red];

17884

# float green = [protocolor green];

17885

# float blue = [protocolor blue];

17886

# FloatValue* alpha_wrapper = [protocolor alpha];

17887

# float alpha = 1.0;

17888

# if (alpha_wrapper != nil) {

17889

# alpha = [alpha_wrapper value];

17890

# }

17891

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

17892

# }

17893

#

17894

# static Color* toProto(UIColor* color) {

17895

# CGFloat red, green, blue, alpha;

17896

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

17897

# return nil;

17898

# }

17899

# Color* result = [Color alloc] init];

17900

# [result setRed:red];

17901

# [result setGreen:green];

17902

# [result setBlue:blue];

17903

# if (alpha <= 0.9999) {

17904

# [result setAlpha:floatWrapperWithValue(alpha)];

17905

# }

17906

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

17916

# var redFrac = rgb_color.red || 0.0;

17917

# var greenFrac = rgb_color.green || 0.0;

17918

# var blueFrac = rgb_color.blue || 0.0;

17919

# var red = Math.floor(redFrac * 255);

17920

# var green = Math.floor(greenFrac * 255);

17921

# var blue = Math.floor(blueFrac * 255);

17922

#

17923

# if (!('alpha' in rgb_color)) {

17924

# return rgbToCssColor_(red, green, blue);

17925

# }

17926

#

17927

# var alphaFrac = rgb_color.alpha.value || 0.0;

17928

# var rgbParams = [red, green, blue].join(',');

17929

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

17930

# };

17931

#

17932

# var rgbToCssColor_ = function(red, green, blue) {

17933

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

17934

# var hexString = rgbNumber.toString(16);

17935

# var missingZeros = 6 - hexString.length;

17936

# var resultBuilder = ['#'];

17937

# for (var i = 0; i < missingZeros; i++) {

17938

# resultBuilder.push('0');

17939

# }

17940

# resultBuilder.push(hexString);

17941

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

17946

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

17947

# the final pixel color is defined by the equation:

17948

#

17949

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

17950

#

17951

# This means that a value of 1.0 corresponds to a solid color, whereas

17952

# a value of 0.0 corresponds to a completely transparent color. This

17953

# uses a wrapper message rather than a simple float scalar so that it is

17954

# possible to distinguish between a default value and the value being unset.

17955

# If omitted, this color object is to be rendered as a solid color

17956

# (as if the alpha value had been explicitly given with a value of 1.0).

17957

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

17958

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

17959

},

17960

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17961

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17962

"style": "A String", # The style of the border.

17963

},

17964

},

17965

"wrapStrategy": "A String", # The wrap strategy for the value in the cell.

17966

},

17967

},

17968

"gradientRule": { # A rule that applies a gradient color scale format, based on # The formatting will vary based on the gradients in the rule.

17969

# the interpolation points listed. The format of a cell will vary

17970

# based on its contents as compared to the values of the interpolation

17971

# points.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

17972

"maxpoint": { # A single interpolation point on a gradient conditional format. # The final interpolation point.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

17973

# These pin the gradient color scale according to the color,

17974

# type and value chosen.

17975

"color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.

17976

# for simplicity of conversion to/from color representations in various

17977

# languages over compactness; for example, the fields of this representation

17978

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

17979

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

17980

# method in iOS; and, with just a little work, it can be easily formatted into

17981

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

17986

#

17987

# // ...

17988

# public static java.awt.Color fromProto(Color protocolor) {

17989

# float alpha = protocolor.hasAlpha()

17990

# ? protocolor.getAlpha().getValue()

17991

# : 1.0;

17992

#

17993

# return new java.awt.Color(

17994

# protocolor.getRed(),

17995

# protocolor.getGreen(),

17996

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

18001

# float red = (float) color.getRed();

18002

# float green = (float) color.getGreen();

18003

# float blue = (float) color.getBlue();

18004

# float denominator = 255.0;

18005

# Color.Builder resultBuilder =

18006

# Color

18007

# .newBuilder()

18008

# .setRed(red / denominator)

18009

# .setGreen(green / denominator)

18010

# .setBlue(blue / denominator);

18011

# int alpha = color.getAlpha();

18012

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

18017

# .build());

18018

# }

18019

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

18024

#

18025

# // ...

18026

# static UIColor* fromProto(Color* protocolor) {

18027

# float red = [protocolor red];

18028

# float green = [protocolor green];

18029

# float blue = [protocolor blue];

18030

# FloatValue* alpha_wrapper = [protocolor alpha];

18031

# float alpha = 1.0;

18032

# if (alpha_wrapper != nil) {

18033

# alpha = [alpha_wrapper value];

18034

# }

18035

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

18036

# }

18037

#

18038

# static Color* toProto(UIColor* color) {

18039

# CGFloat red, green, blue, alpha;

18040

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

18041

# return nil;

18042

# }

18043

# Color* result = [Color alloc] init];

18044

# [result setRed:red];

18045

# [result setGreen:green];

18046

# [result setBlue:blue];

18047

# if (alpha <= 0.9999) {

18048

# [result setAlpha:floatWrapperWithValue(alpha)];

18049

# }

18050

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

18060

# var redFrac = rgb_color.red || 0.0;

18061

# var greenFrac = rgb_color.green || 0.0;

18062

# var blueFrac = rgb_color.blue || 0.0;

18063

# var red = Math.floor(redFrac * 255);

18064

# var green = Math.floor(greenFrac * 255);

18065

# var blue = Math.floor(blueFrac * 255);

18066

#

18067

# if (!('alpha' in rgb_color)) {

18068

# return rgbToCssColor_(red, green, blue);

18069

# }

18070

#

18071

# var alphaFrac = rgb_color.alpha.value || 0.0;

18072

# var rgbParams = [red, green, blue].join(',');

18073

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

18074

# };

18075

#

18076

# var rgbToCssColor_ = function(red, green, blue) {

18077

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

18078

# var hexString = rgbNumber.toString(16);

18079

# var missingZeros = 6 - hexString.length;

18080

# var resultBuilder = ['#'];

18081

# for (var i = 0; i < missingZeros; i++) {

18082

# resultBuilder.push('0');

18083

# }

18084

# resultBuilder.push(hexString);

18085

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

18090

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

18091

# the final pixel color is defined by the equation:

18092

#

18093

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

18094

#

18095

# This means that a value of 1.0 corresponds to a solid color, whereas

18096

# a value of 0.0 corresponds to a completely transparent color. This

18097

# uses a wrapper message rather than a simple float scalar so that it is

18098

# possible to distinguish between a default value and the value being unset.

18099

# If omitted, this color object is to be rendered as a solid color

18100

# (as if the alpha value had been explicitly given with a value of 1.0).

18101

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

18102

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

18103

},

18104

"type": "A String", # How the value should be interpreted.

18105

"value": "A String", # The value this interpolation point uses. May be a formula.

18106

# Unused if type is MIN or

18107

# MAX.

18108

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18109

"midpoint": { # A single interpolation point on a gradient conditional format. # An optional midway interpolation point.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18110

# These pin the gradient color scale according to the color,

18111

# type and value chosen.

18112

"color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.

18113

# for simplicity of conversion to/from color representations in various

18114

# languages over compactness; for example, the fields of this representation

18115

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

18116

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

18117

# method in iOS; and, with just a little work, it can be easily formatted into

18118

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

18123

#

18124

# // ...

18125

# public static java.awt.Color fromProto(Color protocolor) {

18126

# float alpha = protocolor.hasAlpha()

18127

# ? protocolor.getAlpha().getValue()

18128

# : 1.0;

18129

#

18130

# return new java.awt.Color(

18131

# protocolor.getRed(),

18132

# protocolor.getGreen(),

18133

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

18138

# float red = (float) color.getRed();

18139

# float green = (float) color.getGreen();

18140

# float blue = (float) color.getBlue();

18141

# float denominator = 255.0;

18142

# Color.Builder resultBuilder =

18143

# Color

18144

# .newBuilder()

18145

# .setRed(red / denominator)

18146

# .setGreen(green / denominator)

18147

# .setBlue(blue / denominator);

18148

# int alpha = color.getAlpha();

18149

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

18154

# .build());

18155

# }

18156

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

18161

#

18162

# // ...

18163

# static UIColor* fromProto(Color* protocolor) {

18164

# float red = [protocolor red];

18165

# float green = [protocolor green];

18166

# float blue = [protocolor blue];

18167

# FloatValue* alpha_wrapper = [protocolor alpha];

18168

# float alpha = 1.0;

18169

# if (alpha_wrapper != nil) {

18170

# alpha = [alpha_wrapper value];

18171

# }

18172

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

18173

# }

18174

#

18175

# static Color* toProto(UIColor* color) {

18176

# CGFloat red, green, blue, alpha;

18177

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

18178

# return nil;

18179

# }

18180

# Color* result = [Color alloc] init];

18181

# [result setRed:red];

18182

# [result setGreen:green];

18183

# [result setBlue:blue];

18184

# if (alpha <= 0.9999) {

18185

# [result setAlpha:floatWrapperWithValue(alpha)];

18186

# }

18187

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

18197

# var redFrac = rgb_color.red || 0.0;

18198

# var greenFrac = rgb_color.green || 0.0;

18199

# var blueFrac = rgb_color.blue || 0.0;

18200

# var red = Math.floor(redFrac * 255);

18201

# var green = Math.floor(greenFrac * 255);

18202

# var blue = Math.floor(blueFrac * 255);

18203

#

18204

# if (!('alpha' in rgb_color)) {

18205

# return rgbToCssColor_(red, green, blue);

18206

# }

18207

#

18208

# var alphaFrac = rgb_color.alpha.value || 0.0;

18209

# var rgbParams = [red, green, blue].join(',');

18210

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

18211

# };

18212

#

18213

# var rgbToCssColor_ = function(red, green, blue) {

18214

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

18215

# var hexString = rgbNumber.toString(16);

18216

# var missingZeros = 6 - hexString.length;

18217

# var resultBuilder = ['#'];

18218

# for (var i = 0; i < missingZeros; i++) {

18219

# resultBuilder.push('0');

18220

# }

18221

# resultBuilder.push(hexString);

18222

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

18227

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

18228

# the final pixel color is defined by the equation:

18229

#

18230

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

18231

#

18232

# This means that a value of 1.0 corresponds to a solid color, whereas

18233

# a value of 0.0 corresponds to a completely transparent color. This

18234

# uses a wrapper message rather than a simple float scalar so that it is

18235

# possible to distinguish between a default value and the value being unset.

18236

# If omitted, this color object is to be rendered as a solid color

18237

# (as if the alpha value had been explicitly given with a value of 1.0).

18238

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

18239

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

18240

},

18241

"type": "A String", # How the value should be interpreted.

18242

"value": "A String", # The value this interpolation point uses. May be a formula.

18243

# Unused if type is MIN or

18244

# MAX.

18245

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18246

"minpoint": { # A single interpolation point on a gradient conditional format. # The starting interpolation point.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18247

# These pin the gradient color scale according to the color,

18248

# type and value chosen.

18249

"color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.

18250

# for simplicity of conversion to/from color representations in various

18251

# languages over compactness; for example, the fields of this representation

18252

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

18253

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

18254

# method in iOS; and, with just a little work, it can be easily formatted into

18255

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

18260

#

18261

# // ...

18262

# public static java.awt.Color fromProto(Color protocolor) {

18263

# float alpha = protocolor.hasAlpha()

18264

# ? protocolor.getAlpha().getValue()

18265

# : 1.0;

18266

#

18267

# return new java.awt.Color(

18268

# protocolor.getRed(),

18269

# protocolor.getGreen(),

18270

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

18275

# float red = (float) color.getRed();

18276

# float green = (float) color.getGreen();

18277

# float blue = (float) color.getBlue();

18278

# float denominator = 255.0;

18279

# Color.Builder resultBuilder =

18280

# Color

18281

# .newBuilder()

18282

# .setRed(red / denominator)

18283

# .setGreen(green / denominator)

18284

# .setBlue(blue / denominator);

18285

# int alpha = color.getAlpha();

18286

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

18291

# .build());

18292

# }

18293

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

18298

#

18299

# // ...

18300

# static UIColor* fromProto(Color* protocolor) {

18301

# float red = [protocolor red];

18302

# float green = [protocolor green];

18303

# float blue = [protocolor blue];

18304

# FloatValue* alpha_wrapper = [protocolor alpha];

18305

# float alpha = 1.0;

18306

# if (alpha_wrapper != nil) {

18307

# alpha = [alpha_wrapper value];

18308

# }

18309

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

18310

# }

18311

#

18312

# static Color* toProto(UIColor* color) {

18313

# CGFloat red, green, blue, alpha;

18314

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

18315

# return nil;

18316

# }

18317

# Color* result = [Color alloc] init];

18318

# [result setRed:red];

18319

# [result setGreen:green];

18320

# [result setBlue:blue];

18321

# if (alpha <= 0.9999) {

18322

# [result setAlpha:floatWrapperWithValue(alpha)];

18323

# }

18324

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

18334

# var redFrac = rgb_color.red || 0.0;

18335

# var greenFrac = rgb_color.green || 0.0;

18336

# var blueFrac = rgb_color.blue || 0.0;

18337

# var red = Math.floor(redFrac * 255);

18338

# var green = Math.floor(greenFrac * 255);

18339

# var blue = Math.floor(blueFrac * 255);

18340

#

18341

# if (!('alpha' in rgb_color)) {

18342

# return rgbToCssColor_(red, green, blue);

18343

# }

18344

#

18345

# var alphaFrac = rgb_color.alpha.value || 0.0;

18346

# var rgbParams = [red, green, blue].join(',');

18347

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

18348

# };

18349

#

18350

# var rgbToCssColor_ = function(red, green, blue) {

18351

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

18352

# var hexString = rgbNumber.toString(16);

18353

# var missingZeros = 6 - hexString.length;

18354

# var resultBuilder = ['#'];

18355

# for (var i = 0; i < missingZeros; i++) {

18356

# resultBuilder.push('0');

18357

# }

18358

# resultBuilder.push(hexString);

18359

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

18364

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

18365

# the final pixel color is defined by the equation:

18366

#

18367

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

18368

#

18369

# This means that a value of 1.0 corresponds to a solid color, whereas

18370

# a value of 0.0 corresponds to a completely transparent color. This

18371

# uses a wrapper message rather than a simple float scalar so that it is

18372

# possible to distinguish between a default value and the value being unset.

18373

# If omitted, this color object is to be rendered as a solid color

18374

# (as if the alpha value had been explicitly given with a value of 1.0).

18375

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

18376

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

18377

},

18378

"type": "A String", # How the value should be interpreted.

18379

"value": "A String", # The value this interpolation point uses. May be a formula.

18380

# Unused if type is MIN or

# MAX.

},

},

},

},

"addFilterView": { # The result of adding a filter view. # A reply from adding a filter view.

18387

"filter": { # A filter view. # The newly added filter view.

18388

"title": "A String", # The name of the filter view.

18389

"namedRangeId": "A String", # The named range this filter view is backed by, if any.

18390

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18391

# When writing, only one of range or named_range_id

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18392

# may be set.

18393

"filterViewId": 42, # The ID of the filter view.

18394

"range": { # A range on a sheet. # The range this filter view covers.

18395

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18396

# When writing, only one of range or named_range_id

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18397

# may be set.

18398

# All indexes are zero-based.

18399

# Indexes are half open, e.g the start index is inclusive

18400

# and the end index is exclusive -- [start_index, end_index).

18401

# Missing indexes indicate the range is unbounded on that side.

18402

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18403

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18404

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18405

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18406

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18407

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18408

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18409

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18410

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18411

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18412

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18413

# `Sheet1!A:B == sheet_id: 0,

18414

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18415

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18416

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18417

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18418

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18419

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18420

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18421

#

18422

# The start index must always be less than or equal to the end index.

18423

# If the start index equals the end index, then the range is empty.

18424

# Empty ranges are typically not meaningful and are usually rendered in the

18425

# UI as `#REF!`.

18426

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

18427

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

18428

"sheetId": 42, # The sheet this range is on.

18429

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

18430

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

18431

},

18432

"sortSpecs": [ # The sort order per column. Later specifications are used when values

18433

# are equal in the earlier specifications.

18434

{ # A sort order associated with a specific column or row.

18435

"sortOrder": "A String", # The order data should be sorted.

18436

"dimensionIndex": 42, # The dimension the sort should be applied to.

18437

},

18438

],

18439

"criteria": { # The criteria for showing/hiding values per column.

18440

# The map's key is the column index, and the value is the criteria for

18441

# that column.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18442

"a_key": { # Criteria for showing/hiding rows in a filter or filter view.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18443

"hiddenValues": [ # Values that should be hidden.

18444

"A String",

18445

],

18446

"condition": { # A condition that can evaluate to true or false. # A condition that must be true for values to be shown.

18447

# (This does not override hiddenValues -- if a value is listed there,

18448

# it will still be hidden.)

18449

# BooleanConditions are used by conditional formatting,

18450

# data validation, and the criteria in filters.

18451

"type": "A String", # The type of condition.

18452

"values": [ # The values of the condition. The number of supported values depends

18453

# on the condition type. Some support zero values,

18454

# others one or two values,

18455

# and ConditionType.ONE_OF_LIST supports an arbitrary number of values.

18456

{ # The value of the condition.

18457

"relativeDate": "A String", # A relative date (based on the current date).

18458

# Valid only if the type is

18459

# DATE_BEFORE,

18460

# DATE_AFTER,

18461

# DATE_ON_OR_BEFORE or

18462

# DATE_ON_OR_AFTER.

18463

#

18464

# Relative dates are not supported in data validation.

18465

# They are supported only in conditional formatting and

18466

# conditional filters.

18467

"userEnteredValue": "A String", # A value the condition is based on.

18468

# The value will be parsed as if the user typed into a cell.

18469

# Formulas are supported (and must begin with an `=`).

},

],

},

},

},

},

},

},

],

}</pre>

</div>

<code class="details" id="create">create(body, x__xgafv=None)</code>

18484

<pre>Creates a spreadsheet, returning the newly created spreadsheet.

18485

18486

Args:

18487

body: object, The request body. (required)

18488

The object takes the form of:

18489

18490

{ # Resource that represents a spreadsheet.

18491

"spreadsheetId": "A String", # The ID of the spreadsheet.

18492

# This field is read-only.

18493

"namedRanges": [ # The named ranges defined in a spreadsheet.

18494

{ # A named range.

18495

"namedRangeId": "A String", # The ID of the named range.

18496

"range": { # A range on a sheet. # The range this represents.

18497

# All indexes are zero-based.

18498

# Indexes are half open, e.g the start index is inclusive

18499

# and the end index is exclusive -- [start_index, end_index).

18500

# Missing indexes indicate the range is unbounded on that side.

18501

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18502

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18503

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18504

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18505

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18506

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18507

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18508

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18509

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18510

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18511

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18512

# `Sheet1!A:B == sheet_id: 0,

18513

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18514

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18515

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18516

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18517

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18518

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18519

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18520

#

18521

# The start index must always be less than or equal to the end index.

18522

# If the start index equals the end index, then the range is empty.

18523

# Empty ranges are typically not meaningful and are usually rendered in the

18524

# UI as `#REF!`.

18525

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

18526

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

18527

"sheetId": 42, # The sheet this range is on.

18528

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

18529

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

18530

},

18531

"name": "A String", # The name of the named range.

18532

},

18533

],

18534

"properties": { # Properties of a spreadsheet. # Overall properties of a spreadsheet.

18535

"locale": "A String", # The locale of the spreadsheet in one of the following formats:

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18536

#

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18537

# * an ISO 639-1 language code such as `en`

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18538

#

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18539

# * an ISO 639-2 language code such as `fil`, if no 639-1 code exists

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18540

#

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18541

# * a combination of the ISO language code and country code, such as `en_US`

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18542

#

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18543

# Note: when updating this field, not all locales/languages are supported.

18544

"timeZone": "A String", # The time zone of the spreadsheet, in CLDR format such as

18545

# `America/New_York`. If the time zone isn't recognized, this may

18546

# be a custom time zone such as `GMT-07:00`.

18547

"autoRecalc": "A String", # The amount of time to wait before volatile functions are recalculated.

18548

"defaultFormat": { # The format of a cell. # The default format of all cells in the spreadsheet.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18549

# CellData.effectiveFormat will not be set if the

18550

# cell's format is equal to this default format.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18551

# This field is read-only.

18552

"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18553

"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on

18554

# the user's locale will be used if necessary for the given type.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame^]

18555

# See the [Date and Number Formats guide](/sheets/guides/formats) for more

18556

# information about the supported patterns.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18557

"type": "A String", # The type of the number format.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18558

# When writing, this field must be set.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18559

},

18560

"textDirection": "A String", # The direction of the text in the cell.

18561

"padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.

18562

# When updating padding, every field must be specified.

18563

"top": 42, # The top padding of the cell.

18564

"right": 42, # The right padding of the cell.

18565

"bottom": 42, # The bottom padding of the cell.

18566

"left": 42, # The left padding of the cell.

18567

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18568

"horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18569

"backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.

18570

# for simplicity of conversion to/from color representations in various

18571

# languages over compactness; for example, the fields of this representation

18572

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

18573

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

18574

# method in iOS; and, with just a little work, it can be easily formatted into

18575

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

18580

#

18581

# // ...

18582

# public static java.awt.Color fromProto(Color protocolor) {

18583

# float alpha = protocolor.hasAlpha()

18584

# ? protocolor.getAlpha().getValue()

18585

# : 1.0;

18586

#

18587

# return new java.awt.Color(

18588

# protocolor.getRed(),

18589

# protocolor.getGreen(),

18590

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

18595

# float red = (float) color.getRed();

18596

# float green = (float) color.getGreen();

18597

# float blue = (float) color.getBlue();

18598

# float denominator = 255.0;

18599

# Color.Builder resultBuilder =

18600

# Color

18601

# .newBuilder()

18602

# .setRed(red / denominator)

18603

# .setGreen(green / denominator)

18604

# .setBlue(blue / denominator);

18605

# int alpha = color.getAlpha();

18606

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

18611

# .build());

18612

# }

18613

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

18618

#

18619

# // ...

18620

# static UIColor* fromProto(Color* protocolor) {

18621

# float red = [protocolor red];

18622

# float green = [protocolor green];

18623

# float blue = [protocolor blue];

18624

# FloatValue* alpha_wrapper = [protocolor alpha];

18625

# float alpha = 1.0;

18626

# if (alpha_wrapper != nil) {

18627

# alpha = [alpha_wrapper value];

18628

# }

18629

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

18630

# }

18631

#

18632

# static Color* toProto(UIColor* color) {

18633

# CGFloat red, green, blue, alpha;

18634

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

18635

# return nil;

18636

# }

18637

# Color* result = [Color alloc] init];

18638

# [result setRed:red];

18639

# [result setGreen:green];

18640

# [result setBlue:blue];

18641

# if (alpha <= 0.9999) {

18642

# [result setAlpha:floatWrapperWithValue(alpha)];

18643

# }

18644

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

18654

# var redFrac = rgb_color.red || 0.0;

18655

# var greenFrac = rgb_color.green || 0.0;

18656

# var blueFrac = rgb_color.blue || 0.0;

18657

# var red = Math.floor(redFrac * 255);

18658

# var green = Math.floor(greenFrac * 255);

18659

# var blue = Math.floor(blueFrac * 255);

18660

#

18661

# if (!('alpha' in rgb_color)) {

18662

# return rgbToCssColor_(red, green, blue);

18663

# }

18664

#

18665

# var alphaFrac = rgb_color.alpha.value || 0.0;

18666

# var rgbParams = [red, green, blue].join(',');

18667

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

18668

# };

18669

#

18670

# var rgbToCssColor_ = function(red, green, blue) {

18671

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

18672

# var hexString = rgbNumber.toString(16);

18673

# var missingZeros = 6 - hexString.length;

18674

# var resultBuilder = ['#'];

18675

# for (var i = 0; i < missingZeros; i++) {

18676

# resultBuilder.push('0');

18677

# }

18678

# resultBuilder.push(hexString);

18679

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

18684

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

18685

# the final pixel color is defined by the equation:

18686

#

18687

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

18688

#

18689

# This means that a value of 1.0 corresponds to a solid color, whereas

18690

# a value of 0.0 corresponds to a completely transparent color. This

18691

# uses a wrapper message rather than a simple float scalar so that it is

18692

# possible to distinguish between a default value and the value being unset.

18693

# If omitted, this color object is to be rendered as a solid color

18694

# (as if the alpha value had been explicitly given with a value of 1.0).

18695

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

18696

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

18697

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18698

"verticalAlignment": "A String", # The vertical alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18699

"textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).

18700

# Absent values indicate that the field isn't specified.

18701

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

18702

# for simplicity of conversion to/from color representations in various

18703

# languages over compactness; for example, the fields of this representation

18704

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

18705

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

18706

# method in iOS; and, with just a little work, it can be easily formatted into

18707

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

18712

#

18713

# // ...

18714

# public static java.awt.Color fromProto(Color protocolor) {

18715

# float alpha = protocolor.hasAlpha()

18716

# ? protocolor.getAlpha().getValue()

18717

# : 1.0;

18718

#

18719

# return new java.awt.Color(

18720

# protocolor.getRed(),

18721

# protocolor.getGreen(),

18722

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

18727

# float red = (float) color.getRed();

18728

# float green = (float) color.getGreen();

18729

# float blue = (float) color.getBlue();

18730

# float denominator = 255.0;

18731

# Color.Builder resultBuilder =

18732

# Color

18733

# .newBuilder()

18734

# .setRed(red / denominator)

18735

# .setGreen(green / denominator)

18736

# .setBlue(blue / denominator);

18737

# int alpha = color.getAlpha();

18738

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

18743

# .build());

18744

# }

18745

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

18750

#

18751

# // ...

18752

# static UIColor* fromProto(Color* protocolor) {

18753

# float red = [protocolor red];

18754

# float green = [protocolor green];

18755

# float blue = [protocolor blue];

18756

# FloatValue* alpha_wrapper = [protocolor alpha];

18757

# float alpha = 1.0;

18758

# if (alpha_wrapper != nil) {

18759

# alpha = [alpha_wrapper value];

18760

# }

18761

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

18762

# }

18763

#

18764

# static Color* toProto(UIColor* color) {

18765

# CGFloat red, green, blue, alpha;

18766

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

18767

# return nil;

18768

# }

18769

# Color* result = [Color alloc] init];

18770

# [result setRed:red];

18771

# [result setGreen:green];

18772

# [result setBlue:blue];

18773

# if (alpha <= 0.9999) {

18774

# [result setAlpha:floatWrapperWithValue(alpha)];

18775

# }

18776

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

18786

# var redFrac = rgb_color.red || 0.0;

18787

# var greenFrac = rgb_color.green || 0.0;

18788

# var blueFrac = rgb_color.blue || 0.0;

18789

# var red = Math.floor(redFrac * 255);

18790

# var green = Math.floor(greenFrac * 255);

18791

# var blue = Math.floor(blueFrac * 255);

18792

#

18793

# if (!('alpha' in rgb_color)) {

18794

# return rgbToCssColor_(red, green, blue);

18795

# }

18796

#

18797

# var alphaFrac = rgb_color.alpha.value || 0.0;

18798

# var rgbParams = [red, green, blue].join(',');

18799

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

18800

# };

18801

#

18802

# var rgbToCssColor_ = function(red, green, blue) {

18803

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

18804

# var hexString = rgbNumber.toString(16);

18805

# var missingZeros = 6 - hexString.length;

18806

# var resultBuilder = ['#'];

18807

# for (var i = 0; i < missingZeros; i++) {

18808

# resultBuilder.push('0');

18809

# }

18810

# resultBuilder.push(hexString);

18811

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

18816

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

18817

# the final pixel color is defined by the equation:

18818

#

18819

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

18820

#

18821

# This means that a value of 1.0 corresponds to a solid color, whereas

18822

# a value of 0.0 corresponds to a completely transparent color. This

18823

# uses a wrapper message rather than a simple float scalar so that it is

18824

# possible to distinguish between a default value and the value being unset.

18825

# If omitted, this color object is to be rendered as a solid color

18826

# (as if the alpha value had been explicitly given with a value of 1.0).

18827

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

18828

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

18829

},

18830

"bold": True or False, # True if the text is bold.

18831

"strikethrough": True or False, # True if the text has a strikethrough.

18832

"fontFamily": "A String", # The font family.

18833

"fontSize": 42, # The size of the font.

18834

"italic": True or False, # True if the text is italicized.

18835

"underline": True or False, # True if the text is underlined.

18836

},

18837

"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.

18838

"borders": { # The borders of the cell. # The borders of the cell.

18839

"top": { # A border along a cell. # The top border of the cell.

18840

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

18841

# for simplicity of conversion to/from color representations in various

18842

# languages over compactness; for example, the fields of this representation

18843

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

18844

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

18845

# method in iOS; and, with just a little work, it can be easily formatted into

18846

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

18851

#

18852

# // ...

18853

# public static java.awt.Color fromProto(Color protocolor) {

18854

# float alpha = protocolor.hasAlpha()

18855

# ? protocolor.getAlpha().getValue()

18856

# : 1.0;

18857

#

18858

# return new java.awt.Color(

18859

# protocolor.getRed(),

18860

# protocolor.getGreen(),

18861

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

18866

# float red = (float) color.getRed();

18867

# float green = (float) color.getGreen();

18868

# float blue = (float) color.getBlue();

18869

# float denominator = 255.0;

18870

# Color.Builder resultBuilder =

18871

# Color

18872

# .newBuilder()

18873

# .setRed(red / denominator)

18874

# .setGreen(green / denominator)

18875

# .setBlue(blue / denominator);

18876

# int alpha = color.getAlpha();

18877

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

18882

# .build());

18883

# }

18884

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

18889

#

18890

# // ...

18891

# static UIColor* fromProto(Color* protocolor) {

18892

# float red = [protocolor red];

18893

# float green = [protocolor green];

18894

# float blue = [protocolor blue];

18895

# FloatValue* alpha_wrapper = [protocolor alpha];

18896

# float alpha = 1.0;

18897

# if (alpha_wrapper != nil) {

18898

# alpha = [alpha_wrapper value];

18899

# }

18900

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

18901

# }

18902

#

18903

# static Color* toProto(UIColor* color) {

18904

# CGFloat red, green, blue, alpha;

18905

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

18906

# return nil;

18907

# }

18908

# Color* result = [Color alloc] init];

18909

# [result setRed:red];

18910

# [result setGreen:green];

18911

# [result setBlue:blue];

18912

# if (alpha <= 0.9999) {

18913

# [result setAlpha:floatWrapperWithValue(alpha)];

18914

# }

18915

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

18925

# var redFrac = rgb_color.red || 0.0;

18926

# var greenFrac = rgb_color.green || 0.0;

18927

# var blueFrac = rgb_color.blue || 0.0;

18928

# var red = Math.floor(redFrac * 255);

18929

# var green = Math.floor(greenFrac * 255);

18930

# var blue = Math.floor(blueFrac * 255);

18931

#

18932

# if (!('alpha' in rgb_color)) {

18933

# return rgbToCssColor_(red, green, blue);

18934

# }

18935

#

18936

# var alphaFrac = rgb_color.alpha.value || 0.0;

18937

# var rgbParams = [red, green, blue].join(',');

18938

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

18939

# };

18940

#

18941

# var rgbToCssColor_ = function(red, green, blue) {

18942

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

18943

# var hexString = rgbNumber.toString(16);

18944

# var missingZeros = 6 - hexString.length;

18945

# var resultBuilder = ['#'];

18946

# for (var i = 0; i < missingZeros; i++) {

18947

# resultBuilder.push('0');

18948

# }

18949

# resultBuilder.push(hexString);

18950

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

18955

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

18956

# the final pixel color is defined by the equation:

18957

#

18958

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

18959

#

18960

# This means that a value of 1.0 corresponds to a solid color, whereas

18961

# a value of 0.0 corresponds to a completely transparent color. This

18962

# uses a wrapper message rather than a simple float scalar so that it is

18963

# possible to distinguish between a default value and the value being unset.

18964

# If omitted, this color object is to be rendered as a solid color

18965

# (as if the alpha value had been explicitly given with a value of 1.0).

18966

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

18967

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

18968

},

18969

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

18970

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

18971

"style": "A String", # The style of the border.

18972

},

18973

"right": { # A border along a cell. # The right border of the cell.

18974

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

18975

# for simplicity of conversion to/from color representations in various

18976

# languages over compactness; for example, the fields of this representation

18977

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

18978

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

18979

# method in iOS; and, with just a little work, it can be easily formatted into

18980

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

18985

#

18986

# // ...

18987

# public static java.awt.Color fromProto(Color protocolor) {

18988

# float alpha = protocolor.hasAlpha()

18989

# ? protocolor.getAlpha().getValue()

18990

# : 1.0;

18991

#

18992

# return new java.awt.Color(

18993

# protocolor.getRed(),

18994

# protocolor.getGreen(),

18995

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

19000

# float red = (float) color.getRed();

19001

# float green = (float) color.getGreen();

19002

# float blue = (float) color.getBlue();

19003

# float denominator = 255.0;

19004

# Color.Builder resultBuilder =

19005

# Color

19006

# .newBuilder()

19007

# .setRed(red / denominator)

19008

# .setGreen(green / denominator)

19009

# .setBlue(blue / denominator);

19010

# int alpha = color.getAlpha();

19011

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

19016

# .build());

19017

# }

19018

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

19023

#

19024

# // ...

19025

# static UIColor* fromProto(Color* protocolor) {

19026

# float red = [protocolor red];

19027

# float green = [protocolor green];

19028

# float blue = [protocolor blue];

19029

# FloatValue* alpha_wrapper = [protocolor alpha];

19030

# float alpha = 1.0;

19031

# if (alpha_wrapper != nil) {

19032

# alpha = [alpha_wrapper value];

19033

# }

19034

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

19035

# }

19036

#

19037

# static Color* toProto(UIColor* color) {

19038

# CGFloat red, green, blue, alpha;

19039

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

19040

# return nil;

19041

# }

19042

# Color* result = [Color alloc] init];

19043

# [result setRed:red];

19044

# [result setGreen:green];

19045

# [result setBlue:blue];

19046

# if (alpha <= 0.9999) {

19047

# [result setAlpha:floatWrapperWithValue(alpha)];

19048

# }

19049

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

19059

# var redFrac = rgb_color.red || 0.0;

19060

# var greenFrac = rgb_color.green || 0.0;

19061

# var blueFrac = rgb_color.blue || 0.0;

19062

# var red = Math.floor(redFrac * 255);

19063

# var green = Math.floor(greenFrac * 255);

19064

# var blue = Math.floor(blueFrac * 255);

19065

#

19066

# if (!('alpha' in rgb_color)) {

19067

# return rgbToCssColor_(red, green, blue);

19068

# }

19069

#

19070

# var alphaFrac = rgb_color.alpha.value || 0.0;

19071

# var rgbParams = [red, green, blue].join(',');

19072

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

19073

# };

19074

#

19075

# var rgbToCssColor_ = function(red, green, blue) {

19076

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

19077

# var hexString = rgbNumber.toString(16);

19078

# var missingZeros = 6 - hexString.length;

19079

# var resultBuilder = ['#'];

19080

# for (var i = 0; i < missingZeros; i++) {

19081

# resultBuilder.push('0');

19082

# }

19083

# resultBuilder.push(hexString);

19084

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

19089

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

19090

# the final pixel color is defined by the equation:

19091

#

19092

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

19093

#

19094

# This means that a value of 1.0 corresponds to a solid color, whereas

19095

# a value of 0.0 corresponds to a completely transparent color. This

19096

# uses a wrapper message rather than a simple float scalar so that it is

19097

# possible to distinguish between a default value and the value being unset.

19098

# If omitted, this color object is to be rendered as a solid color

19099

# (as if the alpha value had been explicitly given with a value of 1.0).

19100

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

19101

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

19102

},

19103

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

19104

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

19105

"style": "A String", # The style of the border.

19106

},

19107

"bottom": { # A border along a cell. # The bottom border of the cell.

19108

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

19109

# for simplicity of conversion to/from color representations in various

19110

# languages over compactness; for example, the fields of this representation

19111

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

19112

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

19113

# method in iOS; and, with just a little work, it can be easily formatted into

19114

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

19119

#

19120

# // ...

19121

# public static java.awt.Color fromProto(Color protocolor) {

19122

# float alpha = protocolor.hasAlpha()

19123

# ? protocolor.getAlpha().getValue()

19124

# : 1.0;

19125

#

19126

# return new java.awt.Color(

19127

# protocolor.getRed(),

19128

# protocolor.getGreen(),

19129

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

19134

# float red = (float) color.getRed();

19135

# float green = (float) color.getGreen();

19136

# float blue = (float) color.getBlue();

19137

# float denominator = 255.0;

19138

# Color.Builder resultBuilder =

19139

# Color

19140

# .newBuilder()

19141

# .setRed(red / denominator)

19142

# .setGreen(green / denominator)

19143

# .setBlue(blue / denominator);

19144

# int alpha = color.getAlpha();

19145

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

19150

# .build());

19151

# }

19152

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

19157

#

19158

# // ...

19159

# static UIColor* fromProto(Color* protocolor) {

19160

# float red = [protocolor red];

19161

# float green = [protocolor green];

19162

# float blue = [protocolor blue];

19163

# FloatValue* alpha_wrapper = [protocolor alpha];

19164

# float alpha = 1.0;

19165

# if (alpha_wrapper != nil) {

19166

# alpha = [alpha_wrapper value];

19167

# }

19168

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

19169

# }

19170

#

19171

# static Color* toProto(UIColor* color) {

19172

# CGFloat red, green, blue, alpha;

19173

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

19174

# return nil;

19175

# }

19176

# Color* result = [Color alloc] init];

19177

# [result setRed:red];

19178

# [result setGreen:green];

19179

# [result setBlue:blue];

19180

# if (alpha <= 0.9999) {

19181

# [result setAlpha:floatWrapperWithValue(alpha)];

19182

# }

19183

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

19193

# var redFrac = rgb_color.red || 0.0;

19194

# var greenFrac = rgb_color.green || 0.0;

19195

# var blueFrac = rgb_color.blue || 0.0;

19196

# var red = Math.floor(redFrac * 255);

19197

# var green = Math.floor(greenFrac * 255);

19198

# var blue = Math.floor(blueFrac * 255);

19199

#

19200

# if (!('alpha' in rgb_color)) {

19201

# return rgbToCssColor_(red, green, blue);

19202

# }

19203

#

19204

# var alphaFrac = rgb_color.alpha.value || 0.0;

19205

# var rgbParams = [red, green, blue].join(',');

19206

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

19207

# };

19208

#

19209

# var rgbToCssColor_ = function(red, green, blue) {

19210

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

19211

# var hexString = rgbNumber.toString(16);

19212

# var missingZeros = 6 - hexString.length;

19213

# var resultBuilder = ['#'];

19214

# for (var i = 0; i < missingZeros; i++) {

19215

# resultBuilder.push('0');

19216

# }

19217

# resultBuilder.push(hexString);

19218

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

19223

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

19224

# the final pixel color is defined by the equation:

19225

#

19226

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

19227

#

19228

# This means that a value of 1.0 corresponds to a solid color, whereas

19229

# a value of 0.0 corresponds to a completely transparent color. This

19230

# uses a wrapper message rather than a simple float scalar so that it is

19231

# possible to distinguish between a default value and the value being unset.

19232

# If omitted, this color object is to be rendered as a solid color

19233

# (as if the alpha value had been explicitly given with a value of 1.0).

19234

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

19235

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

19236

},

19237

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

19238

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

19239

"style": "A String", # The style of the border.

19240

},

19241

"left": { # A border along a cell. # The left border of the cell.

19242

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

19243

# for simplicity of conversion to/from color representations in various

19244

# languages over compactness; for example, the fields of this representation

19245

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

19246

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

19247

# method in iOS; and, with just a little work, it can be easily formatted into

19248

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

19253

#

19254

# // ...

19255

# public static java.awt.Color fromProto(Color protocolor) {

19256

# float alpha = protocolor.hasAlpha()

19257

# ? protocolor.getAlpha().getValue()

19258

# : 1.0;

19259

#

19260

# return new java.awt.Color(

19261

# protocolor.getRed(),

19262

# protocolor.getGreen(),

19263

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

19268

# float red = (float) color.getRed();

19269

# float green = (float) color.getGreen();

19270

# float blue = (float) color.getBlue();

19271

# float denominator = 255.0;

19272

# Color.Builder resultBuilder =

19273

# Color

19274

# .newBuilder()

19275

# .setRed(red / denominator)

19276

# .setGreen(green / denominator)

19277

# .setBlue(blue / denominator);

19278

# int alpha = color.getAlpha();

19279

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

19284

# .build());

19285

# }

19286

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

19291

#

19292

# // ...

19293

# static UIColor* fromProto(Color* protocolor) {

19294

# float red = [protocolor red];

19295

# float green = [protocolor green];

19296

# float blue = [protocolor blue];

19297

# FloatValue* alpha_wrapper = [protocolor alpha];

19298

# float alpha = 1.0;

19299

# if (alpha_wrapper != nil) {

19300

# alpha = [alpha_wrapper value];

19301

# }

19302

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

19303

# }

19304

#

19305

# static Color* toProto(UIColor* color) {

19306

# CGFloat red, green, blue, alpha;

19307

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

19308

# return nil;

19309

# }

19310

# Color* result = [Color alloc] init];

19311

# [result setRed:red];

19312

# [result setGreen:green];

19313

# [result setBlue:blue];

19314

# if (alpha <= 0.9999) {

19315

# [result setAlpha:floatWrapperWithValue(alpha)];

19316

# }

19317

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

19327

# var redFrac = rgb_color.red || 0.0;

19328

# var greenFrac = rgb_color.green || 0.0;

19329

# var blueFrac = rgb_color.blue || 0.0;

19330

# var red = Math.floor(redFrac * 255);

19331

# var green = Math.floor(greenFrac * 255);

19332

# var blue = Math.floor(blueFrac * 255);

19333

#

19334

# if (!('alpha' in rgb_color)) {

19335

# return rgbToCssColor_(red, green, blue);

19336

# }

19337

#

19338

# var alphaFrac = rgb_color.alpha.value || 0.0;

19339

# var rgbParams = [red, green, blue].join(',');

19340

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

19341

# };

19342

#

19343

# var rgbToCssColor_ = function(red, green, blue) {

19344

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

19345

# var hexString = rgbNumber.toString(16);

19346

# var missingZeros = 6 - hexString.length;

19347

# var resultBuilder = ['#'];

19348

# for (var i = 0; i < missingZeros; i++) {

19349

# resultBuilder.push('0');

19350

# }

19351

# resultBuilder.push(hexString);

19352

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

19357

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

19358

# the final pixel color is defined by the equation:

19359

#

19360

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

19361

#

19362

# This means that a value of 1.0 corresponds to a solid color, whereas

19363

# a value of 0.0 corresponds to a completely transparent color. This

19364

# uses a wrapper message rather than a simple float scalar so that it is

19365

# possible to distinguish between a default value and the value being unset.

19366

# If omitted, this color object is to be rendered as a solid color

19367

# (as if the alpha value had been explicitly given with a value of 1.0).

19368

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

19369

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

19370

},

19371

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

19372

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

19373

"style": "A String", # The style of the border.

19374

},

19375

},

19376

"wrapStrategy": "A String", # The wrap strategy for the value in the cell.

19377

},

19378

"title": "A String", # The title of the spreadsheet.

19379

},

19380

"sheets": [ # The sheets that are part of a spreadsheet.

19381

{ # A sheet in a spreadsheet.

19382

"conditionalFormats": [ # The conditional format rules in this sheet.

19383

{ # A rule describing a conditional format.

19384

"ranges": [ # The ranges that will be formatted if the condition is true.

19385

# All the ranges must be on the same grid.

19386

{ # A range on a sheet.

19387

# All indexes are zero-based.

19388

# Indexes are half open, e.g the start index is inclusive

19389

# and the end index is exclusive -- [start_index, end_index).

19390

# Missing indexes indicate the range is unbounded on that side.

19391

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

19392

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

19393

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

19394

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

19395

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

19396

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

19397

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

19398

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

19399

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

19400

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

19401

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

19402

# `Sheet1!A:B == sheet_id: 0,

19403

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

19404

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

19405

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

19406

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

19407

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

19408

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

19409

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

19410

#

19411

# The start index must always be less than or equal to the end index.

19412

# If the start index equals the end index, then the range is empty.

19413

# Empty ranges are typically not meaningful and are usually rendered in the

19414

# UI as `#REF!`.

19415

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

19416

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

19417

"sheetId": 42, # The sheet this range is on.

19418

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

19419

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

19420

},

19421

],

19422

"booleanRule": { # A rule that may or may not match, depending on the condition. # The formatting is either "on" or "off" according to the rule.

19423

"condition": { # A condition that can evaluate to true or false. # The condition of the rule. If the condition evaluates to true,

19424

# the format will be applied.

19425

# BooleanConditions are used by conditional formatting,

19426

# data validation, and the criteria in filters.

19427

"type": "A String", # The type of condition.

19428

"values": [ # The values of the condition. The number of supported values depends

19429

# on the condition type. Some support zero values,

19430

# others one or two values,

19431

# and ConditionType.ONE_OF_LIST supports an arbitrary number of values.

19432

{ # The value of the condition.

19433

"relativeDate": "A String", # A relative date (based on the current date).

19434

# Valid only if the type is

19435

# DATE_BEFORE,

19436

# DATE_AFTER,

19437

# DATE_ON_OR_BEFORE or

19438

# DATE_ON_OR_AFTER.

19439

#

19440

# Relative dates are not supported in data validation.

19441

# They are supported only in conditional formatting and

19442

# conditional filters.

19443

"userEnteredValue": "A String", # A value the condition is based on.

19444

# The value will be parsed as if the user typed into a cell.

19445

# Formulas are supported (and must begin with an `=`).

},

],

},

"format": { # The format of a cell. # The format to apply.

19450

# Conditional formatting can only apply a subset of formatting:

# bold, italic,

# strikethrough,

# foreground color &

# background color.

"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

19456

"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on

19457

# the user's locale will be used if necessary for the given type.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame^]

19458

# See the [Date and Number Formats guide](/sheets/guides/formats) for more

19459

# information about the supported patterns.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

19460

"type": "A String", # The type of the number format.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

19461

# When writing, this field must be set.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

19462

},

19463

"textDirection": "A String", # The direction of the text in the cell.

19464

"padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.

19465

# When updating padding, every field must be specified.

19466

"top": 42, # The top padding of the cell.

19467

"right": 42, # The right padding of the cell.

19468

"bottom": 42, # The bottom padding of the cell.

19469

"left": 42, # The left padding of the cell.

19470

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

19471

"horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

19472

"backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.

19473

# for simplicity of conversion to/from color representations in various

19474

# languages over compactness; for example, the fields of this representation

19475

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

19476

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

19477

# method in iOS; and, with just a little work, it can be easily formatted into

19478

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

19483

#

19484

# // ...

19485

# public static java.awt.Color fromProto(Color protocolor) {

19486

# float alpha = protocolor.hasAlpha()

19487

# ? protocolor.getAlpha().getValue()

19488

# : 1.0;

19489

#

19490

# return new java.awt.Color(

19491

# protocolor.getRed(),

19492

# protocolor.getGreen(),

19493

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

19498

# float red = (float) color.getRed();

19499

# float green = (float) color.getGreen();

19500

# float blue = (float) color.getBlue();

19501

# float denominator = 255.0;

19502

# Color.Builder resultBuilder =

19503

# Color

19504

# .newBuilder()

19505

# .setRed(red / denominator)

19506

# .setGreen(green / denominator)

19507

# .setBlue(blue / denominator);

19508

# int alpha = color.getAlpha();

19509

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

19514

# .build());

19515

# }

19516

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

19521

#

19522

# // ...

19523

# static UIColor* fromProto(Color* protocolor) {

19524

# float red = [protocolor red];

19525

# float green = [protocolor green];

19526

# float blue = [protocolor blue];

19527

# FloatValue* alpha_wrapper = [protocolor alpha];

19528

# float alpha = 1.0;

19529

# if (alpha_wrapper != nil) {

19530

# alpha = [alpha_wrapper value];

19531

# }

19532

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

19533

# }

19534

#

19535

# static Color* toProto(UIColor* color) {

19536

# CGFloat red, green, blue, alpha;

19537

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

19538

# return nil;

19539

# }

19540

# Color* result = [Color alloc] init];

19541

# [result setRed:red];

19542

# [result setGreen:green];

19543

# [result setBlue:blue];

19544

# if (alpha <= 0.9999) {

19545

# [result setAlpha:floatWrapperWithValue(alpha)];

19546

# }

19547

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

19557

# var redFrac = rgb_color.red || 0.0;

19558

# var greenFrac = rgb_color.green || 0.0;

19559

# var blueFrac = rgb_color.blue || 0.0;

19560

# var red = Math.floor(redFrac * 255);

19561

# var green = Math.floor(greenFrac * 255);

19562

# var blue = Math.floor(blueFrac * 255);

19563

#

19564

# if (!('alpha' in rgb_color)) {

19565

# return rgbToCssColor_(red, green, blue);

19566

# }

19567

#

19568

# var alphaFrac = rgb_color.alpha.value || 0.0;

19569

# var rgbParams = [red, green, blue].join(',');

19570

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

19571

# };

19572

#

19573

# var rgbToCssColor_ = function(red, green, blue) {

19574

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

19575

# var hexString = rgbNumber.toString(16);

19576

# var missingZeros = 6 - hexString.length;

19577

# var resultBuilder = ['#'];

19578

# for (var i = 0; i < missingZeros; i++) {

19579

# resultBuilder.push('0');

19580

# }

19581

# resultBuilder.push(hexString);

19582

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

19587

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

19588

# the final pixel color is defined by the equation:

19589

#

19590

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

19591

#

19592

# This means that a value of 1.0 corresponds to a solid color, whereas

19593

# a value of 0.0 corresponds to a completely transparent color. This

19594

# uses a wrapper message rather than a simple float scalar so that it is

19595

# possible to distinguish between a default value and the value being unset.

19596

# If omitted, this color object is to be rendered as a solid color

19597

# (as if the alpha value had been explicitly given with a value of 1.0).

19598

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

19599

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

19600

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

19601

"verticalAlignment": "A String", # The vertical alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

19602

"textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).

19603

# Absent values indicate that the field isn't specified.

19604

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

19605

# for simplicity of conversion to/from color representations in various

19606

# languages over compactness; for example, the fields of this representation

19607

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

19608

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

19609

# method in iOS; and, with just a little work, it can be easily formatted into

19610

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

19615

#

19616

# // ...

19617

# public static java.awt.Color fromProto(Color protocolor) {

19618

# float alpha = protocolor.hasAlpha()

19619

# ? protocolor.getAlpha().getValue()

19620

# : 1.0;

19621

#

19622

# return new java.awt.Color(

19623

# protocolor.getRed(),

19624

# protocolor.getGreen(),

19625

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

19630

# float red = (float) color.getRed();

19631

# float green = (float) color.getGreen();

19632

# float blue = (float) color.getBlue();

19633

# float denominator = 255.0;

19634

# Color.Builder resultBuilder =

19635

# Color

19636

# .newBuilder()

19637

# .setRed(red / denominator)

19638

# .setGreen(green / denominator)

19639

# .setBlue(blue / denominator);

19640

# int alpha = color.getAlpha();

19641

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

19646

# .build());

19647

# }

19648

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

19653

#

19654

# // ...

19655

# static UIColor* fromProto(Color* protocolor) {

19656

# float red = [protocolor red];

19657

# float green = [protocolor green];

19658

# float blue = [protocolor blue];

19659

# FloatValue* alpha_wrapper = [protocolor alpha];

19660

# float alpha = 1.0;

19661

# if (alpha_wrapper != nil) {

19662

# alpha = [alpha_wrapper value];

19663

# }

19664

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

19665

# }

19666

#

19667

# static Color* toProto(UIColor* color) {

19668

# CGFloat red, green, blue, alpha;

19669

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

19670

# return nil;

19671

# }

19672

# Color* result = [Color alloc] init];

19673

# [result setRed:red];

19674

# [result setGreen:green];

19675

# [result setBlue:blue];

19676

# if (alpha <= 0.9999) {

19677

# [result setAlpha:floatWrapperWithValue(alpha)];

19678

# }

19679

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

19689

# var redFrac = rgb_color.red || 0.0;

19690

# var greenFrac = rgb_color.green || 0.0;

19691

# var blueFrac = rgb_color.blue || 0.0;

19692

# var red = Math.floor(redFrac * 255);

19693

# var green = Math.floor(greenFrac * 255);

19694

# var blue = Math.floor(blueFrac * 255);

19695

#

19696

# if (!('alpha' in rgb_color)) {

19697

# return rgbToCssColor_(red, green, blue);

19698

# }

19699

#

19700

# var alphaFrac = rgb_color.alpha.value || 0.0;

19701

# var rgbParams = [red, green, blue].join(',');

19702

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

19703

# };

19704

#

19705

# var rgbToCssColor_ = function(red, green, blue) {

19706

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

19707

# var hexString = rgbNumber.toString(16);

19708

# var missingZeros = 6 - hexString.length;

19709

# var resultBuilder = ['#'];

19710

# for (var i = 0; i < missingZeros; i++) {

19711

# resultBuilder.push('0');

19712

# }

19713

# resultBuilder.push(hexString);

19714

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

19719

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

19720

# the final pixel color is defined by the equation:

19721

#

19722

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

19723

#

19724

# This means that a value of 1.0 corresponds to a solid color, whereas

19725

# a value of 0.0 corresponds to a completely transparent color. This

19726

# uses a wrapper message rather than a simple float scalar so that it is

19727

# possible to distinguish between a default value and the value being unset.

19728

# If omitted, this color object is to be rendered as a solid color

19729

# (as if the alpha value had been explicitly given with a value of 1.0).

19730

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

19731

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

19732

},

19733

"bold": True or False, # True if the text is bold.

19734

"strikethrough": True or False, # True if the text has a strikethrough.

19735

"fontFamily": "A String", # The font family.

19736

"fontSize": 42, # The size of the font.

19737

"italic": True or False, # True if the text is italicized.

19738

"underline": True or False, # True if the text is underlined.

19739

},

19740

"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.

19741

"borders": { # The borders of the cell. # The borders of the cell.

19742

"top": { # A border along a cell. # The top border of the cell.

19743

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

19744

# for simplicity of conversion to/from color representations in various

19745

# languages over compactness; for example, the fields of this representation

19746

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

19747

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

19748

# method in iOS; and, with just a little work, it can be easily formatted into

19749

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

19754

#

19755

# // ...

19756

# public static java.awt.Color fromProto(Color protocolor) {

19757

# float alpha = protocolor.hasAlpha()

19758

# ? protocolor.getAlpha().getValue()

19759

# : 1.0;

19760

#

19761

# return new java.awt.Color(

19762

# protocolor.getRed(),

19763

# protocolor.getGreen(),

19764

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

19769

# float red = (float) color.getRed();

19770

# float green = (float) color.getGreen();

19771

# float blue = (float) color.getBlue();

19772

# float denominator = 255.0;

19773

# Color.Builder resultBuilder =

19774

# Color

19775

# .newBuilder()

19776

# .setRed(red / denominator)

19777

# .setGreen(green / denominator)

19778

# .setBlue(blue / denominator);

19779

# int alpha = color.getAlpha();

19780

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

19785

# .build());

19786

# }

19787

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

19792

#

19793

# // ...

19794

# static UIColor* fromProto(Color* protocolor) {

19795

# float red = [protocolor red];

19796

# float green = [protocolor green];

19797

# float blue = [protocolor blue];

19798

# FloatValue* alpha_wrapper = [protocolor alpha];

19799

# float alpha = 1.0;

19800

# if (alpha_wrapper != nil) {

19801

# alpha = [alpha_wrapper value];

19802

# }

19803

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

19804

# }

19805

#

19806

# static Color* toProto(UIColor* color) {

19807

# CGFloat red, green, blue, alpha;

19808

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

19809

# return nil;

19810

# }

19811

# Color* result = [Color alloc] init];

19812

# [result setRed:red];

19813

# [result setGreen:green];

19814

# [result setBlue:blue];

19815

# if (alpha <= 0.9999) {

19816

# [result setAlpha:floatWrapperWithValue(alpha)];

19817

# }

19818

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

19828

# var redFrac = rgb_color.red || 0.0;

19829

# var greenFrac = rgb_color.green || 0.0;

19830

# var blueFrac = rgb_color.blue || 0.0;

19831

# var red = Math.floor(redFrac * 255);

19832

# var green = Math.floor(greenFrac * 255);

19833

# var blue = Math.floor(blueFrac * 255);

19834

#

19835

# if (!('alpha' in rgb_color)) {

19836

# return rgbToCssColor_(red, green, blue);

19837

# }

19838

#

19839

# var alphaFrac = rgb_color.alpha.value || 0.0;

19840

# var rgbParams = [red, green, blue].join(',');

19841

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

19842

# };

19843

#

19844

# var rgbToCssColor_ = function(red, green, blue) {

19845

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

19846

# var hexString = rgbNumber.toString(16);

19847

# var missingZeros = 6 - hexString.length;

19848

# var resultBuilder = ['#'];

19849

# for (var i = 0; i < missingZeros; i++) {

19850

# resultBuilder.push('0');

19851

# }

19852

# resultBuilder.push(hexString);

19853

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

19858

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

19859

# the final pixel color is defined by the equation:

19860

#

19861

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

19862

#

19863

# This means that a value of 1.0 corresponds to a solid color, whereas

19864

# a value of 0.0 corresponds to a completely transparent color. This

19865

# uses a wrapper message rather than a simple float scalar so that it is

19866

# possible to distinguish between a default value and the value being unset.

19867

# If omitted, this color object is to be rendered as a solid color

19868

# (as if the alpha value had been explicitly given with a value of 1.0).

19869

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

19870

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

19871

},

19872

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

19873

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

19874

"style": "A String", # The style of the border.

19875

},

19876

"right": { # A border along a cell. # The right border of the cell.

19877

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

19878

# for simplicity of conversion to/from color representations in various

19879

# languages over compactness; for example, the fields of this representation

19880

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

19881

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

19882

# method in iOS; and, with just a little work, it can be easily formatted into

19883

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

19888

#

19889

# // ...

19890

# public static java.awt.Color fromProto(Color protocolor) {

19891

# float alpha = protocolor.hasAlpha()

19892

# ? protocolor.getAlpha().getValue()

19893

# : 1.0;

19894

#

19895

# return new java.awt.Color(

19896

# protocolor.getRed(),

19897

# protocolor.getGreen(),

19898

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

19903

# float red = (float) color.getRed();

19904

# float green = (float) color.getGreen();

19905

# float blue = (float) color.getBlue();

19906

# float denominator = 255.0;

19907

# Color.Builder resultBuilder =

19908

# Color

19909

# .newBuilder()

19910

# .setRed(red / denominator)

19911

# .setGreen(green / denominator)

19912

# .setBlue(blue / denominator);

19913

# int alpha = color.getAlpha();

19914

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

19919

# .build());

19920

# }

19921

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

19926

#

19927

# // ...

19928

# static UIColor* fromProto(Color* protocolor) {

19929

# float red = [protocolor red];

19930

# float green = [protocolor green];

19931

# float blue = [protocolor blue];

19932

# FloatValue* alpha_wrapper = [protocolor alpha];

19933

# float alpha = 1.0;

19934

# if (alpha_wrapper != nil) {

19935

# alpha = [alpha_wrapper value];

19936

# }

19937

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

19938

# }

19939

#

19940

# static Color* toProto(UIColor* color) {

19941

# CGFloat red, green, blue, alpha;

19942

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

19943

# return nil;

19944

# }

19945

# Color* result = [Color alloc] init];

19946

# [result setRed:red];

19947

# [result setGreen:green];

19948

# [result setBlue:blue];

19949

# if (alpha <= 0.9999) {

19950

# [result setAlpha:floatWrapperWithValue(alpha)];

19951

# }

19952

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

19962

# var redFrac = rgb_color.red || 0.0;

19963

# var greenFrac = rgb_color.green || 0.0;

19964

# var blueFrac = rgb_color.blue || 0.0;

19965

# var red = Math.floor(redFrac * 255);

19966

# var green = Math.floor(greenFrac * 255);

19967

# var blue = Math.floor(blueFrac * 255);

19968

#

19969

# if (!('alpha' in rgb_color)) {

19970

# return rgbToCssColor_(red, green, blue);

19971

# }

19972

#

19973

# var alphaFrac = rgb_color.alpha.value || 0.0;

19974

# var rgbParams = [red, green, blue].join(',');

19975

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

19976

# };

19977

#

19978

# var rgbToCssColor_ = function(red, green, blue) {

19979

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

19980

# var hexString = rgbNumber.toString(16);

19981

# var missingZeros = 6 - hexString.length;

19982

# var resultBuilder = ['#'];

19983

# for (var i = 0; i < missingZeros; i++) {

19984

# resultBuilder.push('0');

19985

# }

19986

# resultBuilder.push(hexString);

19987

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

19992

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

19993

# the final pixel color is defined by the equation:

19994

#

19995

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

19996

#

19997

# This means that a value of 1.0 corresponds to a solid color, whereas

19998

# a value of 0.0 corresponds to a completely transparent color. This

19999

# uses a wrapper message rather than a simple float scalar so that it is

20000

# possible to distinguish between a default value and the value being unset.

20001

# If omitted, this color object is to be rendered as a solid color

20002

# (as if the alpha value had been explicitly given with a value of 1.0).

20003

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

20004

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

20005

},

20006

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20007

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20008

"style": "A String", # The style of the border.

20009

},

20010

"bottom": { # A border along a cell. # The bottom border of the cell.

20011

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

20012

# for simplicity of conversion to/from color representations in various

20013

# languages over compactness; for example, the fields of this representation

20014

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

20015

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

20016

# method in iOS; and, with just a little work, it can be easily formatted into

20017

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

20022

#

20023

# // ...

20024

# public static java.awt.Color fromProto(Color protocolor) {

20025

# float alpha = protocolor.hasAlpha()

20026

# ? protocolor.getAlpha().getValue()

20027

# : 1.0;

20028

#

20029

# return new java.awt.Color(

20030

# protocolor.getRed(),

20031

# protocolor.getGreen(),

20032

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

20037

# float red = (float) color.getRed();

20038

# float green = (float) color.getGreen();

20039

# float blue = (float) color.getBlue();

20040

# float denominator = 255.0;

20041

# Color.Builder resultBuilder =

20042

# Color

20043

# .newBuilder()

20044

# .setRed(red / denominator)

20045

# .setGreen(green / denominator)

20046

# .setBlue(blue / denominator);

20047

# int alpha = color.getAlpha();

20048

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

20053

# .build());

20054

# }

20055

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

20060

#

20061

# // ...

20062

# static UIColor* fromProto(Color* protocolor) {

20063

# float red = [protocolor red];

20064

# float green = [protocolor green];

20065

# float blue = [protocolor blue];

20066

# FloatValue* alpha_wrapper = [protocolor alpha];

20067

# float alpha = 1.0;

20068

# if (alpha_wrapper != nil) {

20069

# alpha = [alpha_wrapper value];

20070

# }

20071

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

20072

# }

20073

#

20074

# static Color* toProto(UIColor* color) {

20075

# CGFloat red, green, blue, alpha;

20076

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

20077

# return nil;

20078

# }

20079

# Color* result = [Color alloc] init];

20080

# [result setRed:red];

20081

# [result setGreen:green];

20082

# [result setBlue:blue];

20083

# if (alpha <= 0.9999) {

20084

# [result setAlpha:floatWrapperWithValue(alpha)];

20085

# }

20086

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

20096

# var redFrac = rgb_color.red || 0.0;

20097

# var greenFrac = rgb_color.green || 0.0;

20098

# var blueFrac = rgb_color.blue || 0.0;

20099

# var red = Math.floor(redFrac * 255);

20100

# var green = Math.floor(greenFrac * 255);

20101

# var blue = Math.floor(blueFrac * 255);

20102

#

20103

# if (!('alpha' in rgb_color)) {

20104

# return rgbToCssColor_(red, green, blue);

20105

# }

20106

#

20107

# var alphaFrac = rgb_color.alpha.value || 0.0;

20108

# var rgbParams = [red, green, blue].join(',');

20109

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

20110

# };

20111

#

20112

# var rgbToCssColor_ = function(red, green, blue) {

20113

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

20114

# var hexString = rgbNumber.toString(16);

20115

# var missingZeros = 6 - hexString.length;

20116

# var resultBuilder = ['#'];

20117

# for (var i = 0; i < missingZeros; i++) {

20118

# resultBuilder.push('0');

20119

# }

20120

# resultBuilder.push(hexString);

20121

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

20126

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

20127

# the final pixel color is defined by the equation:

20128

#

20129

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

20130

#

20131

# This means that a value of 1.0 corresponds to a solid color, whereas

20132

# a value of 0.0 corresponds to a completely transparent color. This

20133

# uses a wrapper message rather than a simple float scalar so that it is

20134

# possible to distinguish between a default value and the value being unset.

20135

# If omitted, this color object is to be rendered as a solid color

20136

# (as if the alpha value had been explicitly given with a value of 1.0).

20137

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

20138

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

20139

},

20140

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20141

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20142

"style": "A String", # The style of the border.

20143

},

20144

"left": { # A border along a cell. # The left border of the cell.

20145

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

20146

# for simplicity of conversion to/from color representations in various

20147

# languages over compactness; for example, the fields of this representation

20148

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

20149

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

20150

# method in iOS; and, with just a little work, it can be easily formatted into

20151

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

20156

#

20157

# // ...

20158

# public static java.awt.Color fromProto(Color protocolor) {

20159

# float alpha = protocolor.hasAlpha()

20160

# ? protocolor.getAlpha().getValue()

20161

# : 1.0;

20162

#

20163

# return new java.awt.Color(

20164

# protocolor.getRed(),

20165

# protocolor.getGreen(),

20166

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

20171

# float red = (float) color.getRed();

20172

# float green = (float) color.getGreen();

20173

# float blue = (float) color.getBlue();

20174

# float denominator = 255.0;

20175

# Color.Builder resultBuilder =

20176

# Color

20177

# .newBuilder()

20178

# .setRed(red / denominator)

20179

# .setGreen(green / denominator)

20180

# .setBlue(blue / denominator);

20181

# int alpha = color.getAlpha();

20182

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

20187

# .build());

20188

# }

20189

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

20194

#

20195

# // ...

20196

# static UIColor* fromProto(Color* protocolor) {

20197

# float red = [protocolor red];

20198

# float green = [protocolor green];

20199

# float blue = [protocolor blue];

20200

# FloatValue* alpha_wrapper = [protocolor alpha];

20201

# float alpha = 1.0;

20202

# if (alpha_wrapper != nil) {

20203

# alpha = [alpha_wrapper value];

20204

# }

20205

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

20206

# }

20207

#

20208

# static Color* toProto(UIColor* color) {

20209

# CGFloat red, green, blue, alpha;

20210

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

20211

# return nil;

20212

# }

20213

# Color* result = [Color alloc] init];

20214

# [result setRed:red];

20215

# [result setGreen:green];

20216

# [result setBlue:blue];

20217

# if (alpha <= 0.9999) {

20218

# [result setAlpha:floatWrapperWithValue(alpha)];

20219

# }

20220

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

20230

# var redFrac = rgb_color.red || 0.0;

20231

# var greenFrac = rgb_color.green || 0.0;

20232

# var blueFrac = rgb_color.blue || 0.0;

20233

# var red = Math.floor(redFrac * 255);

20234

# var green = Math.floor(greenFrac * 255);

20235

# var blue = Math.floor(blueFrac * 255);

20236

#

20237

# if (!('alpha' in rgb_color)) {

20238

# return rgbToCssColor_(red, green, blue);

20239

# }

20240

#

20241

# var alphaFrac = rgb_color.alpha.value || 0.0;

20242

# var rgbParams = [red, green, blue].join(',');

20243

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

20244

# };

20245

#

20246

# var rgbToCssColor_ = function(red, green, blue) {

20247

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

20248

# var hexString = rgbNumber.toString(16);

20249

# var missingZeros = 6 - hexString.length;

20250

# var resultBuilder = ['#'];

20251

# for (var i = 0; i < missingZeros; i++) {

20252

# resultBuilder.push('0');

20253

# }

20254

# resultBuilder.push(hexString);

20255

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

20260

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

20261

# the final pixel color is defined by the equation:

20262

#

20263

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

20264

#

20265

# This means that a value of 1.0 corresponds to a solid color, whereas

20266

# a value of 0.0 corresponds to a completely transparent color. This

20267

# uses a wrapper message rather than a simple float scalar so that it is

20268

# possible to distinguish between a default value and the value being unset.

20269

# If omitted, this color object is to be rendered as a solid color

20270

# (as if the alpha value had been explicitly given with a value of 1.0).

20271

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

20272

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

20273

},

20274

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20275

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20276

"style": "A String", # The style of the border.

20277

},

20278

},

20279

"wrapStrategy": "A String", # The wrap strategy for the value in the cell.

20280

},

20281

},

20282

"gradientRule": { # A rule that applies a gradient color scale format, based on # The formatting will vary based on the gradients in the rule.

20283

# the interpolation points listed. The format of a cell will vary

20284

# based on its contents as compared to the values of the interpolation

20285

# points.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20286

"maxpoint": { # A single interpolation point on a gradient conditional format. # The final interpolation point.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20287

# These pin the gradient color scale according to the color,

20288

# type and value chosen.

20289

"color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.

20290

# for simplicity of conversion to/from color representations in various

20291

# languages over compactness; for example, the fields of this representation

20292

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

20293

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

20294

# method in iOS; and, with just a little work, it can be easily formatted into

20295

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

20300

#

20301

# // ...

20302

# public static java.awt.Color fromProto(Color protocolor) {

20303

# float alpha = protocolor.hasAlpha()

20304

# ? protocolor.getAlpha().getValue()

20305

# : 1.0;

20306

#

20307

# return new java.awt.Color(

20308

# protocolor.getRed(),

20309

# protocolor.getGreen(),

20310

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

20315

# float red = (float) color.getRed();

20316

# float green = (float) color.getGreen();

20317

# float blue = (float) color.getBlue();

20318

# float denominator = 255.0;

20319

# Color.Builder resultBuilder =

20320

# Color

20321

# .newBuilder()

20322

# .setRed(red / denominator)

20323

# .setGreen(green / denominator)

20324

# .setBlue(blue / denominator);

20325

# int alpha = color.getAlpha();

20326

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

20331

# .build());

20332

# }

20333

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

20338

#

20339

# // ...

20340

# static UIColor* fromProto(Color* protocolor) {

20341

# float red = [protocolor red];

20342

# float green = [protocolor green];

20343

# float blue = [protocolor blue];

20344

# FloatValue* alpha_wrapper = [protocolor alpha];

20345

# float alpha = 1.0;

20346

# if (alpha_wrapper != nil) {

20347

# alpha = [alpha_wrapper value];

20348

# }

20349

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

20350

# }

20351

#

20352

# static Color* toProto(UIColor* color) {

20353

# CGFloat red, green, blue, alpha;

20354

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

20355

# return nil;

20356

# }

20357

# Color* result = [Color alloc] init];

20358

# [result setRed:red];

20359

# [result setGreen:green];

20360

# [result setBlue:blue];

20361

# if (alpha <= 0.9999) {

20362

# [result setAlpha:floatWrapperWithValue(alpha)];

20363

# }

20364

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

20374

# var redFrac = rgb_color.red || 0.0;

20375

# var greenFrac = rgb_color.green || 0.0;

20376

# var blueFrac = rgb_color.blue || 0.0;

20377

# var red = Math.floor(redFrac * 255);

20378

# var green = Math.floor(greenFrac * 255);

20379

# var blue = Math.floor(blueFrac * 255);

20380

#

20381

# if (!('alpha' in rgb_color)) {

20382

# return rgbToCssColor_(red, green, blue);

20383

# }

20384

#

20385

# var alphaFrac = rgb_color.alpha.value || 0.0;

20386

# var rgbParams = [red, green, blue].join(',');

20387

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

20388

# };

20389

#

20390

# var rgbToCssColor_ = function(red, green, blue) {

20391

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

20392

# var hexString = rgbNumber.toString(16);

20393

# var missingZeros = 6 - hexString.length;

20394

# var resultBuilder = ['#'];

20395

# for (var i = 0; i < missingZeros; i++) {

20396

# resultBuilder.push('0');

20397

# }

20398

# resultBuilder.push(hexString);

20399

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

20404

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

20405

# the final pixel color is defined by the equation:

20406

#

20407

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

20408

#

20409

# This means that a value of 1.0 corresponds to a solid color, whereas

20410

# a value of 0.0 corresponds to a completely transparent color. This

20411

# uses a wrapper message rather than a simple float scalar so that it is

20412

# possible to distinguish between a default value and the value being unset.

20413

# If omitted, this color object is to be rendered as a solid color

20414

# (as if the alpha value had been explicitly given with a value of 1.0).

20415

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

20416

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

20417

},

20418

"type": "A String", # How the value should be interpreted.

20419

"value": "A String", # The value this interpolation point uses. May be a formula.

20420

# Unused if type is MIN or

20421

# MAX.

20422

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20423

"midpoint": { # A single interpolation point on a gradient conditional format. # An optional midway interpolation point.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20424

# These pin the gradient color scale according to the color,

20425

# type and value chosen.

20426

"color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.

20427

# for simplicity of conversion to/from color representations in various

20428

# languages over compactness; for example, the fields of this representation

20429

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

20430

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

20431

# method in iOS; and, with just a little work, it can be easily formatted into

20432

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

20437

#

20438

# // ...

20439

# public static java.awt.Color fromProto(Color protocolor) {

20440

# float alpha = protocolor.hasAlpha()

20441

# ? protocolor.getAlpha().getValue()

20442

# : 1.0;

20443

#

20444

# return new java.awt.Color(

20445

# protocolor.getRed(),

20446

# protocolor.getGreen(),

20447

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

20452

# float red = (float) color.getRed();

20453

# float green = (float) color.getGreen();

20454

# float blue = (float) color.getBlue();

20455

# float denominator = 255.0;

20456

# Color.Builder resultBuilder =

20457

# Color

20458

# .newBuilder()

20459

# .setRed(red / denominator)

20460

# .setGreen(green / denominator)

20461

# .setBlue(blue / denominator);

20462

# int alpha = color.getAlpha();

20463

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

20468

# .build());

20469

# }

20470

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

20475

#

20476

# // ...

20477

# static UIColor* fromProto(Color* protocolor) {

20478

# float red = [protocolor red];

20479

# float green = [protocolor green];

20480

# float blue = [protocolor blue];

20481

# FloatValue* alpha_wrapper = [protocolor alpha];

20482

# float alpha = 1.0;

20483

# if (alpha_wrapper != nil) {

20484

# alpha = [alpha_wrapper value];

20485

# }

20486

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

20487

# }

20488

#

20489

# static Color* toProto(UIColor* color) {

20490

# CGFloat red, green, blue, alpha;

20491

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

20492

# return nil;

20493

# }

20494

# Color* result = [Color alloc] init];

20495

# [result setRed:red];

20496

# [result setGreen:green];

20497

# [result setBlue:blue];

20498

# if (alpha <= 0.9999) {

20499

# [result setAlpha:floatWrapperWithValue(alpha)];

20500

# }

20501

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

20511

# var redFrac = rgb_color.red || 0.0;

20512

# var greenFrac = rgb_color.green || 0.0;

20513

# var blueFrac = rgb_color.blue || 0.0;

20514

# var red = Math.floor(redFrac * 255);

20515

# var green = Math.floor(greenFrac * 255);

20516

# var blue = Math.floor(blueFrac * 255);

20517

#

20518

# if (!('alpha' in rgb_color)) {

20519

# return rgbToCssColor_(red, green, blue);

20520

# }

20521

#

20522

# var alphaFrac = rgb_color.alpha.value || 0.0;

20523

# var rgbParams = [red, green, blue].join(',');

20524

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

20525

# };

20526

#

20527

# var rgbToCssColor_ = function(red, green, blue) {

20528

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

20529

# var hexString = rgbNumber.toString(16);

20530

# var missingZeros = 6 - hexString.length;

20531

# var resultBuilder = ['#'];

20532

# for (var i = 0; i < missingZeros; i++) {

20533

# resultBuilder.push('0');

20534

# }

20535

# resultBuilder.push(hexString);

20536

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

20541

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

20542

# the final pixel color is defined by the equation:

20543

#

20544

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

20545

#

20546

# This means that a value of 1.0 corresponds to a solid color, whereas

20547

# a value of 0.0 corresponds to a completely transparent color. This

20548

# uses a wrapper message rather than a simple float scalar so that it is

20549

# possible to distinguish between a default value and the value being unset.

20550

# If omitted, this color object is to be rendered as a solid color

20551

# (as if the alpha value had been explicitly given with a value of 1.0).

20552

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

20553

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

20554

},

20555

"type": "A String", # How the value should be interpreted.

20556

"value": "A String", # The value this interpolation point uses. May be a formula.

20557

# Unused if type is MIN or

20558

# MAX.

20559

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20560

"minpoint": { # A single interpolation point on a gradient conditional format. # The starting interpolation point.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20561

# These pin the gradient color scale according to the color,

20562

# type and value chosen.

20563

"color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.

20564

# for simplicity of conversion to/from color representations in various

20565

# languages over compactness; for example, the fields of this representation

20566

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

20567

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

20568

# method in iOS; and, with just a little work, it can be easily formatted into

20569

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

20574

#

20575

# // ...

20576

# public static java.awt.Color fromProto(Color protocolor) {

20577

# float alpha = protocolor.hasAlpha()

20578

# ? protocolor.getAlpha().getValue()

20579

# : 1.0;

20580

#

20581

# return new java.awt.Color(

20582

# protocolor.getRed(),

20583

# protocolor.getGreen(),

20584

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

20589

# float red = (float) color.getRed();

20590

# float green = (float) color.getGreen();

20591

# float blue = (float) color.getBlue();

20592

# float denominator = 255.0;

20593

# Color.Builder resultBuilder =

20594

# Color

20595

# .newBuilder()

20596

# .setRed(red / denominator)

20597

# .setGreen(green / denominator)

20598

# .setBlue(blue / denominator);

20599

# int alpha = color.getAlpha();

20600

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

20605

# .build());

20606

# }

20607

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

20612

#

20613

# // ...

20614

# static UIColor* fromProto(Color* protocolor) {

20615

# float red = [protocolor red];

20616

# float green = [protocolor green];

20617

# float blue = [protocolor blue];

20618

# FloatValue* alpha_wrapper = [protocolor alpha];

20619

# float alpha = 1.0;

20620

# if (alpha_wrapper != nil) {

20621

# alpha = [alpha_wrapper value];

20622

# }

20623

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

20624

# }

20625

#

20626

# static Color* toProto(UIColor* color) {

20627

# CGFloat red, green, blue, alpha;

20628

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

20629

# return nil;

20630

# }

20631

# Color* result = [Color alloc] init];

20632

# [result setRed:red];

20633

# [result setGreen:green];

20634

# [result setBlue:blue];

20635

# if (alpha <= 0.9999) {

20636

# [result setAlpha:floatWrapperWithValue(alpha)];

20637

# }

20638

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

20648

# var redFrac = rgb_color.red || 0.0;

20649

# var greenFrac = rgb_color.green || 0.0;

20650

# var blueFrac = rgb_color.blue || 0.0;

20651

# var red = Math.floor(redFrac * 255);

20652

# var green = Math.floor(greenFrac * 255);

20653

# var blue = Math.floor(blueFrac * 255);

20654

#

20655

# if (!('alpha' in rgb_color)) {

20656

# return rgbToCssColor_(red, green, blue);

20657

# }

20658

#

20659

# var alphaFrac = rgb_color.alpha.value || 0.0;

20660

# var rgbParams = [red, green, blue].join(',');

20661

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

20662

# };

20663

#

20664

# var rgbToCssColor_ = function(red, green, blue) {

20665

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

20666

# var hexString = rgbNumber.toString(16);

20667

# var missingZeros = 6 - hexString.length;

20668

# var resultBuilder = ['#'];

20669

# for (var i = 0; i < missingZeros; i++) {

20670

# resultBuilder.push('0');

20671

# }

20672

# resultBuilder.push(hexString);

20673

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

20678

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

20679

# the final pixel color is defined by the equation:

20680

#

20681

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

20682

#

20683

# This means that a value of 1.0 corresponds to a solid color, whereas

20684

# a value of 0.0 corresponds to a completely transparent color. This

20685

# uses a wrapper message rather than a simple float scalar so that it is

20686

# possible to distinguish between a default value and the value being unset.

20687

# If omitted, this color object is to be rendered as a solid color

20688

# (as if the alpha value had been explicitly given with a value of 1.0).

20689

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

20690

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

20691

},

20692

"type": "A String", # How the value should be interpreted.

20693

"value": "A String", # The value this interpolation point uses. May be a formula.

20694

# Unused if type is MIN or

# MAX.

},

},

},

],

"merges": [ # The ranges that are merged together.

20701

{ # A range on a sheet.

20702

# All indexes are zero-based.

20703

# Indexes are half open, e.g the start index is inclusive

20704

# and the end index is exclusive -- [start_index, end_index).

20705

# Missing indexes indicate the range is unbounded on that side.

20706

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20707

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20708

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20709

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20710

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20711

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20712

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20713

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20714

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20715

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20716

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20717

# `Sheet1!A:B == sheet_id: 0,

20718

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20719

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20720

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20721

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20722

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20723

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20724

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20725

#

20726

# The start index must always be less than or equal to the end index.

20727

# If the start index equals the end index, then the range is empty.

20728

# Empty ranges are typically not meaningful and are usually rendered in the

20729

# UI as `#REF!`.

20730

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

20731

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

20732

"sheetId": 42, # The sheet this range is on.

20733

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

20734

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

20735

},

20736

],

20737

"basicFilter": { # The default filter associated with a sheet. # The filter on this sheet, if any.

20738

"range": { # A range on a sheet. # The range the filter covers.

20739

# All indexes are zero-based.

20740

# Indexes are half open, e.g the start index is inclusive

20741

# and the end index is exclusive -- [start_index, end_index).

20742

# Missing indexes indicate the range is unbounded on that side.

20743

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20744

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20745

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20746

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20747

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20748

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20749

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20750

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20751

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20752

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20753

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20754

# `Sheet1!A:B == sheet_id: 0,

20755

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20756

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20757

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20758

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20759

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20760

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20761

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20762

#

20763

# The start index must always be less than or equal to the end index.

20764

# If the start index equals the end index, then the range is empty.

20765

# Empty ranges are typically not meaningful and are usually rendered in the

20766

# UI as `#REF!`.

20767

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

20768

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

20769

"sheetId": 42, # The sheet this range is on.

20770

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

20771

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

20772

},

20773

"sortSpecs": [ # The sort order per column. Later specifications are used when values

20774

# are equal in the earlier specifications.

20775

{ # A sort order associated with a specific column or row.

20776

"sortOrder": "A String", # The order data should be sorted.

20777

"dimensionIndex": 42, # The dimension the sort should be applied to.

20778

},

20779

],

20780

"criteria": { # The criteria for showing/hiding values per column.

20781

# The map's key is the column index, and the value is the criteria for

20782

# that column.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20783

"a_key": { # Criteria for showing/hiding rows in a filter or filter view.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20784

"hiddenValues": [ # Values that should be hidden.

20785

"A String",

20786

],

20787

"condition": { # A condition that can evaluate to true or false. # A condition that must be true for values to be shown.

20788

# (This does not override hiddenValues -- if a value is listed there,

20789

# it will still be hidden.)

20790

# BooleanConditions are used by conditional formatting,

20791

# data validation, and the criteria in filters.

20792

"type": "A String", # The type of condition.

20793

"values": [ # The values of the condition. The number of supported values depends

20794

# on the condition type. Some support zero values,

20795

# others one or two values,

20796

# and ConditionType.ONE_OF_LIST supports an arbitrary number of values.

20797

{ # The value of the condition.

20798

"relativeDate": "A String", # A relative date (based on the current date).

20799

# Valid only if the type is

20800

# DATE_BEFORE,

20801

# DATE_AFTER,

20802

# DATE_ON_OR_BEFORE or

20803

# DATE_ON_OR_AFTER.

20804

#

20805

# Relative dates are not supported in data validation.

20806

# They are supported only in conditional formatting and

20807

# conditional filters.

20808

"userEnteredValue": "A String", # A value the condition is based on.

20809

# The value will be parsed as if the user typed into a cell.

20810

# Formulas are supported (and must begin with an `=`).

},

],

},

},

},

},

"charts": [ # The specifications of every chart on this sheet.

20818

{ # A chart embedded in a sheet.

20819

"chartId": 42, # The ID of the chart.

20820

"position": { # The position of an embedded object such as a chart. # The position of the chart.

20821

"newSheet": True or False, # If true, the embedded object will be put on a new sheet whose ID

20822

# is chosen for you. Used only when writing.

20823

"sheetId": 42, # The sheet this is on. Set only if the embedded object

20824

# is on its own sheet. Must be non-negative.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20825

"overlayPosition": { # The location an object is overlaid on top of a grid. # The position at which the object is overlaid on top of a grid.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20826

"anchorCell": { # A coordinate in a sheet. # The cell the object is anchored to.

20827

# All indexes are zero-based.

20828

"rowIndex": 42, # The row index of the coordinate.

20829

"columnIndex": 42, # The column index of the coordinate.

20830

"sheetId": 42, # The sheet this coordinate is on.

20831

},

20832

"offsetYPixels": 42, # The vertical offset, in pixels, that the object is offset

20833

# from the anchor cell.

20834

"widthPixels": 42, # The width of the object, in pixels. Defaults to 600.

20835

"offsetXPixels": 42, # The horizontal offset, in pixels, that the object is offset

20836

# from the anchor cell.

20837

"heightPixels": 42, # The height of the object, in pixels. Defaults to 371.

20838

},

20839

},

20840

"spec": { # The specifications of a chart. # The specification of the chart.

20841

"hiddenDimensionStrategy": "A String", # Determines how the charts will use hidden rows or columns.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20842

"pieChart": { # A <a href="/chart/interactive/docs/gallery/piechart">pie chart</a>. # A pie chart specification.

20843

"series": { # The data included in a domain or series. # The data that covers the one and only series of the pie chart.

20844

"sourceRange": { # Source ranges for a chart. # The source ranges of the data.

20845

"sources": [ # The ranges of data for a series or domain.

20846

# Exactly one dimension must have a length of 1,

20847

# and all sources in the list must have the same dimension

20848

# with length 1.

20849

# The domain (if it exists) & all series must have the same number

20850

# of source ranges. If using more than one source range, then the source

20851

# range at a given offset must be contiguous across the domain and series.

20852

#

20853

# For example, these are valid configurations:

20854

#

20855

# domain sources: A1:A5

20856

# series1 sources: B1:B5

20857

# series2 sources: D6:D10

20858

#

20859

# domain sources: A1:A5, C10:C12

20860

# series1 sources: B1:B5, D10:D12

20861

# series2 sources: C1:C5, E10:E12

20862

{ # A range on a sheet.

20863

# All indexes are zero-based.

20864

# Indexes are half open, e.g the start index is inclusive

20865

# and the end index is exclusive -- [start_index, end_index).

20866

# Missing indexes indicate the range is unbounded on that side.

20867

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20868

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20869

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20870

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20871

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20872

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20873

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20874

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20875

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20876

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20877

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20878

# `Sheet1!A:B == sheet_id: 0,

20879

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20880

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20881

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20882

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20883

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20884

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20885

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20886

#

20887

# The start index must always be less than or equal to the end index.

20888

# If the start index equals the end index, then the range is empty.

20889

# Empty ranges are typically not meaningful and are usually rendered in the

20890

# UI as `#REF!`.

20891

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

20892

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

20893

"sheetId": 42, # The sheet this range is on.

20894

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

20895

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

],

},

},

"domain": { # The data included in a domain or series. # The data that covers the domain of the pie chart.

20901

"sourceRange": { # Source ranges for a chart. # The source ranges of the data.

20902

"sources": [ # The ranges of data for a series or domain.

20903

# Exactly one dimension must have a length of 1,

20904

# and all sources in the list must have the same dimension

20905

# with length 1.

20906

# The domain (if it exists) & all series must have the same number

20907

# of source ranges. If using more than one source range, then the source

20908

# range at a given offset must be contiguous across the domain and series.

20909

#

20910

# For example, these are valid configurations:

20911

#

20912

# domain sources: A1:A5

20913

# series1 sources: B1:B5

20914

# series2 sources: D6:D10

20915

#

20916

# domain sources: A1:A5, C10:C12

20917

# series1 sources: B1:B5, D10:D12

20918

# series2 sources: C1:C5, E10:E12

20919

{ # A range on a sheet.

20920

# All indexes are zero-based.

20921

# Indexes are half open, e.g the start index is inclusive

20922

# and the end index is exclusive -- [start_index, end_index).

20923

# Missing indexes indicate the range is unbounded on that side.

20924

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20925

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20926

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20927

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20928

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20929

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20930

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20931

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20932

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20933

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20934

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20935

# `Sheet1!A:B == sheet_id: 0,

20936

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20937

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20938

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20939

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20940

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20941

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20942

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20943

#

20944

# The start index must always be less than or equal to the end index.

20945

# If the start index equals the end index, then the range is empty.

20946

# Empty ranges are typically not meaningful and are usually rendered in the

20947

# UI as `#REF!`.

20948

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

20949

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

20950

"sheetId": 42, # The sheet this range is on.

20951

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

20952

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

],

},

},

"threeDimensional": True or False, # True if the pie is three dimensional.

20958

"legendPosition": "A String", # Where the legend of the pie chart should be drawn.

20959

"pieHole": 3.14, # The size of the hole in the pie chart.

20960

},

20961

"basicChart": { # The specification for a basic chart. See BasicChartType for the list # A basic chart specification, can be one of many kinds of charts.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

20962

# See BasicChartType for the list of all

20963

# charts this supports.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

20964

# of charts this supports.

20965

"headerCount": 42, # The number of rows or columns in the data that are "headers".

20966

# If not set, Google Sheets will guess how many rows are headers based

20967

# on the data.

20968

#

20969

# (Note that BasicChartAxis.title may override the axis title

20970

# inferred from the header values.)

20971

"series": [ # The data this chart is visualizing.

20972

{ # A single series of data in a chart.

20973

# For example, if charting stock prices over time, multiple series may exist,

20974

# one for the "Open Price", "High Price", "Low Price" and "Close Price".

20975

"series": { # The data included in a domain or series. # The data being visualized in this chart series.

20976

"sourceRange": { # Source ranges for a chart. # The source ranges of the data.

20977

"sources": [ # The ranges of data for a series or domain.

20978

# Exactly one dimension must have a length of 1,

20979

# and all sources in the list must have the same dimension

20980

# with length 1.

20981

# The domain (if it exists) & all series must have the same number

20982

# of source ranges. If using more than one source range, then the source

20983

# range at a given offset must be contiguous across the domain and series.

20984

#

20985

# For example, these are valid configurations:

20986

#

20987

# domain sources: A1:A5

20988

# series1 sources: B1:B5

20989

# series2 sources: D6:D10

20990

#

20991

# domain sources: A1:A5, C10:C12

20992

# series1 sources: B1:B5, D10:D12

20993

# series2 sources: C1:C5, E10:E12

20994

{ # A range on a sheet.

20995

# All indexes are zero-based.

20996

# Indexes are half open, e.g the start index is inclusive

20997

# and the end index is exclusive -- [start_index, end_index).

20998

# Missing indexes indicate the range is unbounded on that side.

20999

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21000

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21001

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21002

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21003

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21004

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21005

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21006

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21007

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21008

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21009

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21010

# `Sheet1!A:B == sheet_id: 0,

21011

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21012

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21013

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21014

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21015

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21016

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21017

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21018

#

21019

# The start index must always be less than or equal to the end index.

21020

# If the start index equals the end index, then the range is empty.

21021

# Empty ranges are typically not meaningful and are usually rendered in the

21022

# UI as `#REF!`.

21023

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

21024

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

21025

"sheetId": 42, # The sheet this range is on.

21026

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

21027

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

],

},

},

"targetAxis": "A String", # The minor axis that will specify the range of values for this series.

21033

# For example, if charting stocks over time, the "Volume" series

21034

# may want to be pinned to the right with the prices pinned to the left,

21035

# because the scale of trading volume is different than the scale of

21036

# prices.

21037

# It is an error to specify an axis that isn't a valid minor axis

21038

# for the chart's type.

21039

"type": "A String", # The type of this series. Valid only if the

21040

# chartType is

21041

# COMBO.

21042

# Different types will change the way the series is visualized.

21043

# Only LINE, AREA,

21044

# and COLUMN are supported.

21045

},

21046

],

21047

"legendPosition": "A String", # The position of the chart legend.

21048

"domains": [ # The domain of data this is charting.

21049

# Only a single domain is currently supported.

21050

{ # The domain of a chart.

21051

# For example, if charting stock prices over time, this would be the date.

21052

"domain": { # The data included in a domain or series. # The data of the domain. For example, if charting stock prices over time,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21053

# this is the data representing the dates.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21054

"sourceRange": { # Source ranges for a chart. # The source ranges of the data.

21055

"sources": [ # The ranges of data for a series or domain.

21056

# Exactly one dimension must have a length of 1,

21057

# and all sources in the list must have the same dimension

21058

# with length 1.

21059

# The domain (if it exists) & all series must have the same number

21060

# of source ranges. If using more than one source range, then the source

21061

# range at a given offset must be contiguous across the domain and series.

21062

#

21063

# For example, these are valid configurations:

21064

#

21065

# domain sources: A1:A5

21066

# series1 sources: B1:B5

21067

# series2 sources: D6:D10

21068

#

21069

# domain sources: A1:A5, C10:C12

21070

# series1 sources: B1:B5, D10:D12

21071

# series2 sources: C1:C5, E10:E12

21072

{ # A range on a sheet.

21073

# All indexes are zero-based.

21074

# Indexes are half open, e.g the start index is inclusive

21075

# and the end index is exclusive -- [start_index, end_index).

21076

# Missing indexes indicate the range is unbounded on that side.

21077

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21078

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21079

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21080

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21081

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21082

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21083

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21084

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21085

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21086

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21087

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21088

# `Sheet1!A:B == sheet_id: 0,

21089

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21090

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21091

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21092

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21093

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21094

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21095

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21096

#

21097

# The start index must always be less than or equal to the end index.

21098

# If the start index equals the end index, then the range is empty.

21099

# Empty ranges are typically not meaningful and are usually rendered in the

21100

# UI as `#REF!`.

21101

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

21102

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

21103

"sheetId": 42, # The sheet this range is on.

21104

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

21105

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

],

},

},

},

],

"chartType": "A String", # The type of the chart.

21113

"axis": [ # The axis on the chart.

21114

{ # An axis of the chart.

21115

# A chart may not have more than one axis per

21116

# axis position.

21117

"position": "A String", # The position of this axis.

21118

"format": { # The format of a run of text in a cell. # The format of the title.

21119

# Only valid if the axis is not associated with the domain.

21120

# Absent values indicate that the field isn't specified.

21121

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

21122

# for simplicity of conversion to/from color representations in various

21123

# languages over compactness; for example, the fields of this representation

21124

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

21125

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

21126

# method in iOS; and, with just a little work, it can be easily formatted into

21127

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

21132

#

21133

# // ...

21134

# public static java.awt.Color fromProto(Color protocolor) {

21135

# float alpha = protocolor.hasAlpha()

21136

# ? protocolor.getAlpha().getValue()

21137

# : 1.0;

21138

#

21139

# return new java.awt.Color(

21140

# protocolor.getRed(),

21141

# protocolor.getGreen(),

21142

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

21147

# float red = (float) color.getRed();

21148

# float green = (float) color.getGreen();

21149

# float blue = (float) color.getBlue();

21150

# float denominator = 255.0;

21151

# Color.Builder resultBuilder =

21152

# Color

21153

# .newBuilder()

21154

# .setRed(red / denominator)

21155

# .setGreen(green / denominator)

21156

# .setBlue(blue / denominator);

21157

# int alpha = color.getAlpha();

21158

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

21163

# .build());

21164

# }

21165

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

21170

#

21171

# // ...

21172

# static UIColor* fromProto(Color* protocolor) {

21173

# float red = [protocolor red];

21174

# float green = [protocolor green];

21175

# float blue = [protocolor blue];

21176

# FloatValue* alpha_wrapper = [protocolor alpha];

21177

# float alpha = 1.0;

21178

# if (alpha_wrapper != nil) {

21179

# alpha = [alpha_wrapper value];

21180

# }

21181

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

21182

# }

21183

#

21184

# static Color* toProto(UIColor* color) {

21185

# CGFloat red, green, blue, alpha;

21186

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

21187

# return nil;

21188

# }

21189

# Color* result = [Color alloc] init];

21190

# [result setRed:red];

21191

# [result setGreen:green];

21192

# [result setBlue:blue];

21193

# if (alpha <= 0.9999) {

21194

# [result setAlpha:floatWrapperWithValue(alpha)];

21195

# }

21196

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

21206

# var redFrac = rgb_color.red || 0.0;

21207

# var greenFrac = rgb_color.green || 0.0;

21208

# var blueFrac = rgb_color.blue || 0.0;

21209

# var red = Math.floor(redFrac * 255);

21210

# var green = Math.floor(greenFrac * 255);

21211

# var blue = Math.floor(blueFrac * 255);

21212

#

21213

# if (!('alpha' in rgb_color)) {

21214

# return rgbToCssColor_(red, green, blue);

21215

# }

21216

#

21217

# var alphaFrac = rgb_color.alpha.value || 0.0;

21218

# var rgbParams = [red, green, blue].join(',');

21219

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

21220

# };

21221

#

21222

# var rgbToCssColor_ = function(red, green, blue) {

21223

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

21224

# var hexString = rgbNumber.toString(16);

21225

# var missingZeros = 6 - hexString.length;

21226

# var resultBuilder = ['#'];

21227

# for (var i = 0; i < missingZeros; i++) {

21228

# resultBuilder.push('0');

21229

# }

21230

# resultBuilder.push(hexString);

21231

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

21236

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

21237

# the final pixel color is defined by the equation:

21238

#

21239

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

21240

#

21241

# This means that a value of 1.0 corresponds to a solid color, whereas

21242

# a value of 0.0 corresponds to a completely transparent color. This

21243

# uses a wrapper message rather than a simple float scalar so that it is

21244

# possible to distinguish between a default value and the value being unset.

21245

# If omitted, this color object is to be rendered as a solid color

21246

# (as if the alpha value had been explicitly given with a value of 1.0).

21247

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

21248

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

21249

},

21250

"bold": True or False, # True if the text is bold.

21251

"strikethrough": True or False, # True if the text has a strikethrough.

21252

"fontFamily": "A String", # The font family.

21253

"fontSize": 42, # The size of the font.

21254

"italic": True or False, # True if the text is italicized.

21255

"underline": True or False, # True if the text is underlined.

21256

},

21257

"title": "A String", # The title of this axis. If set, this overrides any title inferred

21258

# from headers of the data.

},

],

},

"title": "A String", # The title of the chart.

},

},

],

"filterViews": [ # The filter views in this sheet.

21267

{ # A filter view.

21268

"title": "A String", # The name of the filter view.

21269

"namedRangeId": "A String", # The named range this filter view is backed by, if any.

21270

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21271

# When writing, only one of range or named_range_id

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21272

# may be set.

21273

"filterViewId": 42, # The ID of the filter view.

21274

"range": { # A range on a sheet. # The range this filter view covers.

21275

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21276

# When writing, only one of range or named_range_id

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21277

# may be set.

21278

# All indexes are zero-based.

21279

# Indexes are half open, e.g the start index is inclusive

21280

# and the end index is exclusive -- [start_index, end_index).

21281

# Missing indexes indicate the range is unbounded on that side.

21282

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21283

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21284

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21285

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21286

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21287

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21288

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21289

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21290

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21291

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21292

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21293

# `Sheet1!A:B == sheet_id: 0,

21294

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21295

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21296

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21297

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21298

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21299

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21300

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21301

#

21302

# The start index must always be less than or equal to the end index.

21303

# If the start index equals the end index, then the range is empty.

21304

# Empty ranges are typically not meaningful and are usually rendered in the

21305

# UI as `#REF!`.

21306

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

21307

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

21308

"sheetId": 42, # The sheet this range is on.

21309

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

21310

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

21311

},

21312

"sortSpecs": [ # The sort order per column. Later specifications are used when values

21313

# are equal in the earlier specifications.

21314

{ # A sort order associated with a specific column or row.

21315

"sortOrder": "A String", # The order data should be sorted.

21316

"dimensionIndex": 42, # The dimension the sort should be applied to.

21317

},

21318

],

21319

"criteria": { # The criteria for showing/hiding values per column.

21320

# The map's key is the column index, and the value is the criteria for

21321

# that column.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21322

"a_key": { # Criteria for showing/hiding rows in a filter or filter view.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21323

"hiddenValues": [ # Values that should be hidden.

21324

"A String",

21325

],

21326

"condition": { # A condition that can evaluate to true or false. # A condition that must be true for values to be shown.

21327

# (This does not override hiddenValues -- if a value is listed there,

21328

# it will still be hidden.)

21329

# BooleanConditions are used by conditional formatting,

21330

# data validation, and the criteria in filters.

21331

"type": "A String", # The type of condition.

21332

"values": [ # The values of the condition. The number of supported values depends

21333

# on the condition type. Some support zero values,

21334

# others one or two values,

21335

# and ConditionType.ONE_OF_LIST supports an arbitrary number of values.

21336

{ # The value of the condition.

21337

"relativeDate": "A String", # A relative date (based on the current date).

21338

# Valid only if the type is

21339

# DATE_BEFORE,

21340

# DATE_AFTER,

21341

# DATE_ON_OR_BEFORE or

21342

# DATE_ON_OR_AFTER.

21343

#

21344

# Relative dates are not supported in data validation.

21345

# They are supported only in conditional formatting and

21346

# conditional filters.

21347

"userEnteredValue": "A String", # A value the condition is based on.

21348

# The value will be parsed as if the user typed into a cell.

21349

# Formulas are supported (and must begin with an `=`).

},

],

},

},

},

},

],

"protectedRanges": [ # The protected ranges in this sheet.

21358

{ # A protected range.

21359

"unprotectedRanges": [ # The list of unprotected ranges within a protected sheet.

21360

# Unprotected ranges are only supported on protected sheets.

21361

{ # A range on a sheet.

21362

# All indexes are zero-based.

21363

# Indexes are half open, e.g the start index is inclusive

21364

# and the end index is exclusive -- [start_index, end_index).

21365

# Missing indexes indicate the range is unbounded on that side.

21366

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21367

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21368

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21369

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21370

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21371

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21372

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21373

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21374

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21375

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21376

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21377

# `Sheet1!A:B == sheet_id: 0,

21378

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21379

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21380

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21381

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21382

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21383

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21384

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21385

#

21386

# The start index must always be less than or equal to the end index.

21387

# If the start index equals the end index, then the range is empty.

21388

# Empty ranges are typically not meaningful and are usually rendered in the

21389

# UI as `#REF!`.

21390

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

21391

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

21392

"sheetId": 42, # The sheet this range is on.

21393

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

21394

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

21395

},

21396

],

21397

"requestingUserCanEdit": True or False, # True if the user who requested this protected range can edit the

21398

# protected area.

21399

# This field is read-only.

21400

"description": "A String", # The description of this protected range.

21401

"namedRangeId": "A String", # The named range this protected range is backed by, if any.

21402

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21403

# When writing, only one of range or named_range_id

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21404

# may be set.

21405

"editors": { # The editors of a protected range. # The users and groups with edit access to the protected range.

21406

# This field is only visible to users with edit access to the protected

21407

# range and the document.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21408

# Editors are not supported with warning_only protection.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21409

"domainUsersCanEdit": True or False, # True if anyone in the document's domain has edit access to the protected

21410

# range. Domain protection is only supported on documents within a domain.

21411

"users": [ # The email addresses of users with edit access to the protected range.

21412

"A String",

21413

],

21414

"groups": [ # The email addresses of groups with edit access to the protected range.

"A String",

],

},

"protectedRangeId": 42, # The ID of the protected range.

21419

# This field is read-only.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21420

"warningOnly": True or False, # True if this protected range will show a warning when editing.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21421

# Warning-based protection means that every user can edit data in the

21422

# protected range, except editing will prompt a warning asking the user

21423

# to confirm the edit.

21424

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21425

# When writing: if this field is true, then editors is ignored.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21426

# Additionally, if this field is changed from true to false and the

21427

# `editors` field is not set (nor included in the field mask), then

21428

# the editors will be set to all the editors in the document.

21429

"range": { # A range on a sheet. # The range that is being protected.

21430

# The range may be fully unbounded, in which case this is considered

21431

# a protected sheet.

21432

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21433

# When writing, only one of range or named_range_id

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21434

# may be set.

21435

# All indexes are zero-based.

21436

# Indexes are half open, e.g the start index is inclusive

21437

# and the end index is exclusive -- [start_index, end_index).

21438

# Missing indexes indicate the range is unbounded on that side.

21439

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21440

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21441

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21442

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21443

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21444

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21445

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21446

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21447

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21448

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21449

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21450

# `Sheet1!A:B == sheet_id: 0,

21451

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21452

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21453

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21454

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21455

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21456

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21457

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21458

#

21459

# The start index must always be less than or equal to the end index.

21460

# If the start index equals the end index, then the range is empty.

21461

# Empty ranges are typically not meaningful and are usually rendered in the

21462

# UI as `#REF!`.

21463

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

21464

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

21465

"sheetId": 42, # The sheet this range is on.

21466

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

21467

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

},

],

"data": [ # Data in the grid, if this is a grid sheet.

21472

# The number of GridData objects returned is dependent on the number of

21473

# ranges requested on this sheet. For example, if this is representing

21474

# `Sheet1`, and the spreadsheet was requested with ranges

21475

# `Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a

21476

# startRow/startColumn of `0`,

21477

# while the second one will have `startRow 14` (zero-based row 15),

21478

# and `startColumn 3` (zero-based column D).

21479

{ # Data in the grid, as well as metadata about the dimensions.

21480

"startRow": 42, # The first row this GridData refers to, zero-based.

21481

"rowMetadata": [ # Metadata about the requested rows in the grid, starting with the row

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21482

# in start_row.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21483

{ # Properties about a dimension.

21484

"pixelSize": 42, # The height (if a row) or width (if a column) of the dimension in pixels.

21485

"hiddenByUser": True or False, # True if this dimension is explicitly hidden.

21486

"hiddenByFilter": True or False, # True if this dimension is being filtered.

21487

# This field is read-only.

21488

},

21489

],

21490

"startColumn": 42, # The first column this GridData refers to, zero-based.

21491

"columnMetadata": [ # Metadata about the requested columns in the grid, starting with the column

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21492

# in start_column.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21493

{ # Properties about a dimension.

21494

"pixelSize": 42, # The height (if a row) or width (if a column) of the dimension in pixels.

21495

"hiddenByUser": True or False, # True if this dimension is explicitly hidden.

21496

"hiddenByFilter": True or False, # True if this dimension is being filtered.

21497

# This field is read-only.

21498

},

21499

],

21500

"rowData": [ # The data in the grid, one entry per row,

21501

# starting with the row in startRow.

21502

# The values in RowData will correspond to columns starting

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21503

# at start_column.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21504

{ # Data about each cell in a row.

21505

"values": [ # The values in the row, one per column.

21506

{ # Data about a specific cell.

21507

"pivotTable": { # A pivot table. # A pivot table anchored at this cell. The size of pivot table itself

21508

# is computed dynamically based on its data, grouping, filters, values,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21509

# etc. Only the top-left cell of the pivot table contains the pivot table

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21510

# definition. The other cells will contain the calculated values of the

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21511

# results of the pivot in their effective_value fields.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21512

"valueLayout": "A String", # Whether values should be listed horizontally (as columns)

21513

# or vertically (as rows).

21514

"rows": [ # Each row grouping in the pivot table.

21515

{ # A single grouping (either row or column) in a pivot table.

21516

"showTotals": True or False, # True if the pivot table should include the totals for this grouping.

21517

"valueMetadata": [ # Metadata about values in the grouping.

21518

{ # Metadata about a value in a pivot grouping.

21519

"collapsed": True or False, # True if the data corresponding to the value is collapsed.

21520

"value": { # The kinds of value that a cell in a spreadsheet can have. # The calculated value the metadata corresponds to.

21521

# (Note that formulaValue is not valid,

21522

# because the values will be calculated.)

21523

"numberValue": 3.14, # Represents a double value.

21524

# Note: Dates, Times and DateTimes are represented as doubles in

21525

# "serial number" format.

21526

"boolValue": True or False, # Represents a boolean value.

21527

"formulaValue": "A String", # Represents a formula.

21528

"stringValue": "A String", # Represents a string value.

21529

# Leading single quotes are not included. For example, if the user typed

21530

# `'123` into the UI, this would be represented as a `stringValue` of

21531

# `"123"`.

21532

"errorValue": { # An error in a cell. # Represents an error.

21533

# This field is read-only.

21534

"message": "A String", # A message with more information about the error

21535

# (in the spreadsheet's locale).

21536

"type": "A String", # The type of error.

},

},

},

],

"valueBucket": { # Information about which values in a pivot group should be used for sorting. # The bucket of the opposite pivot group to sort by.

21542

# If not specified, sorting is alphabetical by this group's values.

21543

"buckets": [ # Determines the bucket from which values are chosen to sort.

21544

#

21545

# For example, in a pivot table with one row group & two column groups,

21546

# the row group can list up to two values. The first value corresponds

21547

# to a value within the first column group, and the second value

21548

# corresponds to a value in the second column group. If no values

21549

# are listed, this would indicate that the row should be sorted according

21550

# to the "Grand Total" over the column groups. If a single value is listed,

21551

# this would correspond to using the "Total" of that bucket.

21552

{ # The kinds of value that a cell in a spreadsheet can have.

21553

"numberValue": 3.14, # Represents a double value.

21554

# Note: Dates, Times and DateTimes are represented as doubles in

21555

# "serial number" format.

21556

"boolValue": True or False, # Represents a boolean value.

21557

"formulaValue": "A String", # Represents a formula.

21558

"stringValue": "A String", # Represents a string value.

21559

# Leading single quotes are not included. For example, if the user typed

21560

# `'123` into the UI, this would be represented as a `stringValue` of

21561

# `"123"`.

21562

"errorValue": { # An error in a cell. # Represents an error.

21563

# This field is read-only.

21564

"message": "A String", # A message with more information about the error

21565

# (in the spreadsheet's locale).

21566

"type": "A String", # The type of error.

21567

},

21568

},

21569

],

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21570

"valuesIndex": 42, # The offset in the PivotTable.values list which the values in this

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21571

# grouping should be sorted by.

21572

},

21573

"sortOrder": "A String", # The order the values in this group should be sorted.

21574

"sourceColumnOffset": 42, # The column offset of the source range that this grouping is based on.

21575

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21576

# For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21577

# means this group refers to column `C`, whereas the offset `1` would refer

# to column `D`.

},

],

"source": { # A range on a sheet. # The range the pivot table is reading data from.

21582

# All indexes are zero-based.

21583

# Indexes are half open, e.g the start index is inclusive

21584

# and the end index is exclusive -- [start_index, end_index).

21585

# Missing indexes indicate the range is unbounded on that side.

21586

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21587

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21588

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21589

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21590

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21591

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21592

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21593

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21594

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21595

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21596

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21597

# `Sheet1!A:B == sheet_id: 0,

21598

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21599

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21600

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21601

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21602

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21603

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21604

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21605

#

21606

# The start index must always be less than or equal to the end index.

21607

# If the start index equals the end index, then the range is empty.

21608

# Empty ranges are typically not meaningful and are usually rendered in the

21609

# UI as `#REF!`.

21610

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

21611

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

21612

"sheetId": 42, # The sheet this range is on.

21613

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

21614

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

21615

},

21616

"values": [ # A list of values to include in the pivot table.

21617

{ # The definition of how a value in a pivot table should be calculated.

21618

"formula": "A String", # A custom formula to calculate the value. The formula must start

21619

# with an `=` character.

21620

"summarizeFunction": "A String", # A function to summarize the value.

21621

# If formula is set, the only supported values are

21622

# SUM and

21623

# CUSTOM.

21624

# If sourceColumnOffset is set, then `CUSTOM`

21625

# is not supported.

21626

"sourceColumnOffset": 42, # The column offset of the source range that this value reads from.

21627

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21628

# For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21629

# means this value refers to column `C`, whereas the offset `1` would

21630

# refer to column `D`.

21631

"name": "A String", # A name to use for the value. This is only used if formula was set.

21632

# Otherwise, the column name is used.

21633

},

21634

],

21635

"criteria": { # An optional mapping of filters per source column offset.

21636

#

21637

# The filters will be applied before aggregating data into the pivot table.

21638

# The map's key is the column offset of the source range that you want to

21639

# filter, and the value is the criteria for that column.

21640

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21641

# For example, if the source was `C10:E15`, a key of `0` will have the filter

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21642

# for column `C`, whereas the key `1` is for column `D`.

21643

"a_key": { # Criteria for showing/hiding rows in a pivot table.

21644

"visibleValues": [ # Values that should be included. Values not listed here are excluded.

"A String",

],

},

},

"columns": [ # Each column grouping in the pivot table.

21650

{ # A single grouping (either row or column) in a pivot table.

21651

"showTotals": True or False, # True if the pivot table should include the totals for this grouping.

21652

"valueMetadata": [ # Metadata about values in the grouping.

21653

{ # Metadata about a value in a pivot grouping.

21654

"collapsed": True or False, # True if the data corresponding to the value is collapsed.

21655

"value": { # The kinds of value that a cell in a spreadsheet can have. # The calculated value the metadata corresponds to.

21656

# (Note that formulaValue is not valid,

21657

# because the values will be calculated.)

21658

"numberValue": 3.14, # Represents a double value.

21659

# Note: Dates, Times and DateTimes are represented as doubles in

21660

# "serial number" format.

21661

"boolValue": True or False, # Represents a boolean value.

21662

"formulaValue": "A String", # Represents a formula.

21663

"stringValue": "A String", # Represents a string value.

21664

# Leading single quotes are not included. For example, if the user typed

21665

# `'123` into the UI, this would be represented as a `stringValue` of

21666

# `"123"`.

21667

"errorValue": { # An error in a cell. # Represents an error.

21668

# This field is read-only.

21669

"message": "A String", # A message with more information about the error

21670

# (in the spreadsheet's locale).

21671

"type": "A String", # The type of error.

},

},

},

],

"valueBucket": { # Information about which values in a pivot group should be used for sorting. # The bucket of the opposite pivot group to sort by.

21677

# If not specified, sorting is alphabetical by this group's values.

21678

"buckets": [ # Determines the bucket from which values are chosen to sort.

21679

#

21680

# For example, in a pivot table with one row group & two column groups,

21681

# the row group can list up to two values. The first value corresponds

21682

# to a value within the first column group, and the second value

21683

# corresponds to a value in the second column group. If no values

21684

# are listed, this would indicate that the row should be sorted according

21685

# to the "Grand Total" over the column groups. If a single value is listed,

21686

# this would correspond to using the "Total" of that bucket.

21687

{ # The kinds of value that a cell in a spreadsheet can have.

21688

"numberValue": 3.14, # Represents a double value.

21689

# Note: Dates, Times and DateTimes are represented as doubles in

21690

# "serial number" format.

21691

"boolValue": True or False, # Represents a boolean value.

21692

"formulaValue": "A String", # Represents a formula.

21693

"stringValue": "A String", # Represents a string value.

21694

# Leading single quotes are not included. For example, if the user typed

21695

# `'123` into the UI, this would be represented as a `stringValue` of

21696

# `"123"`.

21697

"errorValue": { # An error in a cell. # Represents an error.

21698

# This field is read-only.

21699

"message": "A String", # A message with more information about the error

21700

# (in the spreadsheet's locale).

21701

"type": "A String", # The type of error.

21702

},

21703

},

21704

],

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21705

"valuesIndex": 42, # The offset in the PivotTable.values list which the values in this

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21706

# grouping should be sorted by.

21707

},

21708

"sortOrder": "A String", # The order the values in this group should be sorted.

21709

"sourceColumnOffset": 42, # The column offset of the source range that this grouping is based on.

21710

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21711

# For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21712

# means this group refers to column `C`, whereas the offset `1` would refer

# to column `D`.

},

],

},

"hyperlink": "A String", # A hyperlink this cell points to, if any.

21718

# This field is read-only. (To set it, use a `=HYPERLINK` formula.)

21719

"effectiveValue": { # The kinds of value that a cell in a spreadsheet can have. # The effective value of the cell. For cells with formulas, this will be

21720

# the calculated value. For cells with literals, this will be

21721

# the same as the user_entered_value.

21722

# This field is read-only.

21723

"numberValue": 3.14, # Represents a double value.

21724

# Note: Dates, Times and DateTimes are represented as doubles in

21725

# "serial number" format.

21726

"boolValue": True or False, # Represents a boolean value.

21727

"formulaValue": "A String", # Represents a formula.

21728

"stringValue": "A String", # Represents a string value.

21729

# Leading single quotes are not included. For example, if the user typed

21730

# `'123` into the UI, this would be represented as a `stringValue` of

21731

# `"123"`.

21732

"errorValue": { # An error in a cell. # Represents an error.

21733

# This field is read-only.

21734

"message": "A String", # A message with more information about the error

21735

# (in the spreadsheet's locale).

21736

"type": "A String", # The type of error.

21737

},

21738

},

21739

"formattedValue": "A String", # The formatted value of the cell.

21740

# This is the value as it's shown to the user.

21741

# This field is read-only.

21742

"userEnteredValue": { # The kinds of value that a cell in a spreadsheet can have. # The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`

21743

# Note: Dates, Times and DateTimes are represented as doubles in

21744

# serial number format.

21745

"numberValue": 3.14, # Represents a double value.

21746

# Note: Dates, Times and DateTimes are represented as doubles in

21747

# "serial number" format.

21748

"boolValue": True or False, # Represents a boolean value.

21749

"formulaValue": "A String", # Represents a formula.

21750

"stringValue": "A String", # Represents a string value.

21751

# Leading single quotes are not included. For example, if the user typed

21752

# `'123` into the UI, this would be represented as a `stringValue` of

21753

# `"123"`.

21754

"errorValue": { # An error in a cell. # Represents an error.

21755

# This field is read-only.

21756

"message": "A String", # A message with more information about the error

21757

# (in the spreadsheet's locale).

21758

"type": "A String", # The type of error.

21759

},

21760

},

21761

"note": "A String", # Any note on the cell.

21762

"effectiveFormat": { # The format of a cell. # The effective format being used by the cell.

21763

# This includes the results of applying any conditional formatting and,

21764

# if the cell contains a formula, the computed number format.

21765

# If the effective format is the default format, effective format will

21766

# not be written.

21767

# This field is read-only.

21768

"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21769

"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on

21770

# the user's locale will be used if necessary for the given type.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame^]

21771

# See the [Date and Number Formats guide](/sheets/guides/formats) for more

21772

# information about the supported patterns.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21773

"type": "A String", # The type of the number format.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21774

# When writing, this field must be set.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21775

},

21776

"textDirection": "A String", # The direction of the text in the cell.

21777

"padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.

21778

# When updating padding, every field must be specified.

21779

"top": 42, # The top padding of the cell.

21780

"right": 42, # The right padding of the cell.

21781

"bottom": 42, # The bottom padding of the cell.

21782

"left": 42, # The left padding of the cell.

21783

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21784

"horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21785

"backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.

21786

# for simplicity of conversion to/from color representations in various

21787

# languages over compactness; for example, the fields of this representation

21788

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

21789

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

21790

# method in iOS; and, with just a little work, it can be easily formatted into

21791

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

21796

#

21797

# // ...

21798

# public static java.awt.Color fromProto(Color protocolor) {

21799

# float alpha = protocolor.hasAlpha()

21800

# ? protocolor.getAlpha().getValue()

21801

# : 1.0;

21802

#

21803

# return new java.awt.Color(

21804

# protocolor.getRed(),

21805

# protocolor.getGreen(),

21806

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

21811

# float red = (float) color.getRed();

21812

# float green = (float) color.getGreen();

21813

# float blue = (float) color.getBlue();

21814

# float denominator = 255.0;

21815

# Color.Builder resultBuilder =

21816

# Color

21817

# .newBuilder()

21818

# .setRed(red / denominator)

21819

# .setGreen(green / denominator)

21820

# .setBlue(blue / denominator);

21821

# int alpha = color.getAlpha();

21822

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

21827

# .build());

21828

# }

21829

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

21834

#

21835

# // ...

21836

# static UIColor* fromProto(Color* protocolor) {

21837

# float red = [protocolor red];

21838

# float green = [protocolor green];

21839

# float blue = [protocolor blue];

21840

# FloatValue* alpha_wrapper = [protocolor alpha];

21841

# float alpha = 1.0;

21842

# if (alpha_wrapper != nil) {

21843

# alpha = [alpha_wrapper value];

21844

# }

21845

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

21846

# }

21847

#

21848

# static Color* toProto(UIColor* color) {

21849

# CGFloat red, green, blue, alpha;

21850

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

21851

# return nil;

21852

# }

21853

# Color* result = [Color alloc] init];

21854

# [result setRed:red];

21855

# [result setGreen:green];

21856

# [result setBlue:blue];

21857

# if (alpha <= 0.9999) {

21858

# [result setAlpha:floatWrapperWithValue(alpha)];

21859

# }

21860

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

21870

# var redFrac = rgb_color.red || 0.0;

21871

# var greenFrac = rgb_color.green || 0.0;

21872

# var blueFrac = rgb_color.blue || 0.0;

21873

# var red = Math.floor(redFrac * 255);

21874

# var green = Math.floor(greenFrac * 255);

21875

# var blue = Math.floor(blueFrac * 255);

21876

#

21877

# if (!('alpha' in rgb_color)) {

21878

# return rgbToCssColor_(red, green, blue);

21879

# }

21880

#

21881

# var alphaFrac = rgb_color.alpha.value || 0.0;

21882

# var rgbParams = [red, green, blue].join(',');

21883

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

21884

# };

21885

#

21886

# var rgbToCssColor_ = function(red, green, blue) {

21887

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

21888

# var hexString = rgbNumber.toString(16);

21889

# var missingZeros = 6 - hexString.length;

21890

# var resultBuilder = ['#'];

21891

# for (var i = 0; i < missingZeros; i++) {

21892

# resultBuilder.push('0');

21893

# }

21894

# resultBuilder.push(hexString);

21895

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

21900

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

21901

# the final pixel color is defined by the equation:

21902

#

21903

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

21904

#

21905

# This means that a value of 1.0 corresponds to a solid color, whereas

21906

# a value of 0.0 corresponds to a completely transparent color. This

21907

# uses a wrapper message rather than a simple float scalar so that it is

21908

# possible to distinguish between a default value and the value being unset.

21909

# If omitted, this color object is to be rendered as a solid color

21910

# (as if the alpha value had been explicitly given with a value of 1.0).

21911

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

21912

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

21913

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

21914

"verticalAlignment": "A String", # The vertical alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

21915

"textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).

21916

# Absent values indicate that the field isn't specified.

21917

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

21918

# for simplicity of conversion to/from color representations in various

21919

# languages over compactness; for example, the fields of this representation

21920

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

21921

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

21922

# method in iOS; and, with just a little work, it can be easily formatted into

21923

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

21928

#

21929

# // ...

21930

# public static java.awt.Color fromProto(Color protocolor) {

21931

# float alpha = protocolor.hasAlpha()

21932

# ? protocolor.getAlpha().getValue()

21933

# : 1.0;

21934

#

21935

# return new java.awt.Color(

21936

# protocolor.getRed(),

21937

# protocolor.getGreen(),

21938

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

21943

# float red = (float) color.getRed();

21944

# float green = (float) color.getGreen();

21945

# float blue = (float) color.getBlue();

21946

# float denominator = 255.0;

21947

# Color.Builder resultBuilder =

21948

# Color

21949

# .newBuilder()

21950

# .setRed(red / denominator)

21951

# .setGreen(green / denominator)

21952

# .setBlue(blue / denominator);

21953

# int alpha = color.getAlpha();

21954

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

21959

# .build());

21960

# }

21961

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

21966

#

21967

# // ...

21968

# static UIColor* fromProto(Color* protocolor) {

21969

# float red = [protocolor red];

21970

# float green = [protocolor green];

21971

# float blue = [protocolor blue];

21972

# FloatValue* alpha_wrapper = [protocolor alpha];

21973

# float alpha = 1.0;

21974

# if (alpha_wrapper != nil) {

21975

# alpha = [alpha_wrapper value];

21976

# }

21977

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

21978

# }

21979

#

21980

# static Color* toProto(UIColor* color) {

21981

# CGFloat red, green, blue, alpha;

21982

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

21983

# return nil;

21984

# }

21985

# Color* result = [Color alloc] init];

21986

# [result setRed:red];

21987

# [result setGreen:green];

21988

# [result setBlue:blue];

21989

# if (alpha <= 0.9999) {

21990

# [result setAlpha:floatWrapperWithValue(alpha)];

21991

# }

21992

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

22002

# var redFrac = rgb_color.red || 0.0;

22003

# var greenFrac = rgb_color.green || 0.0;

22004

# var blueFrac = rgb_color.blue || 0.0;

22005

# var red = Math.floor(redFrac * 255);

22006

# var green = Math.floor(greenFrac * 255);

22007

# var blue = Math.floor(blueFrac * 255);

22008

#

22009

# if (!('alpha' in rgb_color)) {

22010

# return rgbToCssColor_(red, green, blue);

22011

# }

22012

#

22013

# var alphaFrac = rgb_color.alpha.value || 0.0;

22014

# var rgbParams = [red, green, blue].join(',');

22015

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

22016

# };

22017

#

22018

# var rgbToCssColor_ = function(red, green, blue) {

22019

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

22020

# var hexString = rgbNumber.toString(16);

22021

# var missingZeros = 6 - hexString.length;

22022

# var resultBuilder = ['#'];

22023

# for (var i = 0; i < missingZeros; i++) {

22024

# resultBuilder.push('0');

22025

# }

22026

# resultBuilder.push(hexString);

22027

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

22032

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

22033

# the final pixel color is defined by the equation:

22034

#

22035

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

22036

#

22037

# This means that a value of 1.0 corresponds to a solid color, whereas

22038

# a value of 0.0 corresponds to a completely transparent color. This

22039

# uses a wrapper message rather than a simple float scalar so that it is

22040

# possible to distinguish between a default value and the value being unset.

22041

# If omitted, this color object is to be rendered as a solid color

22042

# (as if the alpha value had been explicitly given with a value of 1.0).

22043

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

22044

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

22045

},

22046

"bold": True or False, # True if the text is bold.

22047

"strikethrough": True or False, # True if the text has a strikethrough.

22048

"fontFamily": "A String", # The font family.

22049

"fontSize": 42, # The size of the font.

22050

"italic": True or False, # True if the text is italicized.

22051

"underline": True or False, # True if the text is underlined.

22052

},

22053

"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.

22054

"borders": { # The borders of the cell. # The borders of the cell.

22055

"top": { # A border along a cell. # The top border of the cell.

22056

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

22057

# for simplicity of conversion to/from color representations in various

22058

# languages over compactness; for example, the fields of this representation

22059

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

22060

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

22061

# method in iOS; and, with just a little work, it can be easily formatted into

22062

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

22067

#

22068

# // ...

22069

# public static java.awt.Color fromProto(Color protocolor) {

22070

# float alpha = protocolor.hasAlpha()

22071

# ? protocolor.getAlpha().getValue()

22072

# : 1.0;

22073

#

22074

# return new java.awt.Color(

22075

# protocolor.getRed(),

22076

# protocolor.getGreen(),

22077

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

22082

# float red = (float) color.getRed();

22083

# float green = (float) color.getGreen();

22084

# float blue = (float) color.getBlue();

22085

# float denominator = 255.0;

22086

# Color.Builder resultBuilder =

22087

# Color

22088

# .newBuilder()

22089

# .setRed(red / denominator)

22090

# .setGreen(green / denominator)

22091

# .setBlue(blue / denominator);

22092

# int alpha = color.getAlpha();

22093

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

22098

# .build());

22099

# }

22100

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

22105

#

22106

# // ...

22107

# static UIColor* fromProto(Color* protocolor) {

22108

# float red = [protocolor red];

22109

# float green = [protocolor green];

22110

# float blue = [protocolor blue];

22111

# FloatValue* alpha_wrapper = [protocolor alpha];

22112

# float alpha = 1.0;

22113

# if (alpha_wrapper != nil) {

22114

# alpha = [alpha_wrapper value];

22115

# }

22116

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

22117

# }

22118

#

22119

# static Color* toProto(UIColor* color) {

22120

# CGFloat red, green, blue, alpha;

22121

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

22122

# return nil;

22123

# }

22124

# Color* result = [Color alloc] init];

22125

# [result setRed:red];

22126

# [result setGreen:green];

22127

# [result setBlue:blue];

22128

# if (alpha <= 0.9999) {

22129

# [result setAlpha:floatWrapperWithValue(alpha)];

22130

# }

22131

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

22141

# var redFrac = rgb_color.red || 0.0;

22142

# var greenFrac = rgb_color.green || 0.0;

22143

# var blueFrac = rgb_color.blue || 0.0;

22144

# var red = Math.floor(redFrac * 255);

22145

# var green = Math.floor(greenFrac * 255);

22146

# var blue = Math.floor(blueFrac * 255);

22147

#

22148

# if (!('alpha' in rgb_color)) {

22149

# return rgbToCssColor_(red, green, blue);

22150

# }

22151

#

22152

# var alphaFrac = rgb_color.alpha.value || 0.0;

22153

# var rgbParams = [red, green, blue].join(',');

22154

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

22155

# };

22156

#

22157

# var rgbToCssColor_ = function(red, green, blue) {

22158

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

22159

# var hexString = rgbNumber.toString(16);

22160

# var missingZeros = 6 - hexString.length;

22161

# var resultBuilder = ['#'];

22162

# for (var i = 0; i < missingZeros; i++) {

22163

# resultBuilder.push('0');

22164

# }

22165

# resultBuilder.push(hexString);

22166

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

22171

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

22172

# the final pixel color is defined by the equation:

22173

#

22174

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

22175

#

22176

# This means that a value of 1.0 corresponds to a solid color, whereas

22177

# a value of 0.0 corresponds to a completely transparent color. This

22178

# uses a wrapper message rather than a simple float scalar so that it is

22179

# possible to distinguish between a default value and the value being unset.

22180

# If omitted, this color object is to be rendered as a solid color

22181

# (as if the alpha value had been explicitly given with a value of 1.0).

22182

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

22183

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

22184

},

22185

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

22186

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

22187

"style": "A String", # The style of the border.

22188

},

22189

"right": { # A border along a cell. # The right border of the cell.

22190

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

22191

# for simplicity of conversion to/from color representations in various

22192

# languages over compactness; for example, the fields of this representation

22193

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

22194

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

22195

# method in iOS; and, with just a little work, it can be easily formatted into

22196

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

22201

#

22202

# // ...

22203

# public static java.awt.Color fromProto(Color protocolor) {

22204

# float alpha = protocolor.hasAlpha()

22205

# ? protocolor.getAlpha().getValue()

22206

# : 1.0;

22207

#

22208

# return new java.awt.Color(

22209

# protocolor.getRed(),

22210

# protocolor.getGreen(),

22211

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

22216

# float red = (float) color.getRed();

22217

# float green = (float) color.getGreen();

22218

# float blue = (float) color.getBlue();

22219

# float denominator = 255.0;

22220

# Color.Builder resultBuilder =

22221

# Color

22222

# .newBuilder()

22223

# .setRed(red / denominator)

22224

# .setGreen(green / denominator)

22225

# .setBlue(blue / denominator);

22226

# int alpha = color.getAlpha();

22227

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

22232

# .build());

22233

# }

22234

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

22239

#

22240

# // ...

22241

# static UIColor* fromProto(Color* protocolor) {

22242

# float red = [protocolor red];

22243

# float green = [protocolor green];

22244

# float blue = [protocolor blue];

22245

# FloatValue* alpha_wrapper = [protocolor alpha];

22246

# float alpha = 1.0;

22247

# if (alpha_wrapper != nil) {

22248

# alpha = [alpha_wrapper value];

22249

# }

22250

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

22251

# }

22252

#

22253

# static Color* toProto(UIColor* color) {

22254

# CGFloat red, green, blue, alpha;

22255

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

22256

# return nil;

22257

# }

22258

# Color* result = [Color alloc] init];

22259

# [result setRed:red];

22260

# [result setGreen:green];

22261

# [result setBlue:blue];

22262

# if (alpha <= 0.9999) {

22263

# [result setAlpha:floatWrapperWithValue(alpha)];

22264

# }

22265

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

22275

# var redFrac = rgb_color.red || 0.0;

22276

# var greenFrac = rgb_color.green || 0.0;

22277

# var blueFrac = rgb_color.blue || 0.0;

22278

# var red = Math.floor(redFrac * 255);

22279

# var green = Math.floor(greenFrac * 255);

22280

# var blue = Math.floor(blueFrac * 255);

22281

#

22282

# if (!('alpha' in rgb_color)) {

22283

# return rgbToCssColor_(red, green, blue);

22284

# }

22285

#

22286

# var alphaFrac = rgb_color.alpha.value || 0.0;

22287

# var rgbParams = [red, green, blue].join(',');

22288

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

22289

# };

22290

#

22291

# var rgbToCssColor_ = function(red, green, blue) {

22292

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

22293

# var hexString = rgbNumber.toString(16);

22294

# var missingZeros = 6 - hexString.length;

22295

# var resultBuilder = ['#'];

22296

# for (var i = 0; i < missingZeros; i++) {

22297

# resultBuilder.push('0');

22298

# }

22299

# resultBuilder.push(hexString);

22300

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

22305

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

22306

# the final pixel color is defined by the equation:

22307

#

22308

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

22309

#

22310

# This means that a value of 1.0 corresponds to a solid color, whereas

22311

# a value of 0.0 corresponds to a completely transparent color. This

22312

# uses a wrapper message rather than a simple float scalar so that it is

22313

# possible to distinguish between a default value and the value being unset.

22314

# If omitted, this color object is to be rendered as a solid color

22315

# (as if the alpha value had been explicitly given with a value of 1.0).

22316

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

22317

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

22318

},

22319

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

22320

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

22321

"style": "A String", # The style of the border.

22322

},

22323

"bottom": { # A border along a cell. # The bottom border of the cell.

22324

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

22325

# for simplicity of conversion to/from color representations in various

22326

# languages over compactness; for example, the fields of this representation

22327

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

22328

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

22329

# method in iOS; and, with just a little work, it can be easily formatted into

22330

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

22335

#

22336

# // ...

22337

# public static java.awt.Color fromProto(Color protocolor) {

22338

# float alpha = protocolor.hasAlpha()

22339

# ? protocolor.getAlpha().getValue()

22340

# : 1.0;

22341

#

22342

# return new java.awt.Color(

22343

# protocolor.getRed(),

22344

# protocolor.getGreen(),

22345

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

22350

# float red = (float) color.getRed();

22351

# float green = (float) color.getGreen();

22352

# float blue = (float) color.getBlue();

22353

# float denominator = 255.0;

22354

# Color.Builder resultBuilder =

22355

# Color

22356

# .newBuilder()

22357

# .setRed(red / denominator)

22358

# .setGreen(green / denominator)

22359

# .setBlue(blue / denominator);

22360

# int alpha = color.getAlpha();

22361

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

22366

# .build());

22367

# }

22368

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

22373

#

22374

# // ...

22375

# static UIColor* fromProto(Color* protocolor) {

22376

# float red = [protocolor red];

22377

# float green = [protocolor green];

22378

# float blue = [protocolor blue];

22379

# FloatValue* alpha_wrapper = [protocolor alpha];

22380

# float alpha = 1.0;

22381

# if (alpha_wrapper != nil) {

22382

# alpha = [alpha_wrapper value];

22383

# }

22384

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

22385

# }

22386

#

22387

# static Color* toProto(UIColor* color) {

22388

# CGFloat red, green, blue, alpha;

22389

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

22390

# return nil;

22391

# }

22392

# Color* result = [Color alloc] init];

22393

# [result setRed:red];

22394

# [result setGreen:green];

22395

# [result setBlue:blue];

22396

# if (alpha <= 0.9999) {

22397

# [result setAlpha:floatWrapperWithValue(alpha)];

22398

# }

22399

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

22409

# var redFrac = rgb_color.red || 0.0;

22410

# var greenFrac = rgb_color.green || 0.0;

22411

# var blueFrac = rgb_color.blue || 0.0;

22412

# var red = Math.floor(redFrac * 255);

22413

# var green = Math.floor(greenFrac * 255);

22414

# var blue = Math.floor(blueFrac * 255);

22415

#

22416

# if (!('alpha' in rgb_color)) {

22417

# return rgbToCssColor_(red, green, blue);

22418

# }

22419

#

22420

# var alphaFrac = rgb_color.alpha.value || 0.0;

22421

# var rgbParams = [red, green, blue].join(',');

22422

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

22423

# };

22424

#

22425

# var rgbToCssColor_ = function(red, green, blue) {

22426

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

22427

# var hexString = rgbNumber.toString(16);

22428

# var missingZeros = 6 - hexString.length;

22429

# var resultBuilder = ['#'];

22430

# for (var i = 0; i < missingZeros; i++) {

22431

# resultBuilder.push('0');

22432

# }

22433

# resultBuilder.push(hexString);

22434

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

22439

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

22440

# the final pixel color is defined by the equation:

22441

#

22442

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

22443

#

22444

# This means that a value of 1.0 corresponds to a solid color, whereas

22445

# a value of 0.0 corresponds to a completely transparent color. This

22446

# uses a wrapper message rather than a simple float scalar so that it is

22447

# possible to distinguish between a default value and the value being unset.

22448

# If omitted, this color object is to be rendered as a solid color

22449

# (as if the alpha value had been explicitly given with a value of 1.0).

22450

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

22451

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

22452

},

22453

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

22454

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

22455

"style": "A String", # The style of the border.

22456

},

22457

"left": { # A border along a cell. # The left border of the cell.

22458

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

22459

# for simplicity of conversion to/from color representations in various

22460

# languages over compactness; for example, the fields of this representation

22461

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

22462

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

22463

# method in iOS; and, with just a little work, it can be easily formatted into

22464

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

22469

#

22470

# // ...

22471

# public static java.awt.Color fromProto(Color protocolor) {

22472

# float alpha = protocolor.hasAlpha()

22473

# ? protocolor.getAlpha().getValue()

22474

# : 1.0;

22475

#

22476

# return new java.awt.Color(

22477

# protocolor.getRed(),

22478

# protocolor.getGreen(),

22479

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

22484

# float red = (float) color.getRed();

22485

# float green = (float) color.getGreen();

22486

# float blue = (float) color.getBlue();

22487

# float denominator = 255.0;

22488

# Color.Builder resultBuilder =

22489

# Color

22490

# .newBuilder()

22491

# .setRed(red / denominator)

22492

# .setGreen(green / denominator)

22493

# .setBlue(blue / denominator);

22494

# int alpha = color.getAlpha();

22495

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

22500

# .build());

22501

# }

22502

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

22507

#

22508

# // ...

22509

# static UIColor* fromProto(Color* protocolor) {

22510

# float red = [protocolor red];

22511

# float green = [protocolor green];

22512

# float blue = [protocolor blue];

22513

# FloatValue* alpha_wrapper = [protocolor alpha];

22514

# float alpha = 1.0;

22515

# if (alpha_wrapper != nil) {

22516

# alpha = [alpha_wrapper value];

22517

# }

22518

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

22519

# }

22520

#

22521

# static Color* toProto(UIColor* color) {

22522

# CGFloat red, green, blue, alpha;

22523

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

22524

# return nil;

22525

# }

22526

# Color* result = [Color alloc] init];

22527

# [result setRed:red];

22528

# [result setGreen:green];

22529

# [result setBlue:blue];

22530

# if (alpha <= 0.9999) {

22531

# [result setAlpha:floatWrapperWithValue(alpha)];

22532

# }

22533

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

22543

# var redFrac = rgb_color.red || 0.0;

22544

# var greenFrac = rgb_color.green || 0.0;

22545

# var blueFrac = rgb_color.blue || 0.0;

22546

# var red = Math.floor(redFrac * 255);

22547

# var green = Math.floor(greenFrac * 255);

22548

# var blue = Math.floor(blueFrac * 255);

22549

#

22550

# if (!('alpha' in rgb_color)) {

22551

# return rgbToCssColor_(red, green, blue);

22552

# }

22553

#

22554

# var alphaFrac = rgb_color.alpha.value || 0.0;

22555

# var rgbParams = [red, green, blue].join(',');

22556

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

22557

# };

22558

#

22559

# var rgbToCssColor_ = function(red, green, blue) {

22560

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

22561

# var hexString = rgbNumber.toString(16);

22562

# var missingZeros = 6 - hexString.length;

22563

# var resultBuilder = ['#'];

22564

# for (var i = 0; i < missingZeros; i++) {

22565

# resultBuilder.push('0');

22566

# }

22567

# resultBuilder.push(hexString);

22568

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

22573

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

22574

# the final pixel color is defined by the equation:

22575

#

22576

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

22577

#

22578

# This means that a value of 1.0 corresponds to a solid color, whereas

22579

# a value of 0.0 corresponds to a completely transparent color. This

22580

# uses a wrapper message rather than a simple float scalar so that it is

22581

# possible to distinguish between a default value and the value being unset.

22582

# If omitted, this color object is to be rendered as a solid color

22583

# (as if the alpha value had been explicitly given with a value of 1.0).

22584

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

22585

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

22586

},

22587

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

22588

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

22589

"style": "A String", # The style of the border.

22590

},

22591

},

22592

"wrapStrategy": "A String", # The wrap strategy for the value in the cell.

22593

},

22594

"userEnteredFormat": { # The format of a cell. # The format the user entered for the cell.

22595

#

22596

# When writing, the new format will be merged with the existing format.

22597

"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

22598

"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on

22599

# the user's locale will be used if necessary for the given type.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame^]

22600

# See the [Date and Number Formats guide](/sheets/guides/formats) for more

22601

# information about the supported patterns.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

22602

"type": "A String", # The type of the number format.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

22603

# When writing, this field must be set.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

22604

},

22605

"textDirection": "A String", # The direction of the text in the cell.

22606

"padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.

22607

# When updating padding, every field must be specified.

22608

"top": 42, # The top padding of the cell.

22609

"right": 42, # The right padding of the cell.

22610

"bottom": 42, # The bottom padding of the cell.

22611

"left": 42, # The left padding of the cell.

22612

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

22613

"horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

22614

"backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.

22615

# for simplicity of conversion to/from color representations in various

22616

# languages over compactness; for example, the fields of this representation

22617

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

22618

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

22619

# method in iOS; and, with just a little work, it can be easily formatted into

22620

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

22625

#

22626

# // ...

22627

# public static java.awt.Color fromProto(Color protocolor) {

22628

# float alpha = protocolor.hasAlpha()

22629

# ? protocolor.getAlpha().getValue()

22630

# : 1.0;

22631

#

22632

# return new java.awt.Color(

22633

# protocolor.getRed(),

22634

# protocolor.getGreen(),

22635

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

22640

# float red = (float) color.getRed();

22641

# float green = (float) color.getGreen();

22642

# float blue = (float) color.getBlue();

22643

# float denominator = 255.0;

22644

# Color.Builder resultBuilder =

22645

# Color

22646

# .newBuilder()

22647

# .setRed(red / denominator)

22648

# .setGreen(green / denominator)

22649

# .setBlue(blue / denominator);

22650

# int alpha = color.getAlpha();

22651

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

22656

# .build());

22657

# }

22658

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

22663

#

22664

# // ...

22665

# static UIColor* fromProto(Color* protocolor) {

22666

# float red = [protocolor red];

22667

# float green = [protocolor green];

22668

# float blue = [protocolor blue];

22669

# FloatValue* alpha_wrapper = [protocolor alpha];

22670

# float alpha = 1.0;

22671

# if (alpha_wrapper != nil) {

22672

# alpha = [alpha_wrapper value];

22673

# }

22674

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

22675

# }

22676

#

22677

# static Color* toProto(UIColor* color) {

22678

# CGFloat red, green, blue, alpha;

22679

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

22680

# return nil;

22681

# }

22682

# Color* result = [Color alloc] init];

22683

# [result setRed:red];

22684

# [result setGreen:green];

22685

# [result setBlue:blue];

22686

# if (alpha <= 0.9999) {

22687

# [result setAlpha:floatWrapperWithValue(alpha)];

22688

# }

22689

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

22699

# var redFrac = rgb_color.red || 0.0;

22700

# var greenFrac = rgb_color.green || 0.0;

22701

# var blueFrac = rgb_color.blue || 0.0;

22702

# var red = Math.floor(redFrac * 255);

22703

# var green = Math.floor(greenFrac * 255);

22704

# var blue = Math.floor(blueFrac * 255);

22705

#

22706

# if (!('alpha' in rgb_color)) {

22707

# return rgbToCssColor_(red, green, blue);

22708

# }

22709

#

22710

# var alphaFrac = rgb_color.alpha.value || 0.0;

22711

# var rgbParams = [red, green, blue].join(',');

22712

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

22713

# };

22714

#

22715

# var rgbToCssColor_ = function(red, green, blue) {

22716

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

22717

# var hexString = rgbNumber.toString(16);

22718

# var missingZeros = 6 - hexString.length;

22719

# var resultBuilder = ['#'];

22720

# for (var i = 0; i < missingZeros; i++) {

22721

# resultBuilder.push('0');

22722

# }

22723

# resultBuilder.push(hexString);

22724

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

22729

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

22730

# the final pixel color is defined by the equation:

22731

#

22732

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

22733

#

22734

# This means that a value of 1.0 corresponds to a solid color, whereas

22735

# a value of 0.0 corresponds to a completely transparent color. This

22736

# uses a wrapper message rather than a simple float scalar so that it is

22737

# possible to distinguish between a default value and the value being unset.

22738

# If omitted, this color object is to be rendered as a solid color

22739

# (as if the alpha value had been explicitly given with a value of 1.0).

22740

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

22741

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

22742

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

22743

"verticalAlignment": "A String", # The vertical alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

22744

"textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).

22745

# Absent values indicate that the field isn't specified.

22746

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

22747

# for simplicity of conversion to/from color representations in various

22748

# languages over compactness; for example, the fields of this representation

22749

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

22750

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

22751

# method in iOS; and, with just a little work, it can be easily formatted into

22752

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

22757

#

22758

# // ...

22759

# public static java.awt.Color fromProto(Color protocolor) {

22760

# float alpha = protocolor.hasAlpha()

22761

# ? protocolor.getAlpha().getValue()

22762

# : 1.0;

22763

#

22764

# return new java.awt.Color(

22765

# protocolor.getRed(),

22766

# protocolor.getGreen(),

22767

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

22772

# float red = (float) color.getRed();

22773

# float green = (float) color.getGreen();

22774

# float blue = (float) color.getBlue();

22775

# float denominator = 255.0;

22776

# Color.Builder resultBuilder =

22777

# Color

22778

# .newBuilder()

22779

# .setRed(red / denominator)

22780

# .setGreen(green / denominator)

22781

# .setBlue(blue / denominator);

22782

# int alpha = color.getAlpha();

22783

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

22788

# .build());

22789

# }

22790

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

22795

#

22796

# // ...

22797

# static UIColor* fromProto(Color* protocolor) {

22798

# float red = [protocolor red];

22799

# float green = [protocolor green];

22800

# float blue = [protocolor blue];

22801

# FloatValue* alpha_wrapper = [protocolor alpha];

22802

# float alpha = 1.0;

22803

# if (alpha_wrapper != nil) {

22804

# alpha = [alpha_wrapper value];

22805

# }

22806

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

22807

# }

22808

#

22809

# static Color* toProto(UIColor* color) {

22810

# CGFloat red, green, blue, alpha;

22811

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

22812

# return nil;

22813

# }

22814

# Color* result = [Color alloc] init];

22815

# [result setRed:red];

22816

# [result setGreen:green];

22817

# [result setBlue:blue];

22818

# if (alpha <= 0.9999) {

22819

# [result setAlpha:floatWrapperWithValue(alpha)];

22820

# }

22821

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

22831

# var redFrac = rgb_color.red || 0.0;

22832

# var greenFrac = rgb_color.green || 0.0;

22833

# var blueFrac = rgb_color.blue || 0.0;

22834

# var red = Math.floor(redFrac * 255);

22835

# var green = Math.floor(greenFrac * 255);

22836

# var blue = Math.floor(blueFrac * 255);

22837

#

22838

# if (!('alpha' in rgb_color)) {

22839

# return rgbToCssColor_(red, green, blue);

22840

# }

22841

#

22842

# var alphaFrac = rgb_color.alpha.value || 0.0;

22843

# var rgbParams = [red, green, blue].join(',');

22844

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

22845

# };

22846

#

22847

# var rgbToCssColor_ = function(red, green, blue) {

22848

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

22849

# var hexString = rgbNumber.toString(16);

22850

# var missingZeros = 6 - hexString.length;

22851

# var resultBuilder = ['#'];

22852

# for (var i = 0; i < missingZeros; i++) {

22853

# resultBuilder.push('0');

22854

# }

22855

# resultBuilder.push(hexString);

22856

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

22861

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

22862

# the final pixel color is defined by the equation:

22863

#

22864

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

22865

#

22866

# This means that a value of 1.0 corresponds to a solid color, whereas

22867

# a value of 0.0 corresponds to a completely transparent color. This

22868

# uses a wrapper message rather than a simple float scalar so that it is

22869

# possible to distinguish between a default value and the value being unset.

22870

# If omitted, this color object is to be rendered as a solid color

22871

# (as if the alpha value had been explicitly given with a value of 1.0).

22872

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

22873

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

22874

},

22875

"bold": True or False, # True if the text is bold.

22876

"strikethrough": True or False, # True if the text has a strikethrough.

22877

"fontFamily": "A String", # The font family.

22878

"fontSize": 42, # The size of the font.

22879

"italic": True or False, # True if the text is italicized.

22880

"underline": True or False, # True if the text is underlined.

22881

},

22882

"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.

22883

"borders": { # The borders of the cell. # The borders of the cell.

22884

"top": { # A border along a cell. # The top border of the cell.

22885

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

22886

# for simplicity of conversion to/from color representations in various

22887

# languages over compactness; for example, the fields of this representation

22888

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

22889

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

22890

# method in iOS; and, with just a little work, it can be easily formatted into

22891

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

22896

#

22897

# // ...

22898

# public static java.awt.Color fromProto(Color protocolor) {

22899

# float alpha = protocolor.hasAlpha()

22900

# ? protocolor.getAlpha().getValue()

22901

# : 1.0;

22902

#

22903

# return new java.awt.Color(

22904

# protocolor.getRed(),

22905

# protocolor.getGreen(),

22906

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

22911

# float red = (float) color.getRed();

22912

# float green = (float) color.getGreen();

22913

# float blue = (float) color.getBlue();

22914

# float denominator = 255.0;

22915

# Color.Builder resultBuilder =

22916

# Color

22917

# .newBuilder()

22918

# .setRed(red / denominator)

22919

# .setGreen(green / denominator)

22920

# .setBlue(blue / denominator);

22921

# int alpha = color.getAlpha();

22922

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

22927

# .build());

22928

# }

22929

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

22934

#

22935

# // ...

22936

# static UIColor* fromProto(Color* protocolor) {

22937

# float red = [protocolor red];

22938

# float green = [protocolor green];

22939

# float blue = [protocolor blue];

22940

# FloatValue* alpha_wrapper = [protocolor alpha];

22941

# float alpha = 1.0;

22942

# if (alpha_wrapper != nil) {

22943

# alpha = [alpha_wrapper value];

22944

# }

22945

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

22946

# }

22947

#

22948

# static Color* toProto(UIColor* color) {

22949

# CGFloat red, green, blue, alpha;

22950

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

22951

# return nil;

22952

# }

22953

# Color* result = [Color alloc] init];

22954

# [result setRed:red];

22955

# [result setGreen:green];

22956

# [result setBlue:blue];

22957

# if (alpha <= 0.9999) {

22958

# [result setAlpha:floatWrapperWithValue(alpha)];

22959

# }

22960

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

22970

# var redFrac = rgb_color.red || 0.0;

22971

# var greenFrac = rgb_color.green || 0.0;

22972

# var blueFrac = rgb_color.blue || 0.0;

22973

# var red = Math.floor(redFrac * 255);

22974

# var green = Math.floor(greenFrac * 255);

22975

# var blue = Math.floor(blueFrac * 255);

22976

#

22977

# if (!('alpha' in rgb_color)) {

22978

# return rgbToCssColor_(red, green, blue);

22979

# }

22980

#

22981

# var alphaFrac = rgb_color.alpha.value || 0.0;

22982

# var rgbParams = [red, green, blue].join(',');

22983

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

22984

# };

22985

#

22986

# var rgbToCssColor_ = function(red, green, blue) {

22987

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

22988

# var hexString = rgbNumber.toString(16);

22989

# var missingZeros = 6 - hexString.length;

22990

# var resultBuilder = ['#'];

22991

# for (var i = 0; i < missingZeros; i++) {

22992

# resultBuilder.push('0');

22993

# }

22994

# resultBuilder.push(hexString);

22995

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

23000

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

23001

# the final pixel color is defined by the equation:

23002

#

23003

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

23004

#

23005

# This means that a value of 1.0 corresponds to a solid color, whereas

23006

# a value of 0.0 corresponds to a completely transparent color. This

23007

# uses a wrapper message rather than a simple float scalar so that it is

23008

# possible to distinguish between a default value and the value being unset.

23009

# If omitted, this color object is to be rendered as a solid color

23010

# (as if the alpha value had been explicitly given with a value of 1.0).

23011

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

23012

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

23013

},

23014

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

23015

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

23016

"style": "A String", # The style of the border.

23017

},

23018

"right": { # A border along a cell. # The right border of the cell.

23019

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

23020

# for simplicity of conversion to/from color representations in various

23021

# languages over compactness; for example, the fields of this representation

23022

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

23023

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

23024

# method in iOS; and, with just a little work, it can be easily formatted into

23025

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

23030

#

23031

# // ...

23032

# public static java.awt.Color fromProto(Color protocolor) {

23033

# float alpha = protocolor.hasAlpha()

23034

# ? protocolor.getAlpha().getValue()

23035

# : 1.0;

23036

#

23037

# return new java.awt.Color(

23038

# protocolor.getRed(),

23039

# protocolor.getGreen(),

23040

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

23045

# float red = (float) color.getRed();

23046

# float green = (float) color.getGreen();

23047

# float blue = (float) color.getBlue();

23048

# float denominator = 255.0;

23049

# Color.Builder resultBuilder =

23050

# Color

23051

# .newBuilder()

23052

# .setRed(red / denominator)

23053

# .setGreen(green / denominator)

23054

# .setBlue(blue / denominator);

23055

# int alpha = color.getAlpha();

23056

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

23061

# .build());

23062

# }

23063

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

23068

#

23069

# // ...

23070

# static UIColor* fromProto(Color* protocolor) {

23071

# float red = [protocolor red];

23072

# float green = [protocolor green];

23073

# float blue = [protocolor blue];

23074

# FloatValue* alpha_wrapper = [protocolor alpha];

23075

# float alpha = 1.0;

23076

# if (alpha_wrapper != nil) {

23077

# alpha = [alpha_wrapper value];

23078

# }

23079

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

23080

# }

23081

#

23082

# static Color* toProto(UIColor* color) {

23083

# CGFloat red, green, blue, alpha;

23084

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

23085

# return nil;

23086

# }

23087

# Color* result = [Color alloc] init];

23088

# [result setRed:red];

23089

# [result setGreen:green];

23090

# [result setBlue:blue];

23091

# if (alpha <= 0.9999) {

23092

# [result setAlpha:floatWrapperWithValue(alpha)];

23093

# }

23094

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

23104

# var redFrac = rgb_color.red || 0.0;

23105

# var greenFrac = rgb_color.green || 0.0;

23106

# var blueFrac = rgb_color.blue || 0.0;

23107

# var red = Math.floor(redFrac * 255);

23108

# var green = Math.floor(greenFrac * 255);

23109

# var blue = Math.floor(blueFrac * 255);

23110

#

23111

# if (!('alpha' in rgb_color)) {

23112

# return rgbToCssColor_(red, green, blue);

23113

# }

23114

#

23115

# var alphaFrac = rgb_color.alpha.value || 0.0;

23116

# var rgbParams = [red, green, blue].join(',');

23117

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

23118

# };

23119

#

23120

# var rgbToCssColor_ = function(red, green, blue) {

23121

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

23122

# var hexString = rgbNumber.toString(16);

23123

# var missingZeros = 6 - hexString.length;

23124

# var resultBuilder = ['#'];

23125

# for (var i = 0; i < missingZeros; i++) {

23126

# resultBuilder.push('0');

23127

# }

23128

# resultBuilder.push(hexString);

23129

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

23134

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

23135

# the final pixel color is defined by the equation:

23136

#

23137

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

23138

#

23139

# This means that a value of 1.0 corresponds to a solid color, whereas

23140

# a value of 0.0 corresponds to a completely transparent color. This

23141

# uses a wrapper message rather than a simple float scalar so that it is

23142

# possible to distinguish between a default value and the value being unset.

23143

# If omitted, this color object is to be rendered as a solid color

23144

# (as if the alpha value had been explicitly given with a value of 1.0).

23145

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

23146

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

23147

},

23148

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

23149

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

23150

"style": "A String", # The style of the border.

23151

},

23152

"bottom": { # A border along a cell. # The bottom border of the cell.

23153

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

23154

# for simplicity of conversion to/from color representations in various

23155

# languages over compactness; for example, the fields of this representation

23156

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

23157

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

23158

# method in iOS; and, with just a little work, it can be easily formatted into

23159

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

23164

#

23165

# // ...

23166

# public static java.awt.Color fromProto(Color protocolor) {

23167

# float alpha = protocolor.hasAlpha()

23168

# ? protocolor.getAlpha().getValue()

23169

# : 1.0;

23170

#

23171

# return new java.awt.Color(

23172

# protocolor.getRed(),

23173

# protocolor.getGreen(),

23174

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

23179

# float red = (float) color.getRed();

23180

# float green = (float) color.getGreen();

23181

# float blue = (float) color.getBlue();

23182

# float denominator = 255.0;

23183

# Color.Builder resultBuilder =

23184

# Color

23185

# .newBuilder()

23186

# .setRed(red / denominator)

23187

# .setGreen(green / denominator)

23188

# .setBlue(blue / denominator);

23189

# int alpha = color.getAlpha();

23190

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

23195

# .build());

23196

# }

23197

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

23202

#

23203

# // ...

23204

# static UIColor* fromProto(Color* protocolor) {

23205

# float red = [protocolor red];

23206

# float green = [protocolor green];

23207

# float blue = [protocolor blue];

23208

# FloatValue* alpha_wrapper = [protocolor alpha];

23209

# float alpha = 1.0;

23210

# if (alpha_wrapper != nil) {

23211

# alpha = [alpha_wrapper value];

23212

# }

23213

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

23214

# }

23215

#

23216

# static Color* toProto(UIColor* color) {

23217

# CGFloat red, green, blue, alpha;

23218

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

23219

# return nil;

23220

# }

23221

# Color* result = [Color alloc] init];

23222

# [result setRed:red];

23223

# [result setGreen:green];

23224

# [result setBlue:blue];

23225

# if (alpha <= 0.9999) {

23226

# [result setAlpha:floatWrapperWithValue(alpha)];

23227

# }

23228

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

23238

# var redFrac = rgb_color.red || 0.0;

23239

# var greenFrac = rgb_color.green || 0.0;

23240

# var blueFrac = rgb_color.blue || 0.0;

23241

# var red = Math.floor(redFrac * 255);

23242

# var green = Math.floor(greenFrac * 255);

23243

# var blue = Math.floor(blueFrac * 255);

23244

#

23245

# if (!('alpha' in rgb_color)) {

23246

# return rgbToCssColor_(red, green, blue);

23247

# }

23248

#

23249

# var alphaFrac = rgb_color.alpha.value || 0.0;

23250

# var rgbParams = [red, green, blue].join(',');

23251

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

23252

# };

23253

#

23254

# var rgbToCssColor_ = function(red, green, blue) {

23255

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

23256

# var hexString = rgbNumber.toString(16);

23257

# var missingZeros = 6 - hexString.length;

23258

# var resultBuilder = ['#'];

23259

# for (var i = 0; i < missingZeros; i++) {

23260

# resultBuilder.push('0');

23261

# }

23262

# resultBuilder.push(hexString);

23263

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

23268

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

23269

# the final pixel color is defined by the equation:

23270

#

23271

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

23272

#

23273

# This means that a value of 1.0 corresponds to a solid color, whereas

23274

# a value of 0.0 corresponds to a completely transparent color. This

23275

# uses a wrapper message rather than a simple float scalar so that it is

23276

# possible to distinguish between a default value and the value being unset.

23277

# If omitted, this color object is to be rendered as a solid color

23278

# (as if the alpha value had been explicitly given with a value of 1.0).

23279

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

23280

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

23281

},

23282

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

23283

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

23284

"style": "A String", # The style of the border.

23285

},

23286

"left": { # A border along a cell. # The left border of the cell.

23287

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

23288

# for simplicity of conversion to/from color representations in various

23289

# languages over compactness; for example, the fields of this representation

23290

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

23291

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

23292

# method in iOS; and, with just a little work, it can be easily formatted into

23293

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

23298

#

23299

# // ...

23300

# public static java.awt.Color fromProto(Color protocolor) {

23301

# float alpha = protocolor.hasAlpha()

23302

# ? protocolor.getAlpha().getValue()

23303

# : 1.0;

23304

#

23305

# return new java.awt.Color(

23306

# protocolor.getRed(),

23307

# protocolor.getGreen(),

23308

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

23313

# float red = (float) color.getRed();

23314

# float green = (float) color.getGreen();

23315

# float blue = (float) color.getBlue();

23316

# float denominator = 255.0;

23317

# Color.Builder resultBuilder =

23318

# Color

23319

# .newBuilder()

23320

# .setRed(red / denominator)

23321

# .setGreen(green / denominator)

23322

# .setBlue(blue / denominator);

23323

# int alpha = color.getAlpha();

23324

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

23329

# .build());

23330

# }

23331

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

23336

#

23337

# // ...

23338

# static UIColor* fromProto(Color* protocolor) {

23339

# float red = [protocolor red];

23340

# float green = [protocolor green];

23341

# float blue = [protocolor blue];

23342

# FloatValue* alpha_wrapper = [protocolor alpha];

23343

# float alpha = 1.0;

23344

# if (alpha_wrapper != nil) {

23345

# alpha = [alpha_wrapper value];

23346

# }

23347

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

23348

# }

23349

#

23350

# static Color* toProto(UIColor* color) {

23351

# CGFloat red, green, blue, alpha;

23352

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

23353

# return nil;

23354

# }

23355

# Color* result = [Color alloc] init];

23356

# [result setRed:red];

23357

# [result setGreen:green];

23358

# [result setBlue:blue];

23359

# if (alpha <= 0.9999) {

23360

# [result setAlpha:floatWrapperWithValue(alpha)];

23361

# }

23362

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

23372

# var redFrac = rgb_color.red || 0.0;

23373

# var greenFrac = rgb_color.green || 0.0;

23374

# var blueFrac = rgb_color.blue || 0.0;

23375

# var red = Math.floor(redFrac * 255);

23376

# var green = Math.floor(greenFrac * 255);

23377

# var blue = Math.floor(blueFrac * 255);

23378

#

23379

# if (!('alpha' in rgb_color)) {

23380

# return rgbToCssColor_(red, green, blue);

23381

# }

23382

#

23383

# var alphaFrac = rgb_color.alpha.value || 0.0;

23384

# var rgbParams = [red, green, blue].join(',');

23385

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

23386

# };

23387

#

23388

# var rgbToCssColor_ = function(red, green, blue) {

23389

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

23390

# var hexString = rgbNumber.toString(16);

23391

# var missingZeros = 6 - hexString.length;

23392

# var resultBuilder = ['#'];

23393

# for (var i = 0; i < missingZeros; i++) {

23394

# resultBuilder.push('0');

23395

# }

23396

# resultBuilder.push(hexString);

23397

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

23402

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

23403

# the final pixel color is defined by the equation:

23404

#

23405

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

23406

#

23407

# This means that a value of 1.0 corresponds to a solid color, whereas

23408

# a value of 0.0 corresponds to a completely transparent color. This

23409

# uses a wrapper message rather than a simple float scalar so that it is

23410

# possible to distinguish between a default value and the value being unset.

23411

# If omitted, this color object is to be rendered as a solid color

23412

# (as if the alpha value had been explicitly given with a value of 1.0).

23413

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

23414

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

23415

},

23416

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

23417

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

23418

"style": "A String", # The style of the border.

23419

},

23420

},

23421

"wrapStrategy": "A String", # The wrap strategy for the value in the cell.

23422

},

23423

"dataValidation": { # A data validation rule. # A data validation rule on the cell, if any.

23424

#

23425

# When writing, the new data validation rule will overwrite any prior rule.

23426

"showCustomUi": True or False, # True if the UI should be customized based on the kind of condition.

23427

# If true, "List" conditions will show a dropdown.

23428

"strict": True or False, # True if invalid data should be rejected.

23429

"inputMessage": "A String", # A message to show the user when adding data to the cell.

23430

"condition": { # A condition that can evaluate to true or false. # The condition that data in the cell must match.

23431

# BooleanConditions are used by conditional formatting,

23432

# data validation, and the criteria in filters.

23433

"type": "A String", # The type of condition.

23434

"values": [ # The values of the condition. The number of supported values depends

23435

# on the condition type. Some support zero values,

23436

# others one or two values,

23437

# and ConditionType.ONE_OF_LIST supports an arbitrary number of values.

23438

{ # The value of the condition.

23439

"relativeDate": "A String", # A relative date (based on the current date).

23440

# Valid only if the type is

23441

# DATE_BEFORE,

23442

# DATE_AFTER,

23443

# DATE_ON_OR_BEFORE or

23444

# DATE_ON_OR_AFTER.

23445

#

23446

# Relative dates are not supported in data validation.

23447

# They are supported only in conditional formatting and

23448

# conditional filters.

23449

"userEnteredValue": "A String", # A value the condition is based on.

23450

# The value will be parsed as if the user typed into a cell.

23451

# Formulas are supported (and must begin with an `=`).

},

],

},

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

23456

"textFormatRuns": [ # Runs of rich text applied to subsections of the cell. Runs are only valid

23457

# on user entered strings, not formulas, bools, or numbers.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

23458

# Runs start at specific indexes in the text and continue until the next

23459

# run. Properties of a run will continue unless explicitly changed

23460

# in a subsequent run (and properties of the first run will continue

23461

# the properties of the cell unless explicitly changed).

23462

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

23463

# When writing, the new runs will overwrite any prior runs. When writing a

23464

# new user_entered_value, previous runs will be erased.

23465

{ # A run of a text format. The format of this run continues until the start

23466

# index of the next run.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

23467

# When updating, all fields must be set.

23468

"startIndex": 42, # The character index where this run starts.

23469

"format": { # The format of a run of text in a cell. # The format of this run. Absent values inherit the cell's format.

23470

# Absent values indicate that the field isn't specified.

23471

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

23472

# for simplicity of conversion to/from color representations in various

23473

# languages over compactness; for example, the fields of this representation

23474

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

23475

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

23476

# method in iOS; and, with just a little work, it can be easily formatted into

23477

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

23482

#

23483

# // ...

23484

# public static java.awt.Color fromProto(Color protocolor) {

23485

# float alpha = protocolor.hasAlpha()

23486

# ? protocolor.getAlpha().getValue()

23487

# : 1.0;

23488

#

23489

# return new java.awt.Color(

23490

# protocolor.getRed(),

23491

# protocolor.getGreen(),

23492

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

23497

# float red = (float) color.getRed();

23498

# float green = (float) color.getGreen();

23499

# float blue = (float) color.getBlue();

23500

# float denominator = 255.0;

23501

# Color.Builder resultBuilder =

23502

# Color

23503

# .newBuilder()

23504

# .setRed(red / denominator)

23505

# .setGreen(green / denominator)

23506

# .setBlue(blue / denominator);

23507

# int alpha = color.getAlpha();

23508

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

23513

# .build());

23514

# }

23515

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

23520

#

23521

# // ...

23522

# static UIColor* fromProto(Color* protocolor) {

23523

# float red = [protocolor red];

23524

# float green = [protocolor green];

23525

# float blue = [protocolor blue];

23526

# FloatValue* alpha_wrapper = [protocolor alpha];

23527

# float alpha = 1.0;

23528

# if (alpha_wrapper != nil) {

23529

# alpha = [alpha_wrapper value];

23530

# }

23531

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

23532

# }

23533

#

23534

# static Color* toProto(UIColor* color) {

23535

# CGFloat red, green, blue, alpha;

23536

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

23537

# return nil;

23538

# }

23539

# Color* result = [Color alloc] init];

23540

# [result setRed:red];

23541

# [result setGreen:green];

23542

# [result setBlue:blue];

23543

# if (alpha <= 0.9999) {

23544

# [result setAlpha:floatWrapperWithValue(alpha)];

23545

# }

23546

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

23556

# var redFrac = rgb_color.red || 0.0;

23557

# var greenFrac = rgb_color.green || 0.0;

23558

# var blueFrac = rgb_color.blue || 0.0;

23559

# var red = Math.floor(redFrac * 255);

23560

# var green = Math.floor(greenFrac * 255);

23561

# var blue = Math.floor(blueFrac * 255);

23562

#

23563

# if (!('alpha' in rgb_color)) {

23564

# return rgbToCssColor_(red, green, blue);

23565

# }

23566

#

23567

# var alphaFrac = rgb_color.alpha.value || 0.0;

23568

# var rgbParams = [red, green, blue].join(',');

23569

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

23570

# };

23571

#

23572

# var rgbToCssColor_ = function(red, green, blue) {

23573

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

23574

# var hexString = rgbNumber.toString(16);

23575

# var missingZeros = 6 - hexString.length;

23576

# var resultBuilder = ['#'];

23577

# for (var i = 0; i < missingZeros; i++) {

23578

# resultBuilder.push('0');

23579

# }

23580

# resultBuilder.push(hexString);

23581

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

23586

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

23587

# the final pixel color is defined by the equation:

23588

#

23589

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

23590

#

23591

# This means that a value of 1.0 corresponds to a solid color, whereas

23592

# a value of 0.0 corresponds to a completely transparent color. This

23593

# uses a wrapper message rather than a simple float scalar so that it is

23594

# possible to distinguish between a default value and the value being unset.

23595

# If omitted, this color object is to be rendered as a solid color

23596

# (as if the alpha value had been explicitly given with a value of 1.0).

23597

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

23598

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

23599

},

23600

"bold": True or False, # True if the text is bold.

23601

"strikethrough": True or False, # True if the text has a strikethrough.

23602

"fontFamily": "A String", # The font family.

23603

"fontSize": 42, # The size of the font.

23604

"italic": True or False, # True if the text is italicized.

23605

"underline": True or False, # True if the text is underlined.

},

},

],

},

],

},

],

},

],

"properties": { # Properties of a sheet. # The properties of the sheet.

23616

"sheetType": "A String", # The type of sheet. Defaults to GRID.

23617

# This field cannot be changed once set.

23618

"index": 42, # The index of the sheet within the spreadsheet.

23619

# When adding or updating sheet properties, if this field

23620

# is excluded then the sheet will be added or moved to the end

23621

# of the sheet list.

23622

"title": "A String", # The name of the sheet.

23623

"gridProperties": { # Properties of a grid. # Additional properties of the sheet if this sheet is a grid.

23624

# (If the sheet is an object sheet, containing a chart or image, then

23625

# this field will be absent.)

23626

# When writing it is an error to set any grid properties on non-grid sheets.

23627

"columnCount": 42, # The number of columns in the grid.

23628

"rowCount": 42, # The number of rows in the grid.

23629

"frozenColumnCount": 42, # The number of columns that are frozen in the grid.

23630

"hideGridlines": True or False, # True if the grid isn't showing gridlines in the UI.

23631

"frozenRowCount": 42, # The number of rows that are frozen in the grid.

23632

},

23633

"rightToLeft": True or False, # True if the sheet is an RTL sheet instead of an LTR sheet.

23634

"tabColor": { # Represents a color in the RGBA color space. This representation is designed # The color of the tab in the UI.

23635

# for simplicity of conversion to/from color representations in various

23636

# languages over compactness; for example, the fields of this representation

23637

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

23638

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

23639

# method in iOS; and, with just a little work, it can be easily formatted into

23640

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

23645

#

23646

# // ...

23647

# public static java.awt.Color fromProto(Color protocolor) {

23648

# float alpha = protocolor.hasAlpha()

23649

# ? protocolor.getAlpha().getValue()

23650

# : 1.0;

23651

#

23652

# return new java.awt.Color(

23653

# protocolor.getRed(),

23654

# protocolor.getGreen(),

23655

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

23660

# float red = (float) color.getRed();

23661

# float green = (float) color.getGreen();

23662

# float blue = (float) color.getBlue();

23663

# float denominator = 255.0;

23664

# Color.Builder resultBuilder =

23665

# Color

23666

# .newBuilder()

23667

# .setRed(red / denominator)

23668

# .setGreen(green / denominator)

23669

# .setBlue(blue / denominator);

23670

# int alpha = color.getAlpha();

23671

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

23676

# .build());

23677

# }

23678

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

23683

#

23684

# // ...

23685

# static UIColor* fromProto(Color* protocolor) {

23686

# float red = [protocolor red];

23687

# float green = [protocolor green];

23688

# float blue = [protocolor blue];

23689

# FloatValue* alpha_wrapper = [protocolor alpha];

23690

# float alpha = 1.0;

23691

# if (alpha_wrapper != nil) {

23692

# alpha = [alpha_wrapper value];

23693

# }

23694

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

23695

# }

23696

#

23697

# static Color* toProto(UIColor* color) {

23698

# CGFloat red, green, blue, alpha;

23699

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

23700

# return nil;

23701

# }

23702

# Color* result = [Color alloc] init];

23703

# [result setRed:red];

23704

# [result setGreen:green];

23705

# [result setBlue:blue];

23706

# if (alpha <= 0.9999) {

23707

# [result setAlpha:floatWrapperWithValue(alpha)];

23708

# }

23709

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

23719

# var redFrac = rgb_color.red || 0.0;

23720

# var greenFrac = rgb_color.green || 0.0;

23721

# var blueFrac = rgb_color.blue || 0.0;

23722

# var red = Math.floor(redFrac * 255);

23723

# var green = Math.floor(greenFrac * 255);

23724

# var blue = Math.floor(blueFrac * 255);

23725

#

23726

# if (!('alpha' in rgb_color)) {

23727

# return rgbToCssColor_(red, green, blue);

23728

# }

23729

#

23730

# var alphaFrac = rgb_color.alpha.value || 0.0;

23731

# var rgbParams = [red, green, blue].join(',');

23732

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

23733

# };

23734

#

23735

# var rgbToCssColor_ = function(red, green, blue) {

23736

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

23737

# var hexString = rgbNumber.toString(16);

23738

# var missingZeros = 6 - hexString.length;

23739

# var resultBuilder = ['#'];

23740

# for (var i = 0; i < missingZeros; i++) {

23741

# resultBuilder.push('0');

23742

# }

23743

# resultBuilder.push(hexString);

23744

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

23749

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

23750

# the final pixel color is defined by the equation:

23751

#

23752

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

23753

#

23754

# This means that a value of 1.0 corresponds to a solid color, whereas

23755

# a value of 0.0 corresponds to a completely transparent color. This

23756

# uses a wrapper message rather than a simple float scalar so that it is

23757

# possible to distinguish between a default value and the value being unset.

23758

# If omitted, this color object is to be rendered as a solid color

23759

# (as if the alpha value had been explicitly given with a value of 1.0).

23760

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

23761

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

23762

},

23763

"hidden": True or False, # True if the sheet is hidden in the UI, false if it's visible.

23764

"sheetId": 42, # The ID of the sheet. Must be non-negative.

23765

# This field cannot be changed once set.

},

},

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

23778

23779

{ # Resource that represents a spreadsheet.

23780

"spreadsheetId": "A String", # The ID of the spreadsheet.

23781

# This field is read-only.

23782

"namedRanges": [ # The named ranges defined in a spreadsheet.

23783

{ # A named range.

23784

"namedRangeId": "A String", # The ID of the named range.

23785

"range": { # A range on a sheet. # The range this represents.

23786

# All indexes are zero-based.

23787

# Indexes are half open, e.g the start index is inclusive

23788

# and the end index is exclusive -- [start_index, end_index).

23789

# Missing indexes indicate the range is unbounded on that side.

23790

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

23791

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

23792

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

23793

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

23794

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

23795

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

23796

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

23797

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

23798

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

23799

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

23800

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

23801

# `Sheet1!A:B == sheet_id: 0,

23802

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

23803

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

23804

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

23805

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

23806

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

23807

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

23808

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

23809

#

23810

# The start index must always be less than or equal to the end index.

23811

# If the start index equals the end index, then the range is empty.

23812

# Empty ranges are typically not meaningful and are usually rendered in the

23813

# UI as `#REF!`.

23814

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

23815

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

23816

"sheetId": 42, # The sheet this range is on.

23817

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

23818

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

23819

},

23820

"name": "A String", # The name of the named range.

23821

},

23822

],

23823

"properties": { # Properties of a spreadsheet. # Overall properties of a spreadsheet.

23824

"locale": "A String", # The locale of the spreadsheet in one of the following formats:

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

23825

#

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

23826

# * an ISO 639-1 language code such as `en`

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

23827

#

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

23828

# * an ISO 639-2 language code such as `fil`, if no 639-1 code exists

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

23829

#

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

23830

# * a combination of the ISO language code and country code, such as `en_US`

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

23831

#

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

23832

# Note: when updating this field, not all locales/languages are supported.

23833

"timeZone": "A String", # The time zone of the spreadsheet, in CLDR format such as

23834

# `America/New_York`. If the time zone isn't recognized, this may

23835

# be a custom time zone such as `GMT-07:00`.

23836

"autoRecalc": "A String", # The amount of time to wait before volatile functions are recalculated.

23837

"defaultFormat": { # The format of a cell. # The default format of all cells in the spreadsheet.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

23838

# CellData.effectiveFormat will not be set if the

23839

# cell's format is equal to this default format.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

23840

# This field is read-only.

23841

"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

23842

"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on

23843

# the user's locale will be used if necessary for the given type.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame^]

23844

# See the [Date and Number Formats guide](/sheets/guides/formats) for more

23845

# information about the supported patterns.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

23846

"type": "A String", # The type of the number format.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

23847

# When writing, this field must be set.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

23848

},

23849

"textDirection": "A String", # The direction of the text in the cell.

23850

"padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.

23851

# When updating padding, every field must be specified.

23852

"top": 42, # The top padding of the cell.

23853

"right": 42, # The right padding of the cell.

23854

"bottom": 42, # The bottom padding of the cell.

23855

"left": 42, # The left padding of the cell.

23856

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

23857

"horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

23858

"backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.

23859

# for simplicity of conversion to/from color representations in various

23860

# languages over compactness; for example, the fields of this representation

23861

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

23862

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

23863

# method in iOS; and, with just a little work, it can be easily formatted into

23864

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

23869

#

23870

# // ...

23871

# public static java.awt.Color fromProto(Color protocolor) {

23872

# float alpha = protocolor.hasAlpha()

23873

# ? protocolor.getAlpha().getValue()

23874

# : 1.0;

23875

#

23876

# return new java.awt.Color(

23877

# protocolor.getRed(),

23878

# protocolor.getGreen(),

23879

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

23884

# float red = (float) color.getRed();

23885

# float green = (float) color.getGreen();

23886

# float blue = (float) color.getBlue();

23887

# float denominator = 255.0;

23888

# Color.Builder resultBuilder =

23889

# Color

23890

# .newBuilder()

23891

# .setRed(red / denominator)

23892

# .setGreen(green / denominator)

23893

# .setBlue(blue / denominator);

23894

# int alpha = color.getAlpha();

23895

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

23900

# .build());

23901

# }

23902

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

23907

#

23908

# // ...

23909

# static UIColor* fromProto(Color* protocolor) {

23910

# float red = [protocolor red];

23911

# float green = [protocolor green];

23912

# float blue = [protocolor blue];

23913

# FloatValue* alpha_wrapper = [protocolor alpha];

23914

# float alpha = 1.0;

23915

# if (alpha_wrapper != nil) {

23916

# alpha = [alpha_wrapper value];

23917

# }

23918

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

23919

# }

23920

#

23921

# static Color* toProto(UIColor* color) {

23922

# CGFloat red, green, blue, alpha;

23923

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

23924

# return nil;

23925

# }

23926

# Color* result = [Color alloc] init];

23927

# [result setRed:red];

23928

# [result setGreen:green];

23929

# [result setBlue:blue];

23930

# if (alpha <= 0.9999) {

23931

# [result setAlpha:floatWrapperWithValue(alpha)];

23932

# }

23933

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

23943

# var redFrac = rgb_color.red || 0.0;

23944

# var greenFrac = rgb_color.green || 0.0;

23945

# var blueFrac = rgb_color.blue || 0.0;

23946

# var red = Math.floor(redFrac * 255);

23947

# var green = Math.floor(greenFrac * 255);

23948

# var blue = Math.floor(blueFrac * 255);

23949

#

23950

# if (!('alpha' in rgb_color)) {

23951

# return rgbToCssColor_(red, green, blue);

23952

# }

23953

#

23954

# var alphaFrac = rgb_color.alpha.value || 0.0;

23955

# var rgbParams = [red, green, blue].join(',');

23956

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

23957

# };

23958

#

23959

# var rgbToCssColor_ = function(red, green, blue) {

23960

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

23961

# var hexString = rgbNumber.toString(16);

23962

# var missingZeros = 6 - hexString.length;

23963

# var resultBuilder = ['#'];

23964

# for (var i = 0; i < missingZeros; i++) {

23965

# resultBuilder.push('0');

23966

# }

23967

# resultBuilder.push(hexString);

23968

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

23973

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

23974

# the final pixel color is defined by the equation:

23975

#

23976

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

23977

#

23978

# This means that a value of 1.0 corresponds to a solid color, whereas

23979

# a value of 0.0 corresponds to a completely transparent color. This

23980

# uses a wrapper message rather than a simple float scalar so that it is

23981

# possible to distinguish between a default value and the value being unset.

23982

# If omitted, this color object is to be rendered as a solid color

23983

# (as if the alpha value had been explicitly given with a value of 1.0).

23984

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

23985

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

23986

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

23987

"verticalAlignment": "A String", # The vertical alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

23988

"textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).

23989

# Absent values indicate that the field isn't specified.

23990

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

23991

# for simplicity of conversion to/from color representations in various

23992

# languages over compactness; for example, the fields of this representation

23993

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

23994

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

23995

# method in iOS; and, with just a little work, it can be easily formatted into

23996

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

24001

#

24002

# // ...

24003

# public static java.awt.Color fromProto(Color protocolor) {

24004

# float alpha = protocolor.hasAlpha()

24005

# ? protocolor.getAlpha().getValue()

24006

# : 1.0;

24007

#

24008

# return new java.awt.Color(

24009

# protocolor.getRed(),

24010

# protocolor.getGreen(),

24011

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

24016

# float red = (float) color.getRed();

24017

# float green = (float) color.getGreen();

24018

# float blue = (float) color.getBlue();

24019

# float denominator = 255.0;

24020

# Color.Builder resultBuilder =

24021

# Color

24022

# .newBuilder()

24023

# .setRed(red / denominator)

24024

# .setGreen(green / denominator)

24025

# .setBlue(blue / denominator);

24026

# int alpha = color.getAlpha();

24027

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

24032

# .build());

24033

# }

24034

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

24039

#

24040

# // ...

24041

# static UIColor* fromProto(Color* protocolor) {

24042

# float red = [protocolor red];

24043

# float green = [protocolor green];

24044

# float blue = [protocolor blue];

24045

# FloatValue* alpha_wrapper = [protocolor alpha];

24046

# float alpha = 1.0;

24047

# if (alpha_wrapper != nil) {

24048

# alpha = [alpha_wrapper value];

24049

# }

24050

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

24051

# }

24052

#

24053

# static Color* toProto(UIColor* color) {

24054

# CGFloat red, green, blue, alpha;

24055

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

24056

# return nil;

24057

# }

24058

# Color* result = [Color alloc] init];

24059

# [result setRed:red];

24060

# [result setGreen:green];

24061

# [result setBlue:blue];

24062

# if (alpha <= 0.9999) {

24063

# [result setAlpha:floatWrapperWithValue(alpha)];

24064

# }

24065

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

24075

# var redFrac = rgb_color.red || 0.0;

24076

# var greenFrac = rgb_color.green || 0.0;

24077

# var blueFrac = rgb_color.blue || 0.0;

24078

# var red = Math.floor(redFrac * 255);

24079

# var green = Math.floor(greenFrac * 255);

24080

# var blue = Math.floor(blueFrac * 255);

24081

#

24082

# if (!('alpha' in rgb_color)) {

24083

# return rgbToCssColor_(red, green, blue);

24084

# }

24085

#

24086

# var alphaFrac = rgb_color.alpha.value || 0.0;

24087

# var rgbParams = [red, green, blue].join(',');

24088

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

24089

# };

24090

#

24091

# var rgbToCssColor_ = function(red, green, blue) {

24092

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

24093

# var hexString = rgbNumber.toString(16);

24094

# var missingZeros = 6 - hexString.length;

24095

# var resultBuilder = ['#'];

24096

# for (var i = 0; i < missingZeros; i++) {

24097

# resultBuilder.push('0');

24098

# }

24099

# resultBuilder.push(hexString);

24100

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

24105

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

24106

# the final pixel color is defined by the equation:

24107

#

24108

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

24109

#

24110

# This means that a value of 1.0 corresponds to a solid color, whereas

24111

# a value of 0.0 corresponds to a completely transparent color. This

24112

# uses a wrapper message rather than a simple float scalar so that it is

24113

# possible to distinguish between a default value and the value being unset.

24114

# If omitted, this color object is to be rendered as a solid color

24115

# (as if the alpha value had been explicitly given with a value of 1.0).

24116

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

24117

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

24118

},

24119

"bold": True or False, # True if the text is bold.

24120

"strikethrough": True or False, # True if the text has a strikethrough.

24121

"fontFamily": "A String", # The font family.

24122

"fontSize": 42, # The size of the font.

24123

"italic": True or False, # True if the text is italicized.

24124

"underline": True or False, # True if the text is underlined.

24125

},

24126

"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.

24127

"borders": { # The borders of the cell. # The borders of the cell.

24128

"top": { # A border along a cell. # The top border of the cell.

24129

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

24130

# for simplicity of conversion to/from color representations in various

24131

# languages over compactness; for example, the fields of this representation

24132

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

24133

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

24134

# method in iOS; and, with just a little work, it can be easily formatted into

24135

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

24140

#

24141

# // ...

24142

# public static java.awt.Color fromProto(Color protocolor) {

24143

# float alpha = protocolor.hasAlpha()

24144

# ? protocolor.getAlpha().getValue()

24145

# : 1.0;

24146

#

24147

# return new java.awt.Color(

24148

# protocolor.getRed(),

24149

# protocolor.getGreen(),

24150

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

24155

# float red = (float) color.getRed();

24156

# float green = (float) color.getGreen();

24157

# float blue = (float) color.getBlue();

24158

# float denominator = 255.0;

24159

# Color.Builder resultBuilder =

24160

# Color

24161

# .newBuilder()

24162

# .setRed(red / denominator)

24163

# .setGreen(green / denominator)

24164

# .setBlue(blue / denominator);

24165

# int alpha = color.getAlpha();

24166

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

24171

# .build());

24172

# }

24173

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

24178

#

24179

# // ...

24180

# static UIColor* fromProto(Color* protocolor) {

24181

# float red = [protocolor red];

24182

# float green = [protocolor green];

24183

# float blue = [protocolor blue];

24184

# FloatValue* alpha_wrapper = [protocolor alpha];

24185

# float alpha = 1.0;

24186

# if (alpha_wrapper != nil) {

24187

# alpha = [alpha_wrapper value];

24188

# }

24189

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

24190

# }

24191

#

24192

# static Color* toProto(UIColor* color) {

24193

# CGFloat red, green, blue, alpha;

24194

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

24195

# return nil;

24196

# }

24197

# Color* result = [Color alloc] init];

24198

# [result setRed:red];

24199

# [result setGreen:green];

24200

# [result setBlue:blue];

24201

# if (alpha <= 0.9999) {

24202

# [result setAlpha:floatWrapperWithValue(alpha)];

24203

# }

24204

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

24214

# var redFrac = rgb_color.red || 0.0;

24215

# var greenFrac = rgb_color.green || 0.0;

24216

# var blueFrac = rgb_color.blue || 0.0;

24217

# var red = Math.floor(redFrac * 255);

24218

# var green = Math.floor(greenFrac * 255);

24219

# var blue = Math.floor(blueFrac * 255);

24220

#

24221

# if (!('alpha' in rgb_color)) {

24222

# return rgbToCssColor_(red, green, blue);

24223

# }

24224

#

24225

# var alphaFrac = rgb_color.alpha.value || 0.0;

24226

# var rgbParams = [red, green, blue].join(',');

24227

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

24228

# };

24229

#

24230

# var rgbToCssColor_ = function(red, green, blue) {

24231

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

24232

# var hexString = rgbNumber.toString(16);

24233

# var missingZeros = 6 - hexString.length;

24234

# var resultBuilder = ['#'];

24235

# for (var i = 0; i < missingZeros; i++) {

24236

# resultBuilder.push('0');

24237

# }

24238

# resultBuilder.push(hexString);

24239

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

24244

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

24245

# the final pixel color is defined by the equation:

24246

#

24247

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

24248

#

24249

# This means that a value of 1.0 corresponds to a solid color, whereas

24250

# a value of 0.0 corresponds to a completely transparent color. This

24251

# uses a wrapper message rather than a simple float scalar so that it is

24252

# possible to distinguish between a default value and the value being unset.

24253

# If omitted, this color object is to be rendered as a solid color

24254

# (as if the alpha value had been explicitly given with a value of 1.0).

24255

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

24256

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

24257

},

24258

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

24259

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

24260

"style": "A String", # The style of the border.

24261

},

24262

"right": { # A border along a cell. # The right border of the cell.

24263

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

24264

# for simplicity of conversion to/from color representations in various

24265

# languages over compactness; for example, the fields of this representation

24266

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

24267

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

24268

# method in iOS; and, with just a little work, it can be easily formatted into

24269

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

24274

#

24275

# // ...

24276

# public static java.awt.Color fromProto(Color protocolor) {

24277

# float alpha = protocolor.hasAlpha()

24278

# ? protocolor.getAlpha().getValue()

24279

# : 1.0;

24280

#

24281

# return new java.awt.Color(

24282

# protocolor.getRed(),

24283

# protocolor.getGreen(),

24284

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

24289

# float red = (float) color.getRed();

24290

# float green = (float) color.getGreen();

24291

# float blue = (float) color.getBlue();

24292

# float denominator = 255.0;

24293

# Color.Builder resultBuilder =

24294

# Color

24295

# .newBuilder()

24296

# .setRed(red / denominator)

24297

# .setGreen(green / denominator)

24298

# .setBlue(blue / denominator);

24299

# int alpha = color.getAlpha();

24300

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

24305

# .build());

24306

# }

24307

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

24312

#

24313

# // ...

24314

# static UIColor* fromProto(Color* protocolor) {

24315

# float red = [protocolor red];

24316

# float green = [protocolor green];

24317

# float blue = [protocolor blue];

24318

# FloatValue* alpha_wrapper = [protocolor alpha];

24319

# float alpha = 1.0;

24320

# if (alpha_wrapper != nil) {

24321

# alpha = [alpha_wrapper value];

24322

# }

24323

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

24324

# }

24325

#

24326

# static Color* toProto(UIColor* color) {

24327

# CGFloat red, green, blue, alpha;

24328

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

24329

# return nil;

24330

# }

24331

# Color* result = [Color alloc] init];

24332

# [result setRed:red];

24333

# [result setGreen:green];

24334

# [result setBlue:blue];

24335

# if (alpha <= 0.9999) {

24336

# [result setAlpha:floatWrapperWithValue(alpha)];

24337

# }

24338

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

24348

# var redFrac = rgb_color.red || 0.0;

24349

# var greenFrac = rgb_color.green || 0.0;

24350

# var blueFrac = rgb_color.blue || 0.0;

24351

# var red = Math.floor(redFrac * 255);

24352

# var green = Math.floor(greenFrac * 255);

24353

# var blue = Math.floor(blueFrac * 255);

24354

#

24355

# if (!('alpha' in rgb_color)) {

24356

# return rgbToCssColor_(red, green, blue);

24357

# }

24358

#

24359

# var alphaFrac = rgb_color.alpha.value || 0.0;

24360

# var rgbParams = [red, green, blue].join(',');

24361

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

24362

# };

24363

#

24364

# var rgbToCssColor_ = function(red, green, blue) {

24365

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

24366

# var hexString = rgbNumber.toString(16);

24367

# var missingZeros = 6 - hexString.length;

24368

# var resultBuilder = ['#'];

24369

# for (var i = 0; i < missingZeros; i++) {

24370

# resultBuilder.push('0');

24371

# }

24372

# resultBuilder.push(hexString);

24373

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

24378

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

24379

# the final pixel color is defined by the equation:

24380

#

24381

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

24382

#

24383

# This means that a value of 1.0 corresponds to a solid color, whereas

24384

# a value of 0.0 corresponds to a completely transparent color. This

24385

# uses a wrapper message rather than a simple float scalar so that it is

24386

# possible to distinguish between a default value and the value being unset.

24387

# If omitted, this color object is to be rendered as a solid color

24388

# (as if the alpha value had been explicitly given with a value of 1.0).

24389

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

24390

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

24391

},

24392

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

24393

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

24394

"style": "A String", # The style of the border.

24395

},

24396

"bottom": { # A border along a cell. # The bottom border of the cell.

24397

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

24398

# for simplicity of conversion to/from color representations in various

24399

# languages over compactness; for example, the fields of this representation

24400

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

24401

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

24402

# method in iOS; and, with just a little work, it can be easily formatted into

24403

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

24408

#

24409

# // ...

24410

# public static java.awt.Color fromProto(Color protocolor) {

24411

# float alpha = protocolor.hasAlpha()

24412

# ? protocolor.getAlpha().getValue()

24413

# : 1.0;

24414

#

24415

# return new java.awt.Color(

24416

# protocolor.getRed(),

24417

# protocolor.getGreen(),

24418

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

24423

# float red = (float) color.getRed();

24424

# float green = (float) color.getGreen();

24425

# float blue = (float) color.getBlue();

24426

# float denominator = 255.0;

24427

# Color.Builder resultBuilder =

24428

# Color

24429

# .newBuilder()

24430

# .setRed(red / denominator)

24431

# .setGreen(green / denominator)

24432

# .setBlue(blue / denominator);

24433

# int alpha = color.getAlpha();

24434

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

24439

# .build());

24440

# }

24441

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

24446

#

24447

# // ...

24448

# static UIColor* fromProto(Color* protocolor) {

24449

# float red = [protocolor red];

24450

# float green = [protocolor green];

24451

# float blue = [protocolor blue];

24452

# FloatValue* alpha_wrapper = [protocolor alpha];

24453

# float alpha = 1.0;

24454

# if (alpha_wrapper != nil) {

24455

# alpha = [alpha_wrapper value];

24456

# }

24457

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

24458

# }

24459

#

24460

# static Color* toProto(UIColor* color) {

24461

# CGFloat red, green, blue, alpha;

24462

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

24463

# return nil;

24464

# }

24465

# Color* result = [Color alloc] init];

24466

# [result setRed:red];

24467

# [result setGreen:green];

24468

# [result setBlue:blue];

24469

# if (alpha <= 0.9999) {

24470

# [result setAlpha:floatWrapperWithValue(alpha)];

24471

# }

24472

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

24482

# var redFrac = rgb_color.red || 0.0;

24483

# var greenFrac = rgb_color.green || 0.0;

24484

# var blueFrac = rgb_color.blue || 0.0;

24485

# var red = Math.floor(redFrac * 255);

24486

# var green = Math.floor(greenFrac * 255);

24487

# var blue = Math.floor(blueFrac * 255);

24488

#

24489

# if (!('alpha' in rgb_color)) {

24490

# return rgbToCssColor_(red, green, blue);

24491

# }

24492

#

24493

# var alphaFrac = rgb_color.alpha.value || 0.0;

24494

# var rgbParams = [red, green, blue].join(',');

24495

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

24496

# };

24497

#

24498

# var rgbToCssColor_ = function(red, green, blue) {

24499

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

24500

# var hexString = rgbNumber.toString(16);

24501

# var missingZeros = 6 - hexString.length;

24502

# var resultBuilder = ['#'];

24503

# for (var i = 0; i < missingZeros; i++) {

24504

# resultBuilder.push('0');

24505

# }

24506

# resultBuilder.push(hexString);

24507

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

24512

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

24513

# the final pixel color is defined by the equation:

24514

#

24515

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

24516

#

24517

# This means that a value of 1.0 corresponds to a solid color, whereas

24518

# a value of 0.0 corresponds to a completely transparent color. This

24519

# uses a wrapper message rather than a simple float scalar so that it is

24520

# possible to distinguish between a default value and the value being unset.

24521

# If omitted, this color object is to be rendered as a solid color

24522

# (as if the alpha value had been explicitly given with a value of 1.0).

24523

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

24524

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

24525

},

24526

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

24527

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

24528

"style": "A String", # The style of the border.

24529

},

24530

"left": { # A border along a cell. # The left border of the cell.

24531

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

24532

# for simplicity of conversion to/from color representations in various

24533

# languages over compactness; for example, the fields of this representation

24534

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

24535

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

24536

# method in iOS; and, with just a little work, it can be easily formatted into

24537

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

24542

#

24543

# // ...

24544

# public static java.awt.Color fromProto(Color protocolor) {

24545

# float alpha = protocolor.hasAlpha()

24546

# ? protocolor.getAlpha().getValue()

24547

# : 1.0;

24548

#

24549

# return new java.awt.Color(

24550

# protocolor.getRed(),

24551

# protocolor.getGreen(),

24552

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

24557

# float red = (float) color.getRed();

24558

# float green = (float) color.getGreen();

24559

# float blue = (float) color.getBlue();

24560

# float denominator = 255.0;

24561

# Color.Builder resultBuilder =

24562

# Color

24563

# .newBuilder()

24564

# .setRed(red / denominator)

24565

# .setGreen(green / denominator)

24566

# .setBlue(blue / denominator);

24567

# int alpha = color.getAlpha();

24568

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

24573

# .build());

24574

# }

24575

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

24580

#

24581

# // ...

24582

# static UIColor* fromProto(Color* protocolor) {

24583

# float red = [protocolor red];

24584

# float green = [protocolor green];

24585

# float blue = [protocolor blue];

24586

# FloatValue* alpha_wrapper = [protocolor alpha];

24587

# float alpha = 1.0;

24588

# if (alpha_wrapper != nil) {

24589

# alpha = [alpha_wrapper value];

24590

# }

24591

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

24592

# }

24593

#

24594

# static Color* toProto(UIColor* color) {

24595

# CGFloat red, green, blue, alpha;

24596

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

24597

# return nil;

24598

# }

24599

# Color* result = [Color alloc] init];

24600

# [result setRed:red];

24601

# [result setGreen:green];

24602

# [result setBlue:blue];

24603

# if (alpha <= 0.9999) {

24604

# [result setAlpha:floatWrapperWithValue(alpha)];

24605

# }

24606

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

24616

# var redFrac = rgb_color.red || 0.0;

24617

# var greenFrac = rgb_color.green || 0.0;

24618

# var blueFrac = rgb_color.blue || 0.0;

24619

# var red = Math.floor(redFrac * 255);

24620

# var green = Math.floor(greenFrac * 255);

24621

# var blue = Math.floor(blueFrac * 255);

24622

#

24623

# if (!('alpha' in rgb_color)) {

24624

# return rgbToCssColor_(red, green, blue);

24625

# }

24626

#

24627

# var alphaFrac = rgb_color.alpha.value || 0.0;

24628

# var rgbParams = [red, green, blue].join(',');

24629

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

24630

# };

24631

#

24632

# var rgbToCssColor_ = function(red, green, blue) {

24633

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

24634

# var hexString = rgbNumber.toString(16);

24635

# var missingZeros = 6 - hexString.length;

24636

# var resultBuilder = ['#'];

24637

# for (var i = 0; i < missingZeros; i++) {

24638

# resultBuilder.push('0');

24639

# }

24640

# resultBuilder.push(hexString);

24641

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

24646

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

24647

# the final pixel color is defined by the equation:

24648

#

24649

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

24650

#

24651

# This means that a value of 1.0 corresponds to a solid color, whereas

24652

# a value of 0.0 corresponds to a completely transparent color. This

24653

# uses a wrapper message rather than a simple float scalar so that it is

24654

# possible to distinguish between a default value and the value being unset.

24655

# If omitted, this color object is to be rendered as a solid color

24656

# (as if the alpha value had been explicitly given with a value of 1.0).

24657

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

24658

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

24659

},

24660

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

24661

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

24662

"style": "A String", # The style of the border.

24663

},

24664

},

24665

"wrapStrategy": "A String", # The wrap strategy for the value in the cell.

24666

},

24667

"title": "A String", # The title of the spreadsheet.

24668

},

24669

"sheets": [ # The sheets that are part of a spreadsheet.

24670

{ # A sheet in a spreadsheet.

24671

"conditionalFormats": [ # The conditional format rules in this sheet.

24672

{ # A rule describing a conditional format.

24673

"ranges": [ # The ranges that will be formatted if the condition is true.

24674

# All the ranges must be on the same grid.

24675

{ # A range on a sheet.

24676

# All indexes are zero-based.

24677

# Indexes are half open, e.g the start index is inclusive

24678

# and the end index is exclusive -- [start_index, end_index).

24679

# Missing indexes indicate the range is unbounded on that side.

24680

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

24681

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

24682

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

24683

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

24684

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

24685

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

24686

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

24687

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

24688

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

24689

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

24690

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

24691

# `Sheet1!A:B == sheet_id: 0,

24692

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

24693

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

24694

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

24695

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

24696

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

24697

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

24698

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

24699

#

24700

# The start index must always be less than or equal to the end index.

24701

# If the start index equals the end index, then the range is empty.

24702

# Empty ranges are typically not meaningful and are usually rendered in the

24703

# UI as `#REF!`.

24704

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

24705

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

24706

"sheetId": 42, # The sheet this range is on.

24707

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

24708

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

24709

},

24710

],

24711

"booleanRule": { # A rule that may or may not match, depending on the condition. # The formatting is either "on" or "off" according to the rule.

24712

"condition": { # A condition that can evaluate to true or false. # The condition of the rule. If the condition evaluates to true,

24713

# the format will be applied.

24714

# BooleanConditions are used by conditional formatting,

24715

# data validation, and the criteria in filters.

24716

"type": "A String", # The type of condition.

24717

"values": [ # The values of the condition. The number of supported values depends

24718

# on the condition type. Some support zero values,

24719

# others one or two values,

24720

# and ConditionType.ONE_OF_LIST supports an arbitrary number of values.

24721

{ # The value of the condition.

24722

"relativeDate": "A String", # A relative date (based on the current date).

24723

# Valid only if the type is

24724

# DATE_BEFORE,

24725

# DATE_AFTER,

24726

# DATE_ON_OR_BEFORE or

24727

# DATE_ON_OR_AFTER.

24728

#

24729

# Relative dates are not supported in data validation.

24730

# They are supported only in conditional formatting and

24731

# conditional filters.

24732

"userEnteredValue": "A String", # A value the condition is based on.

24733

# The value will be parsed as if the user typed into a cell.

24734

# Formulas are supported (and must begin with an `=`).

},

],

},

"format": { # The format of a cell. # The format to apply.

24739

# Conditional formatting can only apply a subset of formatting:

# bold, italic,

# strikethrough,

# foreground color &

# background color.

"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

24745

"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on

24746

# the user's locale will be used if necessary for the given type.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame^]

24747

# See the [Date and Number Formats guide](/sheets/guides/formats) for more

24748

# information about the supported patterns.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

24749

"type": "A String", # The type of the number format.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

24750

# When writing, this field must be set.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

24751

},

24752

"textDirection": "A String", # The direction of the text in the cell.

24753

"padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.

24754

# When updating padding, every field must be specified.

24755

"top": 42, # The top padding of the cell.

24756

"right": 42, # The right padding of the cell.

24757

"bottom": 42, # The bottom padding of the cell.

24758

"left": 42, # The left padding of the cell.

24759

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

24760

"horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

24761

"backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.

24762

# for simplicity of conversion to/from color representations in various

24763

# languages over compactness; for example, the fields of this representation

24764

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

24765

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

24766

# method in iOS; and, with just a little work, it can be easily formatted into

24767

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

24772

#

24773

# // ...

24774

# public static java.awt.Color fromProto(Color protocolor) {

24775

# float alpha = protocolor.hasAlpha()

24776

# ? protocolor.getAlpha().getValue()

24777

# : 1.0;

24778

#

24779

# return new java.awt.Color(

24780

# protocolor.getRed(),

24781

# protocolor.getGreen(),

24782

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

24787

# float red = (float) color.getRed();

24788

# float green = (float) color.getGreen();

24789

# float blue = (float) color.getBlue();

24790

# float denominator = 255.0;

24791

# Color.Builder resultBuilder =

24792

# Color

24793

# .newBuilder()

24794

# .setRed(red / denominator)

24795

# .setGreen(green / denominator)

24796

# .setBlue(blue / denominator);

24797

# int alpha = color.getAlpha();

24798

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

24803

# .build());

24804

# }

24805

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

24810

#

24811

# // ...

24812

# static UIColor* fromProto(Color* protocolor) {

24813

# float red = [protocolor red];

24814

# float green = [protocolor green];

24815

# float blue = [protocolor blue];

24816

# FloatValue* alpha_wrapper = [protocolor alpha];

24817

# float alpha = 1.0;

24818

# if (alpha_wrapper != nil) {

24819

# alpha = [alpha_wrapper value];

24820

# }

24821

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

24822

# }

24823

#

24824

# static Color* toProto(UIColor* color) {

24825

# CGFloat red, green, blue, alpha;

24826

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

24827

# return nil;

24828

# }

24829

# Color* result = [Color alloc] init];

24830

# [result setRed:red];

24831

# [result setGreen:green];

24832

# [result setBlue:blue];

24833

# if (alpha <= 0.9999) {

24834

# [result setAlpha:floatWrapperWithValue(alpha)];

24835

# }

24836

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

24846

# var redFrac = rgb_color.red || 0.0;

24847

# var greenFrac = rgb_color.green || 0.0;

24848

# var blueFrac = rgb_color.blue || 0.0;

24849

# var red = Math.floor(redFrac * 255);

24850

# var green = Math.floor(greenFrac * 255);

24851

# var blue = Math.floor(blueFrac * 255);

24852

#

24853

# if (!('alpha' in rgb_color)) {

24854

# return rgbToCssColor_(red, green, blue);

24855

# }

24856

#

24857

# var alphaFrac = rgb_color.alpha.value || 0.0;

24858

# var rgbParams = [red, green, blue].join(',');

24859

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

24860

# };

24861

#

24862

# var rgbToCssColor_ = function(red, green, blue) {

24863

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

24864

# var hexString = rgbNumber.toString(16);

24865

# var missingZeros = 6 - hexString.length;

24866

# var resultBuilder = ['#'];

24867

# for (var i = 0; i < missingZeros; i++) {

24868

# resultBuilder.push('0');

24869

# }

24870

# resultBuilder.push(hexString);

24871

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

24876

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

24877

# the final pixel color is defined by the equation:

24878

#

24879

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

24880

#

24881

# This means that a value of 1.0 corresponds to a solid color, whereas

24882

# a value of 0.0 corresponds to a completely transparent color. This

24883

# uses a wrapper message rather than a simple float scalar so that it is

24884

# possible to distinguish between a default value and the value being unset.

24885

# If omitted, this color object is to be rendered as a solid color

24886

# (as if the alpha value had been explicitly given with a value of 1.0).

24887

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

24888

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

24889

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

24890

"verticalAlignment": "A String", # The vertical alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

24891

"textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).

24892

# Absent values indicate that the field isn't specified.

24893

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

24894

# for simplicity of conversion to/from color representations in various

24895

# languages over compactness; for example, the fields of this representation

24896

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

24897

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

24898

# method in iOS; and, with just a little work, it can be easily formatted into

24899

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

24904

#

24905

# // ...

24906

# public static java.awt.Color fromProto(Color protocolor) {

24907

# float alpha = protocolor.hasAlpha()

24908

# ? protocolor.getAlpha().getValue()

24909

# : 1.0;

24910

#

24911

# return new java.awt.Color(

24912

# protocolor.getRed(),

24913

# protocolor.getGreen(),

24914

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

24919

# float red = (float) color.getRed();

24920

# float green = (float) color.getGreen();

24921

# float blue = (float) color.getBlue();

24922

# float denominator = 255.0;

24923

# Color.Builder resultBuilder =

24924

# Color

24925

# .newBuilder()

24926

# .setRed(red / denominator)

24927

# .setGreen(green / denominator)

24928

# .setBlue(blue / denominator);

24929

# int alpha = color.getAlpha();

24930

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

24935

# .build());

24936

# }

24937

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

24942

#

24943

# // ...

24944

# static UIColor* fromProto(Color* protocolor) {

24945

# float red = [protocolor red];

24946

# float green = [protocolor green];

24947

# float blue = [protocolor blue];

24948

# FloatValue* alpha_wrapper = [protocolor alpha];

24949

# float alpha = 1.0;

24950

# if (alpha_wrapper != nil) {

24951

# alpha = [alpha_wrapper value];

24952

# }

24953

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

24954

# }

24955

#

24956

# static Color* toProto(UIColor* color) {

24957

# CGFloat red, green, blue, alpha;

24958

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

24959

# return nil;

24960

# }

24961

# Color* result = [Color alloc] init];

24962

# [result setRed:red];

24963

# [result setGreen:green];

24964

# [result setBlue:blue];

24965

# if (alpha <= 0.9999) {

24966

# [result setAlpha:floatWrapperWithValue(alpha)];

24967

# }

24968

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

24978

# var redFrac = rgb_color.red || 0.0;

24979

# var greenFrac = rgb_color.green || 0.0;

24980

# var blueFrac = rgb_color.blue || 0.0;

24981

# var red = Math.floor(redFrac * 255);

24982

# var green = Math.floor(greenFrac * 255);

24983

# var blue = Math.floor(blueFrac * 255);

24984

#

24985

# if (!('alpha' in rgb_color)) {

24986

# return rgbToCssColor_(red, green, blue);

24987

# }

24988

#

24989

# var alphaFrac = rgb_color.alpha.value || 0.0;

24990

# var rgbParams = [red, green, blue].join(',');

24991

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

24992

# };

24993

#

24994

# var rgbToCssColor_ = function(red, green, blue) {

24995

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

24996

# var hexString = rgbNumber.toString(16);

24997

# var missingZeros = 6 - hexString.length;

24998

# var resultBuilder = ['#'];

24999

# for (var i = 0; i < missingZeros; i++) {

25000

# resultBuilder.push('0');

25001

# }

25002

# resultBuilder.push(hexString);

25003

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

25008

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

25009

# the final pixel color is defined by the equation:

25010

#

25011

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

25012

#

25013

# This means that a value of 1.0 corresponds to a solid color, whereas

25014

# a value of 0.0 corresponds to a completely transparent color. This

25015

# uses a wrapper message rather than a simple float scalar so that it is

25016

# possible to distinguish between a default value and the value being unset.

25017

# If omitted, this color object is to be rendered as a solid color

25018

# (as if the alpha value had been explicitly given with a value of 1.0).

25019

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

25020

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

25021

},

25022

"bold": True or False, # True if the text is bold.

25023

"strikethrough": True or False, # True if the text has a strikethrough.

25024

"fontFamily": "A String", # The font family.

25025

"fontSize": 42, # The size of the font.

25026

"italic": True or False, # True if the text is italicized.

25027

"underline": True or False, # True if the text is underlined.

25028

},

25029

"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.

25030

"borders": { # The borders of the cell. # The borders of the cell.

25031

"top": { # A border along a cell. # The top border of the cell.

25032

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

25033

# for simplicity of conversion to/from color representations in various

25034

# languages over compactness; for example, the fields of this representation

25035

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

25036

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

25037

# method in iOS; and, with just a little work, it can be easily formatted into

25038

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

25043

#

25044

# // ...

25045

# public static java.awt.Color fromProto(Color protocolor) {

25046

# float alpha = protocolor.hasAlpha()

25047

# ? protocolor.getAlpha().getValue()

25048

# : 1.0;

25049

#

25050

# return new java.awt.Color(

25051

# protocolor.getRed(),

25052

# protocolor.getGreen(),

25053

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

25058

# float red = (float) color.getRed();

25059

# float green = (float) color.getGreen();

25060

# float blue = (float) color.getBlue();

25061

# float denominator = 255.0;

25062

# Color.Builder resultBuilder =

25063

# Color

25064

# .newBuilder()

25065

# .setRed(red / denominator)

25066

# .setGreen(green / denominator)

25067

# .setBlue(blue / denominator);

25068

# int alpha = color.getAlpha();

25069

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

25074

# .build());

25075

# }

25076

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

25081

#

25082

# // ...

25083

# static UIColor* fromProto(Color* protocolor) {

25084

# float red = [protocolor red];

25085

# float green = [protocolor green];

25086

# float blue = [protocolor blue];

25087

# FloatValue* alpha_wrapper = [protocolor alpha];

25088

# float alpha = 1.0;

25089

# if (alpha_wrapper != nil) {

25090

# alpha = [alpha_wrapper value];

25091

# }

25092

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

25093

# }

25094

#

25095

# static Color* toProto(UIColor* color) {

25096

# CGFloat red, green, blue, alpha;

25097

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

25098

# return nil;

25099

# }

25100

# Color* result = [Color alloc] init];

25101

# [result setRed:red];

25102

# [result setGreen:green];

25103

# [result setBlue:blue];

25104

# if (alpha <= 0.9999) {

25105

# [result setAlpha:floatWrapperWithValue(alpha)];

25106

# }

25107

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

25117

# var redFrac = rgb_color.red || 0.0;

25118

# var greenFrac = rgb_color.green || 0.0;

25119

# var blueFrac = rgb_color.blue || 0.0;

25120

# var red = Math.floor(redFrac * 255);

25121

# var green = Math.floor(greenFrac * 255);

25122

# var blue = Math.floor(blueFrac * 255);

25123

#

25124

# if (!('alpha' in rgb_color)) {

25125

# return rgbToCssColor_(red, green, blue);

25126

# }

25127

#

25128

# var alphaFrac = rgb_color.alpha.value || 0.0;

25129

# var rgbParams = [red, green, blue].join(',');

25130

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

25131

# };

25132

#

25133

# var rgbToCssColor_ = function(red, green, blue) {

25134

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

25135

# var hexString = rgbNumber.toString(16);

25136

# var missingZeros = 6 - hexString.length;

25137

# var resultBuilder = ['#'];

25138

# for (var i = 0; i < missingZeros; i++) {

25139

# resultBuilder.push('0');

25140

# }

25141

# resultBuilder.push(hexString);

25142

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

25147

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

25148

# the final pixel color is defined by the equation:

25149

#

25150

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

25151

#

25152

# This means that a value of 1.0 corresponds to a solid color, whereas

25153

# a value of 0.0 corresponds to a completely transparent color. This

25154

# uses a wrapper message rather than a simple float scalar so that it is

25155

# possible to distinguish between a default value and the value being unset.

25156

# If omitted, this color object is to be rendered as a solid color

25157

# (as if the alpha value had been explicitly given with a value of 1.0).

25158

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

25159

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

25160

},

25161

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

25162

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

25163

"style": "A String", # The style of the border.

25164

},

25165

"right": { # A border along a cell. # The right border of the cell.

25166

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

25167

# for simplicity of conversion to/from color representations in various

25168

# languages over compactness; for example, the fields of this representation

25169

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

25170

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

25171

# method in iOS; and, with just a little work, it can be easily formatted into

25172

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

25177

#

25178

# // ...

25179

# public static java.awt.Color fromProto(Color protocolor) {

25180

# float alpha = protocolor.hasAlpha()

25181

# ? protocolor.getAlpha().getValue()

25182

# : 1.0;

25183

#

25184

# return new java.awt.Color(

25185

# protocolor.getRed(),

25186

# protocolor.getGreen(),

25187

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

25192

# float red = (float) color.getRed();

25193

# float green = (float) color.getGreen();

25194

# float blue = (float) color.getBlue();

25195

# float denominator = 255.0;

25196

# Color.Builder resultBuilder =

25197

# Color

25198

# .newBuilder()

25199

# .setRed(red / denominator)

25200

# .setGreen(green / denominator)

25201

# .setBlue(blue / denominator);

25202

# int alpha = color.getAlpha();

25203

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

25208

# .build());

25209

# }

25210

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

25215

#

25216

# // ...

25217

# static UIColor* fromProto(Color* protocolor) {

25218

# float red = [protocolor red];

25219

# float green = [protocolor green];

25220

# float blue = [protocolor blue];

25221

# FloatValue* alpha_wrapper = [protocolor alpha];

25222

# float alpha = 1.0;

25223

# if (alpha_wrapper != nil) {

25224

# alpha = [alpha_wrapper value];

25225

# }

25226

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

25227

# }

25228

#

25229

# static Color* toProto(UIColor* color) {

25230

# CGFloat red, green, blue, alpha;

25231

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

25232

# return nil;

25233

# }

25234

# Color* result = [Color alloc] init];

25235

# [result setRed:red];

25236

# [result setGreen:green];

25237

# [result setBlue:blue];

25238

# if (alpha <= 0.9999) {

25239

# [result setAlpha:floatWrapperWithValue(alpha)];

25240

# }

25241

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

25251

# var redFrac = rgb_color.red || 0.0;

25252

# var greenFrac = rgb_color.green || 0.0;

25253

# var blueFrac = rgb_color.blue || 0.0;

25254

# var red = Math.floor(redFrac * 255);

25255

# var green = Math.floor(greenFrac * 255);

25256

# var blue = Math.floor(blueFrac * 255);

25257

#

25258

# if (!('alpha' in rgb_color)) {

25259

# return rgbToCssColor_(red, green, blue);

25260

# }

25261

#

25262

# var alphaFrac = rgb_color.alpha.value || 0.0;

25263

# var rgbParams = [red, green, blue].join(',');

25264

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

25265

# };

25266

#

25267

# var rgbToCssColor_ = function(red, green, blue) {

25268

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

25269

# var hexString = rgbNumber.toString(16);

25270

# var missingZeros = 6 - hexString.length;

25271

# var resultBuilder = ['#'];

25272

# for (var i = 0; i < missingZeros; i++) {

25273

# resultBuilder.push('0');

25274

# }

25275

# resultBuilder.push(hexString);

25276

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

25281

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

25282

# the final pixel color is defined by the equation:

25283

#

25284

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

25285

#

25286

# This means that a value of 1.0 corresponds to a solid color, whereas

25287

# a value of 0.0 corresponds to a completely transparent color. This

25288

# uses a wrapper message rather than a simple float scalar so that it is

25289

# possible to distinguish between a default value and the value being unset.

25290

# If omitted, this color object is to be rendered as a solid color

25291

# (as if the alpha value had been explicitly given with a value of 1.0).

25292

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

25293

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

25294

},

25295

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

25296

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

25297

"style": "A String", # The style of the border.

25298

},

25299

"bottom": { # A border along a cell. # The bottom border of the cell.

25300

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

25301

# for simplicity of conversion to/from color representations in various

25302

# languages over compactness; for example, the fields of this representation

25303

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

25304

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

25305

# method in iOS; and, with just a little work, it can be easily formatted into

25306

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

25311

#

25312

# // ...

25313

# public static java.awt.Color fromProto(Color protocolor) {

25314

# float alpha = protocolor.hasAlpha()

25315

# ? protocolor.getAlpha().getValue()

25316

# : 1.0;

25317

#

25318

# return new java.awt.Color(

25319

# protocolor.getRed(),

25320

# protocolor.getGreen(),

25321

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

25326

# float red = (float) color.getRed();

25327

# float green = (float) color.getGreen();

25328

# float blue = (float) color.getBlue();

25329

# float denominator = 255.0;

25330

# Color.Builder resultBuilder =

25331

# Color

25332

# .newBuilder()

25333

# .setRed(red / denominator)

25334

# .setGreen(green / denominator)

25335

# .setBlue(blue / denominator);

25336

# int alpha = color.getAlpha();

25337

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

25342

# .build());

25343

# }

25344

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

25349

#

25350

# // ...

25351

# static UIColor* fromProto(Color* protocolor) {

25352

# float red = [protocolor red];

25353

# float green = [protocolor green];

25354

# float blue = [protocolor blue];

25355

# FloatValue* alpha_wrapper = [protocolor alpha];

25356

# float alpha = 1.0;

25357

# if (alpha_wrapper != nil) {

25358

# alpha = [alpha_wrapper value];

25359

# }

25360

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

25361

# }

25362

#

25363

# static Color* toProto(UIColor* color) {

25364

# CGFloat red, green, blue, alpha;

25365

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

25366

# return nil;

25367

# }

25368

# Color* result = [Color alloc] init];

25369

# [result setRed:red];

25370

# [result setGreen:green];

25371

# [result setBlue:blue];

25372

# if (alpha <= 0.9999) {

25373

# [result setAlpha:floatWrapperWithValue(alpha)];

25374

# }

25375

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

25385

# var redFrac = rgb_color.red || 0.0;

25386

# var greenFrac = rgb_color.green || 0.0;

25387

# var blueFrac = rgb_color.blue || 0.0;

25388

# var red = Math.floor(redFrac * 255);

25389

# var green = Math.floor(greenFrac * 255);

25390

# var blue = Math.floor(blueFrac * 255);

25391

#

25392

# if (!('alpha' in rgb_color)) {

25393

# return rgbToCssColor_(red, green, blue);

25394

# }

25395

#

25396

# var alphaFrac = rgb_color.alpha.value || 0.0;

25397

# var rgbParams = [red, green, blue].join(',');

25398

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

25399

# };

25400

#

25401

# var rgbToCssColor_ = function(red, green, blue) {

25402

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

25403

# var hexString = rgbNumber.toString(16);

25404

# var missingZeros = 6 - hexString.length;

25405

# var resultBuilder = ['#'];

25406

# for (var i = 0; i < missingZeros; i++) {

25407

# resultBuilder.push('0');

25408

# }

25409

# resultBuilder.push(hexString);

25410

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

25415

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

25416

# the final pixel color is defined by the equation:

25417

#

25418

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

25419

#

25420

# This means that a value of 1.0 corresponds to a solid color, whereas

25421

# a value of 0.0 corresponds to a completely transparent color. This

25422

# uses a wrapper message rather than a simple float scalar so that it is

25423

# possible to distinguish between a default value and the value being unset.

25424

# If omitted, this color object is to be rendered as a solid color

25425

# (as if the alpha value had been explicitly given with a value of 1.0).

25426

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

25427

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

25428

},

25429

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

25430

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

25431

"style": "A String", # The style of the border.

25432

},

25433

"left": { # A border along a cell. # The left border of the cell.

25434

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

25435

# for simplicity of conversion to/from color representations in various

25436

# languages over compactness; for example, the fields of this representation

25437

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

25438

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

25439

# method in iOS; and, with just a little work, it can be easily formatted into

25440

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

25445

#

25446

# // ...

25447

# public static java.awt.Color fromProto(Color protocolor) {

25448

# float alpha = protocolor.hasAlpha()

25449

# ? protocolor.getAlpha().getValue()

25450

# : 1.0;

25451

#

25452

# return new java.awt.Color(

25453

# protocolor.getRed(),

25454

# protocolor.getGreen(),

25455

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

25460

# float red = (float) color.getRed();

25461

# float green = (float) color.getGreen();

25462

# float blue = (float) color.getBlue();

25463

# float denominator = 255.0;

25464

# Color.Builder resultBuilder =

25465

# Color

25466

# .newBuilder()

25467

# .setRed(red / denominator)

25468

# .setGreen(green / denominator)

25469

# .setBlue(blue / denominator);

25470

# int alpha = color.getAlpha();

25471

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

25476

# .build());

25477

# }

25478

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

25483

#

25484

# // ...

25485

# static UIColor* fromProto(Color* protocolor) {

25486

# float red = [protocolor red];

25487

# float green = [protocolor green];

25488

# float blue = [protocolor blue];

25489

# FloatValue* alpha_wrapper = [protocolor alpha];

25490

# float alpha = 1.0;

25491

# if (alpha_wrapper != nil) {

25492

# alpha = [alpha_wrapper value];

25493

# }

25494

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

25495

# }

25496

#

25497

# static Color* toProto(UIColor* color) {

25498

# CGFloat red, green, blue, alpha;

25499

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

25500

# return nil;

25501

# }

25502

# Color* result = [Color alloc] init];

25503

# [result setRed:red];

25504

# [result setGreen:green];

25505

# [result setBlue:blue];

25506

# if (alpha <= 0.9999) {

25507

# [result setAlpha:floatWrapperWithValue(alpha)];

25508

# }

25509

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

25519

# var redFrac = rgb_color.red || 0.0;

25520

# var greenFrac = rgb_color.green || 0.0;

25521

# var blueFrac = rgb_color.blue || 0.0;

25522

# var red = Math.floor(redFrac * 255);

25523

# var green = Math.floor(greenFrac * 255);

25524

# var blue = Math.floor(blueFrac * 255);

25525

#

25526

# if (!('alpha' in rgb_color)) {

25527

# return rgbToCssColor_(red, green, blue);

25528

# }

25529

#

25530

# var alphaFrac = rgb_color.alpha.value || 0.0;

25531

# var rgbParams = [red, green, blue].join(',');

25532

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

25533

# };

25534

#

25535

# var rgbToCssColor_ = function(red, green, blue) {

25536

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

25537

# var hexString = rgbNumber.toString(16);

25538

# var missingZeros = 6 - hexString.length;

25539

# var resultBuilder = ['#'];

25540

# for (var i = 0; i < missingZeros; i++) {

25541

# resultBuilder.push('0');

25542

# }

25543

# resultBuilder.push(hexString);

25544

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

25549

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

25550

# the final pixel color is defined by the equation:

25551

#

25552

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

25553

#

25554

# This means that a value of 1.0 corresponds to a solid color, whereas

25555

# a value of 0.0 corresponds to a completely transparent color. This

25556

# uses a wrapper message rather than a simple float scalar so that it is

25557

# possible to distinguish between a default value and the value being unset.

25558

# If omitted, this color object is to be rendered as a solid color

25559

# (as if the alpha value had been explicitly given with a value of 1.0).

25560

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

25561

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

25562

},

25563

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

25564

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

25565

"style": "A String", # The style of the border.

25566

},

25567

},

25568

"wrapStrategy": "A String", # The wrap strategy for the value in the cell.

25569

},

25570

},

25571

"gradientRule": { # A rule that applies a gradient color scale format, based on # The formatting will vary based on the gradients in the rule.

25572

# the interpolation points listed. The format of a cell will vary

25573

# based on its contents as compared to the values of the interpolation

25574

# points.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

25575

"maxpoint": { # A single interpolation point on a gradient conditional format. # The final interpolation point.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

25576

# These pin the gradient color scale according to the color,

25577

# type and value chosen.

25578

"color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.

25579

# for simplicity of conversion to/from color representations in various

25580

# languages over compactness; for example, the fields of this representation

25581

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

25582

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

25583

# method in iOS; and, with just a little work, it can be easily formatted into

25584

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

25589

#

25590

# // ...

25591

# public static java.awt.Color fromProto(Color protocolor) {

25592

# float alpha = protocolor.hasAlpha()

25593

# ? protocolor.getAlpha().getValue()

25594

# : 1.0;

25595

#

25596

# return new java.awt.Color(

25597

# protocolor.getRed(),

25598

# protocolor.getGreen(),

25599

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

25604

# float red = (float) color.getRed();

25605

# float green = (float) color.getGreen();

25606

# float blue = (float) color.getBlue();

25607

# float denominator = 255.0;

25608

# Color.Builder resultBuilder =

25609

# Color

25610

# .newBuilder()

25611

# .setRed(red / denominator)

25612

# .setGreen(green / denominator)

25613

# .setBlue(blue / denominator);

25614

# int alpha = color.getAlpha();

25615

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

25620

# .build());

25621

# }

25622

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

25627

#

25628

# // ...

25629

# static UIColor* fromProto(Color* protocolor) {

25630

# float red = [protocolor red];

25631

# float green = [protocolor green];

25632

# float blue = [protocolor blue];

25633

# FloatValue* alpha_wrapper = [protocolor alpha];

25634

# float alpha = 1.0;

25635

# if (alpha_wrapper != nil) {

25636

# alpha = [alpha_wrapper value];

25637

# }

25638

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

25639

# }

25640

#

25641

# static Color* toProto(UIColor* color) {

25642

# CGFloat red, green, blue, alpha;

25643

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

25644

# return nil;

25645

# }

25646

# Color* result = [Color alloc] init];

25647

# [result setRed:red];

25648

# [result setGreen:green];

25649

# [result setBlue:blue];

25650

# if (alpha <= 0.9999) {

25651

# [result setAlpha:floatWrapperWithValue(alpha)];

25652

# }

25653

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

25663

# var redFrac = rgb_color.red || 0.0;

25664

# var greenFrac = rgb_color.green || 0.0;

25665

# var blueFrac = rgb_color.blue || 0.0;

25666

# var red = Math.floor(redFrac * 255);

25667

# var green = Math.floor(greenFrac * 255);

25668

# var blue = Math.floor(blueFrac * 255);

25669

#

25670

# if (!('alpha' in rgb_color)) {

25671

# return rgbToCssColor_(red, green, blue);

25672

# }

25673

#

25674

# var alphaFrac = rgb_color.alpha.value || 0.0;

25675

# var rgbParams = [red, green, blue].join(',');

25676

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

25677

# };

25678

#

25679

# var rgbToCssColor_ = function(red, green, blue) {

25680

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

25681

# var hexString = rgbNumber.toString(16);

25682

# var missingZeros = 6 - hexString.length;

25683

# var resultBuilder = ['#'];

25684

# for (var i = 0; i < missingZeros; i++) {

25685

# resultBuilder.push('0');

25686

# }

25687

# resultBuilder.push(hexString);

25688

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

25693

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

25694

# the final pixel color is defined by the equation:

25695

#

25696

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

25697

#

25698

# This means that a value of 1.0 corresponds to a solid color, whereas

25699

# a value of 0.0 corresponds to a completely transparent color. This

25700

# uses a wrapper message rather than a simple float scalar so that it is

25701

# possible to distinguish between a default value and the value being unset.

25702

# If omitted, this color object is to be rendered as a solid color

25703

# (as if the alpha value had been explicitly given with a value of 1.0).

25704

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

25705

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

25706

},

25707

"type": "A String", # How the value should be interpreted.

25708

"value": "A String", # The value this interpolation point uses. May be a formula.

25709

# Unused if type is MIN or

25710

# MAX.

25711

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

25712

"midpoint": { # A single interpolation point on a gradient conditional format. # An optional midway interpolation point.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

25713

# These pin the gradient color scale according to the color,

25714

# type and value chosen.

25715

"color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.

25716

# for simplicity of conversion to/from color representations in various

25717

# languages over compactness; for example, the fields of this representation

25718

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

25719

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

25720

# method in iOS; and, with just a little work, it can be easily formatted into

25721

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

25726

#

25727

# // ...

25728

# public static java.awt.Color fromProto(Color protocolor) {

25729

# float alpha = protocolor.hasAlpha()

25730

# ? protocolor.getAlpha().getValue()

25731

# : 1.0;

25732

#

25733

# return new java.awt.Color(

25734

# protocolor.getRed(),

25735

# protocolor.getGreen(),

25736

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

25741

# float red = (float) color.getRed();

25742

# float green = (float) color.getGreen();

25743

# float blue = (float) color.getBlue();

25744

# float denominator = 255.0;

25745

# Color.Builder resultBuilder =

25746

# Color

25747

# .newBuilder()

25748

# .setRed(red / denominator)

25749

# .setGreen(green / denominator)

25750

# .setBlue(blue / denominator);

25751

# int alpha = color.getAlpha();

25752

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

25757

# .build());

25758

# }

25759

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

25764

#

25765

# // ...

25766

# static UIColor* fromProto(Color* protocolor) {

25767

# float red = [protocolor red];

25768

# float green = [protocolor green];

25769

# float blue = [protocolor blue];

25770

# FloatValue* alpha_wrapper = [protocolor alpha];

25771

# float alpha = 1.0;

25772

# if (alpha_wrapper != nil) {

25773

# alpha = [alpha_wrapper value];

25774

# }

25775

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

25776

# }

25777

#

25778

# static Color* toProto(UIColor* color) {

25779

# CGFloat red, green, blue, alpha;

25780

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

25781

# return nil;

25782

# }

25783

# Color* result = [Color alloc] init];

25784

# [result setRed:red];

25785

# [result setGreen:green];

25786

# [result setBlue:blue];

25787

# if (alpha <= 0.9999) {

25788

# [result setAlpha:floatWrapperWithValue(alpha)];

25789

# }

25790

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

25800

# var redFrac = rgb_color.red || 0.0;

25801

# var greenFrac = rgb_color.green || 0.0;

25802

# var blueFrac = rgb_color.blue || 0.0;

25803

# var red = Math.floor(redFrac * 255);

25804

# var green = Math.floor(greenFrac * 255);

25805

# var blue = Math.floor(blueFrac * 255);

25806

#

25807

# if (!('alpha' in rgb_color)) {

25808

# return rgbToCssColor_(red, green, blue);

25809

# }

25810

#

25811

# var alphaFrac = rgb_color.alpha.value || 0.0;

25812

# var rgbParams = [red, green, blue].join(',');

25813

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

25814

# };

25815

#

25816

# var rgbToCssColor_ = function(red, green, blue) {

25817

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

25818

# var hexString = rgbNumber.toString(16);

25819

# var missingZeros = 6 - hexString.length;

25820

# var resultBuilder = ['#'];

25821

# for (var i = 0; i < missingZeros; i++) {

25822

# resultBuilder.push('0');

25823

# }

25824

# resultBuilder.push(hexString);

25825

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

25830

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

25831

# the final pixel color is defined by the equation:

25832

#

25833

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

25834

#

25835

# This means that a value of 1.0 corresponds to a solid color, whereas

25836

# a value of 0.0 corresponds to a completely transparent color. This

25837

# uses a wrapper message rather than a simple float scalar so that it is

25838

# possible to distinguish between a default value and the value being unset.

25839

# If omitted, this color object is to be rendered as a solid color

25840

# (as if the alpha value had been explicitly given with a value of 1.0).

25841

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

25842

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

25843

},

25844

"type": "A String", # How the value should be interpreted.

25845

"value": "A String", # The value this interpolation point uses. May be a formula.

25846

# Unused if type is MIN or

25847

# MAX.

25848

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

25849

"minpoint": { # A single interpolation point on a gradient conditional format. # The starting interpolation point.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

25850

# These pin the gradient color scale according to the color,

25851

# type and value chosen.

25852

"color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.

25853

# for simplicity of conversion to/from color representations in various

25854

# languages over compactness; for example, the fields of this representation

25855

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

25856

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

25857

# method in iOS; and, with just a little work, it can be easily formatted into

25858

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

25863

#

25864

# // ...

25865

# public static java.awt.Color fromProto(Color protocolor) {

25866

# float alpha = protocolor.hasAlpha()

25867

# ? protocolor.getAlpha().getValue()

25868

# : 1.0;

25869

#

25870

# return new java.awt.Color(

25871

# protocolor.getRed(),

25872

# protocolor.getGreen(),

25873

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

25878

# float red = (float) color.getRed();

25879

# float green = (float) color.getGreen();

25880

# float blue = (float) color.getBlue();

25881

# float denominator = 255.0;

25882

# Color.Builder resultBuilder =

25883

# Color

25884

# .newBuilder()

25885

# .setRed(red / denominator)

25886

# .setGreen(green / denominator)

25887

# .setBlue(blue / denominator);

25888

# int alpha = color.getAlpha();

25889

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

25894

# .build());

25895

# }

25896

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

25901

#

25902

# // ...

25903

# static UIColor* fromProto(Color* protocolor) {

25904

# float red = [protocolor red];

25905

# float green = [protocolor green];

25906

# float blue = [protocolor blue];

25907

# FloatValue* alpha_wrapper = [protocolor alpha];

25908

# float alpha = 1.0;

25909

# if (alpha_wrapper != nil) {

25910

# alpha = [alpha_wrapper value];

25911

# }

25912

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

25913

# }

25914

#

25915

# static Color* toProto(UIColor* color) {

25916

# CGFloat red, green, blue, alpha;

25917

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

25918

# return nil;

25919

# }

25920

# Color* result = [Color alloc] init];

25921

# [result setRed:red];

25922

# [result setGreen:green];

25923

# [result setBlue:blue];

25924

# if (alpha <= 0.9999) {

25925

# [result setAlpha:floatWrapperWithValue(alpha)];

25926

# }

25927

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

25937

# var redFrac = rgb_color.red || 0.0;

25938

# var greenFrac = rgb_color.green || 0.0;

25939

# var blueFrac = rgb_color.blue || 0.0;

25940

# var red = Math.floor(redFrac * 255);

25941

# var green = Math.floor(greenFrac * 255);

25942

# var blue = Math.floor(blueFrac * 255);

25943

#

25944

# if (!('alpha' in rgb_color)) {

25945

# return rgbToCssColor_(red, green, blue);

25946

# }

25947

#

25948

# var alphaFrac = rgb_color.alpha.value || 0.0;

25949

# var rgbParams = [red, green, blue].join(',');

25950

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

25951

# };

25952

#

25953

# var rgbToCssColor_ = function(red, green, blue) {

25954

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

25955

# var hexString = rgbNumber.toString(16);

25956

# var missingZeros = 6 - hexString.length;

25957

# var resultBuilder = ['#'];

25958

# for (var i = 0; i < missingZeros; i++) {

25959

# resultBuilder.push('0');

25960

# }

25961

# resultBuilder.push(hexString);

25962

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

25967

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

25968

# the final pixel color is defined by the equation:

25969

#

25970

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

25971

#

25972

# This means that a value of 1.0 corresponds to a solid color, whereas

25973

# a value of 0.0 corresponds to a completely transparent color. This

25974

# uses a wrapper message rather than a simple float scalar so that it is

25975

# possible to distinguish between a default value and the value being unset.

25976

# If omitted, this color object is to be rendered as a solid color

25977

# (as if the alpha value had been explicitly given with a value of 1.0).

25978

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

25979

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

25980

},

25981

"type": "A String", # How the value should be interpreted.

25982

"value": "A String", # The value this interpolation point uses. May be a formula.

25983

# Unused if type is MIN or

# MAX.

},

},

},

],

"merges": [ # The ranges that are merged together.

25990

{ # A range on a sheet.

25991

# All indexes are zero-based.

25992

# Indexes are half open, e.g the start index is inclusive

25993

# and the end index is exclusive -- [start_index, end_index).

25994

# Missing indexes indicate the range is unbounded on that side.

25995

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

25996

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

25997

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

25998

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

25999

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26000

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26001

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26002

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26003

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26004

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26005

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26006

# `Sheet1!A:B == sheet_id: 0,

26007

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26008

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26009

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26010

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26011

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26012

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26013

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26014

#

26015

# The start index must always be less than or equal to the end index.

26016

# If the start index equals the end index, then the range is empty.

26017

# Empty ranges are typically not meaningful and are usually rendered in the

26018

# UI as `#REF!`.

26019

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

26020

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

26021

"sheetId": 42, # The sheet this range is on.

26022

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

26023

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

26024

},

26025

],

26026

"basicFilter": { # The default filter associated with a sheet. # The filter on this sheet, if any.

26027

"range": { # A range on a sheet. # The range the filter covers.

26028

# All indexes are zero-based.

26029

# Indexes are half open, e.g the start index is inclusive

26030

# and the end index is exclusive -- [start_index, end_index).

26031

# Missing indexes indicate the range is unbounded on that side.

26032

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26033

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26034

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26035

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26036

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26037

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26038

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26039

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26040

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26041

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26042

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26043

# `Sheet1!A:B == sheet_id: 0,

26044

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26045

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26046

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26047

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26048

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26049

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26050

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26051

#

26052

# The start index must always be less than or equal to the end index.

26053

# If the start index equals the end index, then the range is empty.

26054

# Empty ranges are typically not meaningful and are usually rendered in the

26055

# UI as `#REF!`.

26056

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

26057

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

26058

"sheetId": 42, # The sheet this range is on.

26059

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

26060

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

26061

},

26062

"sortSpecs": [ # The sort order per column. Later specifications are used when values

26063

# are equal in the earlier specifications.

26064

{ # A sort order associated with a specific column or row.

26065

"sortOrder": "A String", # The order data should be sorted.

26066

"dimensionIndex": 42, # The dimension the sort should be applied to.

26067

},

26068

],

26069

"criteria": { # The criteria for showing/hiding values per column.

26070

# The map's key is the column index, and the value is the criteria for

26071

# that column.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26072

"a_key": { # Criteria for showing/hiding rows in a filter or filter view.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26073

"hiddenValues": [ # Values that should be hidden.

26074

"A String",

26075

],

26076

"condition": { # A condition that can evaluate to true or false. # A condition that must be true for values to be shown.

26077

# (This does not override hiddenValues -- if a value is listed there,

26078

# it will still be hidden.)

26079

# BooleanConditions are used by conditional formatting,

26080

# data validation, and the criteria in filters.

26081

"type": "A String", # The type of condition.

26082

"values": [ # The values of the condition. The number of supported values depends

26083

# on the condition type. Some support zero values,

26084

# others one or two values,

26085

# and ConditionType.ONE_OF_LIST supports an arbitrary number of values.

26086

{ # The value of the condition.

26087

"relativeDate": "A String", # A relative date (based on the current date).

26088

# Valid only if the type is

26089

# DATE_BEFORE,

26090

# DATE_AFTER,

26091

# DATE_ON_OR_BEFORE or

26092

# DATE_ON_OR_AFTER.

26093

#

26094

# Relative dates are not supported in data validation.

26095

# They are supported only in conditional formatting and

26096

# conditional filters.

26097

"userEnteredValue": "A String", # A value the condition is based on.

26098

# The value will be parsed as if the user typed into a cell.

26099

# Formulas are supported (and must begin with an `=`).

},

],

},

},

},

},

"charts": [ # The specifications of every chart on this sheet.

26107

{ # A chart embedded in a sheet.

26108

"chartId": 42, # The ID of the chart.

26109

"position": { # The position of an embedded object such as a chart. # The position of the chart.

26110

"newSheet": True or False, # If true, the embedded object will be put on a new sheet whose ID

26111

# is chosen for you. Used only when writing.

26112

"sheetId": 42, # The sheet this is on. Set only if the embedded object

26113

# is on its own sheet. Must be non-negative.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26114

"overlayPosition": { # The location an object is overlaid on top of a grid. # The position at which the object is overlaid on top of a grid.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26115

"anchorCell": { # A coordinate in a sheet. # The cell the object is anchored to.

26116

# All indexes are zero-based.

26117

"rowIndex": 42, # The row index of the coordinate.

26118

"columnIndex": 42, # The column index of the coordinate.

26119

"sheetId": 42, # The sheet this coordinate is on.

26120

},

26121

"offsetYPixels": 42, # The vertical offset, in pixels, that the object is offset

26122

# from the anchor cell.

26123

"widthPixels": 42, # The width of the object, in pixels. Defaults to 600.

26124

"offsetXPixels": 42, # The horizontal offset, in pixels, that the object is offset

26125

# from the anchor cell.

26126

"heightPixels": 42, # The height of the object, in pixels. Defaults to 371.

26127

},

26128

},

26129

"spec": { # The specifications of a chart. # The specification of the chart.

26130

"hiddenDimensionStrategy": "A String", # Determines how the charts will use hidden rows or columns.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26131

"pieChart": { # A <a href="/chart/interactive/docs/gallery/piechart">pie chart</a>. # A pie chart specification.

26132

"series": { # The data included in a domain or series. # The data that covers the one and only series of the pie chart.

26133

"sourceRange": { # Source ranges for a chart. # The source ranges of the data.

26134

"sources": [ # The ranges of data for a series or domain.

26135

# Exactly one dimension must have a length of 1,

26136

# and all sources in the list must have the same dimension

26137

# with length 1.

26138

# The domain (if it exists) & all series must have the same number

26139

# of source ranges. If using more than one source range, then the source

26140

# range at a given offset must be contiguous across the domain and series.

26141

#

26142

# For example, these are valid configurations:

26143

#

26144

# domain sources: A1:A5

26145

# series1 sources: B1:B5

26146

# series2 sources: D6:D10

26147

#

26148

# domain sources: A1:A5, C10:C12

26149

# series1 sources: B1:B5, D10:D12

26150

# series2 sources: C1:C5, E10:E12

26151

{ # A range on a sheet.

26152

# All indexes are zero-based.

26153

# Indexes are half open, e.g the start index is inclusive

26154

# and the end index is exclusive -- [start_index, end_index).

26155

# Missing indexes indicate the range is unbounded on that side.

26156

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26157

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26158

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26159

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26160

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26161

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26162

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26163

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26164

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26165

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26166

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26167

# `Sheet1!A:B == sheet_id: 0,

26168

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26169

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26170

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26171

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26172

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26173

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26174

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26175

#

26176

# The start index must always be less than or equal to the end index.

26177

# If the start index equals the end index, then the range is empty.

26178

# Empty ranges are typically not meaningful and are usually rendered in the

26179

# UI as `#REF!`.

26180

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

26181

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

26182

"sheetId": 42, # The sheet this range is on.

26183

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

26184

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

],

},

},

"domain": { # The data included in a domain or series. # The data that covers the domain of the pie chart.

26190

"sourceRange": { # Source ranges for a chart. # The source ranges of the data.

26191

"sources": [ # The ranges of data for a series or domain.

26192

# Exactly one dimension must have a length of 1,

26193

# and all sources in the list must have the same dimension

26194

# with length 1.

26195

# The domain (if it exists) & all series must have the same number

26196

# of source ranges. If using more than one source range, then the source

26197

# range at a given offset must be contiguous across the domain and series.

26198

#

26199

# For example, these are valid configurations:

26200

#

26201

# domain sources: A1:A5

26202

# series1 sources: B1:B5

26203

# series2 sources: D6:D10

26204

#

26205

# domain sources: A1:A5, C10:C12

26206

# series1 sources: B1:B5, D10:D12

26207

# series2 sources: C1:C5, E10:E12

26208

{ # A range on a sheet.

26209

# All indexes are zero-based.

26210

# Indexes are half open, e.g the start index is inclusive

26211

# and the end index is exclusive -- [start_index, end_index).

26212

# Missing indexes indicate the range is unbounded on that side.

26213

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26214

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26215

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26216

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26217

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26218

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26219

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26220

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26221

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26222

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26223

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26224

# `Sheet1!A:B == sheet_id: 0,

26225

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26226

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26227

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26228

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26229

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26230

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26231

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26232

#

26233

# The start index must always be less than or equal to the end index.

26234

# If the start index equals the end index, then the range is empty.

26235

# Empty ranges are typically not meaningful and are usually rendered in the

26236

# UI as `#REF!`.

26237

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

26238

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

26239

"sheetId": 42, # The sheet this range is on.

26240

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

26241

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

],

},

},

"threeDimensional": True or False, # True if the pie is three dimensional.

26247

"legendPosition": "A String", # Where the legend of the pie chart should be drawn.

26248

"pieHole": 3.14, # The size of the hole in the pie chart.

26249

},

26250

"basicChart": { # The specification for a basic chart. See BasicChartType for the list # A basic chart specification, can be one of many kinds of charts.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26251

# See BasicChartType for the list of all

26252

# charts this supports.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26253

# of charts this supports.

26254

"headerCount": 42, # The number of rows or columns in the data that are "headers".

26255

# If not set, Google Sheets will guess how many rows are headers based

26256

# on the data.

26257

#

26258

# (Note that BasicChartAxis.title may override the axis title

26259

# inferred from the header values.)

26260

"series": [ # The data this chart is visualizing.

26261

{ # A single series of data in a chart.

26262

# For example, if charting stock prices over time, multiple series may exist,

26263

# one for the "Open Price", "High Price", "Low Price" and "Close Price".

26264

"series": { # The data included in a domain or series. # The data being visualized in this chart series.

26265

"sourceRange": { # Source ranges for a chart. # The source ranges of the data.

26266

"sources": [ # The ranges of data for a series or domain.

26267

# Exactly one dimension must have a length of 1,

26268

# and all sources in the list must have the same dimension

26269

# with length 1.

26270

# The domain (if it exists) & all series must have the same number

26271

# of source ranges. If using more than one source range, then the source

26272

# range at a given offset must be contiguous across the domain and series.

26273

#

26274

# For example, these are valid configurations:

26275

#

26276

# domain sources: A1:A5

26277

# series1 sources: B1:B5

26278

# series2 sources: D6:D10

26279

#

26280

# domain sources: A1:A5, C10:C12

26281

# series1 sources: B1:B5, D10:D12

26282

# series2 sources: C1:C5, E10:E12

26283

{ # A range on a sheet.

26284

# All indexes are zero-based.

26285

# Indexes are half open, e.g the start index is inclusive

26286

# and the end index is exclusive -- [start_index, end_index).

26287

# Missing indexes indicate the range is unbounded on that side.

26288

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26289

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26290

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26291

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26292

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26293

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26294

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26295

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26296

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26297

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26298

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26299

# `Sheet1!A:B == sheet_id: 0,

26300

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26301

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26302

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26303

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26304

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26305

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26306

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26307

#

26308

# The start index must always be less than or equal to the end index.

26309

# If the start index equals the end index, then the range is empty.

26310

# Empty ranges are typically not meaningful and are usually rendered in the

26311

# UI as `#REF!`.

26312

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

26313

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

26314

"sheetId": 42, # The sheet this range is on.

26315

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

26316

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

],

},

},

"targetAxis": "A String", # The minor axis that will specify the range of values for this series.

26322

# For example, if charting stocks over time, the "Volume" series

26323

# may want to be pinned to the right with the prices pinned to the left,

26324

# because the scale of trading volume is different than the scale of

26325

# prices.

26326

# It is an error to specify an axis that isn't a valid minor axis

26327

# for the chart's type.

26328

"type": "A String", # The type of this series. Valid only if the

26329

# chartType is

26330

# COMBO.

26331

# Different types will change the way the series is visualized.

26332

# Only LINE, AREA,

26333

# and COLUMN are supported.

26334

},

26335

],

26336

"legendPosition": "A String", # The position of the chart legend.

26337

"domains": [ # The domain of data this is charting.

26338

# Only a single domain is currently supported.

26339

{ # The domain of a chart.

26340

# For example, if charting stock prices over time, this would be the date.

26341

"domain": { # The data included in a domain or series. # The data of the domain. For example, if charting stock prices over time,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26342

# this is the data representing the dates.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26343

"sourceRange": { # Source ranges for a chart. # The source ranges of the data.

26344

"sources": [ # The ranges of data for a series or domain.

26345

# Exactly one dimension must have a length of 1,

26346

# and all sources in the list must have the same dimension

26347

# with length 1.

26348

# The domain (if it exists) & all series must have the same number

26349

# of source ranges. If using more than one source range, then the source

26350

# range at a given offset must be contiguous across the domain and series.

26351

#

26352

# For example, these are valid configurations:

26353

#

26354

# domain sources: A1:A5

26355

# series1 sources: B1:B5

26356

# series2 sources: D6:D10

26357

#

26358

# domain sources: A1:A5, C10:C12

26359

# series1 sources: B1:B5, D10:D12

26360

# series2 sources: C1:C5, E10:E12

26361

{ # A range on a sheet.

26362

# All indexes are zero-based.

26363

# Indexes are half open, e.g the start index is inclusive

26364

# and the end index is exclusive -- [start_index, end_index).

26365

# Missing indexes indicate the range is unbounded on that side.

26366

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26367

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26368

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26369

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26370

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26371

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26372

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26373

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26374

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26375

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26376

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26377

# `Sheet1!A:B == sheet_id: 0,

26378

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26379

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26380

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26381

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26382

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26383

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26384

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26385

#

26386

# The start index must always be less than or equal to the end index.

26387

# If the start index equals the end index, then the range is empty.

26388

# Empty ranges are typically not meaningful and are usually rendered in the

26389

# UI as `#REF!`.

26390

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

26391

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

26392

"sheetId": 42, # The sheet this range is on.

26393

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

26394

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

],

},

},

},

],

"chartType": "A String", # The type of the chart.

26402

"axis": [ # The axis on the chart.

26403

{ # An axis of the chart.

26404

# A chart may not have more than one axis per

26405

# axis position.

26406

"position": "A String", # The position of this axis.

26407

"format": { # The format of a run of text in a cell. # The format of the title.

26408

# Only valid if the axis is not associated with the domain.

26409

# Absent values indicate that the field isn't specified.

26410

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

26411

# for simplicity of conversion to/from color representations in various

26412

# languages over compactness; for example, the fields of this representation

26413

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

26414

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

26415

# method in iOS; and, with just a little work, it can be easily formatted into

26416

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

26421

#

26422

# // ...

26423

# public static java.awt.Color fromProto(Color protocolor) {

26424

# float alpha = protocolor.hasAlpha()

26425

# ? protocolor.getAlpha().getValue()

26426

# : 1.0;

26427

#

26428

# return new java.awt.Color(

26429

# protocolor.getRed(),

26430

# protocolor.getGreen(),

26431

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

26436

# float red = (float) color.getRed();

26437

# float green = (float) color.getGreen();

26438

# float blue = (float) color.getBlue();

26439

# float denominator = 255.0;

26440

# Color.Builder resultBuilder =

26441

# Color

26442

# .newBuilder()

26443

# .setRed(red / denominator)

26444

# .setGreen(green / denominator)

26445

# .setBlue(blue / denominator);

26446

# int alpha = color.getAlpha();

26447

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

26452

# .build());

26453

# }

26454

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

26459

#

26460

# // ...

26461

# static UIColor* fromProto(Color* protocolor) {

26462

# float red = [protocolor red];

26463

# float green = [protocolor green];

26464

# float blue = [protocolor blue];

26465

# FloatValue* alpha_wrapper = [protocolor alpha];

26466

# float alpha = 1.0;

26467

# if (alpha_wrapper != nil) {

26468

# alpha = [alpha_wrapper value];

26469

# }

26470

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

26471

# }

26472

#

26473

# static Color* toProto(UIColor* color) {

26474

# CGFloat red, green, blue, alpha;

26475

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

26476

# return nil;

26477

# }

26478

# Color* result = [Color alloc] init];

26479

# [result setRed:red];

26480

# [result setGreen:green];

26481

# [result setBlue:blue];

26482

# if (alpha <= 0.9999) {

26483

# [result setAlpha:floatWrapperWithValue(alpha)];

26484

# }

26485

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

26495

# var redFrac = rgb_color.red || 0.0;

26496

# var greenFrac = rgb_color.green || 0.0;

26497

# var blueFrac = rgb_color.blue || 0.0;

26498

# var red = Math.floor(redFrac * 255);

26499

# var green = Math.floor(greenFrac * 255);

26500

# var blue = Math.floor(blueFrac * 255);

26501

#

26502

# if (!('alpha' in rgb_color)) {

26503

# return rgbToCssColor_(red, green, blue);

26504

# }

26505

#

26506

# var alphaFrac = rgb_color.alpha.value || 0.0;

26507

# var rgbParams = [red, green, blue].join(',');

26508

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

26509

# };

26510

#

26511

# var rgbToCssColor_ = function(red, green, blue) {

26512

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

26513

# var hexString = rgbNumber.toString(16);

26514

# var missingZeros = 6 - hexString.length;

26515

# var resultBuilder = ['#'];

26516

# for (var i = 0; i < missingZeros; i++) {

26517

# resultBuilder.push('0');

26518

# }

26519

# resultBuilder.push(hexString);

26520

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

26525

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

26526

# the final pixel color is defined by the equation:

26527

#

26528

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

26529

#

26530

# This means that a value of 1.0 corresponds to a solid color, whereas

26531

# a value of 0.0 corresponds to a completely transparent color. This

26532

# uses a wrapper message rather than a simple float scalar so that it is

26533

# possible to distinguish between a default value and the value being unset.

26534

# If omitted, this color object is to be rendered as a solid color

26535

# (as if the alpha value had been explicitly given with a value of 1.0).

26536

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

26537

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

26538

},

26539

"bold": True or False, # True if the text is bold.

26540

"strikethrough": True or False, # True if the text has a strikethrough.

26541

"fontFamily": "A String", # The font family.

26542

"fontSize": 42, # The size of the font.

26543

"italic": True or False, # True if the text is italicized.

26544

"underline": True or False, # True if the text is underlined.

26545

},

26546

"title": "A String", # The title of this axis. If set, this overrides any title inferred

26547

# from headers of the data.

},

],

},

"title": "A String", # The title of the chart.

},

},

],

"filterViews": [ # The filter views in this sheet.

26556

{ # A filter view.

26557

"title": "A String", # The name of the filter view.

26558

"namedRangeId": "A String", # The named range this filter view is backed by, if any.

26559

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26560

# When writing, only one of range or named_range_id

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26561

# may be set.

26562

"filterViewId": 42, # The ID of the filter view.

26563

"range": { # A range on a sheet. # The range this filter view covers.

26564

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26565

# When writing, only one of range or named_range_id

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26566

# may be set.

26567

# All indexes are zero-based.

26568

# Indexes are half open, e.g the start index is inclusive

26569

# and the end index is exclusive -- [start_index, end_index).

26570

# Missing indexes indicate the range is unbounded on that side.

26571

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26572

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26573

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26574

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26575

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26576

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26577

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26578

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26579

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26580

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26581

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26582

# `Sheet1!A:B == sheet_id: 0,

26583

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26584

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26585

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26586

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26587

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26588

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26589

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26590

#

26591

# The start index must always be less than or equal to the end index.

26592

# If the start index equals the end index, then the range is empty.

26593

# Empty ranges are typically not meaningful and are usually rendered in the

26594

# UI as `#REF!`.

26595

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

26596

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

26597

"sheetId": 42, # The sheet this range is on.

26598

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

26599

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

26600

},

26601

"sortSpecs": [ # The sort order per column. Later specifications are used when values

26602

# are equal in the earlier specifications.

26603

{ # A sort order associated with a specific column or row.

26604

"sortOrder": "A String", # The order data should be sorted.

26605

"dimensionIndex": 42, # The dimension the sort should be applied to.

26606

},

26607

],

26608

"criteria": { # The criteria for showing/hiding values per column.

26609

# The map's key is the column index, and the value is the criteria for

26610

# that column.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26611

"a_key": { # Criteria for showing/hiding rows in a filter or filter view.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26612

"hiddenValues": [ # Values that should be hidden.

26613

"A String",

26614

],

26615

"condition": { # A condition that can evaluate to true or false. # A condition that must be true for values to be shown.

26616

# (This does not override hiddenValues -- if a value is listed there,

26617

# it will still be hidden.)

26618

# BooleanConditions are used by conditional formatting,

26619

# data validation, and the criteria in filters.

26620

"type": "A String", # The type of condition.

26621

"values": [ # The values of the condition. The number of supported values depends

26622

# on the condition type. Some support zero values,

26623

# others one or two values,

26624

# and ConditionType.ONE_OF_LIST supports an arbitrary number of values.

26625

{ # The value of the condition.

26626

"relativeDate": "A String", # A relative date (based on the current date).

26627

# Valid only if the type is

26628

# DATE_BEFORE,

26629

# DATE_AFTER,

26630

# DATE_ON_OR_BEFORE or

26631

# DATE_ON_OR_AFTER.

26632

#

26633

# Relative dates are not supported in data validation.

26634

# They are supported only in conditional formatting and

26635

# conditional filters.

26636

"userEnteredValue": "A String", # A value the condition is based on.

26637

# The value will be parsed as if the user typed into a cell.

26638

# Formulas are supported (and must begin with an `=`).

},

],

},

},

},

},

],

"protectedRanges": [ # The protected ranges in this sheet.

26647

{ # A protected range.

26648

"unprotectedRanges": [ # The list of unprotected ranges within a protected sheet.

26649

# Unprotected ranges are only supported on protected sheets.

26650

{ # A range on a sheet.

26651

# All indexes are zero-based.

26652

# Indexes are half open, e.g the start index is inclusive

26653

# and the end index is exclusive -- [start_index, end_index).

26654

# Missing indexes indicate the range is unbounded on that side.

26655

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26656

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26657

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26658

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26659

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26660

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26661

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26662

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26663

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26664

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26665

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26666

# `Sheet1!A:B == sheet_id: 0,

26667

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26668

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26669

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26670

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26671

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26672

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26673

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26674

#

26675

# The start index must always be less than or equal to the end index.

26676

# If the start index equals the end index, then the range is empty.

26677

# Empty ranges are typically not meaningful and are usually rendered in the

26678

# UI as `#REF!`.

26679

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

26680

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

26681

"sheetId": 42, # The sheet this range is on.

26682

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

26683

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

26684

},

26685

],

26686

"requestingUserCanEdit": True or False, # True if the user who requested this protected range can edit the

26687

# protected area.

26688

# This field is read-only.

26689

"description": "A String", # The description of this protected range.

26690

"namedRangeId": "A String", # The named range this protected range is backed by, if any.

26691

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26692

# When writing, only one of range or named_range_id

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26693

# may be set.

26694

"editors": { # The editors of a protected range. # The users and groups with edit access to the protected range.

26695

# This field is only visible to users with edit access to the protected

26696

# range and the document.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26697

# Editors are not supported with warning_only protection.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26698

"domainUsersCanEdit": True or False, # True if anyone in the document's domain has edit access to the protected

26699

# range. Domain protection is only supported on documents within a domain.

26700

"users": [ # The email addresses of users with edit access to the protected range.

26701

"A String",

26702

],

26703

"groups": [ # The email addresses of groups with edit access to the protected range.

"A String",

],

},

"protectedRangeId": 42, # The ID of the protected range.

26708

# This field is read-only.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26709

"warningOnly": True or False, # True if this protected range will show a warning when editing.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26710

# Warning-based protection means that every user can edit data in the

26711

# protected range, except editing will prompt a warning asking the user

26712

# to confirm the edit.

26713

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26714

# When writing: if this field is true, then editors is ignored.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26715

# Additionally, if this field is changed from true to false and the

26716

# `editors` field is not set (nor included in the field mask), then

26717

# the editors will be set to all the editors in the document.

26718

"range": { # A range on a sheet. # The range that is being protected.

26719

# The range may be fully unbounded, in which case this is considered

26720

# a protected sheet.

26721

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26722

# When writing, only one of range or named_range_id

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26723

# may be set.

26724

# All indexes are zero-based.

26725

# Indexes are half open, e.g the start index is inclusive

26726

# and the end index is exclusive -- [start_index, end_index).

26727

# Missing indexes indicate the range is unbounded on that side.

26728

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26729

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26730

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26731

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26732

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26733

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26734

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26735

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26736

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26737

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26738

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26739

# `Sheet1!A:B == sheet_id: 0,

26740

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26741

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26742

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26743

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26744

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26745

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26746

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26747

#

26748

# The start index must always be less than or equal to the end index.

26749

# If the start index equals the end index, then the range is empty.

26750

# Empty ranges are typically not meaningful and are usually rendered in the

26751

# UI as `#REF!`.

26752

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

26753

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

26754

"sheetId": 42, # The sheet this range is on.

26755

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

26756

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

},

],

"data": [ # Data in the grid, if this is a grid sheet.

26761

# The number of GridData objects returned is dependent on the number of

26762

# ranges requested on this sheet. For example, if this is representing

26763

# `Sheet1`, and the spreadsheet was requested with ranges

26764

# `Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a

26765

# startRow/startColumn of `0`,

26766

# while the second one will have `startRow 14` (zero-based row 15),

26767

# and `startColumn 3` (zero-based column D).

26768

{ # Data in the grid, as well as metadata about the dimensions.

26769

"startRow": 42, # The first row this GridData refers to, zero-based.

26770

"rowMetadata": [ # Metadata about the requested rows in the grid, starting with the row

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26771

# in start_row.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26772

{ # Properties about a dimension.

26773

"pixelSize": 42, # The height (if a row) or width (if a column) of the dimension in pixels.

26774

"hiddenByUser": True or False, # True if this dimension is explicitly hidden.

26775

"hiddenByFilter": True or False, # True if this dimension is being filtered.

26776

# This field is read-only.

26777

},

26778

],

26779

"startColumn": 42, # The first column this GridData refers to, zero-based.

26780

"columnMetadata": [ # Metadata about the requested columns in the grid, starting with the column

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26781

# in start_column.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26782

{ # Properties about a dimension.

26783

"pixelSize": 42, # The height (if a row) or width (if a column) of the dimension in pixels.

26784

"hiddenByUser": True or False, # True if this dimension is explicitly hidden.

26785

"hiddenByFilter": True or False, # True if this dimension is being filtered.

26786

# This field is read-only.

26787

},

26788

],

26789

"rowData": [ # The data in the grid, one entry per row,

26790

# starting with the row in startRow.

26791

# The values in RowData will correspond to columns starting

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26792

# at start_column.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26793

{ # Data about each cell in a row.

26794

"values": [ # The values in the row, one per column.

26795

{ # Data about a specific cell.

26796

"pivotTable": { # A pivot table. # A pivot table anchored at this cell. The size of pivot table itself

26797

# is computed dynamically based on its data, grouping, filters, values,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26798

# etc. Only the top-left cell of the pivot table contains the pivot table

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26799

# definition. The other cells will contain the calculated values of the

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26800

# results of the pivot in their effective_value fields.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26801

"valueLayout": "A String", # Whether values should be listed horizontally (as columns)

26802

# or vertically (as rows).

26803

"rows": [ # Each row grouping in the pivot table.

26804

{ # A single grouping (either row or column) in a pivot table.

26805

"showTotals": True or False, # True if the pivot table should include the totals for this grouping.

26806

"valueMetadata": [ # Metadata about values in the grouping.

26807

{ # Metadata about a value in a pivot grouping.

26808

"collapsed": True or False, # True if the data corresponding to the value is collapsed.

26809

"value": { # The kinds of value that a cell in a spreadsheet can have. # The calculated value the metadata corresponds to.

26810

# (Note that formulaValue is not valid,

26811

# because the values will be calculated.)

26812

"numberValue": 3.14, # Represents a double value.

26813

# Note: Dates, Times and DateTimes are represented as doubles in

26814

# "serial number" format.

26815

"boolValue": True or False, # Represents a boolean value.

26816

"formulaValue": "A String", # Represents a formula.

26817

"stringValue": "A String", # Represents a string value.

26818

# Leading single quotes are not included. For example, if the user typed

26819

# `'123` into the UI, this would be represented as a `stringValue` of

26820

# `"123"`.

26821

"errorValue": { # An error in a cell. # Represents an error.

26822

# This field is read-only.

26823

"message": "A String", # A message with more information about the error

26824

# (in the spreadsheet's locale).

26825

"type": "A String", # The type of error.

},

},

},

],

"valueBucket": { # Information about which values in a pivot group should be used for sorting. # The bucket of the opposite pivot group to sort by.

26831

# If not specified, sorting is alphabetical by this group's values.

26832

"buckets": [ # Determines the bucket from which values are chosen to sort.

26833

#

26834

# For example, in a pivot table with one row group & two column groups,

26835

# the row group can list up to two values. The first value corresponds

26836

# to a value within the first column group, and the second value

26837

# corresponds to a value in the second column group. If no values

26838

# are listed, this would indicate that the row should be sorted according

26839

# to the "Grand Total" over the column groups. If a single value is listed,

26840

# this would correspond to using the "Total" of that bucket.

26841

{ # The kinds of value that a cell in a spreadsheet can have.

26842

"numberValue": 3.14, # Represents a double value.

26843

# Note: Dates, Times and DateTimes are represented as doubles in

26844

# "serial number" format.

26845

"boolValue": True or False, # Represents a boolean value.

26846

"formulaValue": "A String", # Represents a formula.

26847

"stringValue": "A String", # Represents a string value.

26848

# Leading single quotes are not included. For example, if the user typed

26849

# `'123` into the UI, this would be represented as a `stringValue` of

26850

# `"123"`.

26851

"errorValue": { # An error in a cell. # Represents an error.

26852

# This field is read-only.

26853

"message": "A String", # A message with more information about the error

26854

# (in the spreadsheet's locale).

26855

"type": "A String", # The type of error.

26856

},

26857

},

26858

],

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26859

"valuesIndex": 42, # The offset in the PivotTable.values list which the values in this

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26860

# grouping should be sorted by.

26861

},

26862

"sortOrder": "A String", # The order the values in this group should be sorted.

26863

"sourceColumnOffset": 42, # The column offset of the source range that this grouping is based on.

26864

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26865

# For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26866

# means this group refers to column `C`, whereas the offset `1` would refer

# to column `D`.

},

],

"source": { # A range on a sheet. # The range the pivot table is reading data from.

26871

# All indexes are zero-based.

26872

# Indexes are half open, e.g the start index is inclusive

26873

# and the end index is exclusive -- [start_index, end_index).

26874

# Missing indexes indicate the range is unbounded on that side.

26875

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26876

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26877

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26878

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26879

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26880

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26881

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26882

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26883

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26884

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26885

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26886

# `Sheet1!A:B == sheet_id: 0,

26887

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26888

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26889

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26890

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26891

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26892

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26893

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26894

#

26895

# The start index must always be less than or equal to the end index.

26896

# If the start index equals the end index, then the range is empty.

26897

# Empty ranges are typically not meaningful and are usually rendered in the

26898

# UI as `#REF!`.

26899

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

26900

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

26901

"sheetId": 42, # The sheet this range is on.

26902

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

26903

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

26904

},

26905

"values": [ # A list of values to include in the pivot table.

26906

{ # The definition of how a value in a pivot table should be calculated.

26907

"formula": "A String", # A custom formula to calculate the value. The formula must start

26908

# with an `=` character.

26909

"summarizeFunction": "A String", # A function to summarize the value.

26910

# If formula is set, the only supported values are

26911

# SUM and

26912

# CUSTOM.

26913

# If sourceColumnOffset is set, then `CUSTOM`

26914

# is not supported.

26915

"sourceColumnOffset": 42, # The column offset of the source range that this value reads from.

26916

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26917

# For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26918

# means this value refers to column `C`, whereas the offset `1` would

26919

# refer to column `D`.

26920

"name": "A String", # A name to use for the value. This is only used if formula was set.

26921

# Otherwise, the column name is used.

26922

},

26923

],

26924

"criteria": { # An optional mapping of filters per source column offset.

26925

#

26926

# The filters will be applied before aggregating data into the pivot table.

26927

# The map's key is the column offset of the source range that you want to

26928

# filter, and the value is the criteria for that column.

26929

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26930

# For example, if the source was `C10:E15`, a key of `0` will have the filter

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26931

# for column `C`, whereas the key `1` is for column `D`.

26932

"a_key": { # Criteria for showing/hiding rows in a pivot table.

26933

"visibleValues": [ # Values that should be included. Values not listed here are excluded.

"A String",

],

},

},

"columns": [ # Each column grouping in the pivot table.

26939

{ # A single grouping (either row or column) in a pivot table.

26940

"showTotals": True or False, # True if the pivot table should include the totals for this grouping.

26941

"valueMetadata": [ # Metadata about values in the grouping.

26942

{ # Metadata about a value in a pivot grouping.

26943

"collapsed": True or False, # True if the data corresponding to the value is collapsed.

26944

"value": { # The kinds of value that a cell in a spreadsheet can have. # The calculated value the metadata corresponds to.

26945

# (Note that formulaValue is not valid,

26946

# because the values will be calculated.)

26947

"numberValue": 3.14, # Represents a double value.

26948

# Note: Dates, Times and DateTimes are represented as doubles in

26949

# "serial number" format.

26950

"boolValue": True or False, # Represents a boolean value.

26951

"formulaValue": "A String", # Represents a formula.

26952

"stringValue": "A String", # Represents a string value.

26953

# Leading single quotes are not included. For example, if the user typed

26954

# `'123` into the UI, this would be represented as a `stringValue` of

26955

# `"123"`.

26956

"errorValue": { # An error in a cell. # Represents an error.

26957

# This field is read-only.

26958

"message": "A String", # A message with more information about the error

26959

# (in the spreadsheet's locale).

26960

"type": "A String", # The type of error.

},

},

},

],

"valueBucket": { # Information about which values in a pivot group should be used for sorting. # The bucket of the opposite pivot group to sort by.

26966

# If not specified, sorting is alphabetical by this group's values.

26967

"buckets": [ # Determines the bucket from which values are chosen to sort.

26968

#

26969

# For example, in a pivot table with one row group & two column groups,

26970

# the row group can list up to two values. The first value corresponds

26971

# to a value within the first column group, and the second value

26972

# corresponds to a value in the second column group. If no values

26973

# are listed, this would indicate that the row should be sorted according

26974

# to the "Grand Total" over the column groups. If a single value is listed,

26975

# this would correspond to using the "Total" of that bucket.

26976

{ # The kinds of value that a cell in a spreadsheet can have.

26977

"numberValue": 3.14, # Represents a double value.

26978

# Note: Dates, Times and DateTimes are represented as doubles in

26979

# "serial number" format.

26980

"boolValue": True or False, # Represents a boolean value.

26981

"formulaValue": "A String", # Represents a formula.

26982

"stringValue": "A String", # Represents a string value.

26983

# Leading single quotes are not included. For example, if the user typed

26984

# `'123` into the UI, this would be represented as a `stringValue` of

26985

# `"123"`.

26986

"errorValue": { # An error in a cell. # Represents an error.

26987

# This field is read-only.

26988

"message": "A String", # A message with more information about the error

26989

# (in the spreadsheet's locale).

26990

"type": "A String", # The type of error.

26991

},

26992

},

26993

],

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

26994

"valuesIndex": 42, # The offset in the PivotTable.values list which the values in this

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

26995

# grouping should be sorted by.

26996

},

26997

"sortOrder": "A String", # The order the values in this group should be sorted.

26998

"sourceColumnOffset": 42, # The column offset of the source range that this grouping is based on.

26999

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

27000

# For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

27001

# means this group refers to column `C`, whereas the offset `1` would refer

# to column `D`.

},

],

},

"hyperlink": "A String", # A hyperlink this cell points to, if any.

27007

# This field is read-only. (To set it, use a `=HYPERLINK` formula.)

27008

"effectiveValue": { # The kinds of value that a cell in a spreadsheet can have. # The effective value of the cell. For cells with formulas, this will be

27009

# the calculated value. For cells with literals, this will be

27010

# the same as the user_entered_value.

27011

# This field is read-only.

27012

"numberValue": 3.14, # Represents a double value.

27013

# Note: Dates, Times and DateTimes are represented as doubles in

27014

# "serial number" format.

27015

"boolValue": True or False, # Represents a boolean value.

27016

"formulaValue": "A String", # Represents a formula.

27017

"stringValue": "A String", # Represents a string value.

27018

# Leading single quotes are not included. For example, if the user typed

27019

# `'123` into the UI, this would be represented as a `stringValue` of

27020

# `"123"`.

27021

"errorValue": { # An error in a cell. # Represents an error.

27022

# This field is read-only.

27023

"message": "A String", # A message with more information about the error

27024

# (in the spreadsheet's locale).

27025

"type": "A String", # The type of error.

27026

},

27027

},

27028

"formattedValue": "A String", # The formatted value of the cell.

27029

# This is the value as it's shown to the user.

27030

# This field is read-only.

27031

"userEnteredValue": { # The kinds of value that a cell in a spreadsheet can have. # The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`

27032

# Note: Dates, Times and DateTimes are represented as doubles in

27033

# serial number format.

27034

"numberValue": 3.14, # Represents a double value.

27035

# Note: Dates, Times and DateTimes are represented as doubles in

27036

# "serial number" format.

27037

"boolValue": True or False, # Represents a boolean value.

27038

"formulaValue": "A String", # Represents a formula.

27039

"stringValue": "A String", # Represents a string value.

27040

# Leading single quotes are not included. For example, if the user typed

27041

# `'123` into the UI, this would be represented as a `stringValue` of

27042

# `"123"`.

27043

"errorValue": { # An error in a cell. # Represents an error.

27044

# This field is read-only.

27045

"message": "A String", # A message with more information about the error

27046

# (in the spreadsheet's locale).

27047

"type": "A String", # The type of error.

27048

},

27049

},

27050

"note": "A String", # Any note on the cell.

27051

"effectiveFormat": { # The format of a cell. # The effective format being used by the cell.

27052

# This includes the results of applying any conditional formatting and,

27053

# if the cell contains a formula, the computed number format.

27054

# If the effective format is the default format, effective format will

27055

# not be written.

27056

# This field is read-only.

27057

"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

27058

"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on

27059

# the user's locale will be used if necessary for the given type.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame^]

27060

# See the [Date and Number Formats guide](/sheets/guides/formats) for more

27061

# information about the supported patterns.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

27062

"type": "A String", # The type of the number format.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

27063

# When writing, this field must be set.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

27064

},

27065

"textDirection": "A String", # The direction of the text in the cell.

27066

"padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.

27067

# When updating padding, every field must be specified.

27068

"top": 42, # The top padding of the cell.

27069

"right": 42, # The right padding of the cell.

27070

"bottom": 42, # The bottom padding of the cell.

27071

"left": 42, # The left padding of the cell.

27072

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

27073

"horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

27074

"backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.

27075

# for simplicity of conversion to/from color representations in various

27076

# languages over compactness; for example, the fields of this representation

27077

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

27078

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

27079

# method in iOS; and, with just a little work, it can be easily formatted into

27080

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

27085

#

27086

# // ...

27087

# public static java.awt.Color fromProto(Color protocolor) {

27088

# float alpha = protocolor.hasAlpha()

27089

# ? protocolor.getAlpha().getValue()

27090

# : 1.0;

27091

#

27092

# return new java.awt.Color(

27093

# protocolor.getRed(),

27094

# protocolor.getGreen(),

27095

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

27100

# float red = (float) color.getRed();

27101

# float green = (float) color.getGreen();

27102

# float blue = (float) color.getBlue();

27103

# float denominator = 255.0;

27104

# Color.Builder resultBuilder =

27105

# Color

27106

# .newBuilder()

27107

# .setRed(red / denominator)

27108

# .setGreen(green / denominator)

27109

# .setBlue(blue / denominator);

27110

# int alpha = color.getAlpha();

27111

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

27116

# .build());

27117

# }

27118

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

27123

#

27124

# // ...

27125

# static UIColor* fromProto(Color* protocolor) {

27126

# float red = [protocolor red];

27127

# float green = [protocolor green];

27128

# float blue = [protocolor blue];

27129

# FloatValue* alpha_wrapper = [protocolor alpha];

27130

# float alpha = 1.0;

27131

# if (alpha_wrapper != nil) {

27132

# alpha = [alpha_wrapper value];

27133

# }

27134

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

27135

# }

27136

#

27137

# static Color* toProto(UIColor* color) {

27138

# CGFloat red, green, blue, alpha;

27139

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

27140

# return nil;

27141

# }

27142

# Color* result = [Color alloc] init];

27143

# [result setRed:red];

27144

# [result setGreen:green];

27145

# [result setBlue:blue];

27146

# if (alpha <= 0.9999) {

27147

# [result setAlpha:floatWrapperWithValue(alpha)];

27148

# }

27149

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

27159

# var redFrac = rgb_color.red || 0.0;

27160

# var greenFrac = rgb_color.green || 0.0;

27161

# var blueFrac = rgb_color.blue || 0.0;

27162

# var red = Math.floor(redFrac * 255);

27163

# var green = Math.floor(greenFrac * 255);

27164

# var blue = Math.floor(blueFrac * 255);

27165

#

27166

# if (!('alpha' in rgb_color)) {

27167

# return rgbToCssColor_(red, green, blue);

27168

# }

27169

#

27170

# var alphaFrac = rgb_color.alpha.value || 0.0;

27171

# var rgbParams = [red, green, blue].join(',');

27172

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

27173

# };

27174

#

27175

# var rgbToCssColor_ = function(red, green, blue) {

27176

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

27177

# var hexString = rgbNumber.toString(16);

27178

# var missingZeros = 6 - hexString.length;

27179

# var resultBuilder = ['#'];

27180

# for (var i = 0; i < missingZeros; i++) {

27181

# resultBuilder.push('0');

27182

# }

27183

# resultBuilder.push(hexString);

27184

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

27189

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

27190

# the final pixel color is defined by the equation:

27191

#

27192

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

27193

#

27194

# This means that a value of 1.0 corresponds to a solid color, whereas

27195

# a value of 0.0 corresponds to a completely transparent color. This

27196

# uses a wrapper message rather than a simple float scalar so that it is

27197

# possible to distinguish between a default value and the value being unset.

27198

# If omitted, this color object is to be rendered as a solid color

27199

# (as if the alpha value had been explicitly given with a value of 1.0).

27200

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

27201

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

27202

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

27203

"verticalAlignment": "A String", # The vertical alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

27204

"textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).

27205

# Absent values indicate that the field isn't specified.

27206

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

27207

# for simplicity of conversion to/from color representations in various

27208

# languages over compactness; for example, the fields of this representation

27209

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

27210

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

27211

# method in iOS; and, with just a little work, it can be easily formatted into

27212

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

27217

#

27218

# // ...

27219

# public static java.awt.Color fromProto(Color protocolor) {

27220

# float alpha = protocolor.hasAlpha()

27221

# ? protocolor.getAlpha().getValue()

27222

# : 1.0;

27223

#

27224

# return new java.awt.Color(

27225

# protocolor.getRed(),

27226

# protocolor.getGreen(),

27227

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

27232

# float red = (float) color.getRed();

27233

# float green = (float) color.getGreen();

27234

# float blue = (float) color.getBlue();

27235

# float denominator = 255.0;

27236

# Color.Builder resultBuilder =

27237

# Color

27238

# .newBuilder()

27239

# .setRed(red / denominator)

27240

# .setGreen(green / denominator)

27241

# .setBlue(blue / denominator);

27242

# int alpha = color.getAlpha();

27243

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

27248

# .build());

27249

# }

27250

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

27255

#

27256

# // ...

27257

# static UIColor* fromProto(Color* protocolor) {

27258

# float red = [protocolor red];

27259

# float green = [protocolor green];

27260

# float blue = [protocolor blue];

27261

# FloatValue* alpha_wrapper = [protocolor alpha];

27262

# float alpha = 1.0;

27263

# if (alpha_wrapper != nil) {

27264

# alpha = [alpha_wrapper value];

27265

# }

27266

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

27267

# }

27268

#

27269

# static Color* toProto(UIColor* color) {

27270

# CGFloat red, green, blue, alpha;

27271

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

27272

# return nil;

27273

# }

27274

# Color* result = [Color alloc] init];

27275

# [result setRed:red];

27276

# [result setGreen:green];

27277

# [result setBlue:blue];

27278

# if (alpha <= 0.9999) {

27279

# [result setAlpha:floatWrapperWithValue(alpha)];

27280

# }

27281

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

27291

# var redFrac = rgb_color.red || 0.0;

27292

# var greenFrac = rgb_color.green || 0.0;

27293

# var blueFrac = rgb_color.blue || 0.0;

27294

# var red = Math.floor(redFrac * 255);

27295

# var green = Math.floor(greenFrac * 255);

27296

# var blue = Math.floor(blueFrac * 255);

27297

#

27298

# if (!('alpha' in rgb_color)) {

27299

# return rgbToCssColor_(red, green, blue);

27300

# }

27301

#

27302

# var alphaFrac = rgb_color.alpha.value || 0.0;

27303

# var rgbParams = [red, green, blue].join(',');

27304

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

27305

# };

27306

#

27307

# var rgbToCssColor_ = function(red, green, blue) {

27308

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

27309

# var hexString = rgbNumber.toString(16);

27310

# var missingZeros = 6 - hexString.length;

27311

# var resultBuilder = ['#'];

27312

# for (var i = 0; i < missingZeros; i++) {

27313

# resultBuilder.push('0');

27314

# }

27315

# resultBuilder.push(hexString);

27316

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

27321

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

27322

# the final pixel color is defined by the equation:

27323

#

27324

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

27325

#

27326

# This means that a value of 1.0 corresponds to a solid color, whereas

27327

# a value of 0.0 corresponds to a completely transparent color. This

27328

# uses a wrapper message rather than a simple float scalar so that it is

27329

# possible to distinguish between a default value and the value being unset.

27330

# If omitted, this color object is to be rendered as a solid color

27331

# (as if the alpha value had been explicitly given with a value of 1.0).

27332

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

27333

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

27334

},

27335

"bold": True or False, # True if the text is bold.

27336

"strikethrough": True or False, # True if the text has a strikethrough.

27337

"fontFamily": "A String", # The font family.

27338

"fontSize": 42, # The size of the font.

27339

"italic": True or False, # True if the text is italicized.

27340

"underline": True or False, # True if the text is underlined.

27341

},

27342

"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.

27343

"borders": { # The borders of the cell. # The borders of the cell.

27344

"top": { # A border along a cell. # The top border of the cell.

27345

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

27346

# for simplicity of conversion to/from color representations in various

27347

# languages over compactness; for example, the fields of this representation

27348

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

27349

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

27350

# method in iOS; and, with just a little work, it can be easily formatted into

27351

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

27356

#

27357

# // ...

27358

# public static java.awt.Color fromProto(Color protocolor) {

27359

# float alpha = protocolor.hasAlpha()

27360

# ? protocolor.getAlpha().getValue()

27361

# : 1.0;

27362

#

27363

# return new java.awt.Color(

27364

# protocolor.getRed(),

27365

# protocolor.getGreen(),

27366

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

27371

# float red = (float) color.getRed();

27372

# float green = (float) color.getGreen();

27373

# float blue = (float) color.getBlue();

27374

# float denominator = 255.0;

27375

# Color.Builder resultBuilder =

27376

# Color

27377

# .newBuilder()

27378

# .setRed(red / denominator)

27379

# .setGreen(green / denominator)

27380

# .setBlue(blue / denominator);

27381

# int alpha = color.getAlpha();

27382

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

27387

# .build());

27388

# }

27389

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

27394

#

27395

# // ...

27396

# static UIColor* fromProto(Color* protocolor) {

27397

# float red = [protocolor red];

27398

# float green = [protocolor green];

27399

# float blue = [protocolor blue];

27400

# FloatValue* alpha_wrapper = [protocolor alpha];

27401

# float alpha = 1.0;

27402

# if (alpha_wrapper != nil) {

27403

# alpha = [alpha_wrapper value];

27404

# }

27405

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

27406

# }

27407

#

27408

# static Color* toProto(UIColor* color) {

27409

# CGFloat red, green, blue, alpha;

27410

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

27411

# return nil;

27412

# }

27413

# Color* result = [Color alloc] init];

27414

# [result setRed:red];

27415

# [result setGreen:green];

27416

# [result setBlue:blue];

27417

# if (alpha <= 0.9999) {

27418

# [result setAlpha:floatWrapperWithValue(alpha)];

27419

# }

27420

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

27430

# var redFrac = rgb_color.red || 0.0;

27431

# var greenFrac = rgb_color.green || 0.0;

27432

# var blueFrac = rgb_color.blue || 0.0;

27433

# var red = Math.floor(redFrac * 255);

27434

# var green = Math.floor(greenFrac * 255);

27435

# var blue = Math.floor(blueFrac * 255);

27436

#

27437

# if (!('alpha' in rgb_color)) {

27438

# return rgbToCssColor_(red, green, blue);

27439

# }

27440

#

27441

# var alphaFrac = rgb_color.alpha.value || 0.0;

27442

# var rgbParams = [red, green, blue].join(',');

27443

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

27444

# };

27445

#

27446

# var rgbToCssColor_ = function(red, green, blue) {

27447

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

27448

# var hexString = rgbNumber.toString(16);

27449

# var missingZeros = 6 - hexString.length;

27450

# var resultBuilder = ['#'];

27451

# for (var i = 0; i < missingZeros; i++) {

27452

# resultBuilder.push('0');

27453

# }

27454

# resultBuilder.push(hexString);

27455

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

27460

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

27461

# the final pixel color is defined by the equation:

27462

#

27463

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

27464

#

27465

# This means that a value of 1.0 corresponds to a solid color, whereas

27466

# a value of 0.0 corresponds to a completely transparent color. This

27467

# uses a wrapper message rather than a simple float scalar so that it is

27468

# possible to distinguish between a default value and the value being unset.

27469

# If omitted, this color object is to be rendered as a solid color

27470

# (as if the alpha value had been explicitly given with a value of 1.0).

27471

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

27472

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

27473

},

27474

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

27475

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

27476

"style": "A String", # The style of the border.

27477

},

27478

"right": { # A border along a cell. # The right border of the cell.

27479

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

27480

# for simplicity of conversion to/from color representations in various

27481

# languages over compactness; for example, the fields of this representation

27482

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

27483

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

27484

# method in iOS; and, with just a little work, it can be easily formatted into

27485

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

27490

#

27491

# // ...

27492

# public static java.awt.Color fromProto(Color protocolor) {

27493

# float alpha = protocolor.hasAlpha()

27494

# ? protocolor.getAlpha().getValue()

27495

# : 1.0;

27496

#

27497

# return new java.awt.Color(

27498

# protocolor.getRed(),

27499

# protocolor.getGreen(),

27500

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

27505

# float red = (float) color.getRed();

27506

# float green = (float) color.getGreen();

27507

# float blue = (float) color.getBlue();

27508

# float denominator = 255.0;

27509

# Color.Builder resultBuilder =

27510

# Color

27511

# .newBuilder()

27512

# .setRed(red / denominator)

27513

# .setGreen(green / denominator)

27514

# .setBlue(blue / denominator);

27515

# int alpha = color.getAlpha();

27516

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

27521

# .build());

27522

# }

27523

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

27528

#

27529

# // ...

27530

# static UIColor* fromProto(Color* protocolor) {

27531

# float red = [protocolor red];

27532

# float green = [protocolor green];

27533

# float blue = [protocolor blue];

27534

# FloatValue* alpha_wrapper = [protocolor alpha];

27535

# float alpha = 1.0;

27536

# if (alpha_wrapper != nil) {

27537

# alpha = [alpha_wrapper value];

27538

# }

27539

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

27540

# }

27541

#

27542

# static Color* toProto(UIColor* color) {

27543

# CGFloat red, green, blue, alpha;

27544

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

27545

# return nil;

27546

# }

27547

# Color* result = [Color alloc] init];

27548

# [result setRed:red];

27549

# [result setGreen:green];

27550

# [result setBlue:blue];

27551

# if (alpha <= 0.9999) {

27552

# [result setAlpha:floatWrapperWithValue(alpha)];

27553

# }

27554

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

27564

# var redFrac = rgb_color.red || 0.0;

27565

# var greenFrac = rgb_color.green || 0.0;

27566

# var blueFrac = rgb_color.blue || 0.0;

27567

# var red = Math.floor(redFrac * 255);

27568

# var green = Math.floor(greenFrac * 255);

27569

# var blue = Math.floor(blueFrac * 255);

27570

#

27571

# if (!('alpha' in rgb_color)) {

27572

# return rgbToCssColor_(red, green, blue);

27573

# }

27574

#

27575

# var alphaFrac = rgb_color.alpha.value || 0.0;

27576

# var rgbParams = [red, green, blue].join(',');

27577

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

27578

# };

27579

#

27580

# var rgbToCssColor_ = function(red, green, blue) {

27581

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

27582

# var hexString = rgbNumber.toString(16);

27583

# var missingZeros = 6 - hexString.length;

27584

# var resultBuilder = ['#'];

27585

# for (var i = 0; i < missingZeros; i++) {

27586

# resultBuilder.push('0');

27587

# }

27588

# resultBuilder.push(hexString);

27589

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

27594

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

27595

# the final pixel color is defined by the equation:

27596

#

27597

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

27598

#

27599

# This means that a value of 1.0 corresponds to a solid color, whereas

27600

# a value of 0.0 corresponds to a completely transparent color. This

27601

# uses a wrapper message rather than a simple float scalar so that it is

27602

# possible to distinguish between a default value and the value being unset.

27603

# If omitted, this color object is to be rendered as a solid color

27604

# (as if the alpha value had been explicitly given with a value of 1.0).

27605

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

27606

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

27607

},

27608

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

27609

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

27610

"style": "A String", # The style of the border.

27611

},

27612

"bottom": { # A border along a cell. # The bottom border of the cell.

27613

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

27614

# for simplicity of conversion to/from color representations in various

27615

# languages over compactness; for example, the fields of this representation

27616

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

27617

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

27618

# method in iOS; and, with just a little work, it can be easily formatted into

27619

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

27624

#

27625

# // ...

27626

# public static java.awt.Color fromProto(Color protocolor) {

27627

# float alpha = protocolor.hasAlpha()

27628

# ? protocolor.getAlpha().getValue()

27629

# : 1.0;

27630

#

27631

# return new java.awt.Color(

27632

# protocolor.getRed(),

27633

# protocolor.getGreen(),

27634

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

27639

# float red = (float) color.getRed();

27640

# float green = (float) color.getGreen();

27641

# float blue = (float) color.getBlue();

27642

# float denominator = 255.0;

27643

# Color.Builder resultBuilder =

27644

# Color

27645

# .newBuilder()

27646

# .setRed(red / denominator)

27647

# .setGreen(green / denominator)

27648

# .setBlue(blue / denominator);

27649

# int alpha = color.getAlpha();

27650

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

27655

# .build());

27656

# }

27657

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

27662

#

27663

# // ...

27664

# static UIColor* fromProto(Color* protocolor) {

27665

# float red = [protocolor red];

27666

# float green = [protocolor green];

27667

# float blue = [protocolor blue];

27668

# FloatValue* alpha_wrapper = [protocolor alpha];

27669

# float alpha = 1.0;

27670

# if (alpha_wrapper != nil) {

27671

# alpha = [alpha_wrapper value];

27672

# }

27673

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

27674

# }

27675

#

27676

# static Color* toProto(UIColor* color) {

27677

# CGFloat red, green, blue, alpha;

27678

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

27679

# return nil;

27680

# }

27681

# Color* result = [Color alloc] init];

27682

# [result setRed:red];

27683

# [result setGreen:green];

27684

# [result setBlue:blue];

27685

# if (alpha <= 0.9999) {

27686

# [result setAlpha:floatWrapperWithValue(alpha)];

27687

# }

27688

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

27698

# var redFrac = rgb_color.red || 0.0;

27699

# var greenFrac = rgb_color.green || 0.0;

27700

# var blueFrac = rgb_color.blue || 0.0;

27701

# var red = Math.floor(redFrac * 255);

27702

# var green = Math.floor(greenFrac * 255);

27703

# var blue = Math.floor(blueFrac * 255);

27704

#

27705

# if (!('alpha' in rgb_color)) {

27706

# return rgbToCssColor_(red, green, blue);

27707

# }

27708

#

27709

# var alphaFrac = rgb_color.alpha.value || 0.0;

27710

# var rgbParams = [red, green, blue].join(',');

27711

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

27712

# };

27713

#

27714

# var rgbToCssColor_ = function(red, green, blue) {

27715

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

27716

# var hexString = rgbNumber.toString(16);

27717

# var missingZeros = 6 - hexString.length;

27718

# var resultBuilder = ['#'];

27719

# for (var i = 0; i < missingZeros; i++) {

27720

# resultBuilder.push('0');

27721

# }

27722

# resultBuilder.push(hexString);

27723

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

27728

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

27729

# the final pixel color is defined by the equation:

27730

#

27731

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

27732

#

27733

# This means that a value of 1.0 corresponds to a solid color, whereas

27734

# a value of 0.0 corresponds to a completely transparent color. This

27735

# uses a wrapper message rather than a simple float scalar so that it is

27736

# possible to distinguish between a default value and the value being unset.

27737

# If omitted, this color object is to be rendered as a solid color

27738

# (as if the alpha value had been explicitly given with a value of 1.0).

27739

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

27740

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

27741

},

27742

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

27743

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

27744

"style": "A String", # The style of the border.

27745

},

27746

"left": { # A border along a cell. # The left border of the cell.

27747

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

27748

# for simplicity of conversion to/from color representations in various

27749

# languages over compactness; for example, the fields of this representation

27750

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

27751

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

27752

# method in iOS; and, with just a little work, it can be easily formatted into

27753

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

27758

#

27759

# // ...

27760

# public static java.awt.Color fromProto(Color protocolor) {

27761

# float alpha = protocolor.hasAlpha()

27762

# ? protocolor.getAlpha().getValue()

27763

# : 1.0;

27764

#

27765

# return new java.awt.Color(

27766

# protocolor.getRed(),

27767

# protocolor.getGreen(),

27768

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

27773

# float red = (float) color.getRed();

27774

# float green = (float) color.getGreen();

27775

# float blue = (float) color.getBlue();

27776

# float denominator = 255.0;

27777

# Color.Builder resultBuilder =

27778

# Color

27779

# .newBuilder()

27780

# .setRed(red / denominator)

27781

# .setGreen(green / denominator)

27782

# .setBlue(blue / denominator);

27783

# int alpha = color.getAlpha();

27784

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

27789

# .build());

27790

# }

27791

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

27796

#

27797

# // ...

27798

# static UIColor* fromProto(Color* protocolor) {

27799

# float red = [protocolor red];

27800

# float green = [protocolor green];

27801

# float blue = [protocolor blue];

27802

# FloatValue* alpha_wrapper = [protocolor alpha];

27803

# float alpha = 1.0;

27804

# if (alpha_wrapper != nil) {

27805

# alpha = [alpha_wrapper value];

27806

# }

27807

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

27808

# }

27809

#

27810

# static Color* toProto(UIColor* color) {

27811

# CGFloat red, green, blue, alpha;

27812

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

27813

# return nil;

27814

# }

27815

# Color* result = [Color alloc] init];

27816

# [result setRed:red];

27817

# [result setGreen:green];

27818

# [result setBlue:blue];

27819

# if (alpha <= 0.9999) {

27820

# [result setAlpha:floatWrapperWithValue(alpha)];

27821

# }

27822

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

27832

# var redFrac = rgb_color.red || 0.0;

27833

# var greenFrac = rgb_color.green || 0.0;

27834

# var blueFrac = rgb_color.blue || 0.0;

27835

# var red = Math.floor(redFrac * 255);

27836

# var green = Math.floor(greenFrac * 255);

27837

# var blue = Math.floor(blueFrac * 255);

27838

#

27839

# if (!('alpha' in rgb_color)) {

27840

# return rgbToCssColor_(red, green, blue);

27841

# }

27842

#

27843

# var alphaFrac = rgb_color.alpha.value || 0.0;

27844

# var rgbParams = [red, green, blue].join(',');

27845

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

27846

# };

27847

#

27848

# var rgbToCssColor_ = function(red, green, blue) {

27849

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

27850

# var hexString = rgbNumber.toString(16);

27851

# var missingZeros = 6 - hexString.length;

27852

# var resultBuilder = ['#'];

27853

# for (var i = 0; i < missingZeros; i++) {

27854

# resultBuilder.push('0');

27855

# }

27856

# resultBuilder.push(hexString);

27857

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

27862

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

27863

# the final pixel color is defined by the equation:

27864

#

27865

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

27866

#

27867

# This means that a value of 1.0 corresponds to a solid color, whereas

27868

# a value of 0.0 corresponds to a completely transparent color. This

27869

# uses a wrapper message rather than a simple float scalar so that it is

27870

# possible to distinguish between a default value and the value being unset.

27871

# If omitted, this color object is to be rendered as a solid color

27872

# (as if the alpha value had been explicitly given with a value of 1.0).

27873

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

27874

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

27875

},

27876

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

27877

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

27878

"style": "A String", # The style of the border.

27879

},

27880

},

27881

"wrapStrategy": "A String", # The wrap strategy for the value in the cell.

27882

},

27883

"userEnteredFormat": { # The format of a cell. # The format the user entered for the cell.

27884

#

27885

# When writing, the new format will be merged with the existing format.

27886

"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

27887

"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on

27888

# the user's locale will be used if necessary for the given type.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame^]

27889

# See the [Date and Number Formats guide](/sheets/guides/formats) for more

27890

# information about the supported patterns.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

27891

"type": "A String", # The type of the number format.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

27892

# When writing, this field must be set.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

27893

},

27894

"textDirection": "A String", # The direction of the text in the cell.

27895

"padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.

27896

# When updating padding, every field must be specified.

27897

"top": 42, # The top padding of the cell.

27898

"right": 42, # The right padding of the cell.

27899

"bottom": 42, # The bottom padding of the cell.

27900

"left": 42, # The left padding of the cell.

27901

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

27902

"horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

27903

"backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.

27904

# for simplicity of conversion to/from color representations in various

27905

# languages over compactness; for example, the fields of this representation

27906

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

27907

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

27908

# method in iOS; and, with just a little work, it can be easily formatted into

27909

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

27914

#

27915

# // ...

27916

# public static java.awt.Color fromProto(Color protocolor) {

27917

# float alpha = protocolor.hasAlpha()

27918

# ? protocolor.getAlpha().getValue()

27919

# : 1.0;

27920

#

27921

# return new java.awt.Color(

27922

# protocolor.getRed(),

27923

# protocolor.getGreen(),

27924

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

27929

# float red = (float) color.getRed();

27930

# float green = (float) color.getGreen();

27931

# float blue = (float) color.getBlue();

27932

# float denominator = 255.0;

27933

# Color.Builder resultBuilder =

27934

# Color

27935

# .newBuilder()

27936

# .setRed(red / denominator)

27937

# .setGreen(green / denominator)

27938

# .setBlue(blue / denominator);

27939

# int alpha = color.getAlpha();

27940

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

27945

# .build());

27946

# }

27947

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

27952

#

27953

# // ...

27954

# static UIColor* fromProto(Color* protocolor) {

27955

# float red = [protocolor red];

27956

# float green = [protocolor green];

27957

# float blue = [protocolor blue];

27958

# FloatValue* alpha_wrapper = [protocolor alpha];

27959

# float alpha = 1.0;

27960

# if (alpha_wrapper != nil) {

27961

# alpha = [alpha_wrapper value];

27962

# }

27963

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

27964

# }

27965

#

27966

# static Color* toProto(UIColor* color) {

27967

# CGFloat red, green, blue, alpha;

27968

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

27969

# return nil;

27970

# }

27971

# Color* result = [Color alloc] init];

27972

# [result setRed:red];

27973

# [result setGreen:green];

27974

# [result setBlue:blue];

27975

# if (alpha <= 0.9999) {

27976

# [result setAlpha:floatWrapperWithValue(alpha)];

27977

# }

27978

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

27988

# var redFrac = rgb_color.red || 0.0;

27989

# var greenFrac = rgb_color.green || 0.0;

27990

# var blueFrac = rgb_color.blue || 0.0;

27991

# var red = Math.floor(redFrac * 255);

27992

# var green = Math.floor(greenFrac * 255);

27993

# var blue = Math.floor(blueFrac * 255);

27994

#

27995

# if (!('alpha' in rgb_color)) {

27996

# return rgbToCssColor_(red, green, blue);

27997

# }

27998

#

27999

# var alphaFrac = rgb_color.alpha.value || 0.0;

28000

# var rgbParams = [red, green, blue].join(',');

28001

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

28002

# };

28003

#

28004

# var rgbToCssColor_ = function(red, green, blue) {

28005

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

28006

# var hexString = rgbNumber.toString(16);

28007

# var missingZeros = 6 - hexString.length;

28008

# var resultBuilder = ['#'];

28009

# for (var i = 0; i < missingZeros; i++) {

28010

# resultBuilder.push('0');

28011

# }

28012

# resultBuilder.push(hexString);

28013

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

28018

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

28019

# the final pixel color is defined by the equation:

28020

#

28021

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

28022

#

28023

# This means that a value of 1.0 corresponds to a solid color, whereas

28024

# a value of 0.0 corresponds to a completely transparent color. This

28025

# uses a wrapper message rather than a simple float scalar so that it is

28026

# possible to distinguish between a default value and the value being unset.

28027

# If omitted, this color object is to be rendered as a solid color

28028

# (as if the alpha value had been explicitly given with a value of 1.0).

28029

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

28030

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

28031

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

28032

"verticalAlignment": "A String", # The vertical alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

28033

"textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).

28034

# Absent values indicate that the field isn't specified.

28035

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

28036

# for simplicity of conversion to/from color representations in various

28037

# languages over compactness; for example, the fields of this representation

28038

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

28039

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

28040

# method in iOS; and, with just a little work, it can be easily formatted into

28041

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

28046

#

28047

# // ...

28048

# public static java.awt.Color fromProto(Color protocolor) {

28049

# float alpha = protocolor.hasAlpha()

28050

# ? protocolor.getAlpha().getValue()

28051

# : 1.0;

28052

#

28053

# return new java.awt.Color(

28054

# protocolor.getRed(),

28055

# protocolor.getGreen(),

28056

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

28061

# float red = (float) color.getRed();

28062

# float green = (float) color.getGreen();

28063

# float blue = (float) color.getBlue();

28064

# float denominator = 255.0;

28065

# Color.Builder resultBuilder =

28066

# Color

28067

# .newBuilder()

28068

# .setRed(red / denominator)

28069

# .setGreen(green / denominator)

28070

# .setBlue(blue / denominator);

28071

# int alpha = color.getAlpha();

28072

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

28077

# .build());

28078

# }

28079

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

28084

#

28085

# // ...

28086

# static UIColor* fromProto(Color* protocolor) {

28087

# float red = [protocolor red];

28088

# float green = [protocolor green];

28089

# float blue = [protocolor blue];

28090

# FloatValue* alpha_wrapper = [protocolor alpha];

28091

# float alpha = 1.0;

28092

# if (alpha_wrapper != nil) {

28093

# alpha = [alpha_wrapper value];

28094

# }

28095

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

28096

# }

28097

#

28098

# static Color* toProto(UIColor* color) {

28099

# CGFloat red, green, blue, alpha;

28100

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

28101

# return nil;

28102

# }

28103

# Color* result = [Color alloc] init];

28104

# [result setRed:red];

28105

# [result setGreen:green];

28106

# [result setBlue:blue];

28107

# if (alpha <= 0.9999) {

28108

# [result setAlpha:floatWrapperWithValue(alpha)];

28109

# }

28110

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

28120

# var redFrac = rgb_color.red || 0.0;

28121

# var greenFrac = rgb_color.green || 0.0;

28122

# var blueFrac = rgb_color.blue || 0.0;

28123

# var red = Math.floor(redFrac * 255);

28124

# var green = Math.floor(greenFrac * 255);

28125

# var blue = Math.floor(blueFrac * 255);

28126

#

28127

# if (!('alpha' in rgb_color)) {

28128

# return rgbToCssColor_(red, green, blue);

28129

# }

28130

#

28131

# var alphaFrac = rgb_color.alpha.value || 0.0;

28132

# var rgbParams = [red, green, blue].join(',');

28133

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

28134

# };

28135

#

28136

# var rgbToCssColor_ = function(red, green, blue) {

28137

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

28138

# var hexString = rgbNumber.toString(16);

28139

# var missingZeros = 6 - hexString.length;

28140

# var resultBuilder = ['#'];

28141

# for (var i = 0; i < missingZeros; i++) {

28142

# resultBuilder.push('0');

28143

# }

28144

# resultBuilder.push(hexString);

28145

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

28150

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

28151

# the final pixel color is defined by the equation:

28152

#

28153

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

28154

#

28155

# This means that a value of 1.0 corresponds to a solid color, whereas

28156

# a value of 0.0 corresponds to a completely transparent color. This

28157

# uses a wrapper message rather than a simple float scalar so that it is

28158

# possible to distinguish between a default value and the value being unset.

28159

# If omitted, this color object is to be rendered as a solid color

28160

# (as if the alpha value had been explicitly given with a value of 1.0).

28161

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

28162

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

28163

},

28164

"bold": True or False, # True if the text is bold.

28165

"strikethrough": True or False, # True if the text has a strikethrough.

28166

"fontFamily": "A String", # The font family.

28167

"fontSize": 42, # The size of the font.

28168

"italic": True or False, # True if the text is italicized.

28169

"underline": True or False, # True if the text is underlined.

28170

},

28171

"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.

28172

"borders": { # The borders of the cell. # The borders of the cell.

28173

"top": { # A border along a cell. # The top border of the cell.

28174

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

28175

# for simplicity of conversion to/from color representations in various

28176

# languages over compactness; for example, the fields of this representation

28177

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

28178

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

28179

# method in iOS; and, with just a little work, it can be easily formatted into

28180

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

28185

#

28186

# // ...

28187

# public static java.awt.Color fromProto(Color protocolor) {

28188

# float alpha = protocolor.hasAlpha()

28189

# ? protocolor.getAlpha().getValue()

28190

# : 1.0;

28191

#

28192

# return new java.awt.Color(

28193

# protocolor.getRed(),

28194

# protocolor.getGreen(),

28195

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

28200

# float red = (float) color.getRed();

28201

# float green = (float) color.getGreen();

28202

# float blue = (float) color.getBlue();

28203

# float denominator = 255.0;

28204

# Color.Builder resultBuilder =

28205

# Color

28206

# .newBuilder()

28207

# .setRed(red / denominator)

28208

# .setGreen(green / denominator)

28209

# .setBlue(blue / denominator);

28210

# int alpha = color.getAlpha();

28211

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

28216

# .build());

28217

# }

28218

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

28223

#

28224

# // ...

28225

# static UIColor* fromProto(Color* protocolor) {

28226

# float red = [protocolor red];

28227

# float green = [protocolor green];

28228

# float blue = [protocolor blue];

28229

# FloatValue* alpha_wrapper = [protocolor alpha];

28230

# float alpha = 1.0;

28231

# if (alpha_wrapper != nil) {

28232

# alpha = [alpha_wrapper value];

28233

# }

28234

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

28235

# }

28236

#

28237

# static Color* toProto(UIColor* color) {

28238

# CGFloat red, green, blue, alpha;

28239

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

28240

# return nil;

28241

# }

28242

# Color* result = [Color alloc] init];

28243

# [result setRed:red];

28244

# [result setGreen:green];

28245

# [result setBlue:blue];

28246

# if (alpha <= 0.9999) {

28247

# [result setAlpha:floatWrapperWithValue(alpha)];

28248

# }

28249

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

28259

# var redFrac = rgb_color.red || 0.0;

28260

# var greenFrac = rgb_color.green || 0.0;

28261

# var blueFrac = rgb_color.blue || 0.0;

28262

# var red = Math.floor(redFrac * 255);

28263

# var green = Math.floor(greenFrac * 255);

28264

# var blue = Math.floor(blueFrac * 255);

28265

#

28266

# if (!('alpha' in rgb_color)) {

28267

# return rgbToCssColor_(red, green, blue);

28268

# }

28269

#

28270

# var alphaFrac = rgb_color.alpha.value || 0.0;

28271

# var rgbParams = [red, green, blue].join(',');

28272

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

28273

# };

28274

#

28275

# var rgbToCssColor_ = function(red, green, blue) {

28276

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

28277

# var hexString = rgbNumber.toString(16);

28278

# var missingZeros = 6 - hexString.length;

28279

# var resultBuilder = ['#'];

28280

# for (var i = 0; i < missingZeros; i++) {

28281

# resultBuilder.push('0');

28282

# }

28283

# resultBuilder.push(hexString);

28284

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

28289

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

28290

# the final pixel color is defined by the equation:

28291

#

28292

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

28293

#

28294

# This means that a value of 1.0 corresponds to a solid color, whereas

28295

# a value of 0.0 corresponds to a completely transparent color. This

28296

# uses a wrapper message rather than a simple float scalar so that it is

28297

# possible to distinguish between a default value and the value being unset.

28298

# If omitted, this color object is to be rendered as a solid color

28299

# (as if the alpha value had been explicitly given with a value of 1.0).

28300

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

28301

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

28302

},

28303

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

28304

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

28305

"style": "A String", # The style of the border.

28306

},

28307

"right": { # A border along a cell. # The right border of the cell.

28308

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

28309

# for simplicity of conversion to/from color representations in various

28310

# languages over compactness; for example, the fields of this representation

28311

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

28312

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

28313

# method in iOS; and, with just a little work, it can be easily formatted into

28314

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

28319

#

28320

# // ...

28321

# public static java.awt.Color fromProto(Color protocolor) {

28322

# float alpha = protocolor.hasAlpha()

28323

# ? protocolor.getAlpha().getValue()

28324

# : 1.0;

28325

#

28326

# return new java.awt.Color(

28327

# protocolor.getRed(),

28328

# protocolor.getGreen(),

28329

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

28334

# float red = (float) color.getRed();

28335

# float green = (float) color.getGreen();

28336

# float blue = (float) color.getBlue();

28337

# float denominator = 255.0;

28338

# Color.Builder resultBuilder =

28339

# Color

28340

# .newBuilder()

28341

# .setRed(red / denominator)

28342

# .setGreen(green / denominator)

28343

# .setBlue(blue / denominator);

28344

# int alpha = color.getAlpha();

28345

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

28350

# .build());

28351

# }

28352

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

28357

#

28358

# // ...

28359

# static UIColor* fromProto(Color* protocolor) {

28360

# float red = [protocolor red];

28361

# float green = [protocolor green];

28362

# float blue = [protocolor blue];

28363

# FloatValue* alpha_wrapper = [protocolor alpha];

28364

# float alpha = 1.0;

28365

# if (alpha_wrapper != nil) {

28366

# alpha = [alpha_wrapper value];

28367

# }

28368

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

28369

# }

28370

#

28371

# static Color* toProto(UIColor* color) {

28372

# CGFloat red, green, blue, alpha;

28373

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

28374

# return nil;

28375

# }

28376

# Color* result = [Color alloc] init];

28377

# [result setRed:red];

28378

# [result setGreen:green];

28379

# [result setBlue:blue];

28380

# if (alpha <= 0.9999) {

28381

# [result setAlpha:floatWrapperWithValue(alpha)];

28382

# }

28383

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

28393

# var redFrac = rgb_color.red || 0.0;

28394

# var greenFrac = rgb_color.green || 0.0;

28395

# var blueFrac = rgb_color.blue || 0.0;

28396

# var red = Math.floor(redFrac * 255);

28397

# var green = Math.floor(greenFrac * 255);

28398

# var blue = Math.floor(blueFrac * 255);

28399

#

28400

# if (!('alpha' in rgb_color)) {

28401

# return rgbToCssColor_(red, green, blue);

28402

# }

28403

#

28404

# var alphaFrac = rgb_color.alpha.value || 0.0;

28405

# var rgbParams = [red, green, blue].join(',');

28406

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

28407

# };

28408

#

28409

# var rgbToCssColor_ = function(red, green, blue) {

28410

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

28411

# var hexString = rgbNumber.toString(16);

28412

# var missingZeros = 6 - hexString.length;

28413

# var resultBuilder = ['#'];

28414

# for (var i = 0; i < missingZeros; i++) {

28415

# resultBuilder.push('0');

28416

# }

28417

# resultBuilder.push(hexString);

28418

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

28423

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

28424

# the final pixel color is defined by the equation:

28425

#

28426

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

28427

#

28428

# This means that a value of 1.0 corresponds to a solid color, whereas

28429

# a value of 0.0 corresponds to a completely transparent color. This

28430

# uses a wrapper message rather than a simple float scalar so that it is

28431

# possible to distinguish between a default value and the value being unset.

28432

# If omitted, this color object is to be rendered as a solid color

28433

# (as if the alpha value had been explicitly given with a value of 1.0).

28434

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

28435

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

28436

},

28437

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

28438

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

28439

"style": "A String", # The style of the border.

28440

},

28441

"bottom": { # A border along a cell. # The bottom border of the cell.

28442

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

28443

# for simplicity of conversion to/from color representations in various

28444

# languages over compactness; for example, the fields of this representation

28445

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

28446

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

28447

# method in iOS; and, with just a little work, it can be easily formatted into

28448

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

28453

#

28454

# // ...

28455

# public static java.awt.Color fromProto(Color protocolor) {

28456

# float alpha = protocolor.hasAlpha()

28457

# ? protocolor.getAlpha().getValue()

28458

# : 1.0;

28459

#

28460

# return new java.awt.Color(

28461

# protocolor.getRed(),

28462

# protocolor.getGreen(),

28463

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

28468

# float red = (float) color.getRed();

28469

# float green = (float) color.getGreen();

28470

# float blue = (float) color.getBlue();

28471

# float denominator = 255.0;

28472

# Color.Builder resultBuilder =

28473

# Color

28474

# .newBuilder()

28475

# .setRed(red / denominator)

28476

# .setGreen(green / denominator)

28477

# .setBlue(blue / denominator);

28478

# int alpha = color.getAlpha();

28479

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

28484

# .build());

28485

# }

28486

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

28491

#

28492

# // ...

28493

# static UIColor* fromProto(Color* protocolor) {

28494

# float red = [protocolor red];

28495

# float green = [protocolor green];

28496

# float blue = [protocolor blue];

28497

# FloatValue* alpha_wrapper = [protocolor alpha];

28498

# float alpha = 1.0;

28499

# if (alpha_wrapper != nil) {

28500

# alpha = [alpha_wrapper value];

28501

# }

28502

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

28503

# }

28504

#

28505

# static Color* toProto(UIColor* color) {

28506

# CGFloat red, green, blue, alpha;

28507

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

28508

# return nil;

28509

# }

28510

# Color* result = [Color alloc] init];

28511

# [result setRed:red];

28512

# [result setGreen:green];

28513

# [result setBlue:blue];

28514

# if (alpha <= 0.9999) {

28515

# [result setAlpha:floatWrapperWithValue(alpha)];

28516

# }

28517

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

28527

# var redFrac = rgb_color.red || 0.0;

28528

# var greenFrac = rgb_color.green || 0.0;

28529

# var blueFrac = rgb_color.blue || 0.0;

28530

# var red = Math.floor(redFrac * 255);

28531

# var green = Math.floor(greenFrac * 255);

28532

# var blue = Math.floor(blueFrac * 255);

28533

#

28534

# if (!('alpha' in rgb_color)) {

28535

# return rgbToCssColor_(red, green, blue);

28536

# }

28537

#

28538

# var alphaFrac = rgb_color.alpha.value || 0.0;

28539

# var rgbParams = [red, green, blue].join(',');

28540

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

28541

# };

28542

#

28543

# var rgbToCssColor_ = function(red, green, blue) {

28544

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

28545

# var hexString = rgbNumber.toString(16);

28546

# var missingZeros = 6 - hexString.length;

28547

# var resultBuilder = ['#'];

28548

# for (var i = 0; i < missingZeros; i++) {

28549

# resultBuilder.push('0');

28550

# }

28551

# resultBuilder.push(hexString);

28552

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

28557

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

28558

# the final pixel color is defined by the equation:

28559

#

28560

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

28561

#

28562

# This means that a value of 1.0 corresponds to a solid color, whereas

28563

# a value of 0.0 corresponds to a completely transparent color. This

28564

# uses a wrapper message rather than a simple float scalar so that it is

28565

# possible to distinguish between a default value and the value being unset.

28566

# If omitted, this color object is to be rendered as a solid color

28567

# (as if the alpha value had been explicitly given with a value of 1.0).

28568

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

28569

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

28570

},

28571

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

28572

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

28573

"style": "A String", # The style of the border.

28574

},

28575

"left": { # A border along a cell. # The left border of the cell.

28576

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

28577

# for simplicity of conversion to/from color representations in various

28578

# languages over compactness; for example, the fields of this representation

28579

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

28580

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

28581

# method in iOS; and, with just a little work, it can be easily formatted into

28582

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

28587

#

28588

# // ...

28589

# public static java.awt.Color fromProto(Color protocolor) {

28590

# float alpha = protocolor.hasAlpha()

28591

# ? protocolor.getAlpha().getValue()

28592

# : 1.0;

28593

#

28594

# return new java.awt.Color(

28595

# protocolor.getRed(),

28596

# protocolor.getGreen(),

28597

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

28602

# float red = (float) color.getRed();

28603

# float green = (float) color.getGreen();

28604

# float blue = (float) color.getBlue();

28605

# float denominator = 255.0;

28606

# Color.Builder resultBuilder =

28607

# Color

28608

# .newBuilder()

28609

# .setRed(red / denominator)

28610

# .setGreen(green / denominator)

28611

# .setBlue(blue / denominator);

28612

# int alpha = color.getAlpha();

28613

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

28618

# .build());

28619

# }

28620

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

28625

#

28626

# // ...

28627

# static UIColor* fromProto(Color* protocolor) {

28628

# float red = [protocolor red];

28629

# float green = [protocolor green];

28630

# float blue = [protocolor blue];

28631

# FloatValue* alpha_wrapper = [protocolor alpha];

28632

# float alpha = 1.0;

28633

# if (alpha_wrapper != nil) {

28634

# alpha = [alpha_wrapper value];

28635

# }

28636

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

28637

# }

28638

#

28639

# static Color* toProto(UIColor* color) {

28640

# CGFloat red, green, blue, alpha;

28641

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

28642

# return nil;

28643

# }

28644

# Color* result = [Color alloc] init];

28645

# [result setRed:red];

28646

# [result setGreen:green];

28647

# [result setBlue:blue];

28648

# if (alpha <= 0.9999) {

28649

# [result setAlpha:floatWrapperWithValue(alpha)];

28650

# }

28651

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

28661

# var redFrac = rgb_color.red || 0.0;

28662

# var greenFrac = rgb_color.green || 0.0;

28663

# var blueFrac = rgb_color.blue || 0.0;

28664

# var red = Math.floor(redFrac * 255);

28665

# var green = Math.floor(greenFrac * 255);

28666

# var blue = Math.floor(blueFrac * 255);

28667

#

28668

# if (!('alpha' in rgb_color)) {

28669

# return rgbToCssColor_(red, green, blue);

28670

# }

28671

#

28672

# var alphaFrac = rgb_color.alpha.value || 0.0;

28673

# var rgbParams = [red, green, blue].join(',');

28674

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

28675

# };

28676

#

28677

# var rgbToCssColor_ = function(red, green, blue) {

28678

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

28679

# var hexString = rgbNumber.toString(16);

28680

# var missingZeros = 6 - hexString.length;

28681

# var resultBuilder = ['#'];

28682

# for (var i = 0; i < missingZeros; i++) {

28683

# resultBuilder.push('0');

28684

# }

28685

# resultBuilder.push(hexString);

28686

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

28691

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

28692

# the final pixel color is defined by the equation:

28693

#

28694

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

28695

#

28696

# This means that a value of 1.0 corresponds to a solid color, whereas

28697

# a value of 0.0 corresponds to a completely transparent color. This

28698

# uses a wrapper message rather than a simple float scalar so that it is

28699

# possible to distinguish between a default value and the value being unset.

28700

# If omitted, this color object is to be rendered as a solid color

28701

# (as if the alpha value had been explicitly given with a value of 1.0).

28702

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

28703

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

28704

},

28705

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

28706

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

28707

"style": "A String", # The style of the border.

28708

},

28709

},

28710

"wrapStrategy": "A String", # The wrap strategy for the value in the cell.

28711

},

28712

"dataValidation": { # A data validation rule. # A data validation rule on the cell, if any.

28713

#

28714

# When writing, the new data validation rule will overwrite any prior rule.

28715

"showCustomUi": True or False, # True if the UI should be customized based on the kind of condition.

28716

# If true, "List" conditions will show a dropdown.

28717

"strict": True or False, # True if invalid data should be rejected.

28718

"inputMessage": "A String", # A message to show the user when adding data to the cell.

28719

"condition": { # A condition that can evaluate to true or false. # The condition that data in the cell must match.

28720

# BooleanConditions are used by conditional formatting,

28721

# data validation, and the criteria in filters.

28722

"type": "A String", # The type of condition.

28723

"values": [ # The values of the condition. The number of supported values depends

28724

# on the condition type. Some support zero values,

28725

# others one or two values,

28726

# and ConditionType.ONE_OF_LIST supports an arbitrary number of values.

28727

{ # The value of the condition.

28728

"relativeDate": "A String", # A relative date (based on the current date).

28729

# Valid only if the type is

28730

# DATE_BEFORE,

28731

# DATE_AFTER,

28732

# DATE_ON_OR_BEFORE or

28733

# DATE_ON_OR_AFTER.

28734

#

28735

# Relative dates are not supported in data validation.

28736

# They are supported only in conditional formatting and

28737

# conditional filters.

28738

"userEnteredValue": "A String", # A value the condition is based on.

28739

# The value will be parsed as if the user typed into a cell.

28740

# Formulas are supported (and must begin with an `=`).

},

],

},

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

28745

"textFormatRuns": [ # Runs of rich text applied to subsections of the cell. Runs are only valid

28746

# on user entered strings, not formulas, bools, or numbers.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

28747

# Runs start at specific indexes in the text and continue until the next

28748

# run. Properties of a run will continue unless explicitly changed

28749

# in a subsequent run (and properties of the first run will continue

28750

# the properties of the cell unless explicitly changed).

28751

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

28752

# When writing, the new runs will overwrite any prior runs. When writing a

28753

# new user_entered_value, previous runs will be erased.

28754

{ # A run of a text format. The format of this run continues until the start

28755

# index of the next run.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

28756

# When updating, all fields must be set.

28757

"startIndex": 42, # The character index where this run starts.

28758

"format": { # The format of a run of text in a cell. # The format of this run. Absent values inherit the cell's format.

28759

# Absent values indicate that the field isn't specified.

28760

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

28761

# for simplicity of conversion to/from color representations in various

28762

# languages over compactness; for example, the fields of this representation

28763

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

28764

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

28765

# method in iOS; and, with just a little work, it can be easily formatted into

28766

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

28771

#

28772

# // ...

28773

# public static java.awt.Color fromProto(Color protocolor) {

28774

# float alpha = protocolor.hasAlpha()

28775

# ? protocolor.getAlpha().getValue()

28776

# : 1.0;

28777

#

28778

# return new java.awt.Color(

28779

# protocolor.getRed(),

28780

# protocolor.getGreen(),

28781

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

28786

# float red = (float) color.getRed();

28787

# float green = (float) color.getGreen();

28788

# float blue = (float) color.getBlue();

28789

# float denominator = 255.0;

28790

# Color.Builder resultBuilder =

28791

# Color

28792

# .newBuilder()

28793

# .setRed(red / denominator)

28794

# .setGreen(green / denominator)

28795

# .setBlue(blue / denominator);

28796

# int alpha = color.getAlpha();

28797

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

28802

# .build());

28803

# }

28804

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

28809

#

28810

# // ...

28811

# static UIColor* fromProto(Color* protocolor) {

28812

# float red = [protocolor red];

28813

# float green = [protocolor green];

28814

# float blue = [protocolor blue];

28815

# FloatValue* alpha_wrapper = [protocolor alpha];

28816

# float alpha = 1.0;

28817

# if (alpha_wrapper != nil) {

28818

# alpha = [alpha_wrapper value];

28819

# }

28820

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

28821

# }

28822

#

28823

# static Color* toProto(UIColor* color) {

28824

# CGFloat red, green, blue, alpha;

28825

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

28826

# return nil;

28827

# }

28828

# Color* result = [Color alloc] init];

28829

# [result setRed:red];

28830

# [result setGreen:green];

28831

# [result setBlue:blue];

28832

# if (alpha <= 0.9999) {

28833

# [result setAlpha:floatWrapperWithValue(alpha)];

28834

# }

28835

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

28845

# var redFrac = rgb_color.red || 0.0;

28846

# var greenFrac = rgb_color.green || 0.0;

28847

# var blueFrac = rgb_color.blue || 0.0;

28848

# var red = Math.floor(redFrac * 255);

28849

# var green = Math.floor(greenFrac * 255);

28850

# var blue = Math.floor(blueFrac * 255);

28851

#

28852

# if (!('alpha' in rgb_color)) {

28853

# return rgbToCssColor_(red, green, blue);

28854

# }

28855

#

28856

# var alphaFrac = rgb_color.alpha.value || 0.0;

28857

# var rgbParams = [red, green, blue].join(',');

28858

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

28859

# };

28860

#

28861

# var rgbToCssColor_ = function(red, green, blue) {

28862

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

28863

# var hexString = rgbNumber.toString(16);

28864

# var missingZeros = 6 - hexString.length;

28865

# var resultBuilder = ['#'];

28866

# for (var i = 0; i < missingZeros; i++) {

28867

# resultBuilder.push('0');

28868

# }

28869

# resultBuilder.push(hexString);

28870

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

28875

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

28876

# the final pixel color is defined by the equation:

28877

#

28878

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

28879

#

28880

# This means that a value of 1.0 corresponds to a solid color, whereas

28881

# a value of 0.0 corresponds to a completely transparent color. This

28882

# uses a wrapper message rather than a simple float scalar so that it is

28883

# possible to distinguish between a default value and the value being unset.

28884

# If omitted, this color object is to be rendered as a solid color

28885

# (as if the alpha value had been explicitly given with a value of 1.0).

28886

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

28887

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

28888

},

28889

"bold": True or False, # True if the text is bold.

28890

"strikethrough": True or False, # True if the text has a strikethrough.

28891

"fontFamily": "A String", # The font family.

28892

"fontSize": 42, # The size of the font.

28893

"italic": True or False, # True if the text is italicized.

28894

"underline": True or False, # True if the text is underlined.

},

},

],

},

],

},

],

},

],

"properties": { # Properties of a sheet. # The properties of the sheet.

28905

"sheetType": "A String", # The type of sheet. Defaults to GRID.

28906

# This field cannot be changed once set.

28907

"index": 42, # The index of the sheet within the spreadsheet.

28908

# When adding or updating sheet properties, if this field

28909

# is excluded then the sheet will be added or moved to the end

28910

# of the sheet list.

28911

"title": "A String", # The name of the sheet.

28912

"gridProperties": { # Properties of a grid. # Additional properties of the sheet if this sheet is a grid.

28913

# (If the sheet is an object sheet, containing a chart or image, then

28914

# this field will be absent.)

28915

# When writing it is an error to set any grid properties on non-grid sheets.

28916

"columnCount": 42, # The number of columns in the grid.

28917

"rowCount": 42, # The number of rows in the grid.

28918

"frozenColumnCount": 42, # The number of columns that are frozen in the grid.

28919

"hideGridlines": True or False, # True if the grid isn't showing gridlines in the UI.

28920

"frozenRowCount": 42, # The number of rows that are frozen in the grid.

28921

},

28922

"rightToLeft": True or False, # True if the sheet is an RTL sheet instead of an LTR sheet.

28923

"tabColor": { # Represents a color in the RGBA color space. This representation is designed # The color of the tab in the UI.

28924

# for simplicity of conversion to/from color representations in various

28925

# languages over compactness; for example, the fields of this representation

28926

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

28927

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

28928

# method in iOS; and, with just a little work, it can be easily formatted into

28929

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

28934

#

28935

# // ...

28936

# public static java.awt.Color fromProto(Color protocolor) {

28937

# float alpha = protocolor.hasAlpha()

28938

# ? protocolor.getAlpha().getValue()

28939

# : 1.0;

28940

#

28941

# return new java.awt.Color(

28942

# protocolor.getRed(),

28943

# protocolor.getGreen(),

28944

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

28949

# float red = (float) color.getRed();

28950

# float green = (float) color.getGreen();

28951

# float blue = (float) color.getBlue();

28952

# float denominator = 255.0;

28953

# Color.Builder resultBuilder =

28954

# Color

28955

# .newBuilder()

28956

# .setRed(red / denominator)

28957

# .setGreen(green / denominator)

28958

# .setBlue(blue / denominator);

28959

# int alpha = color.getAlpha();

28960

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

28965

# .build());

28966

# }

28967

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

28972

#

28973

# // ...

28974

# static UIColor* fromProto(Color* protocolor) {

28975

# float red = [protocolor red];

28976

# float green = [protocolor green];

28977

# float blue = [protocolor blue];

28978

# FloatValue* alpha_wrapper = [protocolor alpha];

28979

# float alpha = 1.0;

28980

# if (alpha_wrapper != nil) {

28981

# alpha = [alpha_wrapper value];

28982

# }

28983

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

28984

# }

28985

#

28986

# static Color* toProto(UIColor* color) {

28987

# CGFloat red, green, blue, alpha;

28988

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

28989

# return nil;

28990

# }

28991

# Color* result = [Color alloc] init];

28992

# [result setRed:red];

28993

# [result setGreen:green];

28994

# [result setBlue:blue];

28995

# if (alpha <= 0.9999) {

28996

# [result setAlpha:floatWrapperWithValue(alpha)];

28997

# }

28998

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

29008

# var redFrac = rgb_color.red || 0.0;

29009

# var greenFrac = rgb_color.green || 0.0;

29010

# var blueFrac = rgb_color.blue || 0.0;

29011

# var red = Math.floor(redFrac * 255);

29012

# var green = Math.floor(greenFrac * 255);

29013

# var blue = Math.floor(blueFrac * 255);

29014

#

29015

# if (!('alpha' in rgb_color)) {

29016

# return rgbToCssColor_(red, green, blue);

29017

# }

29018

#

29019

# var alphaFrac = rgb_color.alpha.value || 0.0;

29020

# var rgbParams = [red, green, blue].join(',');

29021

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

29022

# };

29023

#

29024

# var rgbToCssColor_ = function(red, green, blue) {

29025

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

29026

# var hexString = rgbNumber.toString(16);

29027

# var missingZeros = 6 - hexString.length;

29028

# var resultBuilder = ['#'];

29029

# for (var i = 0; i < missingZeros; i++) {

29030

# resultBuilder.push('0');

29031

# }

29032

# resultBuilder.push(hexString);

29033

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

29038

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

29039

# the final pixel color is defined by the equation:

29040

#

29041

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

29042

#

29043

# This means that a value of 1.0 corresponds to a solid color, whereas

29044

# a value of 0.0 corresponds to a completely transparent color. This

29045

# uses a wrapper message rather than a simple float scalar so that it is

29046

# possible to distinguish between a default value and the value being unset.

29047

# If omitted, this color object is to be rendered as a solid color

29048

# (as if the alpha value had been explicitly given with a value of 1.0).

29049

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

29050

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

29051

},

29052

"hidden": True or False, # True if the sheet is hidden in the UI, false if it's visible.

29053

"sheetId": 42, # The ID of the sheet. Must be non-negative.

29054

# This field cannot be changed once set.

},

},

],

}</pre>

</div>

<code class="details" id="get">get(spreadsheetId, ranges=None, x__xgafv=None, includeGridData=None)</code>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

29063

<pre>Returns the spreadsheet at the given ID.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

29064

The caller must specify the spreadsheet ID.

29065

29066

By default, data within grids will not be returned.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

29067

You can include grid data one of two ways:

29068

29069

* Specify a field mask listing your desired fields using the `fields` URL

29070

parameter in HTTP

29071

29072

* Set the includeGridData

29073

URL parameter to true. If a field mask is set, the `includeGridData`

29074

parameter is ignored

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

29075

29076

For large spreadsheets, it is recommended to retrieve only the specific

29077

fields of the spreadsheet that you want.

29078

29079

To retrieve only subsets of the spreadsheet, use the

29080

ranges URL parameter.

29081

Multiple ranges can be specified. Limiting the range will

29082

return only the portions of the spreadsheet that intersect the requested

29083

ranges. Ranges are specified using A1 notation.

29084

29085

Args:

29086

spreadsheetId: string, The spreadsheet to request. (required)

29087

ranges: string, The ranges to retrieve from the spreadsheet. (repeated)

29088

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

includeGridData: boolean, True if grid data should be returned.

29093

This parameter is ignored if a field mask was set in the request.

29094

29095

Returns:

29096

An object of the form:

29097

29098

{ # Resource that represents a spreadsheet.

29099

"spreadsheetId": "A String", # The ID of the spreadsheet.

29100

# This field is read-only.

29101

"namedRanges": [ # The named ranges defined in a spreadsheet.

29102

{ # A named range.

29103

"namedRangeId": "A String", # The ID of the named range.

29104

"range": { # A range on a sheet. # The range this represents.

29105

# All indexes are zero-based.

29106

# Indexes are half open, e.g the start index is inclusive

29107

# and the end index is exclusive -- [start_index, end_index).

29108

# Missing indexes indicate the range is unbounded on that side.

29109

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

29110

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

29111

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

29112

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

29113

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

29114

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

29115

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

29116

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

29117

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

29118

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

29119

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

29120

# `Sheet1!A:B == sheet_id: 0,

29121

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

29122

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

29123

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

29124

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

29125

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

29126

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

29127

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

29128

#

29129

# The start index must always be less than or equal to the end index.

29130

# If the start index equals the end index, then the range is empty.

29131

# Empty ranges are typically not meaningful and are usually rendered in the

29132

# UI as `#REF!`.

29133

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

29134

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

29135

"sheetId": 42, # The sheet this range is on.

29136

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

29137

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

29138

},

29139

"name": "A String", # The name of the named range.

29140

},

29141

],

29142

"properties": { # Properties of a spreadsheet. # Overall properties of a spreadsheet.

29143

"locale": "A String", # The locale of the spreadsheet in one of the following formats:

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

29144

#

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

29145

# * an ISO 639-1 language code such as `en`

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

29146

#

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

29147

# * an ISO 639-2 language code such as `fil`, if no 639-1 code exists

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

29148

#

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

29149

# * a combination of the ISO language code and country code, such as `en_US`

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

29150

#

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

29151

# Note: when updating this field, not all locales/languages are supported.

29152

"timeZone": "A String", # The time zone of the spreadsheet, in CLDR format such as

29153

# `America/New_York`. If the time zone isn't recognized, this may

29154

# be a custom time zone such as `GMT-07:00`.

29155

"autoRecalc": "A String", # The amount of time to wait before volatile functions are recalculated.

29156

"defaultFormat": { # The format of a cell. # The default format of all cells in the spreadsheet.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

29157

# CellData.effectiveFormat will not be set if the

29158

# cell's format is equal to this default format.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

29159

# This field is read-only.

29160

"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

29161

"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on

29162

# the user's locale will be used if necessary for the given type.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame^]

29163

# See the [Date and Number Formats guide](/sheets/guides/formats) for more

29164

# information about the supported patterns.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

29165

"type": "A String", # The type of the number format.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

29166

# When writing, this field must be set.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

29167

},

29168

"textDirection": "A String", # The direction of the text in the cell.

29169

"padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.

29170

# When updating padding, every field must be specified.

29171

"top": 42, # The top padding of the cell.

29172

"right": 42, # The right padding of the cell.

29173

"bottom": 42, # The bottom padding of the cell.

29174

"left": 42, # The left padding of the cell.

29175

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

29176

"horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

29177

"backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.

29178

# for simplicity of conversion to/from color representations in various

29179

# languages over compactness; for example, the fields of this representation

29180

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

29181

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

29182

# method in iOS; and, with just a little work, it can be easily formatted into

29183

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

29188

#

29189

# // ...

29190

# public static java.awt.Color fromProto(Color protocolor) {

29191

# float alpha = protocolor.hasAlpha()

29192

# ? protocolor.getAlpha().getValue()

29193

# : 1.0;

29194

#

29195

# return new java.awt.Color(

29196

# protocolor.getRed(),

29197

# protocolor.getGreen(),

29198

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

29203

# float red = (float) color.getRed();

29204

# float green = (float) color.getGreen();

29205

# float blue = (float) color.getBlue();

29206

# float denominator = 255.0;

29207

# Color.Builder resultBuilder =

29208

# Color

29209

# .newBuilder()

29210

# .setRed(red / denominator)

29211

# .setGreen(green / denominator)

29212

# .setBlue(blue / denominator);

29213

# int alpha = color.getAlpha();

29214

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

29219

# .build());

29220

# }

29221

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

29226

#

29227

# // ...

29228

# static UIColor* fromProto(Color* protocolor) {

29229

# float red = [protocolor red];

29230

# float green = [protocolor green];

29231

# float blue = [protocolor blue];

29232

# FloatValue* alpha_wrapper = [protocolor alpha];

29233

# float alpha = 1.0;

29234

# if (alpha_wrapper != nil) {

29235

# alpha = [alpha_wrapper value];

29236

# }

29237

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

29238

# }

29239

#

29240

# static Color* toProto(UIColor* color) {

29241

# CGFloat red, green, blue, alpha;

29242

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

29243

# return nil;

29244

# }

29245

# Color* result = [Color alloc] init];

29246

# [result setRed:red];

29247

# [result setGreen:green];

29248

# [result setBlue:blue];

29249

# if (alpha <= 0.9999) {

29250

# [result setAlpha:floatWrapperWithValue(alpha)];

29251

# }

29252

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

29262

# var redFrac = rgb_color.red || 0.0;

29263

# var greenFrac = rgb_color.green || 0.0;

29264

# var blueFrac = rgb_color.blue || 0.0;

29265

# var red = Math.floor(redFrac * 255);

29266

# var green = Math.floor(greenFrac * 255);

29267

# var blue = Math.floor(blueFrac * 255);

29268

#

29269

# if (!('alpha' in rgb_color)) {

29270

# return rgbToCssColor_(red, green, blue);

29271

# }

29272

#

29273

# var alphaFrac = rgb_color.alpha.value || 0.0;

29274

# var rgbParams = [red, green, blue].join(',');

29275

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

29276

# };

29277

#

29278

# var rgbToCssColor_ = function(red, green, blue) {

29279

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

29280

# var hexString = rgbNumber.toString(16);

29281

# var missingZeros = 6 - hexString.length;

29282

# var resultBuilder = ['#'];

29283

# for (var i = 0; i < missingZeros; i++) {

29284

# resultBuilder.push('0');

29285

# }

29286

# resultBuilder.push(hexString);

29287

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

29292

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

29293

# the final pixel color is defined by the equation:

29294

#

29295

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

29296

#

29297

# This means that a value of 1.0 corresponds to a solid color, whereas

29298

# a value of 0.0 corresponds to a completely transparent color. This

29299

# uses a wrapper message rather than a simple float scalar so that it is

29300

# possible to distinguish between a default value and the value being unset.

29301

# If omitted, this color object is to be rendered as a solid color

29302

# (as if the alpha value had been explicitly given with a value of 1.0).

29303

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

29304

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

29305

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

29306

"verticalAlignment": "A String", # The vertical alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

29307

"textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).

29308

# Absent values indicate that the field isn't specified.

29309

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

29310

# for simplicity of conversion to/from color representations in various

29311

# languages over compactness; for example, the fields of this representation

29312

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

29313

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

29314

# method in iOS; and, with just a little work, it can be easily formatted into

29315

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

29320

#

29321

# // ...

29322

# public static java.awt.Color fromProto(Color protocolor) {

29323

# float alpha = protocolor.hasAlpha()

29324

# ? protocolor.getAlpha().getValue()

29325

# : 1.0;

29326

#

29327

# return new java.awt.Color(

29328

# protocolor.getRed(),

29329

# protocolor.getGreen(),

29330

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

29335

# float red = (float) color.getRed();

29336

# float green = (float) color.getGreen();

29337

# float blue = (float) color.getBlue();

29338

# float denominator = 255.0;

29339

# Color.Builder resultBuilder =

29340

# Color

29341

# .newBuilder()

29342

# .setRed(red / denominator)

29343

# .setGreen(green / denominator)

29344

# .setBlue(blue / denominator);

29345

# int alpha = color.getAlpha();

29346

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

29351

# .build());

29352

# }

29353

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

29358

#

29359

# // ...

29360

# static UIColor* fromProto(Color* protocolor) {

29361

# float red = [protocolor red];

29362

# float green = [protocolor green];

29363

# float blue = [protocolor blue];

29364

# FloatValue* alpha_wrapper = [protocolor alpha];

29365

# float alpha = 1.0;

29366

# if (alpha_wrapper != nil) {

29367

# alpha = [alpha_wrapper value];

29368

# }

29369

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

29370

# }

29371

#

29372

# static Color* toProto(UIColor* color) {

29373

# CGFloat red, green, blue, alpha;

29374

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

29375

# return nil;

29376

# }

29377

# Color* result = [Color alloc] init];

29378

# [result setRed:red];

29379

# [result setGreen:green];

29380

# [result setBlue:blue];

29381

# if (alpha <= 0.9999) {

29382

# [result setAlpha:floatWrapperWithValue(alpha)];

29383

# }

29384

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

29394

# var redFrac = rgb_color.red || 0.0;

29395

# var greenFrac = rgb_color.green || 0.0;

29396

# var blueFrac = rgb_color.blue || 0.0;

29397

# var red = Math.floor(redFrac * 255);

29398

# var green = Math.floor(greenFrac * 255);

29399

# var blue = Math.floor(blueFrac * 255);

29400

#

29401

# if (!('alpha' in rgb_color)) {

29402

# return rgbToCssColor_(red, green, blue);

29403

# }

29404

#

29405

# var alphaFrac = rgb_color.alpha.value || 0.0;

29406

# var rgbParams = [red, green, blue].join(',');

29407

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

29408

# };

29409

#

29410

# var rgbToCssColor_ = function(red, green, blue) {

29411

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

29412

# var hexString = rgbNumber.toString(16);

29413

# var missingZeros = 6 - hexString.length;

29414

# var resultBuilder = ['#'];

29415

# for (var i = 0; i < missingZeros; i++) {

29416

# resultBuilder.push('0');

29417

# }

29418

# resultBuilder.push(hexString);

29419

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

29424

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

29425

# the final pixel color is defined by the equation:

29426

#

29427

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

29428

#

29429

# This means that a value of 1.0 corresponds to a solid color, whereas

29430

# a value of 0.0 corresponds to a completely transparent color. This

29431

# uses a wrapper message rather than a simple float scalar so that it is

29432

# possible to distinguish between a default value and the value being unset.

29433

# If omitted, this color object is to be rendered as a solid color

29434

# (as if the alpha value had been explicitly given with a value of 1.0).

29435

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

29436

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

29437

},

29438

"bold": True or False, # True if the text is bold.

29439

"strikethrough": True or False, # True if the text has a strikethrough.

29440

"fontFamily": "A String", # The font family.

29441

"fontSize": 42, # The size of the font.

29442

"italic": True or False, # True if the text is italicized.

29443

"underline": True or False, # True if the text is underlined.

29444

},

29445

"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.

29446

"borders": { # The borders of the cell. # The borders of the cell.

29447

"top": { # A border along a cell. # The top border of the cell.

29448

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

29449

# for simplicity of conversion to/from color representations in various

29450

# languages over compactness; for example, the fields of this representation

29451

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

29452

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

29453

# method in iOS; and, with just a little work, it can be easily formatted into

29454

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

29459

#

29460

# // ...

29461

# public static java.awt.Color fromProto(Color protocolor) {

29462

# float alpha = protocolor.hasAlpha()

29463

# ? protocolor.getAlpha().getValue()

29464

# : 1.0;

29465

#

29466

# return new java.awt.Color(

29467

# protocolor.getRed(),

29468

# protocolor.getGreen(),

29469

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

29474

# float red = (float) color.getRed();

29475

# float green = (float) color.getGreen();

29476

# float blue = (float) color.getBlue();

29477

# float denominator = 255.0;

29478

# Color.Builder resultBuilder =

29479

# Color

29480

# .newBuilder()

29481

# .setRed(red / denominator)

29482

# .setGreen(green / denominator)

29483

# .setBlue(blue / denominator);

29484

# int alpha = color.getAlpha();

29485

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

29490

# .build());

29491

# }

29492

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

29497

#

29498

# // ...

29499

# static UIColor* fromProto(Color* protocolor) {

29500

# float red = [protocolor red];

29501

# float green = [protocolor green];

29502

# float blue = [protocolor blue];

29503

# FloatValue* alpha_wrapper = [protocolor alpha];

29504

# float alpha = 1.0;

29505

# if (alpha_wrapper != nil) {

29506

# alpha = [alpha_wrapper value];

29507

# }

29508

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

29509

# }

29510

#

29511

# static Color* toProto(UIColor* color) {

29512

# CGFloat red, green, blue, alpha;

29513

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

29514

# return nil;

29515

# }

29516

# Color* result = [Color alloc] init];

29517

# [result setRed:red];

29518

# [result setGreen:green];

29519

# [result setBlue:blue];

29520

# if (alpha <= 0.9999) {

29521

# [result setAlpha:floatWrapperWithValue(alpha)];

29522

# }

29523

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

29533

# var redFrac = rgb_color.red || 0.0;

29534

# var greenFrac = rgb_color.green || 0.0;

29535

# var blueFrac = rgb_color.blue || 0.0;

29536

# var red = Math.floor(redFrac * 255);

29537

# var green = Math.floor(greenFrac * 255);

29538

# var blue = Math.floor(blueFrac * 255);

29539

#

29540

# if (!('alpha' in rgb_color)) {

29541

# return rgbToCssColor_(red, green, blue);

29542

# }

29543

#

29544

# var alphaFrac = rgb_color.alpha.value || 0.0;

29545

# var rgbParams = [red, green, blue].join(',');

29546

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

29547

# };

29548

#

29549

# var rgbToCssColor_ = function(red, green, blue) {

29550

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

29551

# var hexString = rgbNumber.toString(16);

29552

# var missingZeros = 6 - hexString.length;

29553

# var resultBuilder = ['#'];

29554

# for (var i = 0; i < missingZeros; i++) {

29555

# resultBuilder.push('0');

29556

# }

29557

# resultBuilder.push(hexString);

29558

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

29563

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

29564

# the final pixel color is defined by the equation:

29565

#

29566

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

29567

#

29568

# This means that a value of 1.0 corresponds to a solid color, whereas

29569

# a value of 0.0 corresponds to a completely transparent color. This

29570

# uses a wrapper message rather than a simple float scalar so that it is

29571

# possible to distinguish between a default value and the value being unset.

29572

# If omitted, this color object is to be rendered as a solid color

29573

# (as if the alpha value had been explicitly given with a value of 1.0).

29574

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

29575

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

29576

},

29577

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

29578

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

29579

"style": "A String", # The style of the border.

29580

},

29581

"right": { # A border along a cell. # The right border of the cell.

29582

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

29583

# for simplicity of conversion to/from color representations in various

29584

# languages over compactness; for example, the fields of this representation

29585

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

29586

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

29587

# method in iOS; and, with just a little work, it can be easily formatted into

29588

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

29593

#

29594

# // ...

29595

# public static java.awt.Color fromProto(Color protocolor) {

29596

# float alpha = protocolor.hasAlpha()

29597

# ? protocolor.getAlpha().getValue()

29598

# : 1.0;

29599

#

29600

# return new java.awt.Color(

29601

# protocolor.getRed(),

29602

# protocolor.getGreen(),

29603

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

29608

# float red = (float) color.getRed();

29609

# float green = (float) color.getGreen();

29610

# float blue = (float) color.getBlue();

29611

# float denominator = 255.0;

29612

# Color.Builder resultBuilder =

29613

# Color

29614

# .newBuilder()

29615

# .setRed(red / denominator)

29616

# .setGreen(green / denominator)

29617

# .setBlue(blue / denominator);

29618

# int alpha = color.getAlpha();

29619

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

29624

# .build());

29625

# }

29626

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

29631

#

29632

# // ...

29633

# static UIColor* fromProto(Color* protocolor) {

29634

# float red = [protocolor red];

29635

# float green = [protocolor green];

29636

# float blue = [protocolor blue];

29637

# FloatValue* alpha_wrapper = [protocolor alpha];

29638

# float alpha = 1.0;

29639

# if (alpha_wrapper != nil) {

29640

# alpha = [alpha_wrapper value];

29641

# }

29642

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

29643

# }

29644

#

29645

# static Color* toProto(UIColor* color) {

29646

# CGFloat red, green, blue, alpha;

29647

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

29648

# return nil;

29649

# }

29650

# Color* result = [Color alloc] init];

29651

# [result setRed:red];

29652

# [result setGreen:green];

29653

# [result setBlue:blue];

29654

# if (alpha <= 0.9999) {

29655

# [result setAlpha:floatWrapperWithValue(alpha)];

29656

# }

29657

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

29667

# var redFrac = rgb_color.red || 0.0;

29668

# var greenFrac = rgb_color.green || 0.0;

29669

# var blueFrac = rgb_color.blue || 0.0;

29670

# var red = Math.floor(redFrac * 255);

29671

# var green = Math.floor(greenFrac * 255);

29672

# var blue = Math.floor(blueFrac * 255);

29673

#

29674

# if (!('alpha' in rgb_color)) {

29675

# return rgbToCssColor_(red, green, blue);

29676

# }

29677

#

29678

# var alphaFrac = rgb_color.alpha.value || 0.0;

29679

# var rgbParams = [red, green, blue].join(',');

29680

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

29681

# };

29682

#

29683

# var rgbToCssColor_ = function(red, green, blue) {

29684

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

29685

# var hexString = rgbNumber.toString(16);

29686

# var missingZeros = 6 - hexString.length;

29687

# var resultBuilder = ['#'];

29688

# for (var i = 0; i < missingZeros; i++) {

29689

# resultBuilder.push('0');

29690

# }

29691

# resultBuilder.push(hexString);

29692

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

29697

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

29698

# the final pixel color is defined by the equation:

29699

#

29700

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

29701

#

29702

# This means that a value of 1.0 corresponds to a solid color, whereas

29703

# a value of 0.0 corresponds to a completely transparent color. This

29704

# uses a wrapper message rather than a simple float scalar so that it is

29705

# possible to distinguish between a default value and the value being unset.

29706

# If omitted, this color object is to be rendered as a solid color

29707

# (as if the alpha value had been explicitly given with a value of 1.0).

29708

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

29709

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

29710

},

29711

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

29712

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

29713

"style": "A String", # The style of the border.

29714

},

29715

"bottom": { # A border along a cell. # The bottom border of the cell.

29716

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

29717

# for simplicity of conversion to/from color representations in various

29718

# languages over compactness; for example, the fields of this representation

29719

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

29720

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

29721

# method in iOS; and, with just a little work, it can be easily formatted into

29722

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

29727

#

29728

# // ...

29729

# public static java.awt.Color fromProto(Color protocolor) {

29730

# float alpha = protocolor.hasAlpha()

29731

# ? protocolor.getAlpha().getValue()

29732

# : 1.0;

29733

#

29734

# return new java.awt.Color(

29735

# protocolor.getRed(),

29736

# protocolor.getGreen(),

29737

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

29742

# float red = (float) color.getRed();

29743

# float green = (float) color.getGreen();

29744

# float blue = (float) color.getBlue();

29745

# float denominator = 255.0;

29746

# Color.Builder resultBuilder =

29747

# Color

29748

# .newBuilder()

29749

# .setRed(red / denominator)

29750

# .setGreen(green / denominator)

29751

# .setBlue(blue / denominator);

29752

# int alpha = color.getAlpha();

29753

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

29758

# .build());

29759

# }

29760

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

29765

#

29766

# // ...

29767

# static UIColor* fromProto(Color* protocolor) {

29768

# float red = [protocolor red];

29769

# float green = [protocolor green];

29770

# float blue = [protocolor blue];

29771

# FloatValue* alpha_wrapper = [protocolor alpha];

29772

# float alpha = 1.0;

29773

# if (alpha_wrapper != nil) {

29774

# alpha = [alpha_wrapper value];

29775

# }

29776

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

29777

# }

29778

#

29779

# static Color* toProto(UIColor* color) {

29780

# CGFloat red, green, blue, alpha;

29781

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

29782

# return nil;

29783

# }

29784

# Color* result = [Color alloc] init];

29785

# [result setRed:red];

29786

# [result setGreen:green];

29787

# [result setBlue:blue];

29788

# if (alpha <= 0.9999) {

29789

# [result setAlpha:floatWrapperWithValue(alpha)];

29790

# }

29791

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

29801

# var redFrac = rgb_color.red || 0.0;

29802

# var greenFrac = rgb_color.green || 0.0;

29803

# var blueFrac = rgb_color.blue || 0.0;

29804

# var red = Math.floor(redFrac * 255);

29805

# var green = Math.floor(greenFrac * 255);

29806

# var blue = Math.floor(blueFrac * 255);

29807

#

29808

# if (!('alpha' in rgb_color)) {

29809

# return rgbToCssColor_(red, green, blue);

29810

# }

29811

#

29812

# var alphaFrac = rgb_color.alpha.value || 0.0;

29813

# var rgbParams = [red, green, blue].join(',');

29814

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

29815

# };

29816

#

29817

# var rgbToCssColor_ = function(red, green, blue) {

29818

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

29819

# var hexString = rgbNumber.toString(16);

29820

# var missingZeros = 6 - hexString.length;

29821

# var resultBuilder = ['#'];

29822

# for (var i = 0; i < missingZeros; i++) {

29823

# resultBuilder.push('0');

29824

# }

29825

# resultBuilder.push(hexString);

29826

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

29831

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

29832

# the final pixel color is defined by the equation:

29833

#

29834

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

29835

#

29836

# This means that a value of 1.0 corresponds to a solid color, whereas

29837

# a value of 0.0 corresponds to a completely transparent color. This

29838

# uses a wrapper message rather than a simple float scalar so that it is

29839

# possible to distinguish between a default value and the value being unset.

29840

# If omitted, this color object is to be rendered as a solid color

29841

# (as if the alpha value had been explicitly given with a value of 1.0).

29842

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

29843

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

29844

},

29845

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

29846

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

29847

"style": "A String", # The style of the border.

29848

},

29849

"left": { # A border along a cell. # The left border of the cell.

29850

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

29851

# for simplicity of conversion to/from color representations in various

29852

# languages over compactness; for example, the fields of this representation

29853

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

29854

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

29855

# method in iOS; and, with just a little work, it can be easily formatted into

29856

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

29861

#

29862

# // ...

29863

# public static java.awt.Color fromProto(Color protocolor) {

29864

# float alpha = protocolor.hasAlpha()

29865

# ? protocolor.getAlpha().getValue()

29866

# : 1.0;

29867

#

29868

# return new java.awt.Color(

29869

# protocolor.getRed(),

29870

# protocolor.getGreen(),

29871

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

29876

# float red = (float) color.getRed();

29877

# float green = (float) color.getGreen();

29878

# float blue = (float) color.getBlue();

29879

# float denominator = 255.0;

29880

# Color.Builder resultBuilder =

29881

# Color

29882

# .newBuilder()

29883

# .setRed(red / denominator)

29884

# .setGreen(green / denominator)

29885

# .setBlue(blue / denominator);

29886

# int alpha = color.getAlpha();

29887

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

29892

# .build());

29893

# }

29894

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

29899

#

29900

# // ...

29901

# static UIColor* fromProto(Color* protocolor) {

29902

# float red = [protocolor red];

29903

# float green = [protocolor green];

29904

# float blue = [protocolor blue];

29905

# FloatValue* alpha_wrapper = [protocolor alpha];

29906

# float alpha = 1.0;

29907

# if (alpha_wrapper != nil) {

29908

# alpha = [alpha_wrapper value];

29909

# }

29910

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

29911

# }

29912

#

29913

# static Color* toProto(UIColor* color) {

29914

# CGFloat red, green, blue, alpha;

29915

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

29916

# return nil;

29917

# }

29918

# Color* result = [Color alloc] init];

29919

# [result setRed:red];

29920

# [result setGreen:green];

29921

# [result setBlue:blue];

29922

# if (alpha <= 0.9999) {

29923

# [result setAlpha:floatWrapperWithValue(alpha)];

29924

# }

29925

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

29935

# var redFrac = rgb_color.red || 0.0;

29936

# var greenFrac = rgb_color.green || 0.0;

29937

# var blueFrac = rgb_color.blue || 0.0;

29938

# var red = Math.floor(redFrac * 255);

29939

# var green = Math.floor(greenFrac * 255);

29940

# var blue = Math.floor(blueFrac * 255);

29941

#

29942

# if (!('alpha' in rgb_color)) {

29943

# return rgbToCssColor_(red, green, blue);

29944

# }

29945

#

29946

# var alphaFrac = rgb_color.alpha.value || 0.0;

29947

# var rgbParams = [red, green, blue].join(',');

29948

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

29949

# };

29950

#

29951

# var rgbToCssColor_ = function(red, green, blue) {

29952

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

29953

# var hexString = rgbNumber.toString(16);

29954

# var missingZeros = 6 - hexString.length;

29955

# var resultBuilder = ['#'];

29956

# for (var i = 0; i < missingZeros; i++) {

29957

# resultBuilder.push('0');

29958

# }

29959

# resultBuilder.push(hexString);

29960

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

29965

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

29966

# the final pixel color is defined by the equation:

29967

#

29968

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

29969

#

29970

# This means that a value of 1.0 corresponds to a solid color, whereas

29971

# a value of 0.0 corresponds to a completely transparent color. This

29972

# uses a wrapper message rather than a simple float scalar so that it is

29973

# possible to distinguish between a default value and the value being unset.

29974

# If omitted, this color object is to be rendered as a solid color

29975

# (as if the alpha value had been explicitly given with a value of 1.0).

29976

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

29977

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

29978

},

29979

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

29980

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

29981

"style": "A String", # The style of the border.

29982

},

29983

},

29984

"wrapStrategy": "A String", # The wrap strategy for the value in the cell.

29985

},

29986

"title": "A String", # The title of the spreadsheet.

29987

},

29988

"sheets": [ # The sheets that are part of a spreadsheet.

29989

{ # A sheet in a spreadsheet.

29990

"conditionalFormats": [ # The conditional format rules in this sheet.

29991

{ # A rule describing a conditional format.

29992

"ranges": [ # The ranges that will be formatted if the condition is true.

29993

# All the ranges must be on the same grid.

29994

{ # A range on a sheet.

29995

# All indexes are zero-based.

29996

# Indexes are half open, e.g the start index is inclusive

29997

# and the end index is exclusive -- [start_index, end_index).

29998

# Missing indexes indicate the range is unbounded on that side.

29999

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

30000

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

30001

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

30002

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

30003

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

30004

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

30005

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

30006

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

30007

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

30008

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

30009

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

30010

# `Sheet1!A:B == sheet_id: 0,

30011

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

30012

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

30013

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

30014

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

30015

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

30016

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

30017

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

30018

#

30019

# The start index must always be less than or equal to the end index.

30020

# If the start index equals the end index, then the range is empty.

30021

# Empty ranges are typically not meaningful and are usually rendered in the

30022

# UI as `#REF!`.

30023

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

30024

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

30025

"sheetId": 42, # The sheet this range is on.

30026

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

30027

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

30028

},

30029

],

30030

"booleanRule": { # A rule that may or may not match, depending on the condition. # The formatting is either "on" or "off" according to the rule.

30031

"condition": { # A condition that can evaluate to true or false. # The condition of the rule. If the condition evaluates to true,

30032

# the format will be applied.

30033

# BooleanConditions are used by conditional formatting,

30034

# data validation, and the criteria in filters.

30035

"type": "A String", # The type of condition.

30036

"values": [ # The values of the condition. The number of supported values depends

30037

# on the condition type. Some support zero values,

30038

# others one or two values,

30039

# and ConditionType.ONE_OF_LIST supports an arbitrary number of values.

30040

{ # The value of the condition.

30041

"relativeDate": "A String", # A relative date (based on the current date).

30042

# Valid only if the type is

30043

# DATE_BEFORE,

30044

# DATE_AFTER,

30045

# DATE_ON_OR_BEFORE or

30046

# DATE_ON_OR_AFTER.

30047

#

30048

# Relative dates are not supported in data validation.

30049

# They are supported only in conditional formatting and

30050

# conditional filters.

30051

"userEnteredValue": "A String", # A value the condition is based on.

30052

# The value will be parsed as if the user typed into a cell.

30053

# Formulas are supported (and must begin with an `=`).

},

],

},

"format": { # The format of a cell. # The format to apply.

30058

# Conditional formatting can only apply a subset of formatting:

# bold, italic,

# strikethrough,

# foreground color &

# background color.

"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

30064

"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on

30065

# the user's locale will be used if necessary for the given type.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame^]

30066

# See the [Date and Number Formats guide](/sheets/guides/formats) for more

30067

# information about the supported patterns.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

30068

"type": "A String", # The type of the number format.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

30069

# When writing, this field must be set.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

30070

},

30071

"textDirection": "A String", # The direction of the text in the cell.

30072

"padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.

30073

# When updating padding, every field must be specified.

30074

"top": 42, # The top padding of the cell.

30075

"right": 42, # The right padding of the cell.

30076

"bottom": 42, # The bottom padding of the cell.

30077

"left": 42, # The left padding of the cell.

30078

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

30079

"horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

30080

"backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.

30081

# for simplicity of conversion to/from color representations in various

30082

# languages over compactness; for example, the fields of this representation

30083

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

30084

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

30085

# method in iOS; and, with just a little work, it can be easily formatted into

30086

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

30091

#

30092

# // ...

30093

# public static java.awt.Color fromProto(Color protocolor) {

30094

# float alpha = protocolor.hasAlpha()

30095

# ? protocolor.getAlpha().getValue()

30096

# : 1.0;

30097

#

30098

# return new java.awt.Color(

30099

# protocolor.getRed(),

30100

# protocolor.getGreen(),

30101

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

30106

# float red = (float) color.getRed();

30107

# float green = (float) color.getGreen();

30108

# float blue = (float) color.getBlue();

30109

# float denominator = 255.0;

30110

# Color.Builder resultBuilder =

30111

# Color

30112

# .newBuilder()

30113

# .setRed(red / denominator)

30114

# .setGreen(green / denominator)

30115

# .setBlue(blue / denominator);

30116

# int alpha = color.getAlpha();

30117

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

30122

# .build());

30123

# }

30124

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

30129

#

30130

# // ...

30131

# static UIColor* fromProto(Color* protocolor) {

30132

# float red = [protocolor red];

30133

# float green = [protocolor green];

30134

# float blue = [protocolor blue];

30135

# FloatValue* alpha_wrapper = [protocolor alpha];

30136

# float alpha = 1.0;

30137

# if (alpha_wrapper != nil) {

30138

# alpha = [alpha_wrapper value];

30139

# }

30140

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

30141

# }

30142

#

30143

# static Color* toProto(UIColor* color) {

30144

# CGFloat red, green, blue, alpha;

30145

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

30146

# return nil;

30147

# }

30148

# Color* result = [Color alloc] init];

30149

# [result setRed:red];

30150

# [result setGreen:green];

30151

# [result setBlue:blue];

30152

# if (alpha <= 0.9999) {

30153

# [result setAlpha:floatWrapperWithValue(alpha)];

30154

# }

30155

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

30165

# var redFrac = rgb_color.red || 0.0;

30166

# var greenFrac = rgb_color.green || 0.0;

30167

# var blueFrac = rgb_color.blue || 0.0;

30168

# var red = Math.floor(redFrac * 255);

30169

# var green = Math.floor(greenFrac * 255);

30170

# var blue = Math.floor(blueFrac * 255);

30171

#

30172

# if (!('alpha' in rgb_color)) {

30173

# return rgbToCssColor_(red, green, blue);

30174

# }

30175

#

30176

# var alphaFrac = rgb_color.alpha.value || 0.0;

30177

# var rgbParams = [red, green, blue].join(',');

30178

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

30179

# };

30180

#

30181

# var rgbToCssColor_ = function(red, green, blue) {

30182

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

30183

# var hexString = rgbNumber.toString(16);

30184

# var missingZeros = 6 - hexString.length;

30185

# var resultBuilder = ['#'];

30186

# for (var i = 0; i < missingZeros; i++) {

30187

# resultBuilder.push('0');

30188

# }

30189

# resultBuilder.push(hexString);

30190

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

30195

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

30196

# the final pixel color is defined by the equation:

30197

#

30198

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

30199

#

30200

# This means that a value of 1.0 corresponds to a solid color, whereas

30201

# a value of 0.0 corresponds to a completely transparent color. This

30202

# uses a wrapper message rather than a simple float scalar so that it is

30203

# possible to distinguish between a default value and the value being unset.

30204

# If omitted, this color object is to be rendered as a solid color

30205

# (as if the alpha value had been explicitly given with a value of 1.0).

30206

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

30207

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

30208

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

30209

"verticalAlignment": "A String", # The vertical alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

30210

"textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).

30211

# Absent values indicate that the field isn't specified.

30212

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

30213

# for simplicity of conversion to/from color representations in various

30214

# languages over compactness; for example, the fields of this representation

30215

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

30216

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

30217

# method in iOS; and, with just a little work, it can be easily formatted into

30218

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

30223

#

30224

# // ...

30225

# public static java.awt.Color fromProto(Color protocolor) {

30226

# float alpha = protocolor.hasAlpha()

30227

# ? protocolor.getAlpha().getValue()

30228

# : 1.0;

30229

#

30230

# return new java.awt.Color(

30231

# protocolor.getRed(),

30232

# protocolor.getGreen(),

30233

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

30238

# float red = (float) color.getRed();

30239

# float green = (float) color.getGreen();

30240

# float blue = (float) color.getBlue();

30241

# float denominator = 255.0;

30242

# Color.Builder resultBuilder =

30243

# Color

30244

# .newBuilder()

30245

# .setRed(red / denominator)

30246

# .setGreen(green / denominator)

30247

# .setBlue(blue / denominator);

30248

# int alpha = color.getAlpha();

30249

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

30254

# .build());

30255

# }

30256

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

30261

#

30262

# // ...

30263

# static UIColor* fromProto(Color* protocolor) {

30264

# float red = [protocolor red];

30265

# float green = [protocolor green];

30266

# float blue = [protocolor blue];

30267

# FloatValue* alpha_wrapper = [protocolor alpha];

30268

# float alpha = 1.0;

30269

# if (alpha_wrapper != nil) {

30270

# alpha = [alpha_wrapper value];

30271

# }

30272

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

30273

# }

30274

#

30275

# static Color* toProto(UIColor* color) {

30276

# CGFloat red, green, blue, alpha;

30277

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

30278

# return nil;

30279

# }

30280

# Color* result = [Color alloc] init];

30281

# [result setRed:red];

30282

# [result setGreen:green];

30283

# [result setBlue:blue];

30284

# if (alpha <= 0.9999) {

30285

# [result setAlpha:floatWrapperWithValue(alpha)];

30286

# }

30287

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

30297

# var redFrac = rgb_color.red || 0.0;

30298

# var greenFrac = rgb_color.green || 0.0;

30299

# var blueFrac = rgb_color.blue || 0.0;

30300

# var red = Math.floor(redFrac * 255);

30301

# var green = Math.floor(greenFrac * 255);

30302

# var blue = Math.floor(blueFrac * 255);

30303

#

30304

# if (!('alpha' in rgb_color)) {

30305

# return rgbToCssColor_(red, green, blue);

30306

# }

30307

#

30308

# var alphaFrac = rgb_color.alpha.value || 0.0;

30309

# var rgbParams = [red, green, blue].join(',');

30310

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

30311

# };

30312

#

30313

# var rgbToCssColor_ = function(red, green, blue) {

30314

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

30315

# var hexString = rgbNumber.toString(16);

30316

# var missingZeros = 6 - hexString.length;

30317

# var resultBuilder = ['#'];

30318

# for (var i = 0; i < missingZeros; i++) {

30319

# resultBuilder.push('0');

30320

# }

30321

# resultBuilder.push(hexString);

30322

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

30327

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

30328

# the final pixel color is defined by the equation:

30329

#

30330

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

30331

#

30332

# This means that a value of 1.0 corresponds to a solid color, whereas

30333

# a value of 0.0 corresponds to a completely transparent color. This

30334

# uses a wrapper message rather than a simple float scalar so that it is

30335

# possible to distinguish between a default value and the value being unset.

30336

# If omitted, this color object is to be rendered as a solid color

30337

# (as if the alpha value had been explicitly given with a value of 1.0).

30338

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

30339

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

30340

},

30341

"bold": True or False, # True if the text is bold.

30342

"strikethrough": True or False, # True if the text has a strikethrough.

30343

"fontFamily": "A String", # The font family.

30344

"fontSize": 42, # The size of the font.

30345

"italic": True or False, # True if the text is italicized.

30346

"underline": True or False, # True if the text is underlined.

30347

},

30348

"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.

30349

"borders": { # The borders of the cell. # The borders of the cell.

30350

"top": { # A border along a cell. # The top border of the cell.

30351

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

30352

# for simplicity of conversion to/from color representations in various

30353

# languages over compactness; for example, the fields of this representation

30354

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

30355

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

30356

# method in iOS; and, with just a little work, it can be easily formatted into

30357

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

30362

#

30363

# // ...

30364

# public static java.awt.Color fromProto(Color protocolor) {

30365

# float alpha = protocolor.hasAlpha()

30366

# ? protocolor.getAlpha().getValue()

30367

# : 1.0;

30368

#

30369

# return new java.awt.Color(

30370

# protocolor.getRed(),

30371

# protocolor.getGreen(),

30372

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

30377

# float red = (float) color.getRed();

30378

# float green = (float) color.getGreen();

30379

# float blue = (float) color.getBlue();

30380

# float denominator = 255.0;

30381

# Color.Builder resultBuilder =

30382

# Color

30383

# .newBuilder()

30384

# .setRed(red / denominator)

30385

# .setGreen(green / denominator)

30386

# .setBlue(blue / denominator);

30387

# int alpha = color.getAlpha();

30388

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

30393

# .build());

30394

# }

30395

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

30400

#

30401

# // ...

30402

# static UIColor* fromProto(Color* protocolor) {

30403

# float red = [protocolor red];

30404

# float green = [protocolor green];

30405

# float blue = [protocolor blue];

30406

# FloatValue* alpha_wrapper = [protocolor alpha];

30407

# float alpha = 1.0;

30408

# if (alpha_wrapper != nil) {

30409

# alpha = [alpha_wrapper value];

30410

# }

30411

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

30412

# }

30413

#

30414

# static Color* toProto(UIColor* color) {

30415

# CGFloat red, green, blue, alpha;

30416

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

30417

# return nil;

30418

# }

30419

# Color* result = [Color alloc] init];

30420

# [result setRed:red];

30421

# [result setGreen:green];

30422

# [result setBlue:blue];

30423

# if (alpha <= 0.9999) {

30424

# [result setAlpha:floatWrapperWithValue(alpha)];

30425

# }

30426

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

30436

# var redFrac = rgb_color.red || 0.0;

30437

# var greenFrac = rgb_color.green || 0.0;

30438

# var blueFrac = rgb_color.blue || 0.0;

30439

# var red = Math.floor(redFrac * 255);

30440

# var green = Math.floor(greenFrac * 255);

30441

# var blue = Math.floor(blueFrac * 255);

30442

#

30443

# if (!('alpha' in rgb_color)) {

30444

# return rgbToCssColor_(red, green, blue);

30445

# }

30446

#

30447

# var alphaFrac = rgb_color.alpha.value || 0.0;

30448

# var rgbParams = [red, green, blue].join(',');

30449

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

30450

# };

30451

#

30452

# var rgbToCssColor_ = function(red, green, blue) {

30453

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

30454

# var hexString = rgbNumber.toString(16);

30455

# var missingZeros = 6 - hexString.length;

30456

# var resultBuilder = ['#'];

30457

# for (var i = 0; i < missingZeros; i++) {

30458

# resultBuilder.push('0');

30459

# }

30460

# resultBuilder.push(hexString);

30461

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

30466

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

30467

# the final pixel color is defined by the equation:

30468

#

30469

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

30470

#

30471

# This means that a value of 1.0 corresponds to a solid color, whereas

30472

# a value of 0.0 corresponds to a completely transparent color. This

30473

# uses a wrapper message rather than a simple float scalar so that it is

30474

# possible to distinguish between a default value and the value being unset.

30475

# If omitted, this color object is to be rendered as a solid color

30476

# (as if the alpha value had been explicitly given with a value of 1.0).

30477

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

30478

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

30479

},

30480

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

30481

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

30482

"style": "A String", # The style of the border.

30483

},

30484

"right": { # A border along a cell. # The right border of the cell.

30485

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

30486

# for simplicity of conversion to/from color representations in various

30487

# languages over compactness; for example, the fields of this representation

30488

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

30489

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

30490

# method in iOS; and, with just a little work, it can be easily formatted into

30491

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

30496

#

30497

# // ...

30498

# public static java.awt.Color fromProto(Color protocolor) {

30499

# float alpha = protocolor.hasAlpha()

30500

# ? protocolor.getAlpha().getValue()

30501

# : 1.0;

30502

#

30503

# return new java.awt.Color(

30504

# protocolor.getRed(),

30505

# protocolor.getGreen(),

30506

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

30511

# float red = (float) color.getRed();

30512

# float green = (float) color.getGreen();

30513

# float blue = (float) color.getBlue();

30514

# float denominator = 255.0;

30515

# Color.Builder resultBuilder =

30516

# Color

30517

# .newBuilder()

30518

# .setRed(red / denominator)

30519

# .setGreen(green / denominator)

30520

# .setBlue(blue / denominator);

30521

# int alpha = color.getAlpha();

30522

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

30527

# .build());

30528

# }

30529

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

30534

#

30535

# // ...

30536

# static UIColor* fromProto(Color* protocolor) {

30537

# float red = [protocolor red];

30538

# float green = [protocolor green];

30539

# float blue = [protocolor blue];

30540

# FloatValue* alpha_wrapper = [protocolor alpha];

30541

# float alpha = 1.0;

30542

# if (alpha_wrapper != nil) {

30543

# alpha = [alpha_wrapper value];

30544

# }

30545

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

30546

# }

30547

#

30548

# static Color* toProto(UIColor* color) {

30549

# CGFloat red, green, blue, alpha;

30550

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

30551

# return nil;

30552

# }

30553

# Color* result = [Color alloc] init];

30554

# [result setRed:red];

30555

# [result setGreen:green];

30556

# [result setBlue:blue];

30557

# if (alpha <= 0.9999) {

30558

# [result setAlpha:floatWrapperWithValue(alpha)];

30559

# }

30560

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

30570

# var redFrac = rgb_color.red || 0.0;

30571

# var greenFrac = rgb_color.green || 0.0;

30572

# var blueFrac = rgb_color.blue || 0.0;

30573

# var red = Math.floor(redFrac * 255);

30574

# var green = Math.floor(greenFrac * 255);

30575

# var blue = Math.floor(blueFrac * 255);

30576

#

30577

# if (!('alpha' in rgb_color)) {

30578

# return rgbToCssColor_(red, green, blue);

30579

# }

30580

#

30581

# var alphaFrac = rgb_color.alpha.value || 0.0;

30582

# var rgbParams = [red, green, blue].join(',');

30583

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

30584

# };

30585

#

30586

# var rgbToCssColor_ = function(red, green, blue) {

30587

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

30588

# var hexString = rgbNumber.toString(16);

30589

# var missingZeros = 6 - hexString.length;

30590

# var resultBuilder = ['#'];

30591

# for (var i = 0; i < missingZeros; i++) {

30592

# resultBuilder.push('0');

30593

# }

30594

# resultBuilder.push(hexString);

30595

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

30600

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

30601

# the final pixel color is defined by the equation:

30602

#

30603

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

30604

#

30605

# This means that a value of 1.0 corresponds to a solid color, whereas

30606

# a value of 0.0 corresponds to a completely transparent color. This

30607

# uses a wrapper message rather than a simple float scalar so that it is

30608

# possible to distinguish between a default value and the value being unset.

30609

# If omitted, this color object is to be rendered as a solid color

30610

# (as if the alpha value had been explicitly given with a value of 1.0).

30611

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

30612

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

30613

},

30614

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

30615

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

30616

"style": "A String", # The style of the border.

30617

},

30618

"bottom": { # A border along a cell. # The bottom border of the cell.

30619

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

30620

# for simplicity of conversion to/from color representations in various

30621

# languages over compactness; for example, the fields of this representation

30622

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

30623

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

30624

# method in iOS; and, with just a little work, it can be easily formatted into

30625

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

30630

#

30631

# // ...

30632

# public static java.awt.Color fromProto(Color protocolor) {

30633

# float alpha = protocolor.hasAlpha()

30634

# ? protocolor.getAlpha().getValue()

30635

# : 1.0;

30636

#

30637

# return new java.awt.Color(

30638

# protocolor.getRed(),

30639

# protocolor.getGreen(),

30640

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

30645

# float red = (float) color.getRed();

30646

# float green = (float) color.getGreen();

30647

# float blue = (float) color.getBlue();

30648

# float denominator = 255.0;

30649

# Color.Builder resultBuilder =

30650

# Color

30651

# .newBuilder()

30652

# .setRed(red / denominator)

30653

# .setGreen(green / denominator)

30654

# .setBlue(blue / denominator);

30655

# int alpha = color.getAlpha();

30656

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

30661

# .build());

30662

# }

30663

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

30668

#

30669

# // ...

30670

# static UIColor* fromProto(Color* protocolor) {

30671

# float red = [protocolor red];

30672

# float green = [protocolor green];

30673

# float blue = [protocolor blue];

30674

# FloatValue* alpha_wrapper = [protocolor alpha];

30675

# float alpha = 1.0;

30676

# if (alpha_wrapper != nil) {

30677

# alpha = [alpha_wrapper value];

30678

# }

30679

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

30680

# }

30681

#

30682

# static Color* toProto(UIColor* color) {

30683

# CGFloat red, green, blue, alpha;

30684

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

30685

# return nil;

30686

# }

30687

# Color* result = [Color alloc] init];

30688

# [result setRed:red];

30689

# [result setGreen:green];

30690

# [result setBlue:blue];

30691

# if (alpha <= 0.9999) {

30692

# [result setAlpha:floatWrapperWithValue(alpha)];

30693

# }

30694

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

30704

# var redFrac = rgb_color.red || 0.0;

30705

# var greenFrac = rgb_color.green || 0.0;

30706

# var blueFrac = rgb_color.blue || 0.0;

30707

# var red = Math.floor(redFrac * 255);

30708

# var green = Math.floor(greenFrac * 255);

30709

# var blue = Math.floor(blueFrac * 255);

30710

#

30711

# if (!('alpha' in rgb_color)) {

30712

# return rgbToCssColor_(red, green, blue);

30713

# }

30714

#

30715

# var alphaFrac = rgb_color.alpha.value || 0.0;

30716

# var rgbParams = [red, green, blue].join(',');

30717

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

30718

# };

30719

#

30720

# var rgbToCssColor_ = function(red, green, blue) {

30721

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

30722

# var hexString = rgbNumber.toString(16);

30723

# var missingZeros = 6 - hexString.length;

30724

# var resultBuilder = ['#'];

30725

# for (var i = 0; i < missingZeros; i++) {

30726

# resultBuilder.push('0');

30727

# }

30728

# resultBuilder.push(hexString);

30729

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

30734

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

30735

# the final pixel color is defined by the equation:

30736

#

30737

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

30738

#

30739

# This means that a value of 1.0 corresponds to a solid color, whereas

30740

# a value of 0.0 corresponds to a completely transparent color. This

30741

# uses a wrapper message rather than a simple float scalar so that it is

30742

# possible to distinguish between a default value and the value being unset.

30743

# If omitted, this color object is to be rendered as a solid color

30744

# (as if the alpha value had been explicitly given with a value of 1.0).

30745

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

30746

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

30747

},

30748

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

30749

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

30750

"style": "A String", # The style of the border.

30751

},

30752

"left": { # A border along a cell. # The left border of the cell.

30753

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

30754

# for simplicity of conversion to/from color representations in various

30755

# languages over compactness; for example, the fields of this representation

30756

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

30757

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

30758

# method in iOS; and, with just a little work, it can be easily formatted into

30759

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

30764

#

30765

# // ...

30766

# public static java.awt.Color fromProto(Color protocolor) {

30767

# float alpha = protocolor.hasAlpha()

30768

# ? protocolor.getAlpha().getValue()

30769

# : 1.0;

30770

#

30771

# return new java.awt.Color(

30772

# protocolor.getRed(),

30773

# protocolor.getGreen(),

30774

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

30779

# float red = (float) color.getRed();

30780

# float green = (float) color.getGreen();

30781

# float blue = (float) color.getBlue();

30782

# float denominator = 255.0;

30783

# Color.Builder resultBuilder =

30784

# Color

30785

# .newBuilder()

30786

# .setRed(red / denominator)

30787

# .setGreen(green / denominator)

30788

# .setBlue(blue / denominator);

30789

# int alpha = color.getAlpha();

30790

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

30795

# .build());

30796

# }

30797

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

30802

#

30803

# // ...

30804

# static UIColor* fromProto(Color* protocolor) {

30805

# float red = [protocolor red];

30806

# float green = [protocolor green];

30807

# float blue = [protocolor blue];

30808

# FloatValue* alpha_wrapper = [protocolor alpha];

30809

# float alpha = 1.0;

30810

# if (alpha_wrapper != nil) {

30811

# alpha = [alpha_wrapper value];

30812

# }

30813

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

30814

# }

30815

#

30816

# static Color* toProto(UIColor* color) {

30817

# CGFloat red, green, blue, alpha;

30818

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

30819

# return nil;

30820

# }

30821

# Color* result = [Color alloc] init];

30822

# [result setRed:red];

30823

# [result setGreen:green];

30824

# [result setBlue:blue];

30825

# if (alpha <= 0.9999) {

30826

# [result setAlpha:floatWrapperWithValue(alpha)];

30827

# }

30828

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

30838

# var redFrac = rgb_color.red || 0.0;

30839

# var greenFrac = rgb_color.green || 0.0;

30840

# var blueFrac = rgb_color.blue || 0.0;

30841

# var red = Math.floor(redFrac * 255);

30842

# var green = Math.floor(greenFrac * 255);

30843

# var blue = Math.floor(blueFrac * 255);

30844

#

30845

# if (!('alpha' in rgb_color)) {

30846

# return rgbToCssColor_(red, green, blue);

30847

# }

30848

#

30849

# var alphaFrac = rgb_color.alpha.value || 0.0;

30850

# var rgbParams = [red, green, blue].join(',');

30851

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

30852

# };

30853

#

30854

# var rgbToCssColor_ = function(red, green, blue) {

30855

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

30856

# var hexString = rgbNumber.toString(16);

30857

# var missingZeros = 6 - hexString.length;

30858

# var resultBuilder = ['#'];

30859

# for (var i = 0; i < missingZeros; i++) {

30860

# resultBuilder.push('0');

30861

# }

30862

# resultBuilder.push(hexString);

30863

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

30868

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

30869

# the final pixel color is defined by the equation:

30870

#

30871

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

30872

#

30873

# This means that a value of 1.0 corresponds to a solid color, whereas

30874

# a value of 0.0 corresponds to a completely transparent color. This

30875

# uses a wrapper message rather than a simple float scalar so that it is

30876

# possible to distinguish between a default value and the value being unset.

30877

# If omitted, this color object is to be rendered as a solid color

30878

# (as if the alpha value had been explicitly given with a value of 1.0).

30879

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

30880

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

30881

},

30882

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

30883

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

30884

"style": "A String", # The style of the border.

30885

},

30886

},

30887

"wrapStrategy": "A String", # The wrap strategy for the value in the cell.

30888

},

30889

},

30890

"gradientRule": { # A rule that applies a gradient color scale format, based on # The formatting will vary based on the gradients in the rule.

30891

# the interpolation points listed. The format of a cell will vary

30892

# based on its contents as compared to the values of the interpolation

30893

# points.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

30894

"maxpoint": { # A single interpolation point on a gradient conditional format. # The final interpolation point.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

30895

# These pin the gradient color scale according to the color,

30896

# type and value chosen.

30897

"color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.

30898

# for simplicity of conversion to/from color representations in various

30899

# languages over compactness; for example, the fields of this representation

30900

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

30901

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

30902

# method in iOS; and, with just a little work, it can be easily formatted into

30903

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

30908

#

30909

# // ...

30910

# public static java.awt.Color fromProto(Color protocolor) {

30911

# float alpha = protocolor.hasAlpha()

30912

# ? protocolor.getAlpha().getValue()

30913

# : 1.0;

30914

#

30915

# return new java.awt.Color(

30916

# protocolor.getRed(),

30917

# protocolor.getGreen(),

30918

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

30923

# float red = (float) color.getRed();

30924

# float green = (float) color.getGreen();

30925

# float blue = (float) color.getBlue();

30926

# float denominator = 255.0;

30927

# Color.Builder resultBuilder =

30928

# Color

30929

# .newBuilder()

30930

# .setRed(red / denominator)

30931

# .setGreen(green / denominator)

30932

# .setBlue(blue / denominator);

30933

# int alpha = color.getAlpha();

30934

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

30939

# .build());

30940

# }

30941

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

30946

#

30947

# // ...

30948

# static UIColor* fromProto(Color* protocolor) {

30949

# float red = [protocolor red];

30950

# float green = [protocolor green];

30951

# float blue = [protocolor blue];

30952

# FloatValue* alpha_wrapper = [protocolor alpha];

30953

# float alpha = 1.0;

30954

# if (alpha_wrapper != nil) {

30955

# alpha = [alpha_wrapper value];

30956

# }

30957

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

30958

# }

30959

#

30960

# static Color* toProto(UIColor* color) {

30961

# CGFloat red, green, blue, alpha;

30962

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

30963

# return nil;

30964

# }

30965

# Color* result = [Color alloc] init];

30966

# [result setRed:red];

30967

# [result setGreen:green];

30968

# [result setBlue:blue];

30969

# if (alpha <= 0.9999) {

30970

# [result setAlpha:floatWrapperWithValue(alpha)];

30971

# }

30972

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

30982

# var redFrac = rgb_color.red || 0.0;

30983

# var greenFrac = rgb_color.green || 0.0;

30984

# var blueFrac = rgb_color.blue || 0.0;

30985

# var red = Math.floor(redFrac * 255);

30986

# var green = Math.floor(greenFrac * 255);

30987

# var blue = Math.floor(blueFrac * 255);

30988

#

30989

# if (!('alpha' in rgb_color)) {

30990

# return rgbToCssColor_(red, green, blue);

30991

# }

30992

#

30993

# var alphaFrac = rgb_color.alpha.value || 0.0;

30994

# var rgbParams = [red, green, blue].join(',');

30995

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

30996

# };

30997

#

30998

# var rgbToCssColor_ = function(red, green, blue) {

30999

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

31000

# var hexString = rgbNumber.toString(16);

31001

# var missingZeros = 6 - hexString.length;

31002

# var resultBuilder = ['#'];

31003

# for (var i = 0; i < missingZeros; i++) {

31004

# resultBuilder.push('0');

31005

# }

31006

# resultBuilder.push(hexString);

31007

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

31012

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

31013

# the final pixel color is defined by the equation:

31014

#

31015

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

31016

#

31017

# This means that a value of 1.0 corresponds to a solid color, whereas

31018

# a value of 0.0 corresponds to a completely transparent color. This

31019

# uses a wrapper message rather than a simple float scalar so that it is

31020

# possible to distinguish between a default value and the value being unset.

31021

# If omitted, this color object is to be rendered as a solid color

31022

# (as if the alpha value had been explicitly given with a value of 1.0).

31023

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

31024

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

31025

},

31026

"type": "A String", # How the value should be interpreted.

31027

"value": "A String", # The value this interpolation point uses. May be a formula.

31028

# Unused if type is MIN or

31029

# MAX.

31030

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31031

"midpoint": { # A single interpolation point on a gradient conditional format. # An optional midway interpolation point.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31032

# These pin the gradient color scale according to the color,

31033

# type and value chosen.

31034

"color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.

31035

# for simplicity of conversion to/from color representations in various

31036

# languages over compactness; for example, the fields of this representation

31037

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

31038

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

31039

# method in iOS; and, with just a little work, it can be easily formatted into

31040

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

31045

#

31046

# // ...

31047

# public static java.awt.Color fromProto(Color protocolor) {

31048

# float alpha = protocolor.hasAlpha()

31049

# ? protocolor.getAlpha().getValue()

31050

# : 1.0;

31051

#

31052

# return new java.awt.Color(

31053

# protocolor.getRed(),

31054

# protocolor.getGreen(),

31055

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

31060

# float red = (float) color.getRed();

31061

# float green = (float) color.getGreen();

31062

# float blue = (float) color.getBlue();

31063

# float denominator = 255.0;

31064

# Color.Builder resultBuilder =

31065

# Color

31066

# .newBuilder()

31067

# .setRed(red / denominator)

31068

# .setGreen(green / denominator)

31069

# .setBlue(blue / denominator);

31070

# int alpha = color.getAlpha();

31071

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

31076

# .build());

31077

# }

31078

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

31083

#

31084

# // ...

31085

# static UIColor* fromProto(Color* protocolor) {

31086

# float red = [protocolor red];

31087

# float green = [protocolor green];

31088

# float blue = [protocolor blue];

31089

# FloatValue* alpha_wrapper = [protocolor alpha];

31090

# float alpha = 1.0;

31091

# if (alpha_wrapper != nil) {

31092

# alpha = [alpha_wrapper value];

31093

# }

31094

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

31095

# }

31096

#

31097

# static Color* toProto(UIColor* color) {

31098

# CGFloat red, green, blue, alpha;

31099

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

31100

# return nil;

31101

# }

31102

# Color* result = [Color alloc] init];

31103

# [result setRed:red];

31104

# [result setGreen:green];

31105

# [result setBlue:blue];

31106

# if (alpha <= 0.9999) {

31107

# [result setAlpha:floatWrapperWithValue(alpha)];

31108

# }

31109

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

31119

# var redFrac = rgb_color.red || 0.0;

31120

# var greenFrac = rgb_color.green || 0.0;

31121

# var blueFrac = rgb_color.blue || 0.0;

31122

# var red = Math.floor(redFrac * 255);

31123

# var green = Math.floor(greenFrac * 255);

31124

# var blue = Math.floor(blueFrac * 255);

31125

#

31126

# if (!('alpha' in rgb_color)) {

31127

# return rgbToCssColor_(red, green, blue);

31128

# }

31129

#

31130

# var alphaFrac = rgb_color.alpha.value || 0.0;

31131

# var rgbParams = [red, green, blue].join(',');

31132

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

31133

# };

31134

#

31135

# var rgbToCssColor_ = function(red, green, blue) {

31136

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

31137

# var hexString = rgbNumber.toString(16);

31138

# var missingZeros = 6 - hexString.length;

31139

# var resultBuilder = ['#'];

31140

# for (var i = 0; i < missingZeros; i++) {

31141

# resultBuilder.push('0');

31142

# }

31143

# resultBuilder.push(hexString);

31144

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

31149

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

31150

# the final pixel color is defined by the equation:

31151

#

31152

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

31153

#

31154

# This means that a value of 1.0 corresponds to a solid color, whereas

31155

# a value of 0.0 corresponds to a completely transparent color. This

31156

# uses a wrapper message rather than a simple float scalar so that it is

31157

# possible to distinguish between a default value and the value being unset.

31158

# If omitted, this color object is to be rendered as a solid color

31159

# (as if the alpha value had been explicitly given with a value of 1.0).

31160

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

31161

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

31162

},

31163

"type": "A String", # How the value should be interpreted.

31164

"value": "A String", # The value this interpolation point uses. May be a formula.

31165

# Unused if type is MIN or

31166

# MAX.

31167

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31168

"minpoint": { # A single interpolation point on a gradient conditional format. # The starting interpolation point.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31169

# These pin the gradient color scale according to the color,

31170

# type and value chosen.

31171

"color": { # Represents a color in the RGBA color space. This representation is designed # The color this interpolation point should use.

31172

# for simplicity of conversion to/from color representations in various

31173

# languages over compactness; for example, the fields of this representation

31174

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

31175

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

31176

# method in iOS; and, with just a little work, it can be easily formatted into

31177

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

31182

#

31183

# // ...

31184

# public static java.awt.Color fromProto(Color protocolor) {

31185

# float alpha = protocolor.hasAlpha()

31186

# ? protocolor.getAlpha().getValue()

31187

# : 1.0;

31188

#

31189

# return new java.awt.Color(

31190

# protocolor.getRed(),

31191

# protocolor.getGreen(),

31192

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

31197

# float red = (float) color.getRed();

31198

# float green = (float) color.getGreen();

31199

# float blue = (float) color.getBlue();

31200

# float denominator = 255.0;

31201

# Color.Builder resultBuilder =

31202

# Color

31203

# .newBuilder()

31204

# .setRed(red / denominator)

31205

# .setGreen(green / denominator)

31206

# .setBlue(blue / denominator);

31207

# int alpha = color.getAlpha();

31208

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

31213

# .build());

31214

# }

31215

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

31220

#

31221

# // ...

31222

# static UIColor* fromProto(Color* protocolor) {

31223

# float red = [protocolor red];

31224

# float green = [protocolor green];

31225

# float blue = [protocolor blue];

31226

# FloatValue* alpha_wrapper = [protocolor alpha];

31227

# float alpha = 1.0;

31228

# if (alpha_wrapper != nil) {

31229

# alpha = [alpha_wrapper value];

31230

# }

31231

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

31232

# }

31233

#

31234

# static Color* toProto(UIColor* color) {

31235

# CGFloat red, green, blue, alpha;

31236

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

31237

# return nil;

31238

# }

31239

# Color* result = [Color alloc] init];

31240

# [result setRed:red];

31241

# [result setGreen:green];

31242

# [result setBlue:blue];

31243

# if (alpha <= 0.9999) {

31244

# [result setAlpha:floatWrapperWithValue(alpha)];

31245

# }

31246

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

31256

# var redFrac = rgb_color.red || 0.0;

31257

# var greenFrac = rgb_color.green || 0.0;

31258

# var blueFrac = rgb_color.blue || 0.0;

31259

# var red = Math.floor(redFrac * 255);

31260

# var green = Math.floor(greenFrac * 255);

31261

# var blue = Math.floor(blueFrac * 255);

31262

#

31263

# if (!('alpha' in rgb_color)) {

31264

# return rgbToCssColor_(red, green, blue);

31265

# }

31266

#

31267

# var alphaFrac = rgb_color.alpha.value || 0.0;

31268

# var rgbParams = [red, green, blue].join(',');

31269

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

31270

# };

31271

#

31272

# var rgbToCssColor_ = function(red, green, blue) {

31273

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

31274

# var hexString = rgbNumber.toString(16);

31275

# var missingZeros = 6 - hexString.length;

31276

# var resultBuilder = ['#'];

31277

# for (var i = 0; i < missingZeros; i++) {

31278

# resultBuilder.push('0');

31279

# }

31280

# resultBuilder.push(hexString);

31281

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

31286

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

31287

# the final pixel color is defined by the equation:

31288

#

31289

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

31290

#

31291

# This means that a value of 1.0 corresponds to a solid color, whereas

31292

# a value of 0.0 corresponds to a completely transparent color. This

31293

# uses a wrapper message rather than a simple float scalar so that it is

31294

# possible to distinguish between a default value and the value being unset.

31295

# If omitted, this color object is to be rendered as a solid color

31296

# (as if the alpha value had been explicitly given with a value of 1.0).

31297

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

31298

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

31299

},

31300

"type": "A String", # How the value should be interpreted.

31301

"value": "A String", # The value this interpolation point uses. May be a formula.

31302

# Unused if type is MIN or

# MAX.

},

},

},

],

"merges": [ # The ranges that are merged together.

31309

{ # A range on a sheet.

31310

# All indexes are zero-based.

31311

# Indexes are half open, e.g the start index is inclusive

31312

# and the end index is exclusive -- [start_index, end_index).

31313

# Missing indexes indicate the range is unbounded on that side.

31314

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31315

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31316

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31317

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31318

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31319

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31320

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31321

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31322

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31323

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31324

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31325

# `Sheet1!A:B == sheet_id: 0,

31326

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31327

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31328

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31329

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31330

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31331

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31332

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31333

#

31334

# The start index must always be less than or equal to the end index.

31335

# If the start index equals the end index, then the range is empty.

31336

# Empty ranges are typically not meaningful and are usually rendered in the

31337

# UI as `#REF!`.

31338

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

31339

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

31340

"sheetId": 42, # The sheet this range is on.

31341

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

31342

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

31343

},

31344

],

31345

"basicFilter": { # The default filter associated with a sheet. # The filter on this sheet, if any.

31346

"range": { # A range on a sheet. # The range the filter covers.

31347

# All indexes are zero-based.

31348

# Indexes are half open, e.g the start index is inclusive

31349

# and the end index is exclusive -- [start_index, end_index).

31350

# Missing indexes indicate the range is unbounded on that side.

31351

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31352

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31353

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31354

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31355

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31356

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31357

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31358

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31359

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31360

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31361

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31362

# `Sheet1!A:B == sheet_id: 0,

31363

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31364

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31365

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31366

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31367

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31368

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31369

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31370

#

31371

# The start index must always be less than or equal to the end index.

31372

# If the start index equals the end index, then the range is empty.

31373

# Empty ranges are typically not meaningful and are usually rendered in the

31374

# UI as `#REF!`.

31375

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

31376

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

31377

"sheetId": 42, # The sheet this range is on.

31378

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

31379

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

31380

},

31381

"sortSpecs": [ # The sort order per column. Later specifications are used when values

31382

# are equal in the earlier specifications.

31383

{ # A sort order associated with a specific column or row.

31384

"sortOrder": "A String", # The order data should be sorted.

31385

"dimensionIndex": 42, # The dimension the sort should be applied to.

31386

},

31387

],

31388

"criteria": { # The criteria for showing/hiding values per column.

31389

# The map's key is the column index, and the value is the criteria for

31390

# that column.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31391

"a_key": { # Criteria for showing/hiding rows in a filter or filter view.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31392

"hiddenValues": [ # Values that should be hidden.

31393

"A String",

31394

],

31395

"condition": { # A condition that can evaluate to true or false. # A condition that must be true for values to be shown.

31396

# (This does not override hiddenValues -- if a value is listed there,

31397

# it will still be hidden.)

31398

# BooleanConditions are used by conditional formatting,

31399

# data validation, and the criteria in filters.

31400

"type": "A String", # The type of condition.

31401

"values": [ # The values of the condition. The number of supported values depends

31402

# on the condition type. Some support zero values,

31403

# others one or two values,

31404

# and ConditionType.ONE_OF_LIST supports an arbitrary number of values.

31405

{ # The value of the condition.

31406

"relativeDate": "A String", # A relative date (based on the current date).

31407

# Valid only if the type is

31408

# DATE_BEFORE,

31409

# DATE_AFTER,

31410

# DATE_ON_OR_BEFORE or

31411

# DATE_ON_OR_AFTER.

31412

#

31413

# Relative dates are not supported in data validation.

31414

# They are supported only in conditional formatting and

31415

# conditional filters.

31416

"userEnteredValue": "A String", # A value the condition is based on.

31417

# The value will be parsed as if the user typed into a cell.

31418

# Formulas are supported (and must begin with an `=`).

},

],

},

},

},

},

"charts": [ # The specifications of every chart on this sheet.

31426

{ # A chart embedded in a sheet.

31427

"chartId": 42, # The ID of the chart.

31428

"position": { # The position of an embedded object such as a chart. # The position of the chart.

31429

"newSheet": True or False, # If true, the embedded object will be put on a new sheet whose ID

31430

# is chosen for you. Used only when writing.

31431

"sheetId": 42, # The sheet this is on. Set only if the embedded object

31432

# is on its own sheet. Must be non-negative.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31433

"overlayPosition": { # The location an object is overlaid on top of a grid. # The position at which the object is overlaid on top of a grid.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31434

"anchorCell": { # A coordinate in a sheet. # The cell the object is anchored to.

31435

# All indexes are zero-based.

31436

"rowIndex": 42, # The row index of the coordinate.

31437

"columnIndex": 42, # The column index of the coordinate.

31438

"sheetId": 42, # The sheet this coordinate is on.

31439

},

31440

"offsetYPixels": 42, # The vertical offset, in pixels, that the object is offset

31441

# from the anchor cell.

31442

"widthPixels": 42, # The width of the object, in pixels. Defaults to 600.

31443

"offsetXPixels": 42, # The horizontal offset, in pixels, that the object is offset

31444

# from the anchor cell.

31445

"heightPixels": 42, # The height of the object, in pixels. Defaults to 371.

31446

},

31447

},

31448

"spec": { # The specifications of a chart. # The specification of the chart.

31449

"hiddenDimensionStrategy": "A String", # Determines how the charts will use hidden rows or columns.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31450

"pieChart": { # A <a href="/chart/interactive/docs/gallery/piechart">pie chart</a>. # A pie chart specification.

31451

"series": { # The data included in a domain or series. # The data that covers the one and only series of the pie chart.

31452

"sourceRange": { # Source ranges for a chart. # The source ranges of the data.

31453

"sources": [ # The ranges of data for a series or domain.

31454

# Exactly one dimension must have a length of 1,

31455

# and all sources in the list must have the same dimension

31456

# with length 1.

31457

# The domain (if it exists) & all series must have the same number

31458

# of source ranges. If using more than one source range, then the source

31459

# range at a given offset must be contiguous across the domain and series.

31460

#

31461

# For example, these are valid configurations:

31462

#

31463

# domain sources: A1:A5

31464

# series1 sources: B1:B5

31465

# series2 sources: D6:D10

31466

#

31467

# domain sources: A1:A5, C10:C12

31468

# series1 sources: B1:B5, D10:D12

31469

# series2 sources: C1:C5, E10:E12

31470

{ # A range on a sheet.

31471

# All indexes are zero-based.

31472

# Indexes are half open, e.g the start index is inclusive

31473

# and the end index is exclusive -- [start_index, end_index).

31474

# Missing indexes indicate the range is unbounded on that side.

31475

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31476

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31477

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31478

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31479

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31480

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31481

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31482

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31483

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31484

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31485

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31486

# `Sheet1!A:B == sheet_id: 0,

31487

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31488

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31489

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31490

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31491

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31492

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31493

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31494

#

31495

# The start index must always be less than or equal to the end index.

31496

# If the start index equals the end index, then the range is empty.

31497

# Empty ranges are typically not meaningful and are usually rendered in the

31498

# UI as `#REF!`.

31499

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

31500

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

31501

"sheetId": 42, # The sheet this range is on.

31502

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

31503

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

],

},

},

"domain": { # The data included in a domain or series. # The data that covers the domain of the pie chart.

31509

"sourceRange": { # Source ranges for a chart. # The source ranges of the data.

31510

"sources": [ # The ranges of data for a series or domain.

31511

# Exactly one dimension must have a length of 1,

31512

# and all sources in the list must have the same dimension

31513

# with length 1.

31514

# The domain (if it exists) & all series must have the same number

31515

# of source ranges. If using more than one source range, then the source

31516

# range at a given offset must be contiguous across the domain and series.

31517

#

31518

# For example, these are valid configurations:

31519

#

31520

# domain sources: A1:A5

31521

# series1 sources: B1:B5

31522

# series2 sources: D6:D10

31523

#

31524

# domain sources: A1:A5, C10:C12

31525

# series1 sources: B1:B5, D10:D12

31526

# series2 sources: C1:C5, E10:E12

31527

{ # A range on a sheet.

31528

# All indexes are zero-based.

31529

# Indexes are half open, e.g the start index is inclusive

31530

# and the end index is exclusive -- [start_index, end_index).

31531

# Missing indexes indicate the range is unbounded on that side.

31532

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31533

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31534

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31535

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31536

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31537

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31538

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31539

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31540

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31541

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31542

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31543

# `Sheet1!A:B == sheet_id: 0,

31544

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31545

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31546

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31547

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31548

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31549

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31550

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31551

#

31552

# The start index must always be less than or equal to the end index.

31553

# If the start index equals the end index, then the range is empty.

31554

# Empty ranges are typically not meaningful and are usually rendered in the

31555

# UI as `#REF!`.

31556

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

31557

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

31558

"sheetId": 42, # The sheet this range is on.

31559

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

31560

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

],

},

},

"threeDimensional": True or False, # True if the pie is three dimensional.

31566

"legendPosition": "A String", # Where the legend of the pie chart should be drawn.

31567

"pieHole": 3.14, # The size of the hole in the pie chart.

31568

},

31569

"basicChart": { # The specification for a basic chart. See BasicChartType for the list # A basic chart specification, can be one of many kinds of charts.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31570

# See BasicChartType for the list of all

31571

# charts this supports.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31572

# of charts this supports.

31573

"headerCount": 42, # The number of rows or columns in the data that are "headers".

31574

# If not set, Google Sheets will guess how many rows are headers based

31575

# on the data.

31576

#

31577

# (Note that BasicChartAxis.title may override the axis title

31578

# inferred from the header values.)

31579

"series": [ # The data this chart is visualizing.

31580

{ # A single series of data in a chart.

31581

# For example, if charting stock prices over time, multiple series may exist,

31582

# one for the "Open Price", "High Price", "Low Price" and "Close Price".

31583

"series": { # The data included in a domain or series. # The data being visualized in this chart series.

31584

"sourceRange": { # Source ranges for a chart. # The source ranges of the data.

31585

"sources": [ # The ranges of data for a series or domain.

31586

# Exactly one dimension must have a length of 1,

31587

# and all sources in the list must have the same dimension

31588

# with length 1.

31589

# The domain (if it exists) & all series must have the same number

31590

# of source ranges. If using more than one source range, then the source

31591

# range at a given offset must be contiguous across the domain and series.

31592

#

31593

# For example, these are valid configurations:

31594

#

31595

# domain sources: A1:A5

31596

# series1 sources: B1:B5

31597

# series2 sources: D6:D10

31598

#

31599

# domain sources: A1:A5, C10:C12

31600

# series1 sources: B1:B5, D10:D12

31601

# series2 sources: C1:C5, E10:E12

31602

{ # A range on a sheet.

31603

# All indexes are zero-based.

31604

# Indexes are half open, e.g the start index is inclusive

31605

# and the end index is exclusive -- [start_index, end_index).

31606

# Missing indexes indicate the range is unbounded on that side.

31607

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31608

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31609

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31610

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31611

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31612

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31613

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31614

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31615

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31616

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31617

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31618

# `Sheet1!A:B == sheet_id: 0,

31619

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31620

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31621

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31622

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31623

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31624

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31625

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31626

#

31627

# The start index must always be less than or equal to the end index.

31628

# If the start index equals the end index, then the range is empty.

31629

# Empty ranges are typically not meaningful and are usually rendered in the

31630

# UI as `#REF!`.

31631

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

31632

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

31633

"sheetId": 42, # The sheet this range is on.

31634

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

31635

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

],

},

},

"targetAxis": "A String", # The minor axis that will specify the range of values for this series.

31641

# For example, if charting stocks over time, the "Volume" series

31642

# may want to be pinned to the right with the prices pinned to the left,

31643

# because the scale of trading volume is different than the scale of

31644

# prices.

31645

# It is an error to specify an axis that isn't a valid minor axis

31646

# for the chart's type.

31647

"type": "A String", # The type of this series. Valid only if the

31648

# chartType is

31649

# COMBO.

31650

# Different types will change the way the series is visualized.

31651

# Only LINE, AREA,

31652

# and COLUMN are supported.

31653

},

31654

],

31655

"legendPosition": "A String", # The position of the chart legend.

31656

"domains": [ # The domain of data this is charting.

31657

# Only a single domain is currently supported.

31658

{ # The domain of a chart.

31659

# For example, if charting stock prices over time, this would be the date.

31660

"domain": { # The data included in a domain or series. # The data of the domain. For example, if charting stock prices over time,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31661

# this is the data representing the dates.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31662

"sourceRange": { # Source ranges for a chart. # The source ranges of the data.

31663

"sources": [ # The ranges of data for a series or domain.

31664

# Exactly one dimension must have a length of 1,

31665

# and all sources in the list must have the same dimension

31666

# with length 1.

31667

# The domain (if it exists) & all series must have the same number

31668

# of source ranges. If using more than one source range, then the source

31669

# range at a given offset must be contiguous across the domain and series.

31670

#

31671

# For example, these are valid configurations:

31672

#

31673

# domain sources: A1:A5

31674

# series1 sources: B1:B5

31675

# series2 sources: D6:D10

31676

#

31677

# domain sources: A1:A5, C10:C12

31678

# series1 sources: B1:B5, D10:D12

31679

# series2 sources: C1:C5, E10:E12

31680

{ # A range on a sheet.

31681

# All indexes are zero-based.

31682

# Indexes are half open, e.g the start index is inclusive

31683

# and the end index is exclusive -- [start_index, end_index).

31684

# Missing indexes indicate the range is unbounded on that side.

31685

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31686

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31687

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31688

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31689

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31690

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31691

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31692

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31693

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31694

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31695

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31696

# `Sheet1!A:B == sheet_id: 0,

31697

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31698

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31699

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31700

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31701

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31702

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31703

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31704

#

31705

# The start index must always be less than or equal to the end index.

31706

# If the start index equals the end index, then the range is empty.

31707

# Empty ranges are typically not meaningful and are usually rendered in the

31708

# UI as `#REF!`.

31709

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

31710

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

31711

"sheetId": 42, # The sheet this range is on.

31712

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

31713

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

],

},

},

},

],

"chartType": "A String", # The type of the chart.

31721

"axis": [ # The axis on the chart.

31722

{ # An axis of the chart.

31723

# A chart may not have more than one axis per

31724

# axis position.

31725

"position": "A String", # The position of this axis.

31726

"format": { # The format of a run of text in a cell. # The format of the title.

31727

# Only valid if the axis is not associated with the domain.

31728

# Absent values indicate that the field isn't specified.

31729

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

31730

# for simplicity of conversion to/from color representations in various

31731

# languages over compactness; for example, the fields of this representation

31732

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

31733

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

31734

# method in iOS; and, with just a little work, it can be easily formatted into

31735

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

31740

#

31741

# // ...

31742

# public static java.awt.Color fromProto(Color protocolor) {

31743

# float alpha = protocolor.hasAlpha()

31744

# ? protocolor.getAlpha().getValue()

31745

# : 1.0;

31746

#

31747

# return new java.awt.Color(

31748

# protocolor.getRed(),

31749

# protocolor.getGreen(),

31750

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

31755

# float red = (float) color.getRed();

31756

# float green = (float) color.getGreen();

31757

# float blue = (float) color.getBlue();

31758

# float denominator = 255.0;

31759

# Color.Builder resultBuilder =

31760

# Color

31761

# .newBuilder()

31762

# .setRed(red / denominator)

31763

# .setGreen(green / denominator)

31764

# .setBlue(blue / denominator);

31765

# int alpha = color.getAlpha();

31766

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

31771

# .build());

31772

# }

31773

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

31778

#

31779

# // ...

31780

# static UIColor* fromProto(Color* protocolor) {

31781

# float red = [protocolor red];

31782

# float green = [protocolor green];

31783

# float blue = [protocolor blue];

31784

# FloatValue* alpha_wrapper = [protocolor alpha];

31785

# float alpha = 1.0;

31786

# if (alpha_wrapper != nil) {

31787

# alpha = [alpha_wrapper value];

31788

# }

31789

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

31790

# }

31791

#

31792

# static Color* toProto(UIColor* color) {

31793

# CGFloat red, green, blue, alpha;

31794

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

31795

# return nil;

31796

# }

31797

# Color* result = [Color alloc] init];

31798

# [result setRed:red];

31799

# [result setGreen:green];

31800

# [result setBlue:blue];

31801

# if (alpha <= 0.9999) {

31802

# [result setAlpha:floatWrapperWithValue(alpha)];

31803

# }

31804

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

31814

# var redFrac = rgb_color.red || 0.0;

31815

# var greenFrac = rgb_color.green || 0.0;

31816

# var blueFrac = rgb_color.blue || 0.0;

31817

# var red = Math.floor(redFrac * 255);

31818

# var green = Math.floor(greenFrac * 255);

31819

# var blue = Math.floor(blueFrac * 255);

31820

#

31821

# if (!('alpha' in rgb_color)) {

31822

# return rgbToCssColor_(red, green, blue);

31823

# }

31824

#

31825

# var alphaFrac = rgb_color.alpha.value || 0.0;

31826

# var rgbParams = [red, green, blue].join(',');

31827

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

31828

# };

31829

#

31830

# var rgbToCssColor_ = function(red, green, blue) {

31831

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

31832

# var hexString = rgbNumber.toString(16);

31833

# var missingZeros = 6 - hexString.length;

31834

# var resultBuilder = ['#'];

31835

# for (var i = 0; i < missingZeros; i++) {

31836

# resultBuilder.push('0');

31837

# }

31838

# resultBuilder.push(hexString);

31839

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

31844

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

31845

# the final pixel color is defined by the equation:

31846

#

31847

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

31848

#

31849

# This means that a value of 1.0 corresponds to a solid color, whereas

31850

# a value of 0.0 corresponds to a completely transparent color. This

31851

# uses a wrapper message rather than a simple float scalar so that it is

31852

# possible to distinguish between a default value and the value being unset.

31853

# If omitted, this color object is to be rendered as a solid color

31854

# (as if the alpha value had been explicitly given with a value of 1.0).

31855

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

31856

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

31857

},

31858

"bold": True or False, # True if the text is bold.

31859

"strikethrough": True or False, # True if the text has a strikethrough.

31860

"fontFamily": "A String", # The font family.

31861

"fontSize": 42, # The size of the font.

31862

"italic": True or False, # True if the text is italicized.

31863

"underline": True or False, # True if the text is underlined.

31864

},

31865

"title": "A String", # The title of this axis. If set, this overrides any title inferred

31866

# from headers of the data.

},

],

},

"title": "A String", # The title of the chart.

},

},

],

"filterViews": [ # The filter views in this sheet.

31875

{ # A filter view.

31876

"title": "A String", # The name of the filter view.

31877

"namedRangeId": "A String", # The named range this filter view is backed by, if any.

31878

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31879

# When writing, only one of range or named_range_id

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31880

# may be set.

31881

"filterViewId": 42, # The ID of the filter view.

31882

"range": { # A range on a sheet. # The range this filter view covers.

31883

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31884

# When writing, only one of range or named_range_id

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31885

# may be set.

31886

# All indexes are zero-based.

31887

# Indexes are half open, e.g the start index is inclusive

31888

# and the end index is exclusive -- [start_index, end_index).

31889

# Missing indexes indicate the range is unbounded on that side.

31890

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31891

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31892

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31893

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31894

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31895

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31896

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31897

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31898

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31899

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31900

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31901

# `Sheet1!A:B == sheet_id: 0,

31902

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31903

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31904

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31905

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31906

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31907

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31908

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31909

#

31910

# The start index must always be less than or equal to the end index.

31911

# If the start index equals the end index, then the range is empty.

31912

# Empty ranges are typically not meaningful and are usually rendered in the

31913

# UI as `#REF!`.

31914

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

31915

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

31916

"sheetId": 42, # The sheet this range is on.

31917

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

31918

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

31919

},

31920

"sortSpecs": [ # The sort order per column. Later specifications are used when values

31921

# are equal in the earlier specifications.

31922

{ # A sort order associated with a specific column or row.

31923

"sortOrder": "A String", # The order data should be sorted.

31924

"dimensionIndex": 42, # The dimension the sort should be applied to.

31925

},

31926

],

31927

"criteria": { # The criteria for showing/hiding values per column.

31928

# The map's key is the column index, and the value is the criteria for

31929

# that column.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31930

"a_key": { # Criteria for showing/hiding rows in a filter or filter view.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31931

"hiddenValues": [ # Values that should be hidden.

31932

"A String",

31933

],

31934

"condition": { # A condition that can evaluate to true or false. # A condition that must be true for values to be shown.

31935

# (This does not override hiddenValues -- if a value is listed there,

31936

# it will still be hidden.)

31937

# BooleanConditions are used by conditional formatting,

31938

# data validation, and the criteria in filters.

31939

"type": "A String", # The type of condition.

31940

"values": [ # The values of the condition. The number of supported values depends

31941

# on the condition type. Some support zero values,

31942

# others one or two values,

31943

# and ConditionType.ONE_OF_LIST supports an arbitrary number of values.

31944

{ # The value of the condition.

31945

"relativeDate": "A String", # A relative date (based on the current date).

31946

# Valid only if the type is

31947

# DATE_BEFORE,

31948

# DATE_AFTER,

31949

# DATE_ON_OR_BEFORE or

31950

# DATE_ON_OR_AFTER.

31951

#

31952

# Relative dates are not supported in data validation.

31953

# They are supported only in conditional formatting and

31954

# conditional filters.

31955

"userEnteredValue": "A String", # A value the condition is based on.

31956

# The value will be parsed as if the user typed into a cell.

31957

# Formulas are supported (and must begin with an `=`).

},

],

},

},

},

},

],

"protectedRanges": [ # The protected ranges in this sheet.

31966

{ # A protected range.

31967

"unprotectedRanges": [ # The list of unprotected ranges within a protected sheet.

31968

# Unprotected ranges are only supported on protected sheets.

31969

{ # A range on a sheet.

31970

# All indexes are zero-based.

31971

# Indexes are half open, e.g the start index is inclusive

31972

# and the end index is exclusive -- [start_index, end_index).

31973

# Missing indexes indicate the range is unbounded on that side.

31974

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31975

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31976

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31977

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31978

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31979

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31980

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31981

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31982

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31983

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31984

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31985

# `Sheet1!A:B == sheet_id: 0,

31986

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31987

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31988

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31989

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31990

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31991

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

31992

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

31993

#

31994

# The start index must always be less than or equal to the end index.

31995

# If the start index equals the end index, then the range is empty.

31996

# Empty ranges are typically not meaningful and are usually rendered in the

31997

# UI as `#REF!`.

31998

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

31999

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

32000

"sheetId": 42, # The sheet this range is on.

32001

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

32002

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

32003

},

32004

],

32005

"requestingUserCanEdit": True or False, # True if the user who requested this protected range can edit the

32006

# protected area.

32007

# This field is read-only.

32008

"description": "A String", # The description of this protected range.

32009

"namedRangeId": "A String", # The named range this protected range is backed by, if any.

32010

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32011

# When writing, only one of range or named_range_id

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32012

# may be set.

32013

"editors": { # The editors of a protected range. # The users and groups with edit access to the protected range.

32014

# This field is only visible to users with edit access to the protected

32015

# range and the document.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32016

# Editors are not supported with warning_only protection.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32017

"domainUsersCanEdit": True or False, # True if anyone in the document's domain has edit access to the protected

32018

# range. Domain protection is only supported on documents within a domain.

32019

"users": [ # The email addresses of users with edit access to the protected range.

32020

"A String",

32021

],

32022

"groups": [ # The email addresses of groups with edit access to the protected range.

"A String",

],

},

"protectedRangeId": 42, # The ID of the protected range.

32027

# This field is read-only.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32028

"warningOnly": True or False, # True if this protected range will show a warning when editing.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32029

# Warning-based protection means that every user can edit data in the

32030

# protected range, except editing will prompt a warning asking the user

32031

# to confirm the edit.

32032

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32033

# When writing: if this field is true, then editors is ignored.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32034

# Additionally, if this field is changed from true to false and the

32035

# `editors` field is not set (nor included in the field mask), then

32036

# the editors will be set to all the editors in the document.

32037

"range": { # A range on a sheet. # The range that is being protected.

32038

# The range may be fully unbounded, in which case this is considered

32039

# a protected sheet.

32040

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32041

# When writing, only one of range or named_range_id

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32042

# may be set.

32043

# All indexes are zero-based.

32044

# Indexes are half open, e.g the start index is inclusive

32045

# and the end index is exclusive -- [start_index, end_index).

32046

# Missing indexes indicate the range is unbounded on that side.

32047

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32048

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32049

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32050

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32051

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32052

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32053

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32054

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32055

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32056

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32057

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32058

# `Sheet1!A:B == sheet_id: 0,

32059

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32060

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32061

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32062

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32063

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32064

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32065

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32066

#

32067

# The start index must always be less than or equal to the end index.

32068

# If the start index equals the end index, then the range is empty.

32069

# Empty ranges are typically not meaningful and are usually rendered in the

32070

# UI as `#REF!`.

32071

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

32072

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

32073

"sheetId": 42, # The sheet this range is on.

32074

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

32075

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

},

},

],

"data": [ # Data in the grid, if this is a grid sheet.

32080

# The number of GridData objects returned is dependent on the number of

32081

# ranges requested on this sheet. For example, if this is representing

32082

# `Sheet1`, and the spreadsheet was requested with ranges

32083

# `Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a

32084

# startRow/startColumn of `0`,

32085

# while the second one will have `startRow 14` (zero-based row 15),

32086

# and `startColumn 3` (zero-based column D).

32087

{ # Data in the grid, as well as metadata about the dimensions.

32088

"startRow": 42, # The first row this GridData refers to, zero-based.

32089

"rowMetadata": [ # Metadata about the requested rows in the grid, starting with the row

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32090

# in start_row.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32091

{ # Properties about a dimension.

32092

"pixelSize": 42, # The height (if a row) or width (if a column) of the dimension in pixels.

32093

"hiddenByUser": True or False, # True if this dimension is explicitly hidden.

32094

"hiddenByFilter": True or False, # True if this dimension is being filtered.

32095

# This field is read-only.

32096

},

32097

],

32098

"startColumn": 42, # The first column this GridData refers to, zero-based.

32099

"columnMetadata": [ # Metadata about the requested columns in the grid, starting with the column

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32100

# in start_column.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32101

{ # Properties about a dimension.

32102

"pixelSize": 42, # The height (if a row) or width (if a column) of the dimension in pixels.

32103

"hiddenByUser": True or False, # True if this dimension is explicitly hidden.

32104

"hiddenByFilter": True or False, # True if this dimension is being filtered.

32105

# This field is read-only.

32106

},

32107

],

32108

"rowData": [ # The data in the grid, one entry per row,

32109

# starting with the row in startRow.

32110

# The values in RowData will correspond to columns starting

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32111

# at start_column.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32112

{ # Data about each cell in a row.

32113

"values": [ # The values in the row, one per column.

32114

{ # Data about a specific cell.

32115

"pivotTable": { # A pivot table. # A pivot table anchored at this cell. The size of pivot table itself

32116

# is computed dynamically based on its data, grouping, filters, values,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32117

# etc. Only the top-left cell of the pivot table contains the pivot table

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32118

# definition. The other cells will contain the calculated values of the

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32119

# results of the pivot in their effective_value fields.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32120

"valueLayout": "A String", # Whether values should be listed horizontally (as columns)

32121

# or vertically (as rows).

32122

"rows": [ # Each row grouping in the pivot table.

32123

{ # A single grouping (either row or column) in a pivot table.

32124

"showTotals": True or False, # True if the pivot table should include the totals for this grouping.

32125

"valueMetadata": [ # Metadata about values in the grouping.

32126

{ # Metadata about a value in a pivot grouping.

32127

"collapsed": True or False, # True if the data corresponding to the value is collapsed.

32128

"value": { # The kinds of value that a cell in a spreadsheet can have. # The calculated value the metadata corresponds to.

32129

# (Note that formulaValue is not valid,

32130

# because the values will be calculated.)

32131

"numberValue": 3.14, # Represents a double value.

32132

# Note: Dates, Times and DateTimes are represented as doubles in

32133

# "serial number" format.

32134

"boolValue": True or False, # Represents a boolean value.

32135

"formulaValue": "A String", # Represents a formula.

32136

"stringValue": "A String", # Represents a string value.

32137

# Leading single quotes are not included. For example, if the user typed

32138

# `'123` into the UI, this would be represented as a `stringValue` of

32139

# `"123"`.

32140

"errorValue": { # An error in a cell. # Represents an error.

32141

# This field is read-only.

32142

"message": "A String", # A message with more information about the error

32143

# (in the spreadsheet's locale).

32144

"type": "A String", # The type of error.

},

},

},

],

"valueBucket": { # Information about which values in a pivot group should be used for sorting. # The bucket of the opposite pivot group to sort by.

32150

# If not specified, sorting is alphabetical by this group's values.

32151

"buckets": [ # Determines the bucket from which values are chosen to sort.

32152

#

32153

# For example, in a pivot table with one row group & two column groups,

32154

# the row group can list up to two values. The first value corresponds

32155

# to a value within the first column group, and the second value

32156

# corresponds to a value in the second column group. If no values

32157

# are listed, this would indicate that the row should be sorted according

32158

# to the "Grand Total" over the column groups. If a single value is listed,

32159

# this would correspond to using the "Total" of that bucket.

32160

{ # The kinds of value that a cell in a spreadsheet can have.

32161

"numberValue": 3.14, # Represents a double value.

32162

# Note: Dates, Times and DateTimes are represented as doubles in

32163

# "serial number" format.

32164

"boolValue": True or False, # Represents a boolean value.

32165

"formulaValue": "A String", # Represents a formula.

32166

"stringValue": "A String", # Represents a string value.

32167

# Leading single quotes are not included. For example, if the user typed

32168

# `'123` into the UI, this would be represented as a `stringValue` of

32169

# `"123"`.

32170

"errorValue": { # An error in a cell. # Represents an error.

32171

# This field is read-only.

32172

"message": "A String", # A message with more information about the error

32173

# (in the spreadsheet's locale).

32174

"type": "A String", # The type of error.

32175

},

32176

},

32177

],

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32178

"valuesIndex": 42, # The offset in the PivotTable.values list which the values in this

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32179

# grouping should be sorted by.

32180

},

32181

"sortOrder": "A String", # The order the values in this group should be sorted.

32182

"sourceColumnOffset": 42, # The column offset of the source range that this grouping is based on.

32183

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32184

# For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32185

# means this group refers to column `C`, whereas the offset `1` would refer

# to column `D`.

},

],

"source": { # A range on a sheet. # The range the pivot table is reading data from.

32190

# All indexes are zero-based.

32191

# Indexes are half open, e.g the start index is inclusive

32192

# and the end index is exclusive -- [start_index, end_index).

32193

# Missing indexes indicate the range is unbounded on that side.

32194

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32195

# For example, if `"Sheet1"` is sheet ID 0, then:

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32196

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32197

# `Sheet1!A1:A1 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32198

# start_row_index: 0, end_row_index: 1,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32199

# start_column_index: 0, end_column_index: 1`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32200

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32201

# `Sheet1!A3:B4 == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32202

# start_row_index: 2, end_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32203

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32204

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32205

# `Sheet1!A:B == sheet_id: 0,

32206

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32207

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32208

# `Sheet1!A5:B == sheet_id: 0,

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32209

# start_row_index: 4,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32210

# start_column_index: 0, end_column_index: 2`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32211

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32212

# `Sheet1 == sheet_id:0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32213

#

32214

# The start index must always be less than or equal to the end index.

32215

# If the start index equals the end index, then the range is empty.

32216

# Empty ranges are typically not meaningful and are usually rendered in the

32217

# UI as `#REF!`.

32218

"endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.

32219

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.

32220

"sheetId": 42, # The sheet this range is on.

32221

"startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.

32222

"endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.

32223

},

32224

"values": [ # A list of values to include in the pivot table.

32225

{ # The definition of how a value in a pivot table should be calculated.

32226

"formula": "A String", # A custom formula to calculate the value. The formula must start

32227

# with an `=` character.

32228

"summarizeFunction": "A String", # A function to summarize the value.

32229

# If formula is set, the only supported values are

32230

# SUM and

32231

# CUSTOM.

32232

# If sourceColumnOffset is set, then `CUSTOM`

32233

# is not supported.

32234

"sourceColumnOffset": 42, # The column offset of the source range that this value reads from.

32235

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32236

# For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32237

# means this value refers to column `C`, whereas the offset `1` would

32238

# refer to column `D`.

32239

"name": "A String", # A name to use for the value. This is only used if formula was set.

32240

# Otherwise, the column name is used.

32241

},

32242

],

32243

"criteria": { # An optional mapping of filters per source column offset.

32244

#

32245

# The filters will be applied before aggregating data into the pivot table.

32246

# The map's key is the column offset of the source range that you want to

32247

# filter, and the value is the criteria for that column.

32248

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32249

# For example, if the source was `C10:E15`, a key of `0` will have the filter

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32250

# for column `C`, whereas the key `1` is for column `D`.

32251

"a_key": { # Criteria for showing/hiding rows in a pivot table.

32252

"visibleValues": [ # Values that should be included. Values not listed here are excluded.

"A String",

],

},

},

"columns": [ # Each column grouping in the pivot table.

32258

{ # A single grouping (either row or column) in a pivot table.

32259

"showTotals": True or False, # True if the pivot table should include the totals for this grouping.

32260

"valueMetadata": [ # Metadata about values in the grouping.

32261

{ # Metadata about a value in a pivot grouping.

32262

"collapsed": True or False, # True if the data corresponding to the value is collapsed.

32263

"value": { # The kinds of value that a cell in a spreadsheet can have. # The calculated value the metadata corresponds to.

32264

# (Note that formulaValue is not valid,

32265

# because the values will be calculated.)

32266

"numberValue": 3.14, # Represents a double value.

32267

# Note: Dates, Times and DateTimes are represented as doubles in

32268

# "serial number" format.

32269

"boolValue": True or False, # Represents a boolean value.

32270

"formulaValue": "A String", # Represents a formula.

32271

"stringValue": "A String", # Represents a string value.

32272

# Leading single quotes are not included. For example, if the user typed

32273

# `'123` into the UI, this would be represented as a `stringValue` of

32274

# `"123"`.

32275

"errorValue": { # An error in a cell. # Represents an error.

32276

# This field is read-only.

32277

"message": "A String", # A message with more information about the error

32278

# (in the spreadsheet's locale).

32279

"type": "A String", # The type of error.

},

},

},

],

"valueBucket": { # Information about which values in a pivot group should be used for sorting. # The bucket of the opposite pivot group to sort by.

32285

# If not specified, sorting is alphabetical by this group's values.

32286

"buckets": [ # Determines the bucket from which values are chosen to sort.

32287

#

32288

# For example, in a pivot table with one row group & two column groups,

32289

# the row group can list up to two values. The first value corresponds

32290

# to a value within the first column group, and the second value

32291

# corresponds to a value in the second column group. If no values

32292

# are listed, this would indicate that the row should be sorted according

32293

# to the "Grand Total" over the column groups. If a single value is listed,

32294

# this would correspond to using the "Total" of that bucket.

32295

{ # The kinds of value that a cell in a spreadsheet can have.

32296

"numberValue": 3.14, # Represents a double value.

32297

# Note: Dates, Times and DateTimes are represented as doubles in

32298

# "serial number" format.

32299

"boolValue": True or False, # Represents a boolean value.

32300

"formulaValue": "A String", # Represents a formula.

32301

"stringValue": "A String", # Represents a string value.

32302

# Leading single quotes are not included. For example, if the user typed

32303

# `'123` into the UI, this would be represented as a `stringValue` of

32304

# `"123"`.

32305

"errorValue": { # An error in a cell. # Represents an error.

32306

# This field is read-only.

32307

"message": "A String", # A message with more information about the error

32308

# (in the spreadsheet's locale).

32309

"type": "A String", # The type of error.

32310

},

32311

},

32312

],

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32313

"valuesIndex": 42, # The offset in the PivotTable.values list which the values in this

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32314

# grouping should be sorted by.

32315

},

32316

"sortOrder": "A String", # The order the values in this group should be sorted.

32317

"sourceColumnOffset": 42, # The column offset of the source range that this grouping is based on.

32318

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32319

# For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32320

# means this group refers to column `C`, whereas the offset `1` would refer

# to column `D`.

},

],

},

"hyperlink": "A String", # A hyperlink this cell points to, if any.

32326

# This field is read-only. (To set it, use a `=HYPERLINK` formula.)

32327

"effectiveValue": { # The kinds of value that a cell in a spreadsheet can have. # The effective value of the cell. For cells with formulas, this will be

32328

# the calculated value. For cells with literals, this will be

32329

# the same as the user_entered_value.

32330

# This field is read-only.

32331

"numberValue": 3.14, # Represents a double value.

32332

# Note: Dates, Times and DateTimes are represented as doubles in

32333

# "serial number" format.

32334

"boolValue": True or False, # Represents a boolean value.

32335

"formulaValue": "A String", # Represents a formula.

32336

"stringValue": "A String", # Represents a string value.

32337

# Leading single quotes are not included. For example, if the user typed

32338

# `'123` into the UI, this would be represented as a `stringValue` of

32339

# `"123"`.

32340

"errorValue": { # An error in a cell. # Represents an error.

32341

# This field is read-only.

32342

"message": "A String", # A message with more information about the error

32343

# (in the spreadsheet's locale).

32344

"type": "A String", # The type of error.

32345

},

32346

},

32347

"formattedValue": "A String", # The formatted value of the cell.

32348

# This is the value as it's shown to the user.

32349

# This field is read-only.

32350

"userEnteredValue": { # The kinds of value that a cell in a spreadsheet can have. # The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`

32351

# Note: Dates, Times and DateTimes are represented as doubles in

32352

# serial number format.

32353

"numberValue": 3.14, # Represents a double value.

32354

# Note: Dates, Times and DateTimes are represented as doubles in

32355

# "serial number" format.

32356

"boolValue": True or False, # Represents a boolean value.

32357

"formulaValue": "A String", # Represents a formula.

32358

"stringValue": "A String", # Represents a string value.

32359

# Leading single quotes are not included. For example, if the user typed

32360

# `'123` into the UI, this would be represented as a `stringValue` of

32361

# `"123"`.

32362

"errorValue": { # An error in a cell. # Represents an error.

32363

# This field is read-only.

32364

"message": "A String", # A message with more information about the error

32365

# (in the spreadsheet's locale).

32366

"type": "A String", # The type of error.

32367

},

32368

},

32369

"note": "A String", # Any note on the cell.

32370

"effectiveFormat": { # The format of a cell. # The effective format being used by the cell.

32371

# This includes the results of applying any conditional formatting and,

32372

# if the cell contains a formula, the computed number format.

32373

# If the effective format is the default format, effective format will

32374

# not be written.

32375

# This field is read-only.

32376

"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32377

"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on

32378

# the user's locale will be used if necessary for the given type.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame^]

32379

# See the [Date and Number Formats guide](/sheets/guides/formats) for more

32380

# information about the supported patterns.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32381

"type": "A String", # The type of the number format.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32382

# When writing, this field must be set.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32383

},

32384

"textDirection": "A String", # The direction of the text in the cell.

32385

"padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.

32386

# When updating padding, every field must be specified.

32387

"top": 42, # The top padding of the cell.

32388

"right": 42, # The right padding of the cell.

32389

"bottom": 42, # The bottom padding of the cell.

32390

"left": 42, # The left padding of the cell.

32391

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32392

"horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32393

"backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.

32394

# for simplicity of conversion to/from color representations in various

32395

# languages over compactness; for example, the fields of this representation

32396

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

32397

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

32398

# method in iOS; and, with just a little work, it can be easily formatted into

32399

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

32404

#

32405

# // ...

32406

# public static java.awt.Color fromProto(Color protocolor) {

32407

# float alpha = protocolor.hasAlpha()

32408

# ? protocolor.getAlpha().getValue()

32409

# : 1.0;

32410

#

32411

# return new java.awt.Color(

32412

# protocolor.getRed(),

32413

# protocolor.getGreen(),

32414

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

32419

# float red = (float) color.getRed();

32420

# float green = (float) color.getGreen();

32421

# float blue = (float) color.getBlue();

32422

# float denominator = 255.0;

32423

# Color.Builder resultBuilder =

32424

# Color

32425

# .newBuilder()

32426

# .setRed(red / denominator)

32427

# .setGreen(green / denominator)

32428

# .setBlue(blue / denominator);

32429

# int alpha = color.getAlpha();

32430

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

32435

# .build());

32436

# }

32437

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

32442

#

32443

# // ...

32444

# static UIColor* fromProto(Color* protocolor) {

32445

# float red = [protocolor red];

32446

# float green = [protocolor green];

32447

# float blue = [protocolor blue];

32448

# FloatValue* alpha_wrapper = [protocolor alpha];

32449

# float alpha = 1.0;

32450

# if (alpha_wrapper != nil) {

32451

# alpha = [alpha_wrapper value];

32452

# }

32453

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

32454

# }

32455

#

32456

# static Color* toProto(UIColor* color) {

32457

# CGFloat red, green, blue, alpha;

32458

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

32459

# return nil;

32460

# }

32461

# Color* result = [Color alloc] init];

32462

# [result setRed:red];

32463

# [result setGreen:green];

32464

# [result setBlue:blue];

32465

# if (alpha <= 0.9999) {

32466

# [result setAlpha:floatWrapperWithValue(alpha)];

32467

# }

32468

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

32478

# var redFrac = rgb_color.red || 0.0;

32479

# var greenFrac = rgb_color.green || 0.0;

32480

# var blueFrac = rgb_color.blue || 0.0;

32481

# var red = Math.floor(redFrac * 255);

32482

# var green = Math.floor(greenFrac * 255);

32483

# var blue = Math.floor(blueFrac * 255);

32484

#

32485

# if (!('alpha' in rgb_color)) {

32486

# return rgbToCssColor_(red, green, blue);

32487

# }

32488

#

32489

# var alphaFrac = rgb_color.alpha.value || 0.0;

32490

# var rgbParams = [red, green, blue].join(',');

32491

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

32492

# };

32493

#

32494

# var rgbToCssColor_ = function(red, green, blue) {

32495

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

32496

# var hexString = rgbNumber.toString(16);

32497

# var missingZeros = 6 - hexString.length;

32498

# var resultBuilder = ['#'];

32499

# for (var i = 0; i < missingZeros; i++) {

32500

# resultBuilder.push('0');

32501

# }

32502

# resultBuilder.push(hexString);

32503

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

32508

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

32509

# the final pixel color is defined by the equation:

32510

#

32511

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

32512

#

32513

# This means that a value of 1.0 corresponds to a solid color, whereas

32514

# a value of 0.0 corresponds to a completely transparent color. This

32515

# uses a wrapper message rather than a simple float scalar so that it is

32516

# possible to distinguish between a default value and the value being unset.

32517

# If omitted, this color object is to be rendered as a solid color

32518

# (as if the alpha value had been explicitly given with a value of 1.0).

32519

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

32520

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

32521

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32522

"verticalAlignment": "A String", # The vertical alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32523

"textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).

32524

# Absent values indicate that the field isn't specified.

32525

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

32526

# for simplicity of conversion to/from color representations in various

32527

# languages over compactness; for example, the fields of this representation

32528

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

32529

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

32530

# method in iOS; and, with just a little work, it can be easily formatted into

32531

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

32536

#

32537

# // ...

32538

# public static java.awt.Color fromProto(Color protocolor) {

32539

# float alpha = protocolor.hasAlpha()

32540

# ? protocolor.getAlpha().getValue()

32541

# : 1.0;

32542

#

32543

# return new java.awt.Color(

32544

# protocolor.getRed(),

32545

# protocolor.getGreen(),

32546

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

32551

# float red = (float) color.getRed();

32552

# float green = (float) color.getGreen();

32553

# float blue = (float) color.getBlue();

32554

# float denominator = 255.0;

32555

# Color.Builder resultBuilder =

32556

# Color

32557

# .newBuilder()

32558

# .setRed(red / denominator)

32559

# .setGreen(green / denominator)

32560

# .setBlue(blue / denominator);

32561

# int alpha = color.getAlpha();

32562

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

32567

# .build());

32568

# }

32569

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

32574

#

32575

# // ...

32576

# static UIColor* fromProto(Color* protocolor) {

32577

# float red = [protocolor red];

32578

# float green = [protocolor green];

32579

# float blue = [protocolor blue];

32580

# FloatValue* alpha_wrapper = [protocolor alpha];

32581

# float alpha = 1.0;

32582

# if (alpha_wrapper != nil) {

32583

# alpha = [alpha_wrapper value];

32584

# }

32585

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

32586

# }

32587

#

32588

# static Color* toProto(UIColor* color) {

32589

# CGFloat red, green, blue, alpha;

32590

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

32591

# return nil;

32592

# }

32593

# Color* result = [Color alloc] init];

32594

# [result setRed:red];

32595

# [result setGreen:green];

32596

# [result setBlue:blue];

32597

# if (alpha <= 0.9999) {

32598

# [result setAlpha:floatWrapperWithValue(alpha)];

32599

# }

32600

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

32610

# var redFrac = rgb_color.red || 0.0;

32611

# var greenFrac = rgb_color.green || 0.0;

32612

# var blueFrac = rgb_color.blue || 0.0;

32613

# var red = Math.floor(redFrac * 255);

32614

# var green = Math.floor(greenFrac * 255);

32615

# var blue = Math.floor(blueFrac * 255);

32616

#

32617

# if (!('alpha' in rgb_color)) {

32618

# return rgbToCssColor_(red, green, blue);

32619

# }

32620

#

32621

# var alphaFrac = rgb_color.alpha.value || 0.0;

32622

# var rgbParams = [red, green, blue].join(',');

32623

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

32624

# };

32625

#

32626

# var rgbToCssColor_ = function(red, green, blue) {

32627

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

32628

# var hexString = rgbNumber.toString(16);

32629

# var missingZeros = 6 - hexString.length;

32630

# var resultBuilder = ['#'];

32631

# for (var i = 0; i < missingZeros; i++) {

32632

# resultBuilder.push('0');

32633

# }

32634

# resultBuilder.push(hexString);

32635

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

32640

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

32641

# the final pixel color is defined by the equation:

32642

#

32643

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

32644

#

32645

# This means that a value of 1.0 corresponds to a solid color, whereas

32646

# a value of 0.0 corresponds to a completely transparent color. This

32647

# uses a wrapper message rather than a simple float scalar so that it is

32648

# possible to distinguish between a default value and the value being unset.

32649

# If omitted, this color object is to be rendered as a solid color

32650

# (as if the alpha value had been explicitly given with a value of 1.0).

32651

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

32652

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

32653

},

32654

"bold": True or False, # True if the text is bold.

32655

"strikethrough": True or False, # True if the text has a strikethrough.

32656

"fontFamily": "A String", # The font family.

32657

"fontSize": 42, # The size of the font.

32658

"italic": True or False, # True if the text is italicized.

32659

"underline": True or False, # True if the text is underlined.

32660

},

32661

"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.

32662

"borders": { # The borders of the cell. # The borders of the cell.

32663

"top": { # A border along a cell. # The top border of the cell.

32664

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

32665

# for simplicity of conversion to/from color representations in various

32666

# languages over compactness; for example, the fields of this representation

32667

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

32668

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

32669

# method in iOS; and, with just a little work, it can be easily formatted into

32670

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

32675

#

32676

# // ...

32677

# public static java.awt.Color fromProto(Color protocolor) {

32678

# float alpha = protocolor.hasAlpha()

32679

# ? protocolor.getAlpha().getValue()

32680

# : 1.0;

32681

#

32682

# return new java.awt.Color(

32683

# protocolor.getRed(),

32684

# protocolor.getGreen(),

32685

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

32690

# float red = (float) color.getRed();

32691

# float green = (float) color.getGreen();

32692

# float blue = (float) color.getBlue();

32693

# float denominator = 255.0;

32694

# Color.Builder resultBuilder =

32695

# Color

32696

# .newBuilder()

32697

# .setRed(red / denominator)

32698

# .setGreen(green / denominator)

32699

# .setBlue(blue / denominator);

32700

# int alpha = color.getAlpha();

32701

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

32706

# .build());

32707

# }

32708

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

32713

#

32714

# // ...

32715

# static UIColor* fromProto(Color* protocolor) {

32716

# float red = [protocolor red];

32717

# float green = [protocolor green];

32718

# float blue = [protocolor blue];

32719

# FloatValue* alpha_wrapper = [protocolor alpha];

32720

# float alpha = 1.0;

32721

# if (alpha_wrapper != nil) {

32722

# alpha = [alpha_wrapper value];

32723

# }

32724

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

32725

# }

32726

#

32727

# static Color* toProto(UIColor* color) {

32728

# CGFloat red, green, blue, alpha;

32729

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

32730

# return nil;

32731

# }

32732

# Color* result = [Color alloc] init];

32733

# [result setRed:red];

32734

# [result setGreen:green];

32735

# [result setBlue:blue];

32736

# if (alpha <= 0.9999) {

32737

# [result setAlpha:floatWrapperWithValue(alpha)];

32738

# }

32739

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

32749

# var redFrac = rgb_color.red || 0.0;

32750

# var greenFrac = rgb_color.green || 0.0;

32751

# var blueFrac = rgb_color.blue || 0.0;

32752

# var red = Math.floor(redFrac * 255);

32753

# var green = Math.floor(greenFrac * 255);

32754

# var blue = Math.floor(blueFrac * 255);

32755

#

32756

# if (!('alpha' in rgb_color)) {

32757

# return rgbToCssColor_(red, green, blue);

32758

# }

32759

#

32760

# var alphaFrac = rgb_color.alpha.value || 0.0;

32761

# var rgbParams = [red, green, blue].join(',');

32762

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

32763

# };

32764

#

32765

# var rgbToCssColor_ = function(red, green, blue) {

32766

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

32767

# var hexString = rgbNumber.toString(16);

32768

# var missingZeros = 6 - hexString.length;

32769

# var resultBuilder = ['#'];

32770

# for (var i = 0; i < missingZeros; i++) {

32771

# resultBuilder.push('0');

32772

# }

32773

# resultBuilder.push(hexString);

32774

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

32779

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

32780

# the final pixel color is defined by the equation:

32781

#

32782

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

32783

#

32784

# This means that a value of 1.0 corresponds to a solid color, whereas

32785

# a value of 0.0 corresponds to a completely transparent color. This

32786

# uses a wrapper message rather than a simple float scalar so that it is

32787

# possible to distinguish between a default value and the value being unset.

32788

# If omitted, this color object is to be rendered as a solid color

32789

# (as if the alpha value had been explicitly given with a value of 1.0).

32790

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

32791

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

32792

},

32793

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32794

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32795

"style": "A String", # The style of the border.

32796

},

32797

"right": { # A border along a cell. # The right border of the cell.

32798

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

32799

# for simplicity of conversion to/from color representations in various

32800

# languages over compactness; for example, the fields of this representation

32801

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

32802

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

32803

# method in iOS; and, with just a little work, it can be easily formatted into

32804

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

32809

#

32810

# // ...

32811

# public static java.awt.Color fromProto(Color protocolor) {

32812

# float alpha = protocolor.hasAlpha()

32813

# ? protocolor.getAlpha().getValue()

32814

# : 1.0;

32815

#

32816

# return new java.awt.Color(

32817

# protocolor.getRed(),

32818

# protocolor.getGreen(),

32819

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

32824

# float red = (float) color.getRed();

32825

# float green = (float) color.getGreen();

32826

# float blue = (float) color.getBlue();

32827

# float denominator = 255.0;

32828

# Color.Builder resultBuilder =

32829

# Color

32830

# .newBuilder()

32831

# .setRed(red / denominator)

32832

# .setGreen(green / denominator)

32833

# .setBlue(blue / denominator);

32834

# int alpha = color.getAlpha();

32835

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

32840

# .build());

32841

# }

32842

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

32847

#

32848

# // ...

32849

# static UIColor* fromProto(Color* protocolor) {

32850

# float red = [protocolor red];

32851

# float green = [protocolor green];

32852

# float blue = [protocolor blue];

32853

# FloatValue* alpha_wrapper = [protocolor alpha];

32854

# float alpha = 1.0;

32855

# if (alpha_wrapper != nil) {

32856

# alpha = [alpha_wrapper value];

32857

# }

32858

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

32859

# }

32860

#

32861

# static Color* toProto(UIColor* color) {

32862

# CGFloat red, green, blue, alpha;

32863

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

32864

# return nil;

32865

# }

32866

# Color* result = [Color alloc] init];

32867

# [result setRed:red];

32868

# [result setGreen:green];

32869

# [result setBlue:blue];

32870

# if (alpha <= 0.9999) {

32871

# [result setAlpha:floatWrapperWithValue(alpha)];

32872

# }

32873

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

32883

# var redFrac = rgb_color.red || 0.0;

32884

# var greenFrac = rgb_color.green || 0.0;

32885

# var blueFrac = rgb_color.blue || 0.0;

32886

# var red = Math.floor(redFrac * 255);

32887

# var green = Math.floor(greenFrac * 255);

32888

# var blue = Math.floor(blueFrac * 255);

32889

#

32890

# if (!('alpha' in rgb_color)) {

32891

# return rgbToCssColor_(red, green, blue);

32892

# }

32893

#

32894

# var alphaFrac = rgb_color.alpha.value || 0.0;

32895

# var rgbParams = [red, green, blue].join(',');

32896

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

32897

# };

32898

#

32899

# var rgbToCssColor_ = function(red, green, blue) {

32900

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

32901

# var hexString = rgbNumber.toString(16);

32902

# var missingZeros = 6 - hexString.length;

32903

# var resultBuilder = ['#'];

32904

# for (var i = 0; i < missingZeros; i++) {

32905

# resultBuilder.push('0');

32906

# }

32907

# resultBuilder.push(hexString);

32908

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

32913

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

32914

# the final pixel color is defined by the equation:

32915

#

32916

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

32917

#

32918

# This means that a value of 1.0 corresponds to a solid color, whereas

32919

# a value of 0.0 corresponds to a completely transparent color. This

32920

# uses a wrapper message rather than a simple float scalar so that it is

32921

# possible to distinguish between a default value and the value being unset.

32922

# If omitted, this color object is to be rendered as a solid color

32923

# (as if the alpha value had been explicitly given with a value of 1.0).

32924

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

32925

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

32926

},

32927

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

32928

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

32929

"style": "A String", # The style of the border.

32930

},

32931

"bottom": { # A border along a cell. # The bottom border of the cell.

32932

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

32933

# for simplicity of conversion to/from color representations in various

32934

# languages over compactness; for example, the fields of this representation

32935

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

32936

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

32937

# method in iOS; and, with just a little work, it can be easily formatted into

32938

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

32943

#

32944

# // ...

32945

# public static java.awt.Color fromProto(Color protocolor) {

32946

# float alpha = protocolor.hasAlpha()

32947

# ? protocolor.getAlpha().getValue()

32948

# : 1.0;

32949

#

32950

# return new java.awt.Color(

32951

# protocolor.getRed(),

32952

# protocolor.getGreen(),

32953

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

32958

# float red = (float) color.getRed();

32959

# float green = (float) color.getGreen();

32960

# float blue = (float) color.getBlue();

32961

# float denominator = 255.0;

32962

# Color.Builder resultBuilder =

32963

# Color

32964

# .newBuilder()

32965

# .setRed(red / denominator)

32966

# .setGreen(green / denominator)

32967

# .setBlue(blue / denominator);

32968

# int alpha = color.getAlpha();

32969

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

32974

# .build());

32975

# }

32976

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

32981

#

32982

# // ...

32983

# static UIColor* fromProto(Color* protocolor) {

32984

# float red = [protocolor red];

32985

# float green = [protocolor green];

32986

# float blue = [protocolor blue];

32987

# FloatValue* alpha_wrapper = [protocolor alpha];

32988

# float alpha = 1.0;

32989

# if (alpha_wrapper != nil) {

32990

# alpha = [alpha_wrapper value];

32991

# }

32992

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

32993

# }

32994

#

32995

# static Color* toProto(UIColor* color) {

32996

# CGFloat red, green, blue, alpha;

32997

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

32998

# return nil;

32999

# }

33000

# Color* result = [Color alloc] init];

33001

# [result setRed:red];

33002

# [result setGreen:green];

33003

# [result setBlue:blue];

33004

# if (alpha <= 0.9999) {

33005

# [result setAlpha:floatWrapperWithValue(alpha)];

33006

# }

33007

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

33017

# var redFrac = rgb_color.red || 0.0;

33018

# var greenFrac = rgb_color.green || 0.0;

33019

# var blueFrac = rgb_color.blue || 0.0;

33020

# var red = Math.floor(redFrac * 255);

33021

# var green = Math.floor(greenFrac * 255);

33022

# var blue = Math.floor(blueFrac * 255);

33023

#

33024

# if (!('alpha' in rgb_color)) {

33025

# return rgbToCssColor_(red, green, blue);

33026

# }

33027

#

33028

# var alphaFrac = rgb_color.alpha.value || 0.0;

33029

# var rgbParams = [red, green, blue].join(',');

33030

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

33031

# };

33032

#

33033

# var rgbToCssColor_ = function(red, green, blue) {

33034

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

33035

# var hexString = rgbNumber.toString(16);

33036

# var missingZeros = 6 - hexString.length;

33037

# var resultBuilder = ['#'];

33038

# for (var i = 0; i < missingZeros; i++) {

33039

# resultBuilder.push('0');

33040

# }

33041

# resultBuilder.push(hexString);

33042

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

33047

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

33048

# the final pixel color is defined by the equation:

33049

#

33050

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

33051

#

33052

# This means that a value of 1.0 corresponds to a solid color, whereas

33053

# a value of 0.0 corresponds to a completely transparent color. This

33054

# uses a wrapper message rather than a simple float scalar so that it is

33055

# possible to distinguish between a default value and the value being unset.

33056

# If omitted, this color object is to be rendered as a solid color

33057

# (as if the alpha value had been explicitly given with a value of 1.0).

33058

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

33059

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

33060

},

33061

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

33062

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

33063

"style": "A String", # The style of the border.

33064

},

33065

"left": { # A border along a cell. # The left border of the cell.

33066

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

33067

# for simplicity of conversion to/from color representations in various

33068

# languages over compactness; for example, the fields of this representation

33069

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

33070

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

33071

# method in iOS; and, with just a little work, it can be easily formatted into

33072

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

33077

#

33078

# // ...

33079

# public static java.awt.Color fromProto(Color protocolor) {

33080

# float alpha = protocolor.hasAlpha()

33081

# ? protocolor.getAlpha().getValue()

33082

# : 1.0;

33083

#

33084

# return new java.awt.Color(

33085

# protocolor.getRed(),

33086

# protocolor.getGreen(),

33087

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

33092

# float red = (float) color.getRed();

33093

# float green = (float) color.getGreen();

33094

# float blue = (float) color.getBlue();

33095

# float denominator = 255.0;

33096

# Color.Builder resultBuilder =

33097

# Color

33098

# .newBuilder()

33099

# .setRed(red / denominator)

33100

# .setGreen(green / denominator)

33101

# .setBlue(blue / denominator);

33102

# int alpha = color.getAlpha();

33103

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

33108

# .build());

33109

# }

33110

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

33115

#

33116

# // ...

33117

# static UIColor* fromProto(Color* protocolor) {

33118

# float red = [protocolor red];

33119

# float green = [protocolor green];

33120

# float blue = [protocolor blue];

33121

# FloatValue* alpha_wrapper = [protocolor alpha];

33122

# float alpha = 1.0;

33123

# if (alpha_wrapper != nil) {

33124

# alpha = [alpha_wrapper value];

33125

# }

33126

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

33127

# }

33128

#

33129

# static Color* toProto(UIColor* color) {

33130

# CGFloat red, green, blue, alpha;

33131

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

33132

# return nil;

33133

# }

33134

# Color* result = [Color alloc] init];

33135

# [result setRed:red];

33136

# [result setGreen:green];

33137

# [result setBlue:blue];

33138

# if (alpha <= 0.9999) {

33139

# [result setAlpha:floatWrapperWithValue(alpha)];

33140

# }

33141

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

33151

# var redFrac = rgb_color.red || 0.0;

33152

# var greenFrac = rgb_color.green || 0.0;

33153

# var blueFrac = rgb_color.blue || 0.0;

33154

# var red = Math.floor(redFrac * 255);

33155

# var green = Math.floor(greenFrac * 255);

33156

# var blue = Math.floor(blueFrac * 255);

33157

#

33158

# if (!('alpha' in rgb_color)) {

33159

# return rgbToCssColor_(red, green, blue);

33160

# }

33161

#

33162

# var alphaFrac = rgb_color.alpha.value || 0.0;

33163

# var rgbParams = [red, green, blue].join(',');

33164

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

33165

# };

33166

#

33167

# var rgbToCssColor_ = function(red, green, blue) {

33168

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

33169

# var hexString = rgbNumber.toString(16);

33170

# var missingZeros = 6 - hexString.length;

33171

# var resultBuilder = ['#'];

33172

# for (var i = 0; i < missingZeros; i++) {

33173

# resultBuilder.push('0');

33174

# }

33175

# resultBuilder.push(hexString);

33176

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

33181

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

33182

# the final pixel color is defined by the equation:

33183

#

33184

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

33185

#

33186

# This means that a value of 1.0 corresponds to a solid color, whereas

33187

# a value of 0.0 corresponds to a completely transparent color. This

33188

# uses a wrapper message rather than a simple float scalar so that it is

33189

# possible to distinguish between a default value and the value being unset.

33190

# If omitted, this color object is to be rendered as a solid color

33191

# (as if the alpha value had been explicitly given with a value of 1.0).

33192

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

33193

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

33194

},

33195

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

33196

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

33197

"style": "A String", # The style of the border.

33198

},

33199

},

33200

"wrapStrategy": "A String", # The wrap strategy for the value in the cell.

33201

},

33202

"userEnteredFormat": { # The format of a cell. # The format the user entered for the cell.

33203

#

33204

# When writing, the new format will be merged with the existing format.

33205

"numberFormat": { # The number format of a cell. # A format describing how number values should be represented to the user.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

33206

"pattern": "A String", # Pattern string used for formatting. If not set, a default pattern based on

33207

# the user's locale will be used if necessary for the given type.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame^]

33208

# See the [Date and Number Formats guide](/sheets/guides/formats) for more

33209

# information about the supported patterns.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

33210

"type": "A String", # The type of the number format.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

33211

# When writing, this field must be set.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

33212

},

33213

"textDirection": "A String", # The direction of the text in the cell.

33214

"padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.

33215

# When updating padding, every field must be specified.

33216

"top": 42, # The top padding of the cell.

33217

"right": 42, # The right padding of the cell.

33218

"bottom": 42, # The bottom padding of the cell.

33219

"left": 42, # The left padding of the cell.

33220

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

33221

"horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

33222

"backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.

33223

# for simplicity of conversion to/from color representations in various

33224

# languages over compactness; for example, the fields of this representation

33225

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

33226

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

33227

# method in iOS; and, with just a little work, it can be easily formatted into

33228

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

33233

#

33234

# // ...

33235

# public static java.awt.Color fromProto(Color protocolor) {

33236

# float alpha = protocolor.hasAlpha()

33237

# ? protocolor.getAlpha().getValue()

33238

# : 1.0;

33239

#

33240

# return new java.awt.Color(

33241

# protocolor.getRed(),

33242

# protocolor.getGreen(),

33243

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

33248

# float red = (float) color.getRed();

33249

# float green = (float) color.getGreen();

33250

# float blue = (float) color.getBlue();

33251

# float denominator = 255.0;

33252

# Color.Builder resultBuilder =

33253

# Color

33254

# .newBuilder()

33255

# .setRed(red / denominator)

33256

# .setGreen(green / denominator)

33257

# .setBlue(blue / denominator);

33258

# int alpha = color.getAlpha();

33259

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

33264

# .build());

33265

# }

33266

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

33271

#

33272

# // ...

33273

# static UIColor* fromProto(Color* protocolor) {

33274

# float red = [protocolor red];

33275

# float green = [protocolor green];

33276

# float blue = [protocolor blue];

33277

# FloatValue* alpha_wrapper = [protocolor alpha];

33278

# float alpha = 1.0;

33279

# if (alpha_wrapper != nil) {

33280

# alpha = [alpha_wrapper value];

33281

# }

33282

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

33283

# }

33284

#

33285

# static Color* toProto(UIColor* color) {

33286

# CGFloat red, green, blue, alpha;

33287

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

33288

# return nil;

33289

# }

33290

# Color* result = [Color alloc] init];

33291

# [result setRed:red];

33292

# [result setGreen:green];

33293

# [result setBlue:blue];

33294

# if (alpha <= 0.9999) {

33295

# [result setAlpha:floatWrapperWithValue(alpha)];

33296

# }

33297

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

33307

# var redFrac = rgb_color.red || 0.0;

33308

# var greenFrac = rgb_color.green || 0.0;

33309

# var blueFrac = rgb_color.blue || 0.0;

33310

# var red = Math.floor(redFrac * 255);

33311

# var green = Math.floor(greenFrac * 255);

33312

# var blue = Math.floor(blueFrac * 255);

33313

#

33314

# if (!('alpha' in rgb_color)) {

33315

# return rgbToCssColor_(red, green, blue);

33316

# }

33317

#

33318

# var alphaFrac = rgb_color.alpha.value || 0.0;

33319

# var rgbParams = [red, green, blue].join(',');

33320

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

33321

# };

33322

#

33323

# var rgbToCssColor_ = function(red, green, blue) {

33324

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

33325

# var hexString = rgbNumber.toString(16);

33326

# var missingZeros = 6 - hexString.length;

33327

# var resultBuilder = ['#'];

33328

# for (var i = 0; i < missingZeros; i++) {

33329

# resultBuilder.push('0');

33330

# }

33331

# resultBuilder.push(hexString);

33332

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

33337

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

33338

# the final pixel color is defined by the equation:

33339

#

33340

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

33341

#

33342

# This means that a value of 1.0 corresponds to a solid color, whereas

33343

# a value of 0.0 corresponds to a completely transparent color. This

33344

# uses a wrapper message rather than a simple float scalar so that it is

33345

# possible to distinguish between a default value and the value being unset.

33346

# If omitted, this color object is to be rendered as a solid color

33347

# (as if the alpha value had been explicitly given with a value of 1.0).

33348

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

33349

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

33350

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

33351

"verticalAlignment": "A String", # The vertical alignment of the value in the cell.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

33352

"textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).

33353

# Absent values indicate that the field isn't specified.

33354

"foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.

33355

# for simplicity of conversion to/from color representations in various

33356

# languages over compactness; for example, the fields of this representation

33357

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

33358

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

33359

# method in iOS; and, with just a little work, it can be easily formatted into

33360

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

33365

#

33366

# // ...

33367

# public static java.awt.Color fromProto(Color protocolor) {

33368

# float alpha = protocolor.hasAlpha()

33369

# ? protocolor.getAlpha().getValue()

33370

# : 1.0;

33371

#

33372

# return new java.awt.Color(

33373

# protocolor.getRed(),

33374

# protocolor.getGreen(),

33375

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

33380

# float red = (float) color.getRed();

33381

# float green = (float) color.getGreen();

33382

# float blue = (float) color.getBlue();

33383

# float denominator = 255.0;

33384

# Color.Builder resultBuilder =

33385

# Color

33386

# .newBuilder()

33387

# .setRed(red / denominator)

33388

# .setGreen(green / denominator)

33389

# .setBlue(blue / denominator);

33390

# int alpha = color.getAlpha();

33391

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

33396

# .build());

33397

# }

33398

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

33403

#

33404

# // ...

33405

# static UIColor* fromProto(Color* protocolor) {

33406

# float red = [protocolor red];

33407

# float green = [protocolor green];

33408

# float blue = [protocolor blue];

33409

# FloatValue* alpha_wrapper = [protocolor alpha];

33410

# float alpha = 1.0;

33411

# if (alpha_wrapper != nil) {

33412

# alpha = [alpha_wrapper value];

33413

# }

33414

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

33415

# }

33416

#

33417

# static Color* toProto(UIColor* color) {

33418

# CGFloat red, green, blue, alpha;

33419

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

33420

# return nil;

33421

# }

33422

# Color* result = [Color alloc] init];

33423

# [result setRed:red];

33424

# [result setGreen:green];

33425

# [result setBlue:blue];

33426

# if (alpha <= 0.9999) {

33427

# [result setAlpha:floatWrapperWithValue(alpha)];

33428

# }

33429

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

33439

# var redFrac = rgb_color.red || 0.0;

33440

# var greenFrac = rgb_color.green || 0.0;

33441

# var blueFrac = rgb_color.blue || 0.0;

33442

# var red = Math.floor(redFrac * 255);

33443

# var green = Math.floor(greenFrac * 255);

33444

# var blue = Math.floor(blueFrac * 255);

33445

#

33446

# if (!('alpha' in rgb_color)) {

33447

# return rgbToCssColor_(red, green, blue);

33448

# }

33449

#

33450

# var alphaFrac = rgb_color.alpha.value || 0.0;

33451

# var rgbParams = [red, green, blue].join(',');

33452

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

33453

# };

33454

#

33455

# var rgbToCssColor_ = function(red, green, blue) {

33456

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

33457

# var hexString = rgbNumber.toString(16);

33458

# var missingZeros = 6 - hexString.length;

33459

# var resultBuilder = ['#'];

33460

# for (var i = 0; i < missingZeros; i++) {

33461

# resultBuilder.push('0');

33462

# }

33463

# resultBuilder.push(hexString);

33464

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

33469

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

33470

# the final pixel color is defined by the equation:

33471

#

33472

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

33473

#

33474

# This means that a value of 1.0 corresponds to a solid color, whereas

33475

# a value of 0.0 corresponds to a completely transparent color. This

33476

# uses a wrapper message rather than a simple float scalar so that it is

33477

# possible to distinguish between a default value and the value being unset.

33478

# If omitted, this color object is to be rendered as a solid color

33479

# (as if the alpha value had been explicitly given with a value of 1.0).

33480

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

33481

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

33482

},

33483

"bold": True or False, # True if the text is bold.

33484

"strikethrough": True or False, # True if the text has a strikethrough.

33485

"fontFamily": "A String", # The font family.

33486

"fontSize": 42, # The size of the font.

33487

"italic": True or False, # True if the text is italicized.

33488

"underline": True or False, # True if the text is underlined.

33489

},

33490

"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.

33491

"borders": { # The borders of the cell. # The borders of the cell.

33492

"top": { # A border along a cell. # The top border of the cell.

33493

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

33494

# for simplicity of conversion to/from color representations in various

33495

# languages over compactness; for example, the fields of this representation

33496

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

33497

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

33498

# method in iOS; and, with just a little work, it can be easily formatted into

33499

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

33504

#

33505

# // ...

33506

# public static java.awt.Color fromProto(Color protocolor) {

33507

# float alpha = protocolor.hasAlpha()

33508

# ? protocolor.getAlpha().getValue()

33509

# : 1.0;

33510

#

33511

# return new java.awt.Color(

33512

# protocolor.getRed(),

33513

# protocolor.getGreen(),

33514

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

33519

# float red = (float) color.getRed();

33520

# float green = (float) color.getGreen();

33521

# float blue = (float) color.getBlue();

33522

# float denominator = 255.0;

33523

# Color.Builder resultBuilder =

33524

# Color

33525

# .newBuilder()

33526

# .setRed(red / denominator)

33527

# .setGreen(green / denominator)

33528

# .setBlue(blue / denominator);

33529

# int alpha = color.getAlpha();

33530

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

33535

# .build());

33536

# }

33537

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

33542

#

33543

# // ...

33544

# static UIColor* fromProto(Color* protocolor) {

33545

# float red = [protocolor red];

33546

# float green = [protocolor green];

33547

# float blue = [protocolor blue];

33548

# FloatValue* alpha_wrapper = [protocolor alpha];

33549

# float alpha = 1.0;

33550

# if (alpha_wrapper != nil) {

33551

# alpha = [alpha_wrapper value];

33552

# }

33553

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

33554

# }

33555

#

33556

# static Color* toProto(UIColor* color) {

33557

# CGFloat red, green, blue, alpha;

33558

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

33559

# return nil;

33560

# }

33561

# Color* result = [Color alloc] init];

33562

# [result setRed:red];

33563

# [result setGreen:green];

33564

# [result setBlue:blue];

33565

# if (alpha <= 0.9999) {

33566

# [result setAlpha:floatWrapperWithValue(alpha)];

33567

# }

33568

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

33578

# var redFrac = rgb_color.red || 0.0;

33579

# var greenFrac = rgb_color.green || 0.0;

33580

# var blueFrac = rgb_color.blue || 0.0;

33581

# var red = Math.floor(redFrac * 255);

33582

# var green = Math.floor(greenFrac * 255);

33583

# var blue = Math.floor(blueFrac * 255);

33584

#

33585

# if (!('alpha' in rgb_color)) {

33586

# return rgbToCssColor_(red, green, blue);

33587

# }

33588

#

33589

# var alphaFrac = rgb_color.alpha.value || 0.0;

33590

# var rgbParams = [red, green, blue].join(',');

33591

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

33592

# };

33593

#

33594

# var rgbToCssColor_ = function(red, green, blue) {

33595

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

33596

# var hexString = rgbNumber.toString(16);

33597

# var missingZeros = 6 - hexString.length;

33598

# var resultBuilder = ['#'];

33599

# for (var i = 0; i < missingZeros; i++) {

33600

# resultBuilder.push('0');

33601

# }

33602

# resultBuilder.push(hexString);

33603

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

33608

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

33609

# the final pixel color is defined by the equation:

33610

#

33611

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

33612

#

33613

# This means that a value of 1.0 corresponds to a solid color, whereas

33614

# a value of 0.0 corresponds to a completely transparent color. This

33615

# uses a wrapper message rather than a simple float scalar so that it is

33616

# possible to distinguish between a default value and the value being unset.

33617

# If omitted, this color object is to be rendered as a solid color

33618

# (as if the alpha value had been explicitly given with a value of 1.0).

33619

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

33620

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

33621

},

33622

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

33623

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

33624

"style": "A String", # The style of the border.

33625

},

33626

"right": { # A border along a cell. # The right border of the cell.

33627

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

33628

# for simplicity of conversion to/from color representations in various

33629

# languages over compactness; for example, the fields of this representation

33630

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

33631

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

33632

# method in iOS; and, with just a little work, it can be easily formatted into

33633

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

33638

#

33639

# // ...

33640

# public static java.awt.Color fromProto(Color protocolor) {

33641

# float alpha = protocolor.hasAlpha()

33642

# ? protocolor.getAlpha().getValue()

33643

# : 1.0;

33644

#

33645

# return new java.awt.Color(

33646

# protocolor.getRed(),

33647

# protocolor.getGreen(),

33648

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

33653

# float red = (float) color.getRed();

33654

# float green = (float) color.getGreen();

33655

# float blue = (float) color.getBlue();

33656

# float denominator = 255.0;

33657

# Color.Builder resultBuilder =

33658

# Color

33659

# .newBuilder()

33660

# .setRed(red / denominator)

33661

# .setGreen(green / denominator)

33662

# .setBlue(blue / denominator);

33663

# int alpha = color.getAlpha();

33664

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

33669

# .build());

33670

# }

33671

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

33676

#

33677

# // ...

33678

# static UIColor* fromProto(Color* protocolor) {

33679

# float red = [protocolor red];

33680

# float green = [protocolor green];

33681

# float blue = [protocolor blue];

33682

# FloatValue* alpha_wrapper = [protocolor alpha];

33683

# float alpha = 1.0;

33684

# if (alpha_wrapper != nil) {

33685

# alpha = [alpha_wrapper value];

33686

# }

33687

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

33688

# }

33689

#

33690

# static Color* toProto(UIColor* color) {

33691

# CGFloat red, green, blue, alpha;

33692

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

33693

# return nil;

33694

# }

33695

# Color* result = [Color alloc] init];

33696

# [result setRed:red];

33697

# [result setGreen:green];

33698

# [result setBlue:blue];

33699

# if (alpha <= 0.9999) {

33700

# [result setAlpha:floatWrapperWithValue(alpha)];

33701

# }

33702

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

33712

# var redFrac = rgb_color.red || 0.0;

33713

# var greenFrac = rgb_color.green || 0.0;

33714

# var blueFrac = rgb_color.blue || 0.0;

33715

# var red = Math.floor(redFrac * 255);

33716

# var green = Math.floor(greenFrac * 255);

33717

# var blue = Math.floor(blueFrac * 255);

33718

#

33719

# if (!('alpha' in rgb_color)) {

33720

# return rgbToCssColor_(red, green, blue);

33721

# }

33722

#

33723

# var alphaFrac = rgb_color.alpha.value || 0.0;

33724

# var rgbParams = [red, green, blue].join(',');

33725

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

33726

# };

33727

#

33728

# var rgbToCssColor_ = function(red, green, blue) {

33729

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

33730

# var hexString = rgbNumber.toString(16);

33731

# var missingZeros = 6 - hexString.length;

33732

# var resultBuilder = ['#'];

33733

# for (var i = 0; i < missingZeros; i++) {

33734

# resultBuilder.push('0');

33735

# }

33736

# resultBuilder.push(hexString);

33737

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

33742

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

33743

# the final pixel color is defined by the equation:

33744

#

33745

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

33746

#

33747

# This means that a value of 1.0 corresponds to a solid color, whereas

33748

# a value of 0.0 corresponds to a completely transparent color. This

33749

# uses a wrapper message rather than a simple float scalar so that it is

33750

# possible to distinguish between a default value and the value being unset.

33751

# If omitted, this color object is to be rendered as a solid color

33752

# (as if the alpha value had been explicitly given with a value of 1.0).

33753

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

33754

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

33755

},

33756

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

33757

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

33758

"style": "A String", # The style of the border.

33759

},

33760

"bottom": { # A border along a cell. # The bottom border of the cell.

33761

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

33762

# for simplicity of conversion to/from color representations in various

33763

# languages over compactness; for example, the fields of this representation

33764

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

33765

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

33766

# method in iOS; and, with just a little work, it can be easily formatted into

33767

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

33772

#

33773

# // ...

33774

# public static java.awt.Color fromProto(Color protocolor) {

33775

# float alpha = protocolor.hasAlpha()

33776

# ? protocolor.getAlpha().getValue()

33777

# : 1.0;

33778

#

33779

# return new java.awt.Color(

33780

# protocolor.getRed(),

33781

# protocolor.getGreen(),

33782

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

33787

# float red = (float) color.getRed();

33788

# float green = (float) color.getGreen();

33789

# float blue = (float) color.getBlue();

33790

# float denominator = 255.0;

33791

# Color.Builder resultBuilder =

33792

# Color

33793

# .newBuilder()

33794

# .setRed(red / denominator)

33795

# .setGreen(green / denominator)

33796

# .setBlue(blue / denominator);

33797

# int alpha = color.getAlpha();

33798

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

33803

# .build());

33804

# }

33805

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

33810

#

33811

# // ...

33812

# static UIColor* fromProto(Color* protocolor) {

33813

# float red = [protocolor red];

33814

# float green = [protocolor green];

33815

# float blue = [protocolor blue];

33816

# FloatValue* alpha_wrapper = [protocolor alpha];

33817

# float alpha = 1.0;

33818

# if (alpha_wrapper != nil) {

33819

# alpha = [alpha_wrapper value];

33820

# }

33821

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

33822

# }

33823

#

33824

# static Color* toProto(UIColor* color) {

33825

# CGFloat red, green, blue, alpha;

33826

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

33827

# return nil;

33828

# }

33829

# Color* result = [Color alloc] init];

33830

# [result setRed:red];

33831

# [result setGreen:green];

33832

# [result setBlue:blue];

33833

# if (alpha <= 0.9999) {

33834

# [result setAlpha:floatWrapperWithValue(alpha)];

33835

# }

33836

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

33846

# var redFrac = rgb_color.red || 0.0;

33847

# var greenFrac = rgb_color.green || 0.0;

33848

# var blueFrac = rgb_color.blue || 0.0;

33849

# var red = Math.floor(redFrac * 255);

33850

# var green = Math.floor(greenFrac * 255);

33851

# var blue = Math.floor(blueFrac * 255);

33852

#

33853

# if (!('alpha' in rgb_color)) {

33854

# return rgbToCssColor_(red, green, blue);

33855

# }

33856

#

33857

# var alphaFrac = rgb_color.alpha.value || 0.0;

33858

# var rgbParams = [red, green, blue].join(',');

33859

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

33860

# };

33861

#

33862

# var rgbToCssColor_ = function(red, green, blue) {

33863

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

33864

# var hexString = rgbNumber.toString(16);

33865

# var missingZeros = 6 - hexString.length;

33866

# var resultBuilder = ['#'];

33867

# for (var i = 0; i < missingZeros; i++) {

33868

# resultBuilder.push('0');

33869

# }

33870

# resultBuilder.push(hexString);

33871

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

33876

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

33877

# the final pixel color is defined by the equation:

33878

#

33879

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

33880

#

33881

# This means that a value of 1.0 corresponds to a solid color, whereas

33882

# a value of 0.0 corresponds to a completely transparent color. This

33883

# uses a wrapper message rather than a simple float scalar so that it is

33884

# possible to distinguish between a default value and the value being unset.

33885

# If omitted, this color object is to be rendered as a solid color

33886

# (as if the alpha value had been explicitly given with a value of 1.0).

33887

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

33888

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

33889

},

33890

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

33891

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

33892

"style": "A String", # The style of the border.

33893

},

33894

"left": { # A border along a cell. # The left border of the cell.

33895

"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.

33896

# for simplicity of conversion to/from color representations in various

33897

# languages over compactness; for example, the fields of this representation

33898

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

33899

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

33900

# method in iOS; and, with just a little work, it can be easily formatted into

33901

# a CSS "rgba()" string in JavaScript, as well. Here are some examples:

#

# Example (Java):

#

# import com.google.type.Color;

33906

#

33907

# // ...

33908

# public static java.awt.Color fromProto(Color protocolor) {

33909

# float alpha = protocolor.hasAlpha()

33910

# ? protocolor.getAlpha().getValue()

33911

# : 1.0;

33912

#

33913

# return new java.awt.Color(

33914

# protocolor.getRed(),

33915

# protocolor.getGreen(),

33916

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

33921

# float red = (float) color.getRed();

33922

# float green = (float) color.getGreen();

33923

# float blue = (float) color.getBlue();

33924

# float denominator = 255.0;

33925

# Color.Builder resultBuilder =

33926

# Color

33927

# .newBuilder()

33928

# .setRed(red / denominator)

33929

# .setGreen(green / denominator)

33930

# .setBlue(blue / denominator);

33931

# int alpha = color.getAlpha();

33932

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

33937

# .build());

33938

# }

33939

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

33944

#

33945

# // ...

33946

# static UIColor* fromProto(Color* protocolor) {

33947

# float red = [protocolor red];

33948

# float green = [protocolor green];

33949

# float blue = [protocolor blue];

33950

# FloatValue* alpha_wrapper = [protocolor alpha];

33951

# float alpha = 1.0;

33952

# if (alpha_wrapper != nil) {

33953

# alpha = [alpha_wrapper value];

33954

# }

33955

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

33956

# }

33957

#

33958

# static Color* toProto(UIColor* color) {

33959

# CGFloat red, green, blue, alpha;

33960

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

33961

# return nil;

33962

# }

33963

# Color* result = [Color alloc] init];

33964

# [result setRed:red];

33965

# [result setGreen:green];

33966

# [result setBlue:blue];

33967

# if (alpha <= 0.9999) {

33968

# [result setAlpha:floatWrapperWithValue(alpha)];

33969

# }

33970

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

33980

# var redFrac = rgb_color.red || 0.0;

33981

# var greenFrac = rgb_color.green || 0.0;

33982

# var blueFrac = rgb_color.blue || 0.0;

33983

# var red = Math.floor(redFrac * 255);

33984

# var green = Math.floor(greenFrac * 255);

33985

# var blue = Math.floor(blueFrac * 255);

33986

#

33987

# if (!('alpha' in rgb_color)) {

33988

# return rgbToCssColor_(red, green, blue);

33989

# }

33990

#

33991

# var alphaFrac = rgb_color.alpha.value || 0.0;

33992

# var rgbParams = [red, green, blue].join(',');

33993

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

33994

# };

33995

#

33996

# var rgbToCssColor_ = function(red, green, blue) {

33997

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

33998

# var hexString = rgbNumber.toString(16);

33999

# var missingZeros = 6 - hexString.length;

34000

# var resultBuilder = ['#'];

34001

# for (var i = 0; i < missingZeros; i++) {

34002

# resultBuilder.push('0');

34003

# }

34004

# resultBuilder.push(hexString);

34005

# return resultBuilder.join('');

# };

#

# // ...

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

34010

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

34011

# the final pixel color is defined by the equation:

34012

#

34013

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

34014

#

34015

# This means that a value of 1.0 corresponds to a solid color, whereas

34016

# a value of 0.0 corresponds to a completely transparent color. This

34017

# uses a wrapper message rather than a simple float scalar so that it is

34018

# possible to distinguish between a default value and the value being unset.

34019

# If omitted, this color object is to be rendered as a solid color

34020

# (as if the alpha value had been explicitly given with a value of 1.0).

34021

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

34022

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

34023

},

34024

"width": 42, # The width of the border, in pixels.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

34025

# Border widths must be between 0 and 3 pixels, inclusive.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

34026

"style": "A String", # The style of the border.

34027

},

34028

},

34029

"wrapStrategy": "A String", # The wrap strategy for the value in the cell.

34030

},

34031

"dataValidation": { # A data validation rule. # A data validation rule on the cell, if any.

34032

#

34033

# When writing, the new data validation rule will overwrite any prior rule.

34034

"showCustomUi": True or False, # True if the UI should be customized based on the kind of condition.

34035

# If true, "List" conditions will show a dropdown.

34036

"strict": True or False, # True if invalid data should be rejected.

34037

"inputMessage": "A String", # A message to show the user when adding data to the cell.

34038

"condition": { # A condition that can evaluate to true or false. # The condition that data in the cell must match.

34039

# BooleanConditions are used by conditional formatting,

34040

# data validation, and the criteria in filters.

34041

"type": "A String", # The type of condition.

34042

"values": [ # The values of the condition. The number of supported values depends

34043

# on the condition type. Some support zero values,

34044

# others one or two values,

34045

# and ConditionType.ONE_OF_LIST supports an arbitrary number of values.

34046

{ # The value of the condition.

34047

"relativeDate": "A String", # A relative date (based on the current date).

34048

# Valid only if the type is

34049

# DATE_BEFORE,

34050

# DATE_AFTER,

34051

# DATE_ON_OR_BEFORE or

34052

# DATE_ON_OR_AFTER.

34053

#

34054

# Relative dates are not supported in data validation.

34055

# They are supported only in conditional formatting and

34056

# conditional filters.

34057

"userEnteredValue": "A String", # A value the condition is based on.

34058

# The value will be parsed as if the user typed into a cell.

34059

# Formulas are supported (and must begin with an `=`).

},

],

},

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

34064

"textFormatRuns": [ # Runs of rich text applied to subsections of the cell. Runs are only valid

34065

# on user entered strings, not formulas, bools, or numbers.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

34066

# Runs start at specific indexes in the text and continue until the next

34067

# run. Properties of a run will continue unless explicitly changed

34068

# in a subsequent run (and properties of the first run will continue

34069

# the properties of the cell unless explicitly changed).

34070

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

34071

# When writing, the new runs will overwrite any prior runs. When writing a

34072

# new user_entered_value, previous runs will be erased.

34073

{ # A run of a text format. The format of this run continues until the start

34074

# index of the next run.

Jon Wayne Parrott