DisplayerSettings (Dashbuilder Displayer API 7.46.0.Final API)

java.lang.Object
- org.dashbuilder.displayer.DisplayerSettings

@Portable
public class DisplayerSettings
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<ColumnSettings>`	`columnSettingsList`
`protected org.dashbuilder.dataset.DataSet`	`dataSet`
`protected org.dashbuilder.dataset.DataSetLookup`	`dataSetLookup`
`protected Map<String,String>`	`settings`
`protected String`	`UUID`

Constructor Summary

Constructors
Constructor and Description

DisplayerSettings()

DisplayerSettings(DisplayerType displayerType)

Constructors
Constructor and Description
`DisplayerSettings()`
`DisplayerSettings(DisplayerType displayerType)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DisplayerSettings`	`cloneInstance()`
`boolean`	`equals(Object obj)`
`String`	`getChartBackgroundColor()`
`int`	`getChartHeight()`
`Position`	`getChartLegendPosition()`
`int`	`getChartMarginBottom()`
`int`	`getChartMarginLeft()`
`int`	`getChartMarginRight()`
`int`	`getChartMarginTop()`
`int`	`getChartMaxHeight()`
`int`	`getChartMaxWidth()`
`int`	`getChartWidth()`
`ColumnSettings`	`getColumnSettings(org.dashbuilder.dataset.DataColumn column)`
`ColumnSettings`	`getColumnSettings(String columnId)`
`List<ColumnSettings>`	`getColumnSettingsList()`
`String`	`getComponentId()`
`String`	`getComponentPartition()`
`Map<String,String>`	`getComponentProperties()`
`String`	`getComponentProperty(String key)`
`org.dashbuilder.dataset.DataSet`	`getDataSet()`
`org.dashbuilder.dataset.DataSetLookup`	`getDataSetLookup()`
`String`	`getDisplayerSetting(DisplayerAttributeDef displayerAttributeDef)`
`String`	`getDonutHoleTitle()`
`String`	`getHtmlTemplate()`
`String`	`getJsTemplate()`
`MapColorScheme`	`getMapColorScheme()`
`long`	`getMeterCritical()`
`long`	`getMeterEnd()`
`long`	`getMeterStart()`
`long`	`getMeterWarning()`
`int`	`getRefreshInterval()`
`String`	`getRenderer()`
`int`	`getSelectorWidth()`
`Map<String,String>`	`getSettingsFlatMap()`
`DisplayerSubType`	`getSubtype()`
`String`	`getTableDefaultSortColumnId()`
`org.dashbuilder.dataset.sort.SortOrder`	`getTableDefaultSortOrder()`
`int`	`getTablePageSize()`
`int`	`getTableWidth()`
`String`	`getTitle()`
`DisplayerType`	`getType()`
`String`	`getUUID()`
`int`	`getXAxisLabelsAngle()`
`String`	`getXAxisTitle()`
`String`	`getYAxisTitle()`
`boolean`	`isChart3D()`
`boolean`	`isChartShowLegend()`
`boolean`	`isCSVExportAllowed()`
`boolean`	`isExcelExportAllowed()`
`boolean`	`isFilterEnabled()`
`boolean`	`isFilterListeningEnabled()`
`boolean`	`isFilterNotificationEnabled()`
`boolean`	`isFilterSelfApplyEnabled()`
`boolean`	`isRefreshStaleData()`
`boolean`	`isResizable()`
`boolean`	`isSelectorInputsEnabled()`
`boolean`	`isSelectorMultiple()`
`boolean`	`isTableColumnPickerEnabled()`
`boolean`	`isTableSortEnabled()`
`boolean`	`isTitleVisible()`
`boolean`	`isXAxisShowLabels()`
`boolean`	`isYAxisShowLabels()`
`void`	`removeColumnSettings(String columnId)`
`void`	`removeDisplayerSetting(DisplayerAttributeDef displayerAttributeDef)`
`void`	`removeDisplayerSetting(DisplayerAttributeGroupDef displayerAttributeGroup)`
`void`	`removeDisplayerSetting(String displayerAttributeDef)`
`void`	`setChart3D(boolean barchartThreeDimension)`
`void`	`setChartBackgroundColor(String color)`
`void`	`setChartHeight(int chartHeight)`
`void`	`setChartLegendPosition(Position chartLegendPosition)`
`void`	`setChartMarginBottom(int chartMarginBottom)`
`void`	`setChartMarginLeft(int chartMarginLeft)`
`void`	`setChartMarginRight(int chartMarginRight)`
`void`	`setChartMarginTop(int chartMarginTop)`
`void`	`setChartMaxHeight(int chartHeight)`
`void`	`setChartMaxWidth(int chartWidth)`
`void`	`setChartShowLegend(boolean chartShowLegend)`
`void`	`setChartWidth(int chartWidth)`
`void`	`setColumnEmptyTemplate(String columnId, String template)`
`void`	`setColumnName(String columnId, String name)`
`void`	`setColumnSettingsList(List<ColumnSettings> columnSettingsList)`
`void`	`setColumnValueExpression(String columnId, String expression)`
`void`	`setColumnValuePattern(String columnId, String pattern)`
`String`	`setComponentId(String componentId)`
`String`	`setComponentPartition(String componentPartition)`
`void`	`setComponentProperty(String key, String value)`
`void`	`setCSVExportAllowed(boolean csvExportAllowed)`
`void`	`setDataSet(org.dashbuilder.dataset.DataSet dataSet)`
`void`	`setDataSetLookup(org.dashbuilder.dataset.DataSetLookup dataSetLookup)`
`void`	`setDisplayerSetting(DisplayerAttributeDef displayerAttributeDef, String value)`
`void`	`setDisplayerSetting(String displayerAttributeDef, String value)`
`void`	`setDonutHoleTitle(String holeTitle)`
`void`	`setExcelExportAllowed(boolean excelExportAllowed)`
`void`	`setFilterEnabled(boolean filterEnabled)`
`void`	`setFilterListeningEnabled(boolean filterListeningEnabled)`
`void`	`setFilterNotificationEnabled(boolean filterNotificationEnabled)`
`void`	`setFilterSelfApplyEnabled(boolean filterSelfApplyEnabled)`
`void`	`setHtmlTemplate(String htmlTemplate)`
`void`	`setJsTemplate(String jsTemplate)`
`void`	`setMapColorScheme(MapColorScheme colorScheme)`
`void`	`setMeterCritical(long meterCritical)`
`void`	`setMeterEnd(long meterEnd)`
`void`	`setMeterStart(long meterStart)`
`void`	`setMeterWarning(long meterWarning)`
`void`	`setRefreshInterval(int refreshInSeconds)`
`void`	`setRefreshStaleData(boolean refresh)`
`void`	`setRenderer(String renderer)`
`void`	`setResizable(boolean resizable)`
`void`	`setSelectorInputsEnabled(boolean enabled)`
`void`	`setSelectorMultiple(boolean filterMultiple)`
`void`	`setSelectorWidth(int filterWidth)`
`void`	`setSettingsFlatMap(Map<String,String> settings)`
`void`	`setSubtype(DisplayerSubType subtype)`
`void`	`setTableColumnPickerEnabled(boolean tableColumnPickerEnabled)`
`void`	`setTableDefaultSortColumnId(String tableDefaultSortColumnId)`
`void`	`setTableDefaultSortOrder(org.dashbuilder.dataset.sort.SortOrder tableDefaultSortOrder)`
`void`	`setTablePageSize(int tablePageSize)`
`void`	`setTableSortEnabled(boolean tableSortEnabled)`
`void`	`setTableWidth(int tableWidth)`
`void`	`setTitle(String title)`
`void`	`setTitleVisible(boolean titleVisible)`
`void`	`setType(DisplayerType displayerType)`
`void`	`setUUID(String UUID)`
`void`	`setXAxisLabelsAngle(int axisLabelsAngle)`
`void`	`setXAxisShowLabels(boolean axisShowLabels)`
`void`	`setXAxisTitle(String axisTitle)`
`void`	`setYAxisShowLabels(boolean axisShowLabels)`
`void`	`setYAxisTitle(String axisTitle)`

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

Field Detail

UUID
```
protected String UUID
```

dataSet

protected org.dashbuilder.dataset.DataSet dataSet

dataSetLookup

protected org.dashbuilder.dataset.DataSetLookup dataSetLookup

columnSettingsList

protected List<ColumnSettings> columnSettingsList

settings
```
protected Map<String,String> settings
```

Constructor Detail

DisplayerSettings
```
public DisplayerSettings()
```

DisplayerSettings

public DisplayerSettings(DisplayerType displayerType)

Method Detail

cloneInstance

public DisplayerSettings cloneInstance()

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

getColumnSettingsList

public List<ColumnSettings> getColumnSettingsList()

setColumnSettingsList

public void setColumnSettingsList(List<ColumnSettings> columnSettingsList)

removeColumnSettings

public void removeColumnSettings(String columnId)

getColumnSettings

public ColumnSettings getColumnSettings(String columnId)

getColumnSettings

public ColumnSettings getColumnSettings(org.dashbuilder.dataset.DataColumn column)

setColumnName

public void setColumnName(String columnId,
                          String name)

setColumnValueExpression

public void setColumnValueExpression(String columnId,
                                     String expression)

setColumnValuePattern

public void setColumnValuePattern(String columnId,
                                  String pattern)

setColumnEmptyTemplate

public void setColumnEmptyTemplate(String columnId,
                                   String template)

getUUID
```
public String getUUID()
```

setUUID
```
public void setUUID(String UUID)
```

getDataSet

public org.dashbuilder.dataset.DataSet getDataSet()

setDataSet

public void setDataSet(org.dashbuilder.dataset.DataSet dataSet)

getDataSetLookup

public org.dashbuilder.dataset.DataSetLookup getDataSetLookup()

setDataSetLookup

public void setDataSetLookup(org.dashbuilder.dataset.DataSetLookup dataSetLookup)

getDisplayerSetting

public String getDisplayerSetting(DisplayerAttributeDef displayerAttributeDef)

setDisplayerSetting

public void setDisplayerSetting(DisplayerAttributeDef displayerAttributeDef,
                                String value)

setDisplayerSetting

public void setDisplayerSetting(String displayerAttributeDef,
                                String value)

removeDisplayerSetting

public void removeDisplayerSetting(DisplayerAttributeDef displayerAttributeDef)

removeDisplayerSetting

public void removeDisplayerSetting(DisplayerAttributeGroupDef displayerAttributeGroup)

removeDisplayerSetting

public void removeDisplayerSetting(String displayerAttributeDef)

getSettingsFlatMap

public Map<String,String> getSettingsFlatMap()

setSettingsFlatMap

public void setSettingsFlatMap(Map<String,String> settings)

getType
```
public DisplayerType getType()
```

setType

public void setType(DisplayerType displayerType)

getSubtype
```
public DisplayerSubType getSubtype()
```

setSubtype

public void setSubtype(DisplayerSubType subtype)

getRenderer
```
public String getRenderer()
```

setRenderer

public void setRenderer(String renderer)

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

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

isTitleVisible
```
public boolean isTitleVisible()
```

setTitleVisible

public void setTitleVisible(boolean titleVisible)

isCSVExportAllowed
```
public boolean isCSVExportAllowed()
```

setCSVExportAllowed

public void setCSVExportAllowed(boolean csvExportAllowed)

isExcelExportAllowed
```
public boolean isExcelExportAllowed()
```

setExcelExportAllowed

public void setExcelExportAllowed(boolean excelExportAllowed)

getRefreshInterval
```
public int getRefreshInterval()
```

setRefreshInterval

public void setRefreshInterval(int refreshInSeconds)

isRefreshStaleData
```
public boolean isRefreshStaleData()
```

setRefreshStaleData

public void setRefreshStaleData(boolean refresh)

isFilterEnabled
```
public boolean isFilterEnabled()
```

setFilterEnabled

public void setFilterEnabled(boolean filterEnabled)

isFilterSelfApplyEnabled

public boolean isFilterSelfApplyEnabled()

setFilterSelfApplyEnabled

public void setFilterSelfApplyEnabled(boolean filterSelfApplyEnabled)

isFilterNotificationEnabled

public boolean isFilterNotificationEnabled()

setFilterNotificationEnabled

public void setFilterNotificationEnabled(boolean filterNotificationEnabled)

isFilterListeningEnabled

public boolean isFilterListeningEnabled()

setFilterListeningEnabled

public void setFilterListeningEnabled(boolean filterListeningEnabled)

getSelectorWidth
```
public int getSelectorWidth()
```

setSelectorWidth

public void setSelectorWidth(int filterWidth)

isSelectorMultiple
```
public boolean isSelectorMultiple()
```

setSelectorMultiple

public void setSelectorMultiple(boolean filterMultiple)

isSelectorInputsEnabled

public boolean isSelectorInputsEnabled()

setSelectorInputsEnabled

public void setSelectorInputsEnabled(boolean enabled)

getChartWidth
```
public int getChartWidth()
```

setChartWidth

public void setChartWidth(int chartWidth)

getChartBackgroundColor

public String getChartBackgroundColor()

setChartBackgroundColor

public void setChartBackgroundColor(String color)

getChartHeight
```
public int getChartHeight()
```

setChartHeight

public void setChartHeight(int chartHeight)

getChartMarginTop
```
public int getChartMarginTop()
```

setChartMarginTop

public void setChartMarginTop(int chartMarginTop)

getChartMarginBottom
```
public int getChartMarginBottom()
```

setChartMarginBottom

public void setChartMarginBottom(int chartMarginBottom)

getChartMarginLeft
```
public int getChartMarginLeft()
```

setChartMarginLeft

public void setChartMarginLeft(int chartMarginLeft)

getChartMarginRight
```
public int getChartMarginRight()
```

setChartMarginRight

public void setChartMarginRight(int chartMarginRight)

getChartMaxWidth
```
public int getChartMaxWidth()
```

setChartMaxWidth

public void setChartMaxWidth(int chartWidth)

getChartMaxHeight
```
public int getChartMaxHeight()
```

setChartMaxHeight

public void setChartMaxHeight(int chartHeight)

setResizable

public void setResizable(boolean resizable)

isResizable
```
public boolean isResizable()
```

isChartShowLegend
```
public boolean isChartShowLegend()
```

setChartShowLegend

public void setChartShowLegend(boolean chartShowLegend)

getChartLegendPosition

public Position getChartLegendPosition()

setChartLegendPosition

public void setChartLegendPosition(Position chartLegendPosition)

getTablePageSize
```
public int getTablePageSize()
```

setTablePageSize

public void setTablePageSize(int tablePageSize)

getTableWidth
```
public int getTableWidth()
```

setTableWidth

public void setTableWidth(int tableWidth)

isTableSortEnabled
```
public boolean isTableSortEnabled()
```

setTableSortEnabled

public void setTableSortEnabled(boolean tableSortEnabled)

setTableColumnPickerEnabled

public void setTableColumnPickerEnabled(boolean tableColumnPickerEnabled)

getTableDefaultSortColumnId

public String getTableDefaultSortColumnId()

setTableDefaultSortColumnId

public void setTableDefaultSortColumnId(String tableDefaultSortColumnId)

getTableDefaultSortOrder

public org.dashbuilder.dataset.sort.SortOrder getTableDefaultSortOrder()

setTableDefaultSortOrder

public void setTableDefaultSortOrder(org.dashbuilder.dataset.sort.SortOrder tableDefaultSortOrder)

isTableColumnPickerEnabled

public boolean isTableColumnPickerEnabled()

isXAxisShowLabels
```
public boolean isXAxisShowLabels()
```

setXAxisShowLabels

public void setXAxisShowLabels(boolean axisShowLabels)

getXAxisLabelsAngle
```
public int getXAxisLabelsAngle()
```

setXAxisLabelsAngle

public void setXAxisLabelsAngle(int axisLabelsAngle)

getXAxisTitle
```
public String getXAxisTitle()
```

setXAxisTitle

public void setXAxisTitle(String axisTitle)

isYAxisShowLabels
```
public boolean isYAxisShowLabels()
```

setYAxisShowLabels

public void setYAxisShowLabels(boolean axisShowLabels)

getYAxisTitle
```
public String getYAxisTitle()
```

setYAxisTitle

public void setYAxisTitle(String axisTitle)

getMeterStart
```
public long getMeterStart()
```

setMeterStart

public void setMeterStart(long meterStart)

getMeterWarning
```
public long getMeterWarning()
```

setMeterWarning

public void setMeterWarning(long meterWarning)

getMeterCritical
```
public long getMeterCritical()
```

setMeterCritical

public void setMeterCritical(long meterCritical)

getMeterEnd
```
public long getMeterEnd()
```

setMeterEnd

public void setMeterEnd(long meterEnd)

getDonutHoleTitle
```
public String getDonutHoleTitle()
```

setDonutHoleTitle

public void setDonutHoleTitle(String holeTitle)

isChart3D
```
public boolean isChart3D()
```

setChart3D

public void setChart3D(boolean barchartThreeDimension)

setHtmlTemplate

public void setHtmlTemplate(String htmlTemplate)

setJsTemplate

public void setJsTemplate(String jsTemplate)

getHtmlTemplate
```
public String getHtmlTemplate()
```

getJsTemplate
```
public String getJsTemplate()
```

setMapColorScheme

public void setMapColorScheme(MapColorScheme colorScheme)

getMapColorScheme

public MapColorScheme getMapColorScheme()

getComponentId
```
public String getComponentId()
```

setComponentId

public String setComponentId(String componentId)

setComponentProperty

public void setComponentProperty(String key,
                                 String value)

getComponentProperty

public String getComponentProperty(String key)

getComponentProperties

public Map<String,String> getComponentProperties()

getComponentPartition
```
public String getComponentPartition()
```

setComponentPartition

public String setComponentPartition(String componentPartition)

Class DisplayerSettings

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UUID

dataSet

dataSetLookup

columnSettingsList

settings

Constructor Detail

DisplayerSettings

DisplayerSettings

Method Detail

cloneInstance

equals

getColumnSettingsList

setColumnSettingsList

removeColumnSettings

getColumnSettings

getColumnSettings

setColumnName

setColumnValueExpression

setColumnValuePattern

setColumnEmptyTemplate

getUUID

setUUID

getDataSet

setDataSet

getDataSetLookup

setDataSetLookup

getDisplayerSetting

setDisplayerSetting

setDisplayerSetting

removeDisplayerSetting

removeDisplayerSetting

removeDisplayerSetting

getSettingsFlatMap

setSettingsFlatMap

getType

setType

getSubtype

setSubtype

getRenderer

setRenderer

getTitle

setTitle

isTitleVisible

setTitleVisible

isCSVExportAllowed

setCSVExportAllowed

isExcelExportAllowed

setExcelExportAllowed

getRefreshInterval

setRefreshInterval

isRefreshStaleData

setRefreshStaleData

isFilterEnabled

setFilterEnabled

isFilterSelfApplyEnabled

setFilterSelfApplyEnabled

isFilterNotificationEnabled

setFilterNotificationEnabled

isFilterListeningEnabled

setFilterListeningEnabled

getSelectorWidth

setSelectorWidth

isSelectorMultiple

setSelectorMultiple

isSelectorInputsEnabled

setSelectorInputsEnabled

getChartWidth

setChartWidth

getChartBackgroundColor

setChartBackgroundColor

getChartHeight

setChartHeight

getChartMarginTop

setChartMarginTop