TimeFilter
Extends:
TimeFilter is a component showing time range and optionally time resolution selectors
Both props: value
and defaultValue
are timeFilter objects:
{
range:'', // time range label
start:'', // datetime string representing time range start, eg. '2017-08-06 16:00' or 'now()-15m'
end:'', // datetime string representing time range end, eg. '2017-08-06 18:00' or 'now()'
resolution:'', // time resolution value, an integer (only used when addTimeResolution is set to true)
unit:'' // time resolution InfluxDB time syntax units, eg. 'm' for minutes, 'h' for hours (only used when addTimeResolution is set to true)
}
Access
Stage.Basic.TimeFilter
Usage
<TimeFilter name='timeFilter' defaultValue={TimeFilter.EMPTY_VALUE} />
Static Member Summary
Static Public Members | ||
public static |
propTypes: * propTypes |
Static Public Members
public static propTypes: * source
propTypes
Properties:
Name | Type | Attribute | Description |
name | string | name of the field |
|
defaultValue | object |
|
timeFilter object ({range:'', start:'', end:'', resolution:'', unit:''}) to be set when Reset button is clicked |
value | object |
|
timeFilter object to set input values |
ranges | object |
|
ranges object ({[range1] : {start: '', end:''}, [range2]: {start:'', end:''}, ...}) |
addTimeResolution | boolean |
|
adds time resolution segment |
dateSyntax | string |
|
defines validation method for input start/end date (allowed values: TimeFilter.INFLUX_DATE_SYNTAX, TimeFilter.ISO_8601_DATE_SYNTAX) |
onChange | function |
|
function called on Apply button click, timeFilter object value is sent as data.value |
onCancel | function |
|
function called on Cancel button click, timeFilter object value is sent as data.value |