Package com.smartsheet.api.models
Class ChartWidgetContent
- java.lang.Object
-
- com.smartsheet.api.models.ChartWidgetContent
-
- All Implemented Interfaces:
WidgetContent
public class ChartWidgetContent extends java.lang.Object implements WidgetContent
-
-
Constructor Summary
Constructors Constructor Description ChartWidgetContent()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<java.lang.Object>getAxes()Gets the array of axesWidgetHyperlinkgetHyperlink()Gets the hyperlink associated with this Widgetjava.util.List<java.lang.Long>getIncludedColumnIds()Gets the array of column IDs if the range was selected through the UIjava.lang.ObjectgetLegend()Gets the location in the widget where Smartsheet renders the legendjava.lang.LonggetReportId()Gets the report ID denoting container source, if applicablejava.util.List<SelectionRange>getSelectionRanges()Gets the selection range if the source is a sheetjava.util.List<java.lang.Object>getSeries()Gets the array os series objectsjava.lang.LonggetSheetId()Gets the sheet ID denoting container source, if applicableWidgetTypegetWidgetType()Returns the type for this widget content objectChartWidgetContentsetAxes(java.util.List<java.lang.Object> axes)Sets the array of axesChartWidgetContentsetHyperlink(WidgetHyperlink hyperlink)Sets the hyperlink associated with this WidgetChartWidgetContentsetIncludedColumnIds(java.util.List<java.lang.Long> includedColumnIds)Sets the array of column IDs if the range was selected through the UIChartWidgetContentsetLegend(java.lang.Object legend)Sets the location in the widget where Smartsheet renders the legendChartWidgetContentsetReportId(java.lang.Long reportId)Sets the report ID denoting container source, if applicableChartWidgetContentsetSelectionRanges(java.util.List<SelectionRange> selectionRanges)Sets the selection range if the source is a sheetChartWidgetContentsetSeries(java.util.List<java.lang.Object> series)Sets the array of series objectsChartWidgetContentsetSheetId(java.lang.Long sheetId)Sets the sheet ID denoting container source, if applicable
-
-
-
Method Detail
-
getWidgetType
public WidgetType getWidgetType()
Returns the type for this widget content object- Specified by:
getWidgetTypein interfaceWidgetContent- Returns:
- CHART
-
getReportId
public java.lang.Long getReportId()
Gets the report ID denoting container source, if applicable- Returns:
- the report ID
-
setReportId
public ChartWidgetContent setReportId(java.lang.Long reportId)
Sets the report ID denoting container source, if applicable
-
getSheetId
public java.lang.Long getSheetId()
Gets the sheet ID denoting container source, if applicable- Returns:
- the sheet ID
-
setSheetId
public ChartWidgetContent setSheetId(java.lang.Long sheetId)
Sets the sheet ID denoting container source, if applicable
-
getAxes
public java.util.List<java.lang.Object> getAxes()
Gets the array of axes- Returns:
- the axes
-
setAxes
public ChartWidgetContent setAxes(java.util.List<java.lang.Object> axes)
Sets the array of axes
-
getHyperlink
public WidgetHyperlink getHyperlink()
Gets the hyperlink associated with this Widget- Returns:
- the hyperlink
-
setHyperlink
public ChartWidgetContent setHyperlink(WidgetHyperlink hyperlink)
Sets the hyperlink associated with this Widget
-
getIncludedColumnIds
public java.util.List<java.lang.Long> getIncludedColumnIds()
Gets the array of column IDs if the range was selected through the UI- Returns:
- the array of column IDs
-
setIncludedColumnIds
public ChartWidgetContent setIncludedColumnIds(java.util.List<java.lang.Long> includedColumnIds)
Sets the array of column IDs if the range was selected through the UI
-
getLegend
public java.lang.Object getLegend()
Gets the location in the widget where Smartsheet renders the legend- Returns:
- the legend
-
setLegend
public ChartWidgetContent setLegend(java.lang.Object legend)
Sets the location in the widget where Smartsheet renders the legend
-
getSelectionRanges
public java.util.List<SelectionRange> getSelectionRanges()
Gets the selection range if the source is a sheet- Returns:
- the selection range
-
setSelectionRanges
public ChartWidgetContent setSelectionRanges(java.util.List<SelectionRange> selectionRanges)
Sets the selection range if the source is a sheet
-
getSeries
public java.util.List<java.lang.Object> getSeries()
Gets the array os series objects- Returns:
- the array of series objects
-
setSeries
public ChartWidgetContent setSeries(java.util.List<java.lang.Object> series)
Sets the array of series objects
-
-