ChartConfig (netxms-client 2.1-M3 API)

java.lang.Object
- org.netxms.client.datacollection.ChartConfig

Direct Known Subclasses:

GraphSettings
```
public class ChartConfig
extends Object
```
Base class for all chart widget configs

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`area`
`protected boolean`	`autoRefresh`
`protected boolean`	`autoScale`
`protected ChartDciConfig[]`	`dciList`
`protected boolean`	`extendedLegend`
`protected int`	`legendPosition`
`protected int`	`lineWidth`
`protected boolean`	`logScale`
`protected int`	`maxYScaleValue`
`protected int`	`minYScaleValue`
`protected int`	`refreshRate`
`protected boolean`	`showGrid`
`protected boolean`	`showHostNames`
`protected boolean`	`showLegend`
`protected boolean`	`showTitle`
`protected boolean`	`stacked`
`protected int`	`timeFrameType`
`protected Date`	`timeFrom`
`protected int`	`timeRange`
`protected Date`	`timeTo`
`protected int`	`timeUnits`
`protected String`	`title`
`protected boolean`	`translucent`

Constructor Summary

Constructors
Constructor and Description

ChartConfig()

Constructors
Constructor and Description
`ChartConfig()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChangeListener(GraphSettingsChangeListener listener)` Add change listener
`static ChartConfig`	`createFromXml(String xml)` Create chart settings object from XML document
`String`	`createXml()` Create XML from configuration.
`void`	`fireChangeNotification()` Fire change notification
`ChartDciConfig[]`	`getDciList()`
`int`	`getLegendPosition()`
`int`	`getLineWidth()`
`int`	`getMaxYScaleValue()`
`int`	`getMinYScaleValue()`
`int`	`getRefreshRate()`
`int`	`getTimeFrameType()`
`Date`	`getTimeFrom()`
`int`	`getTimeRange()`
`long`	`getTimeRangeMillis()` Get time range covered by graph in milliseconds
`Date`	`getTimeTo()`
`int`	`getTimeUnits()`
`String`	`getTitle()`
`boolean`	`isArea()`
`boolean`	`isAutoRefresh()`
`boolean`	`isAutoScale()`
`boolean`	`isExtendedLegend()`
`boolean`	`isLogScale()`
`boolean`	`isShowGrid()`
`boolean`	`isShowHostNames()`
`boolean`	`isShowLegend()`
`boolean`	`isShowTitle()`
`boolean`	`isStacked()`
`boolean`	`isTranslucent()`
`void`	`removeChangeListener(GraphSettingsChangeListener listener)` Remove change listener
`void`	`setArea(boolean area)`
`void`	`setAutoRefresh(boolean autoRefresh)`
`void`	`setAutoScale(boolean autoScale)`
`void`	`setConfig(ChartConfig config)`
`void`	`setDciList(ChartDciConfig[] dciList)`
`void`	`setExtendedLegend(boolean extendedLegend)`
`void`	`setLegendPosition(int legendPosition)`
`void`	`setLineWidth(int lineWidth)`
`void`	`setLogScale(boolean logScale)`
`void`	`setMaxYScaleValue(int maxYScaleValue)`
`void`	`setMinYScaleValue(int minYScaleValue)`
`void`	`setRefreshRate(int refreshRate)`
`void`	`setShowGrid(boolean showGrid)`
`void`	`setShowHostNames(boolean showHostNames)`
`void`	`setShowLegend(boolean showLegend)`
`void`	`setShowTitle(boolean showTitle)`
`void`	`setStacked(boolean stacked)`
`void`	`setTimeFrameType(int timeFrameType)`
`void`	`setTimeFrom(Date timeFrom)`
`void`	`setTimePeriod(TimePeriod tp)`
`void`	`setTimeRange(int timeRange)`
`void`	`setTimeTo(Date timeTo)`
`void`	`setTimeUnits(int timeUnits)`
`void`	`setTitle(String title)`
`void`	`setTranslucent(boolean translucent)`
`TimePeriod`	`timePeriod()`

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

Field Detail

dciList
```
protected ChartDciConfig[] dciList
```

title
```
protected String title
```

legendPosition
```
protected int legendPosition
```

showLegend
```
protected boolean showLegend
```

extendedLegend
```
protected boolean extendedLegend
```

showTitle
```
protected boolean showTitle
```

showGrid
```
protected boolean showGrid
```

