target.apidocs.com.google.api.services.sheets.v4.model.ConditionalFormatRule.html Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-sheets Show documentation

There is a newer version: v4-rev20240514-2.0.0

Show newest version







ConditionalFormatRule (Google Sheets API v4-rev20240319-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.sheets.v4.model
Class ConditionalFormatRule



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.ConditionalFormatRule













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class ConditionalFormatRule
extends com.google.api.client.json.GenericJson
A rule describing a conditional format.

  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>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


ConditionalFormatRule() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


ConditionalFormatRule
clone() 


BooleanRule
getBooleanRule()
The formatting is either "on" or "off" according to the rule.



GradientRule
getGradientRule()
The formatting will vary based on the gradients in the rule.



List<GridRange>
getRanges()
The ranges that are formatted if the condition is true.



ConditionalFormatRule
set(String fieldName,
   Object value) 


ConditionalFormatRule
setBooleanRule(BooleanRule booleanRule)
The formatting is either "on" or "off" according to the rule.



ConditionalFormatRule
setGradientRule(GradientRule gradientRule)
The formatting will vary based on the gradients in the rule.



ConditionalFormatRule
setRanges(List<GridRange> ranges)
The ranges that are formatted if the condition is true.







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














Constructor Detail





ConditionalFormatRule
public ConditionalFormatRule()









Method Detail





getBooleanRule
public BooleanRule getBooleanRule()
The formatting is either "on" or "off" according to the rule.

Returns:
value or null for none








setBooleanRule
public ConditionalFormatRule setBooleanRule(BooleanRule booleanRule)
The formatting is either "on" or "off" according to the rule.

Parameters:
booleanRule - booleanRule or null for none








getGradientRule
public GradientRule getGradientRule()
The formatting will vary based on the gradients in the rule.

Returns:
value or null for none








setGradientRule
public ConditionalFormatRule setGradientRule(GradientRule gradientRule)
The formatting will vary based on the gradients in the rule.

Parameters:
gradientRule - gradientRule or null for none








getRanges
public List<GridRange> getRanges()
The ranges that are formatted if the condition is true. All the ranges must be on the same
 grid.

Returns:
value or null for none








setRanges
public ConditionalFormatRule setRanges(List<GridRange> ranges)
The ranges that are formatted if the condition is true. All the ranges must be on the same
 grid.

Parameters:
ranges - ranges or null for none








set
public ConditionalFormatRule set(String fieldName,
                                 Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public ConditionalFormatRule clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`ConditionalFormatRule`	`clone()`
`BooleanRule`	`getBooleanRule()` The formatting is either "on" or "off" according to the rule.
`GradientRule`	`getGradientRule()` The formatting will vary based on the gradients in the rule.
`List<GridRange>`	`getRanges()` The ranges that are formatted if the condition is true.
`ConditionalFormatRule`	`set(String fieldName, Object value)`
`ConditionalFormatRule`	`setBooleanRule(BooleanRule booleanRule)` The formatting is either "on" or "off" according to the rule.
`ConditionalFormatRule`	`setGradientRule(GradientRule gradientRule)` The formatting will vary based on the gradients in the rule.
`ConditionalFormatRule`	`setRanges(List<GridRange> ranges)` The ranges that are formatted if the condition is true.