PeriodSelector (CHARTS 6.8 API)

java.lang.Object
- com.haulmont.charts.gui.amcharts.model.AbstractChartObject
- - com.haulmont.charts.gui.amcharts.model.PeriodSelector

All Implemented Interfaces:

java.io.Serializable
```
public class PeriodSelector
extends AbstractChartObject
```
See documentation for properties of PeriodSelector JS object.
http://docs.amcharts.com/3/javascriptstockchart/PeriodSelector

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

PeriodSelector()

Constructors
Constructor and Description
`PeriodSelector()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PeriodSelector`	`addPeriods(Period... periods)` Adds periods.
`java.lang.String`	`getDateFormat()`
`java.lang.String`	`getFromText()`
`java.lang.Boolean`	`getHideOutOfScopePeriods()`
`java.lang.Boolean`	`getInputFieldsEnabled()`
`java.lang.Integer`	`getInputFieldWidth()`
`java.util.List<Period>`	`getPeriods()`
`java.lang.String`	`getPeriodsText()`
`Position`	`getPosition()`
`java.lang.Boolean`	`getSelectFromStart()`
`java.lang.String`	`getToText()`
`java.lang.Integer`	`getWidth()`
`PeriodSelector`	`setDateFormat(java.lang.String dateFormat)` Sets date format of date input fields.
`PeriodSelector`	`setFromText(java.lang.String fromText)` Sets text displayed next to "from" date input field.
`PeriodSelector`	`setHideOutOfScopePeriods(java.lang.Boolean hideOutOfScopePeriods)` Set hideOutOfScopePeriods to false if period buttons with date range bigger than available data shouldn't be hidden.
`PeriodSelector`	`setInputFieldsEnabled(java.lang.Boolean inputFieldsEnabled)` Set inputFieldsEnabled to false if period selector shouldn't display "from" and "to" date input fields.
`PeriodSelector`	`setInputFieldWidth(java.lang.Integer inputFieldWidth)` Sets width of date input fields, in pixels.
`PeriodSelector`	`setPeriods(java.util.List<Period> periods)` Sets list of predefined periods.
`PeriodSelector`	`setPeriodsText(java.lang.String periodsText)` Sets text displayed next to predefined period buttons.
`PeriodSelector`	`setPosition(Position position)` Sets position.
`PeriodSelector`	`setSelectFromStart(java.lang.Boolean selectFromStart)` Set selectFromStart to true if predefined period buttons should select a period from the beginning.
`PeriodSelector`	`setToText(java.lang.String toText)` Sets text displayed next to "to" date input field.
`PeriodSelector`	`setWidth(java.lang.Integer width)` Sets width of a period selector, when position is "left" or "right".

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

- Constructor Detail
  - PeriodSelector
```
public PeriodSelector()
```
- Method Detail
  - getDateFormat
```
public java.lang.String getDateFormat()
```
    Returns:
    
    date format of date input fields
  - setDateFormat
```
public PeriodSelector setDateFormat(java.lang.String dateFormat)
```
    Sets date format of date input fields. Note, only numeric date formats are allowed, so don't use "MMM" or "MMMM" month format, two-digit years "YY" is NOT supported in this setting.
    
    Parameters:
    
    dateFormat - date format string
  - getFromText
```
public java.lang.String getFromText()
```
    Returns:
    
    from text
  - setFromText
```
public PeriodSelector setFromText(java.lang.String fromText)
```
    Sets text displayed next to "from" date input field.
    
    Parameters:
    
    fromText - from text
  - getHideOutOfScopePeriods
```
public java.lang.Boolean getHideOutOfScopePeriods()
```
    Returns:
    
    true if period buttons with date range bigger than available data are hidden
  - setHideOutOfScopePeriods
```
public PeriodSelector setHideOutOfScopePeriods(java.lang.Boolean hideOutOfScopePeriods)
```
    Set hideOutOfScopePeriods to false if period buttons with date range bigger than available data shouldn't be hidden.
    
    Parameters:
    
    hideOutOfScopePeriods - hideOutOfScopePeriods option
  - getInputFieldsEnabled
```
public java.lang.Boolean getInputFieldsEnabled()
```
    Returns:
    
    true if period selector displays "from" and "to" date input fields
  - setInputFieldsEnabled
```
public PeriodSelector setInputFieldsEnabled(java.lang.Boolean inputFieldsEnabled)
```
    Set inputFieldsEnabled to false if period selector shouldn't display "from" and "to" date input fields.
    
    Parameters:
    
    inputFieldsEnabled - inputFieldsEnabled option
  - getInputFieldWidth
```
public java.lang.Integer getInputFieldWidth()
```
    Returns:
    
    width of date input fields, in pixels
  - setInputFieldWidth
```
public PeriodSelector setInputFieldWidth(java.lang.Integer inputFieldWidth)
```
    Sets width of date input fields, in pixels. Works only if period selector is horizontal.
    
    Parameters:
    
    inputFieldWidth - width
  - getPeriods
```
public java.util.List<Period> getPeriods()
```
    Returns:
    
    list of periods
  - setPeriods
```
public PeriodSelector setPeriods(java.util.List<Period> periods)
```
    Sets list of predefined periods.
    
    Parameters:
    
    periods - list of periods
  - addPeriods
```
public PeriodSelector addPeriods(Period... periods)
```
    Adds periods.
    
    Parameters:
    
    periods - periods
  - getPeriodsText
```
public java.lang.String getPeriodsText()
```
    Returns:
    
    text displayed next to predefined period buttons
  - setPeriodsText
```
public PeriodSelector setPeriodsText(java.lang.String periodsText)
```
    Sets text displayed next to predefined period buttons.
    
    Parameters:
    
    periodsText - periods text
  - getPosition
```
public Position getPosition()
```
    Returns:
    
    position
  - setPosition
```
public PeriodSelector setPosition(Position position)
```
    Sets position.
    
    Parameters:
    
    position - position
  - getSelectFromStart
```
public java.lang.Boolean getSelectFromStart()
```
    Returns:
    
    true if predefined period buttons select a period from the beginning
  - setSelectFromStart
```
public PeriodSelector setSelectFromStart(java.lang.Boolean selectFromStart)
```
    Set selectFromStart to true if predefined period buttons should select a period from the beginning.
    
    Parameters:
    
    selectFromStart - selectFromStart option
  - getToText
```
public java.lang.String getToText()
```
    Returns:
    
    text displayed next to "to" date input field
  - setToText
```
public PeriodSelector setToText(java.lang.String toText)
```
    Sets text displayed next to "to" date input field.
    
    Parameters:
    
    toText - text
  - getWidth
```
public java.lang.Integer getWidth()
```
    Returns:
    
    width of a period selector
  - setWidth
```
public PeriodSelector setWidth(java.lang.Integer width)
```
    Sets width of a period selector, when position is "left" or "right".
    
    Parameters:
    
    width - width

Class PeriodSelector

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PeriodSelector

Method Detail

getDateFormat

setDateFormat

getFromText

setFromText

getHideOutOfScopePeriods

setHideOutOfScopePeriods

getInputFieldsEnabled

setInputFieldsEnabled

getInputFieldWidth

setInputFieldWidth

getPeriods

setPeriods

addPeriods

getPeriodsText

setPeriodsText

getPosition

setPosition

getSelectFromStart

setSelectFromStart

getToText

setToText

getWidth

setWidth