com.smartsheet.api.models

Class ChartWidgetContent

java.lang.Object

com.smartsheet.api.models.ChartWidgetContent

All Implemented Interfaces:

WidgetContent

public class ChartWidgetContent
extends Object
implements WidgetContent

Constructor Summary

Constructors

Constructor and Description
ChartWidgetContent()

Method Summary

Modifier and Type	Method and Description
List<Object>	getAxes() Gets the array of axes
WidgetHyperlink	getHyperlink() Gets the hyperlink associated with this Widget
List<Long>	getIncludedColumnIds() Gets the array of column IDs if the range was selected through the UI
Object	getLegend() Gets the location in the widget where Smartsheet renders the legend
Long	getReportId() Gets the report ID denoting container source, if applicable
List<SelectionRange>	getSelectionRanges() Gets the selection range if the source is a sheet
List<Object>	getSeries() Gets the array os series objects
Long	getSheetId() Gets the sheet ID denoting container source, if applicable
WidgetType	getWidgetType() Returns the type for this widget content object
ChartWidgetContent	setAxes(List<Object> axes) Sets the array of axes
ChartWidgetContent	setHyperlink(WidgetHyperlink hyperlink) Sets the hyperlink associated with this Widget
ChartWidgetContent	setIncludedColumnIds(List<Long> includedColumnIds) Sets the array of column IDs if the range was selected through the UI
ChartWidgetContent	setLegend(Object legend) Sets the location in the widget where Smartsheet renders the legend
ChartWidgetContent	setReportId(Long reportId) Sets the report ID denoting container source, if applicable
ChartWidgetContent	setSelectionRanges(List<SelectionRange> selectionRanges) Sets the selection range if the source is a sheet
ChartWidgetContent	setSeries(List<Object> series) Sets the array of series objects
ChartWidgetContent	setSheetId(Long sheetId) Sets the sheet ID denoting container source, if applicable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChartWidgetContent

public ChartWidgetContent()

Method Detail

getWidgetType

public WidgetType getWidgetType()

Returns the type for this widget content object

Specified by:

getWidgetType in interface WidgetContent

Returns:

CHART

getReportId

public Long getReportId()

Gets the report ID denoting container source, if applicable

Returns:

the report ID

setReportId

public ChartWidgetContent setReportId(Long reportId)

Sets the report ID denoting container source, if applicable

Parameters:

reportId -

getSheetId

public Long getSheetId()

Gets the sheet ID denoting container source, if applicable

Returns:

the sheet ID

setSheetId

public ChartWidgetContent setSheetId(Long sheetId)

Sets the sheet ID denoting container source, if applicable

Parameters:

sheetId -

getAxes

public List<Object> getAxes()

Gets the array of axes

Returns:

the axes

setAxes

public ChartWidgetContent setAxes(List<Object> axes)

Sets the array of axes

Parameters:

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

Parameters:

hyperlink -

getIncludedColumnIds

public List<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(List<Long> includedColumnIds)

Sets the array of column IDs if the range was selected through the UI

Parameters:

includedColumnIds -

getLegend

public Object getLegend()

Gets the location in the widget where Smartsheet renders the legend

Returns:

the legend

setLegend

public ChartWidgetContent setLegend(Object legend)

Sets the location in the widget where Smartsheet renders the legend

Parameters:

legend -

getSelectionRanges

public List<SelectionRange> getSelectionRanges()

Gets the selection range if the source is a sheet

Returns:

the selection range

setSelectionRanges

public ChartWidgetContent setSelectionRanges(List<SelectionRange> selectionRanges)

Sets the selection range if the source is a sheet

Parameters:

selectionRanges -

getSeries

public List<Object> getSeries()

Gets the array os series objects

Returns:

the array of series objects

setSeries

public ChartWidgetContent setSeries(List<Object> series)

Sets the array of series objects

Parameters:

series -