Home Manual Reference Source
import TimeFilter from 'cloudify-ui-new/basic/TimeFilter.js'
public class | source

TimeFilter

Extends:

react~React.Component → TimeFilter

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

<TimeFilter name='timeFilter' defaultValue={TimeFilter.EMPTY_VALUE} />

Static Member Summary

Static Public Members
public static

propTypes

Static Public Members

public static propTypes: * source

propTypes

Properties:

NameTypeAttributeDescription
name string

name of the field

defaultValue object
  • optional
  • default: TimeFilter.INFLUX_DEFAULT_VALUE

timeFilter object ({range:'', start:'', end:'', resolution:'', unit:''}) to be set when Reset button is clicked

value object
  • optional
  • default: TimeFilter.INFLUX_DEFAULT_VALUE

timeFilter object to set input values

ranges object
  • optional
  • default: TimeFilter.INFLUX_RANGES

ranges object ({[range1] : {start: '', end:''}, [range2]: {start:'', end:''}, ...})

addTimeResolution boolean
  • optional
  • default: true

adds time resolution segment

dateSyntax string
  • optional
  • default: TimeFilter.INFLUX_DATE_SYNTAX

defines validation method for input start/end date (allowed values: TimeFilter.INFLUX_DATE_SYNTAX, TimeFilter.ISO_8601_DATE_SYNTAX)

onChange function
  • optional
  • default: (function (event, data) {});

function called on Apply button click, timeFilter object value is sent as data.value

onCancel function
  • optional
  • default: (function (event, data) {});

function called on Cancel button click, timeFilter object value is sent as data.value