Class: Google::Apis::SheetsV4::TreemapChartSpec

Inherits:
Object
  • Object
show all
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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ TreemapChartSpec

Returns a new instance of TreemapChartSpec



9198
9199
9200
# File 'generated/google/apis/sheets_v4/classes.rb', line 9198

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#color_dataGoogle::Apis::SheetsV4::ChartData

The data included in a domain or series. Corresponds to the JSON property colorData



9027
9028
9029
# File 'generated/google/apis/sheets_v4/classes.rb', line 9027

def color_data
  @color_data
end

#color_scaleGoogle::Apis::SheetsV4::TreemapChartColorScale

A color scale for a treemap chart. Corresponds to the JSON property colorScale



9032
9033
9034
# File 'generated/google/apis/sheets_v4/classes.rb', line 9032

def color_scale
  @color_scale
end

#header_colorGoogle::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. Note: this proto does not carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color space. 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



9139
9140
9141
# File 'generated/google/apis/sheets_v4/classes.rb', line 9139

def header_color
  @header_color
end

#hide_tooltipsBoolean Also known as: hide_tooltips?

True to hide tooltips. Corresponds to the JSON property hideTooltips

Returns:

  • (Boolean)


9144
9145
9146
# File 'generated/google/apis/sheets_v4/classes.rb', line 9144

def hide_tooltips
  @hide_tooltips
end

#hinted_levelsFixnum

The number of additional data levels beyond the labeled levels to be shown on the treemap chart. These levels are not interactive and are shown without their labels. Defaults to 0 if not specified. Corresponds to the JSON property hintedLevels

Returns:

  • (Fixnum)


9152
9153
9154
# File 'generated/google/apis/sheets_v4/classes.rb', line 9152

def hinted_levels
  @hinted_levels
end

#labelsGoogle::Apis::SheetsV4::ChartData

The data included in a domain or series. Corresponds to the JSON property labels



9157
9158
9159
# File 'generated/google/apis/sheets_v4/classes.rb', line 9157

def labels
  @labels
end

#levelsFixnum

The number of data levels to show on the treemap chart. These levels are interactive and are shown with their labels. Defaults to 2 if not specified. Corresponds to the JSON property levels

Returns:

  • (Fixnum)


9164
9165
9166
# File 'generated/google/apis/sheets_v4/classes.rb', line 9164

def levels
  @levels
end

#max_valueFloat

The maximum possible data value. Cells with values greater than this will have the same color as cells with this value. If not specified, defaults to the actual maximum value from color_data, or the maximum value from size_data if color_data is not specified. Corresponds to the JSON property maxValue

Returns:

  • (Float)


9172
9173
9174
# File 'generated/google/apis/sheets_v4/classes.rb', line 9172

def max_value
  @max_value
end

#min_valueFloat

The minimum possible data value. Cells with values less than this will have the same color as cells with this value. If not specified, defaults to the actual minimum value from color_data, or the minimum value from size_data if color_data is not specified. Corresponds to the JSON property minValue

Returns:

  • (Float)


9180
9181
9182
# File 'generated/google/apis/sheets_v4/classes.rb', line 9180

def min_value
  @min_value
end

#parent_labelsGoogle::Apis::SheetsV4::ChartData

The data included in a domain or series. Corresponds to the JSON property parentLabels



9185
9186
9187
# File 'generated/google/apis/sheets_v4/classes.rb', line 9185

def parent_labels
  @parent_labels
end

#size_dataGoogle::Apis::SheetsV4::ChartData

The data included in a domain or series. Corresponds to the JSON property sizeData



9190
9191
9192
# File 'generated/google/apis/sheets_v4/classes.rb', line 9190

def size_data
  @size_data
end

#text_formatGoogle::Apis::SheetsV4::TextFormat

The format of a run of text in a cell. Absent values indicate that the field isn't specified. Corresponds to the JSON property textFormat



9196
9197
9198
# File 'generated/google/apis/sheets_v4/classes.rb', line 9196

def text_format
  @text_format
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
# File 'generated/google/apis/sheets_v4/classes.rb', line 9203

def update!(**args)
  @color_data = args[:color_data] if args.key?(:color_data)
  @color_scale = args[:color_scale] if args.key?(:color_scale)
  @header_color = args[:header_color] if args.key?(:header_color)
  @hide_tooltips = args[:hide_tooltips] if args.key?(:hide_tooltips)
  @hinted_levels = args[:hinted_levels] if args.key?(:hinted_levels)
  @labels = args[:labels] if args.key?(:labels)
  @levels = args[:levels] if args.key?(:levels)
  @max_value = args[:max_value] if args.key?(:max_value)
  @min_value = args[:min_value] if args.key?(:min_value)
  @parent_labels = args[:parent_labels] if args.key?(:parent_labels)
  @size_data = args[:size_data] if args.key?(:size_data)
  @text_format = args[:text_format] if args.key?(:text_format)
end