showHostNames
```
protected boolean showHostNames
```

autoRefresh
```
protected boolean autoRefresh
```

logScale
```
protected boolean logScale
```

stacked
```
protected boolean stacked
```

translucent
```
protected boolean translucent
```

area
```
protected boolean area
```

lineWidth
```
protected int lineWidth
```

autoScale
```
protected boolean autoScale
```

minYScaleValue
```
protected int minYScaleValue
```

maxYScaleValue
```
protected int maxYScaleValue
```

refreshRate
```
protected int refreshRate
```

timeUnits
```
protected int timeUnits
```

timeRange
```
protected int timeRange
```

timeFrameType
```
protected int timeFrameType
```

timeFrom
```
protected Date timeFrom
```

timeTo
```
protected Date timeTo
```

Constructor Detail
- ChartConfig
```
public ChartConfig()
```

Method Detail
- createFromXml
```
public static ChartConfig createFromXml(String xml)
                                 throws Exception
```
  Create chart settings object from XML document
  
  Parameters:
  
  xml - XML document
  
  Returns:
  
  deserialized object
  
  Throws:
  
  Exception - if the object cannot be fully deserialized
- createXml
```
public String createXml()
                 throws Exception
```
  Create XML from configuration.
  
  Returns:
  
  XML document
  
  Throws:
  
  Exception - if the schema for the object is not valid
- getTimeRangeMillis
```
public long getTimeRangeMillis()
```
  Get time range covered by graph in milliseconds
  
  Returns:
- getTitle
```
public String getTitle()
```
  Returns:
  
  the title
- setTitle
```
public void setTitle(String title)
```
  Parameters:
  
  title - the title to set
- getDciList
```
public ChartDciConfig[] getDciList()
```
  Returns:
  
  the dciList
- setDciList
```
public void setDciList(ChartDciConfig[] dciList)
```
  Parameters:
  
  dciList - the dciList to set
- getLegendPosition
```
public int getLegendPosition()
```
  Returns:
  
  the legendPosition
- setLegendPosition
```
public void setLegendPosition(int legendPosition)
```
  Parameters:
  
  legendPosition - the legendPosition to set
- isShowLegend
```
public boolean isShowLegend()
```
  Returns:
  
  the showLegend
- setShowLegend
```
public void setShowLegend(boolean showLegend)
```
  Parameters:
  
  showLegend - the showLegend to set
- getRefreshRate
```
public int getRefreshRate()
```
  Returns:
  
  the refreshRate
- setRefreshRate
```
public void setRefreshRate(int refreshRate)
```
  Parameters:
  
  refreshRate - the refreshRate to set
- isShowTitle
```
public boolean isShowTitle()
```
  Returns:
  
  the showTitle
- setShowTitle
```
public void setShowTitle(boolean showTitle)
```
  Parameters:
  
  showTitle - the showTitle to set
- getTimeUnits
```
public int getTimeUnits()
```
  Returns:
  
  the timeUnits
- setTimeUnits
```
public void setTimeUnits(int timeUnits)
```
  Parameters:
  
  timeUnits - the timeUnits to set
- getTimeRange
```
public int getTimeRange()
```
  Returns:
  
  the timeRange
- setTimeRange
```
public void setTimeRange(int timeRange)
```
  Parameters:
  
  timeRange - the timeRange to set
- isShowHostNames
```
public boolean isShowHostNames()
```
  Returns:
  
  the showHostNames
- setShowHostNames
```
public void setShowHostNames(boolean showHostNames)
```
  Parameters:
  
  showHostNames - the showHostNames to set
- isAutoRefresh
```
public boolean isAutoRefresh()
```
  Returns:
  
  the autoRefresh
- setAutoRefresh
```
public void setAutoRefresh(boolean autoRefresh)
```
  Parameters:
  
  autoRefresh - the autoRefresh to set
- isLogScale
```
public boolean isLogScale()
```
  Returns:
  
  the logScale
- setLogScale
```
public void setLogScale(boolean logScale)
```
  Parameters:
  
  logScale - the logScale to set
- getTimeFrameType
```
public int getTimeFrameType()
```
  Returns:
  
  the timeFrameType
- setTimeFrameType
```
public void setTimeFrameType(int timeFrameType)
```
  Parameters:
  
  timeFrameType - the timeFrameType to set
