DashboardComponent (force-metadata-api 34.0 API)

java.lang.Object
- com.sforce.soap.metadata.DashboardComponent

All Implemented Interfaces:

XMLizable
```
public class DashboardComponent
extends Object
implements XMLizable
```
Generated by ComplexTypeCodeGenerator.java. Please do not edit.

Constructor Summary

Constructors
Constructor and Description

DashboardComponent()
Constructor

Constructors
Constructor and Description
`DashboardComponent()` Constructor

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`getAutoselectColumnsFromReport()`
`ChartRangeType`	`getChartAxisRange()`
`double`	`getChartAxisRangeMax()`
`double`	`getChartAxisRangeMin()`
`ChartSummary[]`	`getChartSummary()`
`DashboardComponentType`	`getComponentType()`
`DashboardFilterColumn[]`	`getDashboardFilterColumns()`
`DashboardTableColumn[]`	`getDashboardTableColumn()`
`ChartUnits`	`getDisplayUnits()`
`String`	`getDrillDownUrl()`
`boolean`	`getDrillEnabled()`
`boolean`	`getDrillToDetailEnabled()`
`boolean`	`getEnableHover()`
`boolean`	`getExpandOthers()`
`String`	`getFooter()`
`double`	`getGaugeMax()`
`double`	`getGaugeMin()`
`String[]`	`getGroupingColumn()`
`String`	`getHeader()`
`double`	`getIndicatorBreakpoint1()`
`double`	`getIndicatorBreakpoint2()`
`String`	`getIndicatorHighColor()`
`String`	`getIndicatorLowColor()`
`String`	`getIndicatorMiddleColor()`
`ChartLegendPosition`	`getLegendPosition()`
`int`	`getMaxValuesDisplayed()`
`String`	`getMetricLabel()`
`String`	`getPage()`
`int`	`getPageHeightInPixels()`
`String`	`getReport()`
`String`	`getScontrol()`
`int`	`getScontrolHeightInPixels()`
`boolean`	`getShowPercentage()`
`boolean`	`getShowPicturesOnCharts()`
`boolean`	`getShowPicturesOnTables()`
`boolean`	`getShowTotal()`
`boolean`	`getShowValues()`
`DashboardComponentFilter`	`getSortBy()`
`String`	`getTitle()`
`boolean`	`getUseReportChart()`
`boolean`	`isAutoselectColumnsFromReport()`
`boolean`	`isDrillEnabled()`
`boolean`	`isDrillToDetailEnabled()`
`boolean`	`isEnableHover()`
`boolean`	`isExpandOthers()`
`boolean`	`isShowPercentage()`
`boolean`	`isShowPicturesOnCharts()`
`boolean`	`isShowPicturesOnTables()`
`boolean`	`isShowTotal()`
`boolean`	`isShowValues()`
`boolean`	`isUseReportChart()`
`void`	`load(XmlInputStream __in, TypeMapper __typeMapper)`
`protected void`	`loadFields(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setAutoselectColumnsFromReport(boolean autoselectColumnsFromReport)`
`void`	`setChartAxisRange(ChartRangeType chartAxisRange)`
`void`	`setChartAxisRangeMax(double chartAxisRangeMax)`
`void`	`setChartAxisRangeMin(double chartAxisRangeMin)`
`void`	`setChartSummary(ChartSummary[] chartSummary)`
`void`	`setComponentType(DashboardComponentType componentType)`
`void`	`setDashboardFilterColumns(DashboardFilterColumn[] dashboardFilterColumns)`
`void`	`setDashboardTableColumn(DashboardTableColumn[] dashboardTableColumn)`
`void`	`setDisplayUnits(ChartUnits displayUnits)`
`void`	`setDrillDownUrl(String drillDownUrl)`
`void`	`setDrillEnabled(boolean drillEnabled)`
`void`	`setDrillToDetailEnabled(boolean drillToDetailEnabled)`
`void`	`setEnableHover(boolean enableHover)`
`void`	`setExpandOthers(boolean expandOthers)`
`void`	`setFooter(String footer)`
`void`	`setGaugeMax(double gaugeMax)`
`void`	`setGaugeMin(double gaugeMin)`
`void`	`setGroupingColumn(String[] groupingColumn)`
`void`	`setHeader(String header)`
`void`	`setIndicatorBreakpoint1(double indicatorBreakpoint1)`
`void`	`setIndicatorBreakpoint2(double indicatorBreakpoint2)`
`void`	`setIndicatorHighColor(String indicatorHighColor)`
`void`	`setIndicatorLowColor(String indicatorLowColor)`
`void`	`setIndicatorMiddleColor(String indicatorMiddleColor)`
`void`	`setLegendPosition(ChartLegendPosition legendPosition)`
`void`	`setMaxValuesDisplayed(int maxValuesDisplayed)`
`void`	`setMetricLabel(String metricLabel)`
`void`	`setPage(String page)`
`void`	`setPageHeightInPixels(int pageHeightInPixels)`
`void`	`setReport(String report)`
`void`	`setScontrol(String scontrol)`
`void`	`setScontrolHeightInPixels(int scontrolHeightInPixels)`
`void`	`setShowPercentage(boolean showPercentage)`
`void`	`setShowPicturesOnCharts(boolean showPicturesOnCharts)`
`void`	`setShowPicturesOnTables(boolean showPicturesOnTables)`
`void`	`setShowTotal(boolean showTotal)`
`void`	`setShowValues(boolean showValues)`
`void`	`setSortBy(DashboardComponentFilter sortBy)`
`void`	`setTitle(String title)`
`void`	`setUseReportChart(boolean useReportChart)`
`String`	`toString()`
`void`	`write(QName __element, XmlOutputStream __out, TypeMapper __typeMapper)`
`protected void`	`writeFields(XmlOutputStream __out, TypeMapper __typeMapper)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail
- DashboardComponent
```
public DashboardComponent()
```
  Constructor

Method Detail

getAutoselectColumnsFromReport

public boolean getAutoselectColumnsFromReport()

isAutoselectColumnsFromReport

public boolean isAutoselectColumnsFromReport()

setAutoselectColumnsFromReport

public void setAutoselectColumnsFromReport(boolean autoselectColumnsFromReport)

getChartAxisRange

public ChartRangeType getChartAxisRange()

setChartAxisRange

public void setChartAxisRange(ChartRangeType chartAxisRange)

getChartAxisRangeMax
```
public double getChartAxisRangeMax()
```

setChartAxisRangeMax

public void setChartAxisRangeMax(double chartAxisRangeMax)

getChartAxisRangeMin
```
public double getChartAxisRangeMin()
```

setChartAxisRangeMin

public void setChartAxisRangeMin(double chartAxisRangeMin)

getChartSummary

public ChartSummary[] getChartSummary()

setChartSummary

public void setChartSummary(ChartSummary[] chartSummary)

getComponentType

public DashboardComponentType getComponentType()

setComponentType

public void setComponentType(DashboardComponentType componentType)

getDashboardFilterColumns

public DashboardFilterColumn[] getDashboardFilterColumns()

setDashboardFilterColumns

public void setDashboardFilterColumns(DashboardFilterColumn[] dashboardFilterColumns)

getDashboardTableColumn

public DashboardTableColumn[] getDashboardTableColumn()

setDashboardTableColumn

public void setDashboardTableColumn(DashboardTableColumn[] dashboardTableColumn)

getDisplayUnits
```
public ChartUnits getDisplayUnits()
```

setDisplayUnits

public void setDisplayUnits(ChartUnits displayUnits)

getDrillDownUrl
```
public String getDrillDownUrl()
```

setDrillDownUrl

public void setDrillDownUrl(String drillDownUrl)

getDrillEnabled
```
public boolean getDrillEnabled()
```

isDrillEnabled
```
public boolean isDrillEnabled()
```

setDrillEnabled

public void setDrillEnabled(boolean drillEnabled)

getDrillToDetailEnabled

public boolean getDrillToDetailEnabled()

isDrillToDetailEnabled

public boolean isDrillToDetailEnabled()

setDrillToDetailEnabled

public void setDrillToDetailEnabled(boolean drillToDetailEnabled)

getEnableHover
```
public boolean getEnableHover()
```

isEnableHover
```
public boolean isEnableHover()
```

setEnableHover

public void setEnableHover(boolean enableHover)

getExpandOthers
```
public boolean getExpandOthers()
```

isExpandOthers
```
public boolean isExpandOthers()
```

setExpandOthers

public void setExpandOthers(boolean expandOthers)

getFooter
```
public String getFooter()
```

setFooter
```
public void setFooter(String footer)
```

getGaugeMax
```
public double getGaugeMax()
```

setGaugeMax

public void setGaugeMax(double gaugeMax)

getGaugeMin
```
public double getGaugeMin()
```

setGaugeMin

public void setGaugeMin(double gaugeMin)

getGroupingColumn
```
public String[] getGroupingColumn()
```

setGroupingColumn

public void setGroupingColumn(String[] groupingColumn)

getHeader
```
public String getHeader()
```

setHeader
```
public void setHeader(String header)
```

getIndicatorBreakpoint1

public double getIndicatorBreakpoint1()

setIndicatorBreakpoint1

public void setIndicatorBreakpoint1(double indicatorBreakpoint1)

getIndicatorBreakpoint2

public double getIndicatorBreakpoint2()

setIndicatorBreakpoint2

public void setIndicatorBreakpoint2(double indicatorBreakpoint2)

getIndicatorHighColor
```
public String getIndicatorHighColor()
```

setIndicatorHighColor

public void setIndicatorHighColor(String indicatorHighColor)

getIndicatorLowColor
```
public String getIndicatorLowColor()
```

setIndicatorLowColor

public void setIndicatorLowColor(String indicatorLowColor)

getIndicatorMiddleColor

public String getIndicatorMiddleColor()

setIndicatorMiddleColor

public void setIndicatorMiddleColor(String indicatorMiddleColor)

getLegendPosition

public ChartLegendPosition getLegendPosition()

setLegendPosition

public void setLegendPosition(ChartLegendPosition legendPosition)

getMaxValuesDisplayed
```
public int getMaxValuesDisplayed()
```

setMaxValuesDisplayed

public void setMaxValuesDisplayed(int maxValuesDisplayed)

getMetricLabel
```
public String getMetricLabel()
```

setMetricLabel

public void setMetricLabel(String metricLabel)

getPage
```
public String getPage()
```

setPage
```
public void setPage(String page)
```

getPageHeightInPixels
```
public int getPageHeightInPixels()
```

setPageHeightInPixels

public void setPageHeightInPixels(int pageHeightInPixels)

getReport
```
public String getReport()
```

setReport
```
public void setReport(String report)
```

getScontrol
```
public String getScontrol()
```

setScontrol

public void setScontrol(String scontrol)

getScontrolHeightInPixels

public int getScontrolHeightInPixels()

setScontrolHeightInPixels

public void setScontrolHeightInPixels(int scontrolHeightInPixels)

getShowPercentage
```
public boolean getShowPercentage()
```

isShowPercentage
```
public boolean isShowPercentage()
```

setShowPercentage

public void setShowPercentage(boolean showPercentage)

getShowPicturesOnCharts

public boolean getShowPicturesOnCharts()

isShowPicturesOnCharts

public boolean isShowPicturesOnCharts()

setShowPicturesOnCharts

public void setShowPicturesOnCharts(boolean showPicturesOnCharts)

getShowPicturesOnTables

public boolean getShowPicturesOnTables()

isShowPicturesOnTables

public boolean isShowPicturesOnTables()

setShowPicturesOnTables

public void setShowPicturesOnTables(boolean showPicturesOnTables)

getShowTotal
```
public boolean getShowTotal()
```

isShowTotal
```
public boolean isShowTotal()
```

setShowTotal

public void setShowTotal(boolean showTotal)

getShowValues
```
public boolean getShowValues()
```

isShowValues
```
public boolean isShowValues()
```

setShowValues

public void setShowValues(boolean showValues)

getSortBy

public DashboardComponentFilter getSortBy()

setSortBy

public void setSortBy(DashboardComponentFilter sortBy)

getTitle
```
public String getTitle()
```

setTitle
```
public void setTitle(String title)
```

getUseReportChart
```
public boolean getUseReportChart()
```

isUseReportChart
```
public boolean isUseReportChart()
```

setUseReportChart

public void setUseReportChart(boolean useReportChart)

write

public void write(QName __element,
         XmlOutputStream __out,
         TypeMapper __typeMapper)
           throws IOException

Specified by:: write in interface XMLizable
Throws:: IOException

writeFields

protected void writeFields(XmlOutputStream __out,
               TypeMapper __typeMapper)
                    throws IOException

Throws:: IOException

load

public void load(XmlInputStream __in,
        TypeMapper __typeMapper)
          throws IOException,
                 ConnectionException

Specified by:: load in interface XMLizable
Throws:: IOException; ConnectionException

loadFields

protected void loadFields(XmlInputStream __in,
              TypeMapper __typeMapper)
                   throws IOException,
                          ConnectionException

Throws:: IOException; ConnectionException

toString
```
public String toString()
```
Overrides:

toString in class Object

Class DashboardComponent

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DashboardComponent

Method Detail

getAutoselectColumnsFromReport

isAutoselectColumnsFromReport

setAutoselectColumnsFromReport

getChartAxisRange

setChartAxisRange

getChartAxisRangeMax

setChartAxisRangeMax

getChartAxisRangeMin

setChartAxisRangeMin

getChartSummary

setChartSummary

getComponentType

setComponentType

getDashboardFilterColumns

setDashboardFilterColumns

getDashboardTableColumn

setDashboardTableColumn

getDisplayUnits

setDisplayUnits

getDrillDownUrl

setDrillDownUrl

getDrillEnabled

isDrillEnabled

setDrillEnabled

getDrillToDetailEnabled

isDrillToDetailEnabled

setDrillToDetailEnabled

getEnableHover

isEnableHover

setEnableHover

getExpandOthers

isExpandOthers

setExpandOthers

getFooter

setFooter

getGaugeMax

setGaugeMax

getGaugeMin

setGaugeMin

getGroupingColumn

setGroupingColumn

getHeader

setHeader

getIndicatorBreakpoint1

setIndicatorBreakpoint1

getIndicatorBreakpoint2

setIndicatorBreakpoint2

getIndicatorHighColor

setIndicatorHighColor

getIndicatorLowColor

setIndicatorLowColor

getIndicatorMiddleColor

setIndicatorMiddleColor

getLegendPosition

setLegendPosition

getMaxValuesDisplayed

setMaxValuesDisplayed

getMetricLabel

setMetricLabel

getPage

setPage

getPageHeightInPixels

setPageHeightInPixels

getReport

setReport

getScontrol

setScontrol

getScontrolHeightInPixels

setScontrolHeightInPixels

getShowPercentage

isShowPercentage

setShowPercentage

getShowPicturesOnCharts