target.apidocs.com.google.api.services.sheets.v4.model.Color.html Maven / Gradle / Ivy
Color (Google Sheets API v4-rev20240312-2.0.0)
com.google.api.services.sheets.v4.model
Class Color
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.sheets.v4.model.Color
-
public final class Color
extends com.google.api.client.json.GenericJson
Represents a color in the RGBA color space. This representation is designed for simplicity of
conversion to and from color representations in various languages over compactness. For example,
the fields of this representation can be trivially provided to the constructor of
`java.awt.Color` in Java; it can also be trivially provided to UIColor's
`+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily
formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information
about the absolute color space that should be used to interpret the RGB value—for example, sRGB,
Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When
color equality needs to be decided, implementations, unless documented otherwise, treat two
colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`.
Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color
protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0;
return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(),
alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed();
float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator =
255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator)
.setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if
(alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) /
denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ...
static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green =
[protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor
alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return
[UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor*
color) { CGFloat red, green, blue, alpha; if (![color getRed: green: blue: alpha:]) { return nil;
} Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result
setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result
autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor =
function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0;
var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green =
Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color))
{ return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var
rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac,
')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new
Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var
missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros;
i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join('');
}; // ...
This is the Java data model class that specifies how to parse/serialize into the JSON that is
transmitted over HTTP when working with the Google Sheets API. For a detailed explanation see:
https://developers.google.com/api-client-library/java/google-http-java-client/json
- Author:
- Google, Inc.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Constructor and Description
Color()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
Colorclone()
FloatgetAlpha()
The fraction of this color that should be applied to the pixel.
FloatgetBlue()
The amount of blue in the color as a value in the interval [0, 1].
FloatgetGreen()
The amount of green in the color as a value in the interval [0, 1].
FloatgetRed()
The amount of red in the color as a value in the interval [0, 1].
Colorset(String fieldName,
Object value)
ColorsetAlpha(Float alpha)
The fraction of this color that should be applied to the pixel.
ColorsetBlue(Float blue)
The amount of blue in the color as a value in the interval [0, 1].
ColorsetGreen(Float green)
The amount of green in the color as a value in the interval [0, 1].
ColorsetRed(Float red)
The amount of red in the color as a value in the interval [0, 1].
-
Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString
-
Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Method Detail
-
getAlpha
public Float getAlpha()
The fraction of this color that should be applied to the pixel. That is, the final pixel color
is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background
color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0
corresponds to a completely transparent color. This uses a wrapper message rather than a simple
float scalar so that it is possible to distinguish between a default value and the value being
unset. If omitted, this color object is rendered as a solid color (as if the alpha value had
been explicitly given a value of 1.0).
- Returns:
- value or
null for none
-
setAlpha
public Color setAlpha(Float alpha)
The fraction of this color that should be applied to the pixel. That is, the final pixel color
is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background
color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0
corresponds to a completely transparent color. This uses a wrapper message rather than a simple
float scalar so that it is possible to distinguish between a default value and the value being
unset. If omitted, this color object is rendered as a solid color (as if the alpha value had
been explicitly given a value of 1.0).
- Parameters:
alpha - alpha or null for none
-
getBlue
public Float getBlue()
The amount of blue in the color as a value in the interval [0, 1].
- Returns:
- value or
null for none
-
setBlue
public Color setBlue(Float blue)
The amount of blue in the color as a value in the interval [0, 1].
- Parameters:
blue - blue or null for none
-
getGreen
public Float getGreen()
The amount of green in the color as a value in the interval [0, 1].
- Returns:
- value or
null for none
-
setGreen
public Color setGreen(Float green)
The amount of green in the color as a value in the interval [0, 1].
- Parameters:
green - green or null for none
-
getRed
public Float getRed()
The amount of red in the color as a value in the interval [0, 1].
- Returns:
- value or
null for none
-
setRed
public Color setRed(Float red)
The amount of red in the color as a value in the interval [0, 1].
- Parameters:
red - red or null for none
-
set
public Color set(String fieldName,
Object value)
- Overrides:
set in class com.google.api.client.json.GenericJson
-
clone
public Color clone()
- Overrides:
clone in class com.google.api.client.json.GenericJson
Copyright © 2011–2024 Google. All rights reserved.