- getTimeFrom
```
public Date getTimeFrom()
```
  Returns:
  
  the timeFrom
- setTimeFrom
```
public void setTimeFrom(Date timeFrom)
```
  Parameters:
  
  timeFrom - the timeFrom to set
- getTimeTo
```
public Date getTimeTo()
```
  Returns:
  
  the timeTo
- setTimeTo
```
public void setTimeTo(Date timeTo)
```
  Parameters:
  
  timeTo - the timeTo to set
- isShowGrid
```
public boolean isShowGrid()
```
  Returns:
  
  the showGrid
- setShowGrid
```
public void setShowGrid(boolean showGrid)
```
  Parameters:
  
  showGrid - the showGrid to set
- isStacked
```
public boolean isStacked()
```
  Returns:
  
  the stacked
- setStacked
```
public void setStacked(boolean stacked)
```
  Parameters:
  
  stacked - the stacked to set
- isTranslucent
```
public boolean isTranslucent()
```
  Returns:
  
  the translucent
- setTranslucent
```
public void setTranslucent(boolean translucent)
```
  Parameters:
  
  translucent - the translucent to set
- isExtendedLegend
```
public boolean isExtendedLegend()
```
  Returns:
  
  the extendedLegend
- setExtendedLegend
```
public void setExtendedLegend(boolean extendedLegend)
```
  Parameters:
  
  extendedLegend - the extendedLegend to set
- getLineWidth
```
public int getLineWidth()
```
  Returns:
  
  the lineWidth
- setLineWidth
```
public void setLineWidth(int lineWidth)
```
  Parameters:
  
  lineWidth - the lineWidth to set
- isAutoScale
```
public boolean isAutoScale()
```
  Returns:
- setAutoScale
```
public void setAutoScale(boolean autoScale)
```
  Parameters:
  
  autoScale -
- isArea
```
public boolean isArea()
```
  Returns:
  
  the area
- setArea
```
public void setArea(boolean area)
```
  Parameters:
  
  area - the area to set
- getMinYScaleValue
```
public int getMinYScaleValue()
```
  Returns:
- setMinYScaleValue
```
public void setMinYScaleValue(int minYScaleValue)
```
  Parameters:
  
  minYScaleValue -
- getMaxYScaleValue
```
public int getMaxYScaleValue()
```
  Returns:
- setMaxYScaleValue
```
public void setMaxYScaleValue(int maxYScaleValue)
```
  Parameters:
  
  maxYScaleValue -
- timePeriod
```
public TimePeriod timePeriod()
```
  Returns:
- setTimePeriod
```
public void setTimePeriod(TimePeriod tp)
```
  Parameters:
  
  tp -
- addChangeListener
```
public void addChangeListener(GraphSettingsChangeListener listener)
```
  Add change listener
  
  Parameters:
  
  listener - change listener
- removeChangeListener
```
public void removeChangeListener(GraphSettingsChangeListener listener)
```
  Remove change listener
  
  Parameters:
  
  listener - change listener to remove
- fireChangeNotification
```
public void fireChangeNotification()
```
  Fire change notification
- setConfig
```
public void setConfig(ChartConfig config)
```

Class ChartConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

dciList

title

legendPosition

showLegend

extendedLegend

showTitle

showGrid

showHostNames

autoRefresh

logScale

stacked

translucent

area

lineWidth

autoScale

minYScaleValue

maxYScaleValue

refreshRate

timeUnits

timeRange

timeFrameType

timeFrom

timeTo

Constructor Detail

ChartConfig

Method Detail

createFromXml

createXml

getTimeRangeMillis

getTitle

setTitle

getDciList

setDciList

getLegendPosition

setLegendPosition

isShowLegend

setShowLegend

getRefreshRate

setRefreshRate

isShowTitle

setShowTitle

getTimeUnits

setTimeUnits

getTimeRange

setTimeRange

isShowHostNames

setShowHostNames

isAutoRefresh

setAutoRefresh

isLogScale

setLogScale

getTimeFrameType

setTimeFrameType

getTimeFrom

setTimeFrom

getTimeTo

setTimeTo

isShowGrid

setShowGrid

isStacked

setStacked

isTranslucent

setTranslucent

isExtendedLegend

setExtendedLegend

getLineWidth

setLineWidth

isAutoScale

setAutoScale

isArea

setArea

getMinYScaleValue

setMinYScaleValue

getMaxYScaleValue