Class: Google::Apis::SheetsV4::BandingProperties
- Inherits:
-
Object
- Object
- Google::Apis::SheetsV4::BandingProperties
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/sheets_v4/classes.rb,
generated/google/apis/sheets_v4/representations.rb,
generated/google/apis/sheets_v4/representations.rb
Overview
Properties referring a single dimension (either row or column). If both BandedRange.row_properties and BandedRange.column_properties are set, the fill colors are applied to cells according to the following rules:
- header_color and footer_color take priority over band colors.
- first_band_color takes priority over second_band_color.
- row_properties takes priority over column_properties. For example, the first row color takes priority over the first column color, but the first column color takes priority over the second row color. Similarly, the row header takes priority over the column header in the top left cell, but the column header takes priority over the first row color if the row header is not set.
Instance Attribute Summary collapse
-
#first_band_color ⇒ Google::Apis::SheetsV4::Color
Represents a color in the RGBA color space.
-
#footer_color ⇒ Google::Apis::SheetsV4::Color
Represents a color in the RGBA color space.
-
#header_color ⇒ Google::Apis::SheetsV4::Color
Represents a color in the RGBA color space.
-
#second_band_color ⇒ Google::Apis::SheetsV4::Color
Represents a color in the RGBA color space.
Instance Method Summary collapse
-
#initialize(**args) ⇒ BandingProperties
constructor
A new instance of BandingProperties.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ BandingProperties
Returns a new instance of BandingProperties
3161 3162 3163 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 3161 def initialize(**args) update!(**args) end |
Instance Attribute Details
#first_band_color ⇒ Google::Apis::SheetsV4::Color
Represents a color in the RGBA color space. This representation is designed
for simplicity of conversion to/from color representations in various
languages over compactness; for example, the fields of this representation
can be trivially provided to the constructor of "java.awt.Color" in Java; it
can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
method in iOS; and, with just a little work, it can be easily formatted into
a CSS "rgba()" string in JavaScript, as well. Here are some examples:
Example (Java):
import com.google.type.Color;
// ...
public static java.awt.Color fromProto(Color protocolor)
float alpha = protocolor.hasAlpha()
? protocolor.getAlpha().getValue()
: 1.0;
return new java.awt.Color(
protocolor.getRed(),
protocolor.getGreen(),
protocolor.getBlue(),
alpha);
public static Color toProto(java.awt.Color color)
float red = (float) color.getRed();
float green = (float) color.getGreen();
float blue = (float) color.getBlue();
float denominator = 255.0;
Color.Builder resultBuilder =
Color
.newBuilder()
.setRed(red / denominator)
.setGreen(green / denominator)
.setBlue(blue / denominator);
int alpha = color.getAlpha();
if (alpha != 255)
result.setAlpha(
FloatValue
.newBuilder()
.setValue(((float) alpha) / denominator)
.build());
return resultBuilder.build();
// ...
Example (iOS / Obj-C):
// ...
static UIColor* fromProto(Color* protocolor)
float red = [protocolor red];
float green = [protocolor green];
float blue = [protocolor blue];
FloatValue* alpha_wrapper = [protocolor alpha];
float alpha = 1.0;
if (alpha_wrapper != nil)
alpha = [alpha_wrapper value];
return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
static Color* toProto(UIColor* color)
CGFloat red, green, blue, alpha;
if (![color getRed:&red green:&green blue:&blue alpha:&alpha])
return nil;
Color* result = [Color alloc] init];
[result setRed:red];
[result setGreen:green];
[result setBlue:blue];
if (alpha <= 0.9999)
[result setAlpha:floatWrapperWithValue(alpha)];
[result autorelease];
return result;
// ...
Example (JavaScript):
// ...
var protoToCssColor = function(rgb_color)
var redFrac = rgb_color.red || 0.0;
var greenFrac = rgb_color.green || 0.0;
var blueFrac = rgb_color.blue || 0.0;
var red = Math.floor(redFrac * 255);
var green = Math.floor(greenFrac * 255);
var blue = Math.floor(blueFrac * 255);
if (!('alpha' in rgb_color))
return rgbToCssColor_(red, green, blue);
var alphaFrac = rgb_color.alpha.value || 0.0;
var rgbParams = [red, green, blue].join(',');
return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
;
var rgbToCssColor_ = function(red, green, blue)
var rgbNumber = new Number((red << 16) | (green << 8) | blue);
var hexString = rgbNumber.toString(16);
var missingZeros = 6 - hexString.length;
var resultBuilder = ['#'];
for (var i = 0; i < missingZeros; i++)
resultBuilder.push('0');
resultBuilder.push(hexString);
return resultBuilder.join('');
;
// ...
Corresponds to the JSON property firstBandColor
3056 3057 3058 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 3056 def first_band_color @first_band_color end |
#footer_color ⇒ Google::Apis::SheetsV4::Color
Represents a color in the RGBA color space. This representation is designed
for simplicity of conversion to/from color representations in various
languages over compactness; for example, the fields of this representation
can be trivially provided to the constructor of "java.awt.Color" in Java; it
can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
method in iOS; and, with just a little work, it can be easily formatted into
a CSS "rgba()" string in JavaScript, as well. Here are some examples:
Example (Java):
import com.google.type.Color;
// ...
public static java.awt.Color fromProto(Color protocolor)
float alpha = protocolor.hasAlpha()
? protocolor.getAlpha().getValue()
: 1.0;
return new java.awt.Color(
protocolor.getRed(),
protocolor.getGreen(),
protocolor.getBlue(),
alpha);
public static Color toProto(java.awt.Color color)
float red = (float) color.getRed();
float green = (float) color.getGreen();
float blue = (float) color.getBlue();
float denominator = 255.0;
Color.Builder resultBuilder =
Color
.newBuilder()
.setRed(red / denominator)
.setGreen(green / denominator)
.setBlue(blue / denominator);
int alpha = color.getAlpha();
if (alpha != 255)
result.setAlpha(
FloatValue
.newBuilder()
.setValue(((float) alpha) / denominator)
.build());
return resultBuilder.build();
// ...
Example (iOS / Obj-C):
// ...
static UIColor* fromProto(Color* protocolor)
float red = [protocolor red];
float green = [protocolor green];
float blue = [protocolor blue];
FloatValue* alpha_wrapper = [protocolor alpha];
float alpha = 1.0;
if (alpha_wrapper != nil)
alpha = [alpha_wrapper value];
return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
static Color* toProto(UIColor* color)
CGFloat red, green, blue, alpha;
if (![color getRed:&red green:&green blue:&blue alpha:&alpha])
return nil;
Color* result = [Color alloc] init];
[result setRed:red];
[result setGreen:green];
[result setBlue:blue];
if (alpha <= 0.9999)
[result setAlpha:floatWrapperWithValue(alpha)];
[result autorelease];
return result;
// ...
Example (JavaScript):
// ...
var protoToCssColor = function(rgb_color)
var redFrac = rgb_color.red || 0.0;
var greenFrac = rgb_color.green || 0.0;
var blueFrac = rgb_color.blue || 0.0;
var red = Math.floor(redFrac * 255);
var green = Math.floor(greenFrac * 255);
var blue = Math.floor(blueFrac * 255);
if (!('alpha' in rgb_color))
return rgbToCssColor_(red, green, blue);
var alphaFrac = rgb_color.alpha.value || 0.0;
var rgbParams = [red, green, blue].join(',');
return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
;
var rgbToCssColor_ = function(red, green, blue)
var rgbNumber = new Number((red << 16) | (green << 8) | blue);
var hexString = rgbNumber.toString(16);
var missingZeros = 6 - hexString.length;
var resultBuilder = ['#'];
for (var i = 0; i < missingZeros; i++)
resultBuilder.push('0');
resultBuilder.push(hexString);
return resultBuilder.join('');
;
// ...
Corresponds to the JSON property footerColor
2850 2851 2852 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 2850 def @footer_color end |
#header_color ⇒ Google::Apis::SheetsV4::Color
Represents a color in the RGBA color space. This representation is designed
for simplicity of conversion to/from color representations in various
languages over compactness; for example, the fields of this representation
can be trivially provided to the constructor of "java.awt.Color" in Java; it
can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
method in iOS; and, with just a little work, it can be easily formatted into
a CSS "rgba()" string in JavaScript, as well. Here are some examples:
Example (Java):
import com.google.type.Color;
// ...
public static java.awt.Color fromProto(Color protocolor)
float alpha = protocolor.hasAlpha()
? protocolor.getAlpha().getValue()
: 1.0;
return new java.awt.Color(
protocolor.getRed(),
protocolor.getGreen(),
protocolor.getBlue(),
alpha);
public static Color toProto(java.awt.Color color)
float red = (float) color.getRed();
float green = (float) color.getGreen();
float blue = (float) color.getBlue();
float denominator = 255.0;
Color.Builder resultBuilder =
Color
.newBuilder()
.setRed(red / denominator)
.setGreen(green / denominator)
.setBlue(blue / denominator);
int alpha = color.getAlpha();
if (alpha != 255)
result.setAlpha(
FloatValue
.newBuilder()
.setValue(((float) alpha) / denominator)
.build());
return resultBuilder.build();
// ...
Example (iOS / Obj-C):
// ...
static UIColor* fromProto(Color* protocolor)
float red = [protocolor red];
float green = [protocolor green];
float blue = [protocolor blue];
FloatValue* alpha_wrapper = [protocolor alpha];
float alpha = 1.0;
if (alpha_wrapper != nil)
alpha = [alpha_wrapper value];
return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
static Color* toProto(UIColor* color)
CGFloat red, green, blue, alpha;
if (![color getRed:&red green:&green blue:&blue alpha:&alpha])
return nil;
Color* result = [Color alloc] init];
[result setRed:red];
[result setGreen:green];
[result setBlue:blue];
if (alpha <= 0.9999)
[result setAlpha:floatWrapperWithValue(alpha)];
[result autorelease];
return result;
// ...
Example (JavaScript):
// ...
var protoToCssColor = function(rgb_color)
var redFrac = rgb_color.red || 0.0;
var greenFrac = rgb_color.green || 0.0;
var blueFrac = rgb_color.blue || 0.0;
var red = Math.floor(redFrac * 255);
var green = Math.floor(greenFrac * 255);
var blue = Math.floor(blueFrac * 255);
if (!('alpha' in rgb_color))
return rgbToCssColor_(red, green, blue);
var alphaFrac = rgb_color.alpha.value || 0.0;
var rgbParams = [red, green, blue].join(',');
return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
;
var rgbToCssColor_ = function(red, green, blue)
var rgbNumber = new Number((red << 16) | (green << 8) | blue);
var hexString = rgbNumber.toString(16);
var missingZeros = 6 - hexString.length;
var resultBuilder = ['#'];
for (var i = 0; i < missingZeros; i++)
resultBuilder.push('0');
resultBuilder.push(hexString);
return resultBuilder.join('');
;
// ...
Corresponds to the JSON property headerColor
2953 2954 2955 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 2953 def header_color @header_color end |
#second_band_color ⇒ Google::Apis::SheetsV4::Color
Represents a color in the RGBA color space. This representation is designed
for simplicity of conversion to/from color representations in various
languages over compactness; for example, the fields of this representation
can be trivially provided to the constructor of "java.awt.Color" in Java; it
can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
method in iOS; and, with just a little work, it can be easily formatted into
a CSS "rgba()" string in JavaScript, as well. Here are some examples:
Example (Java):
import com.google.type.Color;
// ...
public static java.awt.Color fromProto(Color protocolor)
float alpha = protocolor.hasAlpha()
? protocolor.getAlpha().getValue()
: 1.0;
return new java.awt.Color(
protocolor.getRed(),
protocolor.getGreen(),
protocolor.getBlue(),
alpha);
public static Color toProto(java.awt.Color color)
float red = (float) color.getRed();
float green = (float) color.getGreen();
float blue = (float) color.getBlue();
float denominator = 255.0;
Color.Builder resultBuilder =
Color
.newBuilder()
.setRed(red / denominator)
.setGreen(green / denominator)
.setBlue(blue / denominator);
int alpha = color.getAlpha();
if (alpha != 255)
result.setAlpha(
FloatValue
.newBuilder()
.setValue(((float) alpha) / denominator)
.build());
return resultBuilder.build();
// ...
Example (iOS / Obj-C):
// ...
static UIColor* fromProto(Color* protocolor)
float red = [protocolor red];
float green = [protocolor green];
float blue = [protocolor blue];
FloatValue* alpha_wrapper = [protocolor alpha];
float alpha = 1.0;
if (alpha_wrapper != nil)
alpha = [alpha_wrapper value];
return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
static Color* toProto(UIColor* color)
CGFloat red, green, blue, alpha;
if (![color getRed:&red green:&green blue:&blue alpha:&alpha])
return nil;
Color* result = [Color alloc] init];
[result setRed:red];
[result setGreen:green];
[result setBlue:blue];
if (alpha <= 0.9999)
[result setAlpha:floatWrapperWithValue(alpha)];
[result autorelease];
return result;
// ...
Example (JavaScript):
// ...
var protoToCssColor = function(rgb_color)
var redFrac = rgb_color.red || 0.0;
var greenFrac = rgb_color.green || 0.0;
var blueFrac = rgb_color.blue || 0.0;
var red = Math.floor(redFrac * 255);
var green = Math.floor(greenFrac * 255);
var blue = Math.floor(blueFrac * 255);
if (!('alpha' in rgb_color))
return rgbToCssColor_(red, green, blue);
var alphaFrac = rgb_color.alpha.value || 0.0;
var rgbParams = [red, green, blue].join(',');
return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
;
var rgbToCssColor_ = function(red, green, blue)
var rgbNumber = new Number((red << 16) | (green << 8) | blue);
var hexString = rgbNumber.toString(16);
var missingZeros = 6 - hexString.length;
var resultBuilder = ['#'];
for (var i = 0; i < missingZeros; i++)
resultBuilder.push('0');
resultBuilder.push(hexString);
return resultBuilder.join('');
;
// ...
Corresponds to the JSON property secondBandColor
3159 3160 3161 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 3159 def second_band_color @second_band_color end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3166 3167 3168 3169 3170 3171 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 3166 def update!(**args) @footer_color = args[:footer_color] if args.key?(:footer_color) @header_color = args[:header_color] if args.key?(:header_color) @first_band_color = args[:first_band_color] if args.key?(:first_band_color) @second_band_color = args[:second_band_color] if args.key?(:second_band_color) end |