Timeline

JSON Example

Props

Name	Type	Default Value	Required	Description
standalone	boolean	true	no	If true, timeline will display like a standalone viz
periodButtons	boolean	false	no	If true, timeline will show period buttons
currentTimeButton	boolean	false	no	If true, timeline will show a button to change to current time
autoRefreshButton	boolean	true	no	If true, timeline will show an auto-refresh button
offset	number	0	no	The timezone offset, should be from context

Usage Example

Viz Props

import React from 'react'

import { Viz } from 'a10-gui-dgp-viz'

const { Timeline } = Viz
export const MyDashboard = () => {
  return (
    <Timeline
      standalone={true},
      autoRefreshButton={true},
      currentTimeButton={false},
      periodButtons={false},
    />
  )
}

Props Interface

interface ITimelineProps extends IBasicVizProps {
  standalone?: boolean  // if true, timeline will display like a standalone viz
  periodButtons?: boolean // if true, timeline will show period buttons
  currentTimeButton?: boolean // if true, timeline will show a button to change to current time
  autoRefreshButton?: boolean // if true, timeline will show an auto-refresh button
  offset?: number // the timezone offset, should be from context
}

UI JSON

{
  "vizName": "timeline",
  "periodButtons": true,
  "currentTimeButton": true,
  "autoRefreshButton": false,
  "standalone": true,
  "offset": 0
}

Actions

VIZ.TIMELINE.ONCHANGE

Name	Type	Description
type	string	The action type
startTime	number	The unix timestamp of the start time
endTime	number	The unix timestamp of the end time