File: BubbleChartSpec.java

package info (click to toggle)
google-api-services-sheets-java 1.32.1-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 2,008 kB
  • sloc: java: 12,826; xml: 161; makefile: 2
file content (357 lines) | stat: -rw-r--r-- 11,134 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
/*
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.sheets.v4.model;

/**
 * A bubble chart.
 *
 * <p> 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:
 * <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
 * </p>
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class BubbleChartSpec extends com.google.api.client.json.GenericJson {

  /**
   * The bubble border color.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private Color bubbleBorderColor;

  /**
   * The bubble border color. If bubble_border_color is also set, this field takes precedence.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private ColorStyle bubbleBorderColorStyle;

  /**
   * The data containing the bubble labels. These do not need to be unique.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private ChartData bubbleLabels;

  /**
   * The max radius size of the bubbles, in pixels. If specified, the field must be a positive
   * value.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer bubbleMaxRadiusSize;

  /**
   * The minimum radius size of the bubbles, in pixels. If specific, the field must be a positive
   * value.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer bubbleMinRadiusSize;

  /**
   * The opacity of the bubbles between 0 and 1.0. 0 is fully transparent and 1 is fully opaque.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Float bubbleOpacity;

  /**
   * The data containing the bubble sizes. Bubble sizes are used to draw the bubbles at different
   * sizes relative to each other. If specified, group_ids must also be specified. This field is
   * optional.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private ChartData bubbleSizes;

  /**
   * The format of the text inside the bubbles. Strikethrough, underline, and link are not
   * supported.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private TextFormat bubbleTextStyle;

  /**
   * The data containing the bubble x-values. These values locate the bubbles in the chart
   * horizontally.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private ChartData domain;

  /**
   * The data containing the bubble group IDs. All bubbles with the same group ID are drawn in the
   * same color. If bubble_sizes is specified then this field must also be specified but may contain
   * blank values. This field is optional.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private ChartData groupIds;

  /**
   * Where the legend of the chart should be drawn.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String legendPosition;

  /**
   * The data containing the bubble y-values. These values locate the bubbles in the chart
   * vertically.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private ChartData series;

  /**
   * The bubble border color.
   * @return value or {@code null} for none
   */
  public Color getBubbleBorderColor() {
    return bubbleBorderColor;
  }

  /**
   * The bubble border color.
   * @param bubbleBorderColor bubbleBorderColor or {@code null} for none
   */
  public BubbleChartSpec setBubbleBorderColor(Color bubbleBorderColor) {
    this.bubbleBorderColor = bubbleBorderColor;
    return this;
  }

  /**
   * The bubble border color. If bubble_border_color is also set, this field takes precedence.
   * @return value or {@code null} for none
   */
  public ColorStyle getBubbleBorderColorStyle() {
    return bubbleBorderColorStyle;
  }

  /**
   * The bubble border color. If bubble_border_color is also set, this field takes precedence.
   * @param bubbleBorderColorStyle bubbleBorderColorStyle or {@code null} for none
   */
  public BubbleChartSpec setBubbleBorderColorStyle(ColorStyle bubbleBorderColorStyle) {
    this.bubbleBorderColorStyle = bubbleBorderColorStyle;
    return this;
  }

  /**
   * The data containing the bubble labels. These do not need to be unique.
   * @return value or {@code null} for none
   */
  public ChartData getBubbleLabels() {
    return bubbleLabels;
  }

  /**
   * The data containing the bubble labels. These do not need to be unique.
   * @param bubbleLabels bubbleLabels or {@code null} for none
   */
  public BubbleChartSpec setBubbleLabels(ChartData bubbleLabels) {
    this.bubbleLabels = bubbleLabels;
    return this;
  }

  /**
   * The max radius size of the bubbles, in pixels. If specified, the field must be a positive
   * value.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getBubbleMaxRadiusSize() {
    return bubbleMaxRadiusSize;
  }

  /**
   * The max radius size of the bubbles, in pixels. If specified, the field must be a positive
   * value.
   * @param bubbleMaxRadiusSize bubbleMaxRadiusSize or {@code null} for none
   */
  public BubbleChartSpec setBubbleMaxRadiusSize(java.lang.Integer bubbleMaxRadiusSize) {
    this.bubbleMaxRadiusSize = bubbleMaxRadiusSize;
    return this;
  }

  /**
   * The minimum radius size of the bubbles, in pixels. If specific, the field must be a positive
   * value.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getBubbleMinRadiusSize() {
    return bubbleMinRadiusSize;
  }

  /**
   * The minimum radius size of the bubbles, in pixels. If specific, the field must be a positive
   * value.
   * @param bubbleMinRadiusSize bubbleMinRadiusSize or {@code null} for none
   */
  public BubbleChartSpec setBubbleMinRadiusSize(java.lang.Integer bubbleMinRadiusSize) {
    this.bubbleMinRadiusSize = bubbleMinRadiusSize;
    return this;
  }

  /**
   * The opacity of the bubbles between 0 and 1.0. 0 is fully transparent and 1 is fully opaque.
   * @return value or {@code null} for none
   */
  public java.lang.Float getBubbleOpacity() {
    return bubbleOpacity;
  }

  /**
   * The opacity of the bubbles between 0 and 1.0. 0 is fully transparent and 1 is fully opaque.
   * @param bubbleOpacity bubbleOpacity or {@code null} for none
   */
  public BubbleChartSpec setBubbleOpacity(java.lang.Float bubbleOpacity) {
    this.bubbleOpacity = bubbleOpacity;
    return this;
  }

  /**
   * The data containing the bubble sizes. Bubble sizes are used to draw the bubbles at different
   * sizes relative to each other. If specified, group_ids must also be specified. This field is
   * optional.
   * @return value or {@code null} for none
   */
  public ChartData getBubbleSizes() {
    return bubbleSizes;
  }

  /**
   * The data containing the bubble sizes. Bubble sizes are used to draw the bubbles at different
   * sizes relative to each other. If specified, group_ids must also be specified. This field is
   * optional.
   * @param bubbleSizes bubbleSizes or {@code null} for none
   */
  public BubbleChartSpec setBubbleSizes(ChartData bubbleSizes) {
    this.bubbleSizes = bubbleSizes;
    return this;
  }

  /**
   * The format of the text inside the bubbles. Strikethrough, underline, and link are not
   * supported.
   * @return value or {@code null} for none
   */
  public TextFormat getBubbleTextStyle() {
    return bubbleTextStyle;
  }

  /**
   * The format of the text inside the bubbles. Strikethrough, underline, and link are not
   * supported.
   * @param bubbleTextStyle bubbleTextStyle or {@code null} for none
   */
  public BubbleChartSpec setBubbleTextStyle(TextFormat bubbleTextStyle) {
    this.bubbleTextStyle = bubbleTextStyle;
    return this;
  }

  /**
   * The data containing the bubble x-values. These values locate the bubbles in the chart
   * horizontally.
   * @return value or {@code null} for none
   */
  public ChartData getDomain() {
    return domain;
  }

  /**
   * The data containing the bubble x-values. These values locate the bubbles in the chart
   * horizontally.
   * @param domain domain or {@code null} for none
   */
  public BubbleChartSpec setDomain(ChartData domain) {
    this.domain = domain;
    return this;
  }

  /**
   * The data containing the bubble group IDs. All bubbles with the same group ID are drawn in the
   * same color. If bubble_sizes is specified then this field must also be specified but may contain
   * blank values. This field is optional.
   * @return value or {@code null} for none
   */
  public ChartData getGroupIds() {
    return groupIds;
  }

  /**
   * The data containing the bubble group IDs. All bubbles with the same group ID are drawn in the
   * same color. If bubble_sizes is specified then this field must also be specified but may contain
   * blank values. This field is optional.
   * @param groupIds groupIds or {@code null} for none
   */
  public BubbleChartSpec setGroupIds(ChartData groupIds) {
    this.groupIds = groupIds;
    return this;
  }

  /**
   * Where the legend of the chart should be drawn.
   * @return value or {@code null} for none
   */
  public java.lang.String getLegendPosition() {
    return legendPosition;
  }

  /**
   * Where the legend of the chart should be drawn.
   * @param legendPosition legendPosition or {@code null} for none
   */
  public BubbleChartSpec setLegendPosition(java.lang.String legendPosition) {
    this.legendPosition = legendPosition;
    return this;
  }

  /**
   * The data containing the bubble y-values. These values locate the bubbles in the chart
   * vertically.
   * @return value or {@code null} for none
   */
  public ChartData getSeries() {
    return series;
  }

  /**
   * The data containing the bubble y-values. These values locate the bubbles in the chart
   * vertically.
   * @param series series or {@code null} for none
   */
  public BubbleChartSpec setSeries(ChartData series) {
    this.series = series;
    return this;
  }

  @Override
  public BubbleChartSpec set(String fieldName, Object value) {
    return (BubbleChartSpec) super.set(fieldName, value);
  }

  @Override
  public BubbleChartSpec clone() {
    return (BubbleChartSpec) super.clone();
  }

}