class Google::Apis::SheetsV4::ChartSpec

The specifications of a chart.

Attributes

alt_text[RW]

The alternative text that describes the chart. This is often used for accessibility. Corresponds to the JSON property `altText` @return [String]

background_color[RW]

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. This reference page doesn't 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. 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:&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 `backgroundColor` @return [Google::Apis::SheetsV4::Color]

background_color_style[RW]

A color value. Corresponds to the JSON property `backgroundColorStyle` @return [Google::Apis::SheetsV4::ColorStyle]

basic_chart[RW]

The specification for a basic chart. See BasicChartType for the list of charts this supports. Corresponds to the JSON property `basicChart` @return [Google::Apis::SheetsV4::BasicChartSpec]

bubble_chart[RW]

A bubble chart. Corresponds to the JSON property `bubbleChart` @return [Google::Apis::SheetsV4::BubbleChartSpec]

candlestick_chart[RW]

A candlestick chart. Corresponds to the JSON property `candlestickChart` @return [Google::Apis::SheetsV4::CandlestickChartSpec]

data_source_chart_properties[RW]

Properties of a data source chart. Corresponds to the JSON property `dataSourceChartProperties` @return [Google::Apis::SheetsV4::DataSourceChartProperties]

filter_specs[RW]

The filters applied to the source data of the chart. Only supported for data source charts. Corresponds to the JSON property `filterSpecs` @return [Array<Google::Apis::SheetsV4::FilterSpec>]

font_name[RW]

The name of the font to use by default for all chart text (e.g. title, axis labels, legend). If a font is specified for a specific part of the chart it will override this font name. Corresponds to the JSON property `fontName` @return [String]

hidden_dimension_strategy[RW]

Determines how the charts will use hidden rows or columns. Corresponds to the JSON property `hiddenDimensionStrategy` @return [String]

histogram_chart[RW]

A histogram chart. A histogram chart groups data items into bins, displaying each bin as a column of stacked items. Histograms are used to display the distribution of a dataset. Each column of items represents a range into which those items fall. The number of bins can be chosen automatically or specified explicitly. Corresponds to the JSON property `histogramChart` @return [Google::Apis::SheetsV4::HistogramChartSpec]

maximized[RW]

True to make a chart fill the entire space in which it's rendered with minimum padding. False to use the default padding. (Not applicable to Geo and Org charts.) Corresponds to the JSON property `maximized` @return [Boolean]

maximized?[RW]

True to make a chart fill the entire space in which it's rendered with minimum padding. False to use the default padding. (Not applicable to Geo and Org charts.) Corresponds to the JSON property `maximized` @return [Boolean]

org_chart[RW]

An org chart. Org charts require a unique set of labels in labels and may optionally include parent_labels and tooltips. parent_labels contain, for each node, the label identifying the parent node. tooltips contain, for each node, an optional tooltip. For example, to describe an OrgChart with Alice as the CEO, Bob as the President (reporting to Alice) and Cathy as VP of Sales (also reporting to Alice), have labels contain “Alice”, “Bob”, “Cathy”, parent_labels contain “”, “Alice”, “Alice” and tooltips contain “CEO”, “ President”, “VP Sales”. Corresponds to the JSON property `orgChart` @return [Google::Apis::SheetsV4::OrgChartSpec]

pie_chart[RW]

A pie chart. Corresponds to the JSON property `pieChart` @return [Google::Apis::SheetsV4::PieChartSpec]

scorecard_chart[RW]

A scorecard chart. Scorecard charts are used to highlight key performance indicators, known as KPIs, on the spreadsheet. A scorecard chart can represent things like total sales, average cost, or a top selling item. You can specify a single data value, or aggregate over a range of data. Percentage or absolute difference from a baseline value can be highlighted, like changes over time. Corresponds to the JSON property `scorecardChart` @return [Google::Apis::SheetsV4::ScorecardChartSpec]

sort_specs[RW]

The order to sort the chart data by. Only a single sort spec is supported. Only supported for data source charts. Corresponds to the JSON property `sortSpecs` @return [Array<Google::Apis::SheetsV4::SortSpec>]

subtitle[RW]

The subtitle of the chart. Corresponds to the JSON property `subtitle` @return [String]

subtitle_text_format[RW]

The format of a run of text in a cell. Absent values indicate that the field isn't specified. Corresponds to the JSON property `subtitleTextFormat` @return [Google::Apis::SheetsV4::TextFormat]

subtitle_text_position[RW]

Position settings for text. Corresponds to the JSON property `subtitleTextPosition` @return [Google::Apis::SheetsV4::TextPosition]

title[RW]

The title of the chart. Corresponds to the JSON property `title` @return [String]

title_text_format[RW]

The format of a run of text in a cell. Absent values indicate that the field isn't specified. Corresponds to the JSON property `titleTextFormat` @return [Google::Apis::SheetsV4::TextFormat]

title_text_position[RW]

Position settings for text. Corresponds to the JSON property `titleTextPosition` @return [Google::Apis::SheetsV4::TextPosition]

treemap_chart[RW]

A Treemap chart. Corresponds to the JSON property `treemapChart` @return [Google::Apis::SheetsV4::TreemapChartSpec]

waterfall_chart[RW]

A waterfall chart. Corresponds to the JSON property `waterfallChart` @return [Google::Apis::SheetsV4::WaterfallChartSpec]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/sheets_v4/classes.rb, line 3101
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/sheets_v4/classes.rb, line 3106
def update!(**args)
  @alt_text = args[:alt_text] if args.key?(:alt_text)
  @background_color = args[:background_color] if args.key?(:background_color)
  @background_color_style = args[:background_color_style] if args.key?(:background_color_style)
  @basic_chart = args[:basic_chart] if args.key?(:basic_chart)
  @bubble_chart = args[:bubble_chart] if args.key?(:bubble_chart)
  @candlestick_chart = args[:candlestick_chart] if args.key?(:candlestick_chart)
  @data_source_chart_properties = args[:data_source_chart_properties] if args.key?(:data_source_chart_properties)
  @filter_specs = args[:filter_specs] if args.key?(:filter_specs)
  @font_name = args[:font_name] if args.key?(:font_name)
  @hidden_dimension_strategy = args[:hidden_dimension_strategy] if args.key?(:hidden_dimension_strategy)
  @histogram_chart = args[:histogram_chart] if args.key?(:histogram_chart)
  @maximized = args[:maximized] if args.key?(:maximized)
  @org_chart = args[:org_chart] if args.key?(:org_chart)
  @pie_chart = args[:pie_chart] if args.key?(:pie_chart)
  @scorecard_chart = args[:scorecard_chart] if args.key?(:scorecard_chart)
  @sort_specs = args[:sort_specs] if args.key?(:sort_specs)
  @subtitle = args[:subtitle] if args.key?(:subtitle)
  @subtitle_text_format = args[:subtitle_text_format] if args.key?(:subtitle_text_format)
  @subtitle_text_position = args[:subtitle_text_position] if args.key?(:subtitle_text_position)
  @title = args[:title] if args.key?(:title)
  @title_text_format = args[:title_text_format] if args.key?(:title_text_format)
  @title_text_position = args[:title_text_position] if args.key?(:title_text_position)
  @treemap_chart = args[:treemap_chart] if args.key?(:treemap_chart)
  @waterfall_chart = args[:waterfall_chart] if args.key?(:waterfall_chart)
end