Skip to content

Latest commit

 

History

History
71 lines (62 loc) · 5.76 KB

TimeSeries.md

File metadata and controls

71 lines (62 loc) · 5.76 KB
Raw

TimeSeries Component

TimeSeries

mark Object in Graph Props

'mark': {
  'position': {
    'x': {
      'field': 'Year',
    },
    'y': {
      'field': 'Tornadoes',
    },
    'z': {
      'field': 'Deaths',
    }
  },
  'style': {
    'fill': {
      'color': 'red',
      'opacity': 0.4,
    },
    'stroke': {
      'width': 1,
      'color': 'black',
    },
  }
}

Properties for mark for Parametric Time Series

Property Type Description
position object Defines the how the position of vertices for contour will be mapped. Required
position.x object Required.
position.x.field string Defines the field in the data that will be mapped as x position of the points on the timeseries. Required.
position.x.scaleType string Defines the scale type for x position. Not Required. Default value: linear. Available values: linear and ordinal.
position.x.domain float Defines the domain for x position. Not Required. If not present the domain is calculated from the provided data depending on the position.x.scaleType.
position.x.startFromZero boolean Defines if the domain starts from 0 or not. Not Required. Default value: false Only applicable if position.x.domain is not given and position.x.scaleType is linear.
position.y object Required.
position.y.field string Defines the field in the data that will be mapped as y position of the points on the timeseries. Required.
position.y.domain float Defines the domain for y position. Not Required. If not present the domain is calculated from the provided data depending on the position.y.scaleType.
position.y.startFromZero boolean Defines if the domain starts from 0 or not. Not Required. Default value: false Only applicable if position.y.domain is not given and position.y.scaleType is linear.
position.z object Required.
position.z.field string Defines the field in the data that will be mapped as z position of the points on the timeseries. Required.
position.z.domain float Defines the domain for z position. Not Required. If not present the domain is calculated from the provided data depending on the position.z.scaleType.
position.z.startFromZero boolean Defines if the domain starts from 0 or not. Not Required. Default value: false Only applicable if position.z.domain is not given and position.z.scaleType is linear.
style object Defines the style of the contour. Required
style.fill object Defines the fill of the surface. Not Required.
style.fill.opacity float Defines the opacity of the surface. Not Required. Default value: 1. Value must be between 0 and 1.
style.fill.color string Defines the color for fill. Not Required. Default value: "#ff0000"
style.stroke object Defines the stroke for the timeseries. Not Required. If not present the timeseries are not stroked. This can be used to design a mesh to make the timeseries more readable.
style.stroke.width float Defines the stroke of the timeseries. Not Required. Default value: 1.
style.stroke.color string Defines the stroke color for the timeseries. Not Required. Default value: "#000000"
style.stroke.opacity float Defines the stroke opacity for the timeseries. Not Required. Default value: 1. Value must be between 0 and 1.

Example JS of the Visualization

Data

Datafile: csv

Year,Tornadoes,Deaths
1996,35,1
1997,14,1
1998,71,0