BandingProperties (Google Sheets API v4 (Rev. 612) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.sheets.v4.model.BandingProperties

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class BandingProperties
extends com.google.api.client.json.GenericJson
```
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.
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
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

BandingProperties()

Constructors
Constructor and Description
`BandingProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BandingProperties`	`clone()`
`Color`	`getFirstBandColor()` The first color that is alternating.
`ColorStyle`	`getFirstBandColorStyle()` The first color that is alternating.
`Color`	`getFooterColor()` The color of the last row or column.
`ColorStyle`	`getFooterColorStyle()` The color of the last row or column.
`Color`	`getHeaderColor()` The color of the first row or column.
`ColorStyle`	`getHeaderColorStyle()` The color of the first row or column.
`Color`	`getSecondBandColor()` The second color that is alternating.
`ColorStyle`	`getSecondBandColorStyle()` The second color that is alternating.
`BandingProperties`	`set(java.lang.String fieldName, java.lang.Object value)`
`BandingProperties`	`setFirstBandColor(Color firstBandColor)` The first color that is alternating.
`BandingProperties`	`setFirstBandColorStyle(ColorStyle firstBandColorStyle)` The first color that is alternating.
`BandingProperties`	`setFooterColor(Color footerColor)` The color of the last row or column.
`BandingProperties`	`setFooterColorStyle(ColorStyle footerColorStyle)` The color of the last row or column.
`BandingProperties`	`setHeaderColor(Color headerColor)` The color of the first row or column.
`BandingProperties`	`setHeaderColorStyle(ColorStyle headerColorStyle)` The color of the first row or column.
`BandingProperties`	`setSecondBandColor(Color secondBandColor)` The second color that is alternating.
`BandingProperties`	`setSecondBandColorStyle(ColorStyle secondBandColorStyle)` The second color that is alternating.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, 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

- Constructor Detail
  - BandingProperties
```
public BandingProperties()
```
- Method Detail
  - getFirstBandColor
```
public Color getFirstBandColor()
```
    The first color that is alternating. (Required)
    
    Returns:
    
    value or null for none
  - setFirstBandColor
```
public BandingProperties setFirstBandColor(Color firstBandColor)
```
    The first color that is alternating. (Required)
    
    Parameters:
    
    firstBandColor - firstBandColor or null for none
  - getFirstBandColorStyle
```
public ColorStyle getFirstBandColorStyle()
```
    The first color that is alternating. (Required) If first_band_color is also set, this field takes precedence.
    
    Returns:
    
    value or null for none
  - setFirstBandColorStyle
```
public BandingProperties setFirstBandColorStyle(ColorStyle firstBandColorStyle)
```
    The first color that is alternating. (Required) If first_band_color is also set, this field takes precedence.
    
    Parameters:
    
    firstBandColorStyle - firstBandColorStyle or null for none
  - getFooterColor
```
public Color getFooterColor()
```
    The color of the last row or column. If this field is not set, the last row or column is filled with either first_band_color or second_band_color, depending on the color of the previous row or column.
    
    Returns:
    
    value or null for none
  - setFooterColor
```
public BandingProperties setFooterColor(Color footerColor)
```
    The color of the last row or column. If this field is not set, the last row or column is filled with either first_band_color or second_band_color, depending on the color of the previous row or column.
    
    Parameters:
    
    footerColor - footerColor or null for none
  - getFooterColorStyle
```
public ColorStyle getFooterColorStyle()
```
    The color of the last row or column. If this field is not set, the last row or column is filled with either first_band_color or second_band_color, depending on the color of the previous row or column. If footer_color is also set, this field takes precedence.
    
    Returns:
    
    value or null for none
  - setFooterColorStyle
```
public BandingProperties setFooterColorStyle(ColorStyle footerColorStyle)
```
    The color of the last row or column. If this field is not set, the last row or column is filled with either first_band_color or second_band_color, depending on the color of the previous row or column. If footer_color is also set, this field takes precedence.
    
    Parameters:
    
    footerColorStyle - footerColorStyle or null for none
  - getHeaderColor
```
public Color getHeaderColor()
```
    The color of the first row or column. If this field is set, the first row or column is filled with this color and the colors alternate between first_band_color and second_band_color starting from the second row or column. Otherwise, the first row or column is filled with first_band_color and the colors proceed to alternate as they normally would.
    
    Returns:
    
    value or null for none
  - setHeaderColor
```
public BandingProperties setHeaderColor(Color headerColor)
```
    The color of the first row or column. If this field is set, the first row or column is filled with this color and the colors alternate between first_band_color and second_band_color starting from the second row or column. Otherwise, the first row or column is filled with first_band_color and the colors proceed to alternate as they normally would.
    
    Parameters:
    
    headerColor - headerColor or null for none
  - getHeaderColorStyle
```
public ColorStyle getHeaderColorStyle()
```
    The color of the first row or column. If this field is set, the first row or column is filled with this color and the colors alternate between first_band_color and second_band_color starting from the second row or column. Otherwise, the first row or column is filled with first_band_color and the colors proceed to alternate as they normally would. If header_color is also set, this field takes precedence.
    
    Returns:
    
    value or null for none
  - setHeaderColorStyle
```
public BandingProperties setHeaderColorStyle(ColorStyle headerColorStyle)
```
    The color of the first row or column. If this field is set, the first row or column is filled with this color and the colors alternate between first_band_color and second_band_color starting from the second row or column. Otherwise, the first row or column is filled with first_band_color and the colors proceed to alternate as they normally would. If header_color is also set, this field takes precedence.
    
    Parameters:
    
    headerColorStyle - headerColorStyle or null for none
  - getSecondBandColor
```
public Color getSecondBandColor()
```
    The second color that is alternating. (Required)
    
    Returns:
    
    value or null for none
  - setSecondBandColor
```
public BandingProperties setSecondBandColor(Color secondBandColor)
```
    The second color that is alternating. (Required)
    
    Parameters:
    
    secondBandColor - secondBandColor or null for none
  - getSecondBandColorStyle
```
public ColorStyle getSecondBandColorStyle()
```
    The second color that is alternating. (Required) If second_band_color is also set, this field takes precedence.
    
    Returns:
    
    value or null for none
  - setSecondBandColorStyle
```
public BandingProperties setSecondBandColorStyle(ColorStyle secondBandColorStyle)
```
    The second color that is alternating. (Required) If second_band_color is also set, this field takes precedence.
    
    Parameters:
    
    secondBandColorStyle - secondBandColorStyle or null for none
  - set
```
public BandingProperties set(java.lang.String fieldName,
                             java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public BandingProperties clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Google Sheets API v4 (revision 612)

Class BandingProperties

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

BandingProperties

Method Detail

getFirstBandColor

setFirstBandColor

getFirstBandColorStyle

setFirstBandColorStyle

getFooterColor

setFooterColor

getFooterColorStyle

setFooterColorStyle

getHeaderColor

setHeaderColor

getHeaderColorStyle

setHeaderColorStyle

getSecondBandColor

setSecondBandColor

getSecondBandColorStyle

setSecondBandColorStyle

set

clone