Class: Google::Apis::SheetsV4::ChartSpec

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

The specifications of a chart.

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) ⇒ ChartSpec

Returns a new instance of ChartSpec.



2975
2976
2977
# File 'generated/google/apis/sheets_v4/classes.rb', line 2975

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

Instance Attribute Details

#alt_textString

The alternative text that describes the chart. This is often used for accessibility. Corresponds to the JSON property altText

Returns:

  • (String)


2789
2790
2791
# File 'generated/google/apis/sheets_v4/classes.rb', line 2789

def alt_text
  @alt_text
end

#background_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. Note: when color equality needs to be decided, implementations, unless documented otherwise, will treat two colors to be 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



2838
2839
2840
# File 'generated/google/apis/sheets_v4/classes.rb', line 2838

def background_color
  @background_color
end

#background_color_styleGoogle::Apis::SheetsV4::ColorStyle

A color value. Corresponds to the JSON property backgroundColorStyle



2843
2844
2845
# File 'generated/google/apis/sheets_v4/classes.rb', line 2843

def background_color_style
  @background_color_style
end

#basic_chartGoogle::Apis::SheetsV4::BasicChartSpec

The specification for a basic chart. See BasicChartType for the list of charts this supports. Corresponds to the JSON property basicChart



2849
2850
2851
# File 'generated/google/apis/sheets_v4/classes.rb', line 2849

def basic_chart
  @basic_chart
end

#bubble_chartGoogle::Apis::SheetsV4::BubbleChartSpec

A bubble chart. Corresponds to the JSON property bubbleChart



2854
2855
2856
# File 'generated/google/apis/sheets_v4/classes.rb', line 2854

def bubble_chart
  @bubble_chart
end

#candlestick_chartGoogle::Apis::SheetsV4::CandlestickChartSpec

A candlestick chart. Corresponds to the JSON property candlestickChart



2859
2860
2861
# File 'generated/google/apis/sheets_v4/classes.rb', line 2859

def candlestick_chart
  @candlestick_chart
end

#data_source_chart_propertiesGoogle::Apis::SheetsV4::DataSourceChartProperties

Properties of a data source chart. Corresponds to the JSON property dataSourceChartProperties



2864
2865
2866
# File 'generated/google/apis/sheets_v4/classes.rb', line 2864

def data_source_chart_properties
  @data_source_chart_properties
end

#filter_specsArray<Google::Apis::SheetsV4::FilterSpec>

The filters applied to the source data of the chart. Only supported for data source charts. Corresponds to the JSON property filterSpecs



2870
2871
2872
# File 'generated/google/apis/sheets_v4/classes.rb', line 2870

def filter_specs
  @filter_specs
end

#font_nameString

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

Returns:

  • (String)


2877
2878
2879
# File 'generated/google/apis/sheets_v4/classes.rb', line 2877

def font_name
  @font_name
end

#hidden_dimension_strategyString

Determines how the charts will use hidden rows or columns. Corresponds to the JSON property hiddenDimensionStrategy

Returns:

  • (String)


2882
2883
2884
# File 'generated/google/apis/sheets_v4/classes.rb', line 2882

def hidden_dimension_strategy
  @hidden_dimension_strategy
end

#histogram_chartGoogle::Apis::SheetsV4::HistogramChartSpec

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



2891
2892
2893
# File 'generated/google/apis/sheets_v4/classes.rb', line 2891

def histogram_chart
  @histogram_chart
end

#maximizedBoolean Also known as: maximized?

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

Returns:

  • (Boolean)


2898
2899
2900
# File 'generated/google/apis/sheets_v4/classes.rb', line 2898

def maximized
  @maximized
end

#org_chartGoogle::Apis::SheetsV4::OrgChartSpec

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



2911
2912
2913
# File 'generated/google/apis/sheets_v4/classes.rb', line 2911

def org_chart
  @org_chart
end

#pie_chartGoogle::Apis::SheetsV4::PieChartSpec

A pie chart. Corresponds to the JSON property pieChart



2916
2917
2918
# File 'generated/google/apis/sheets_v4/classes.rb', line 2916

def pie_chart
  @pie_chart
end

#scorecard_chartGoogle::Apis::SheetsV4::ScorecardChartSpec

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



2925
2926
2927
# File 'generated/google/apis/sheets_v4/classes.rb', line 2925

def scorecard_chart
  @scorecard_chart
end

#sort_specsArray<Google::Apis::SheetsV4::SortSpec>

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



2931
2932
2933
# File 'generated/google/apis/sheets_v4/classes.rb', line 2931

def sort_specs
  @sort_specs
end

#subtitleString

The subtitle of the chart. Corresponds to the JSON property subtitle

Returns:

  • (String)


2936
2937
2938
# File 'generated/google/apis/sheets_v4/classes.rb', line 2936

def subtitle
  @subtitle
end

#subtitle_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 subtitleTextFormat



2942
2943
2944
# File 'generated/google/apis/sheets_v4/classes.rb', line 2942

def subtitle_text_format
  @subtitle_text_format
end

#subtitle_text_positionGoogle::Apis::SheetsV4::TextPosition

Position settings for text. Corresponds to the JSON property subtitleTextPosition



2947
2948
2949
# File 'generated/google/apis/sheets_v4/classes.rb', line 2947

def subtitle_text_position
  @subtitle_text_position
end

#titleString

The title of the chart. Corresponds to the JSON property title

Returns:

  • (String)


2952
2953
2954
# File 'generated/google/apis/sheets_v4/classes.rb', line 2952

def title
  @title
end

#title_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 titleTextFormat



2958
2959
2960
# File 'generated/google/apis/sheets_v4/classes.rb', line 2958

def title_text_format
  @title_text_format
end

#title_text_positionGoogle::Apis::SheetsV4::TextPosition

Position settings for text. Corresponds to the JSON property titleTextPosition



2963
2964
2965
# File 'generated/google/apis/sheets_v4/classes.rb', line 2963

def title_text_position
  @title_text_position
end

#treemap_chartGoogle::Apis::SheetsV4::TreemapChartSpec

A Treemap chart. Corresponds to the JSON property treemapChart



2968
2969
2970
# File 'generated/google/apis/sheets_v4/classes.rb', line 2968

def treemap_chart
  @treemap_chart
end

#waterfall_chartGoogle::Apis::SheetsV4::WaterfallChartSpec

A waterfall chart. Corresponds to the JSON property waterfallChart



2973
2974
2975
# File 'generated/google/apis/sheets_v4/classes.rb', line 2973

def waterfall_chart
  @waterfall_chart
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
# File 'generated/google/apis/sheets_v4/classes.rb', line 2980

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