import Timeline from 'react-timeline-9000/src/timeline.js'

public class | source

Timeline

Extends:

react~React.Component → Timeline

Timeline class

Static Member Summary

Static Public Members
public static	TIMELINE_MODES: object
public static	changeTypes: * The types of interactions - see onInteraction
public static	defaultProps: *
public static	no_op: * Alias for no op function
public static	propTypes: *

Static Method Summary

Static Public Methods
public static	isBitSet(bit: number, mask: number): boolean Checks if the given bit is set in the given mask

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	itemRowMap: {}
public	mouse_snapped_time: *
public	refreshGrid(config: Object): * re-computes the grid's row sizes
public	resizeTimeout: *
public	rowHeightCache: {}
public	rowItemMap: {}
public	selecting: boolean
public	state: {"selection": , "cursorTime": }

Private Members
private	_grid: *
private	_gridDomNode: *
private	_handleItemRowEvent: *
private	_itemInteractable: *
private	_selectBox: *
private	_selectRectangleInteractable: *

Method Summary

Public Methods
public	cellRenderer(width: number): *
public	changeGroup(item: object, curRow: number, newRow: number) Move an item from one row to another
public	clearSelection() Clears the currently selected time range state
public	componentDidMount()
public	componentDidUpdate(prevProps: , prevState: )
public	componentWillReceiveProps(nextProps: *)
public	componentWillUnmount()
public	getCursor(): *
public	getItem(id: number): Object Gets an item given its ID
public	getTimelineWidth(totalWidth: number): number Get the width of the timeline NOT including the left group list
public	grid_ref_callback(reactComponent: Object) Set the grid ref.
public	itemFromElement(e: Object): Object Returns an item given its DOM element
public	mouseMoveFunc(e: *)
public	render(): *
public	rowHeight(objectPattern: {"index": }): Helper for react virtuaized to get the row height given a row index
public	select_ref_callback(reactComponent: Object) Set the select box ref.
public	setSelection(selections: Object[]) Set the currently selected time ranges (for the timebar to display)
public	setTimeMap(items: Object[], startDate: moment, endDate: moment) Sets the internal maps used by the component for looking up item & row data
public	setUpDragging(canSelect: , canDrag: , canResize: *)
public	throttledMouseMoveFunc(e: *) Event handler for onMouseMove.
public	updateDimensions() Re-renders the grid when the window or container is resized

Static Public Members

public static TIMELINE_MODES: object source

public static changeTypes: * source

The types of interactions - see onInteraction

public static defaultProps: * source

public static no_op: * source

Alias for no op function

public static propTypes: * source

Static Public Methods

public static isBitSet(bit: number, mask: number): boolean source

Checks if the given bit is set in the given mask

Params:

Name	Type	Attribute	Description
bit	number		Bit to check
mask	number		Mask to check against

Return:

boolean

True if bit is set; else false

Public Constructors

public constructor() source

Public Members

public itemRowMap: {} source

public mouse_snapped_time: * source

public refreshGrid(config: Object): * source

re-computes the grid's row sizes

public resizeTimeout: * source

public rowHeightCache: {} source

public rowItemMap: {} source

public selecting: boolean source

public state: {"selection": , "cursorTime": } source

Private Members

private _grid: * source

private _gridDomNode: * source

private _handleItemRowEvent: * source

private _itemInteractable: * source

private _selectBox: * source

private _selectRectangleInteractable: * source

Public Methods

public cellRenderer(width: number): * source

Params:

Name	Type	Attribute	Description
width	number		container width (in px)

Return:

public changeGroup(item: object, curRow: number, newRow: number) source

Move an item from one row to another

Params:

Name	Type	Attribute	Description
item	object		The item object whose groups is to be changed
curRow	number		The item's current row index
newRow	number		The item's new row index

public clearSelection() source

Clears the currently selected time range state

public componentDidMount() source

public componentDidUpdate(prevProps: , prevState: ) source

Params:

Name	Type	Attribute	Description
prevProps	*
prevState	*

public componentWillReceiveProps(nextProps: *) source

Params:

Name	Type	Attribute	Description
nextProps	*

public componentWillUnmount() source

public getCursor(): * source

Return:

public getItem(id: number): Object source

Gets an item given its ID

Params:

Name	Type	Attribute	Description
id	number		item id

Return:

Object

Item object

public getTimelineWidth(totalWidth: number): number source

Get the width of the timeline NOT including the left group list

Params:

Name	Type	Attribute	Description
totalWidth	number	nullable: true	Total timeline width. If not supplied we use the timeline ref

Return:

number

The width in pixels

public grid_ref_callback(reactComponent: Object) source

Set the grid ref.

Params:

Name	Type	Attribute	Description
reactComponent	Object		Grid react element

public itemFromElement(e: Object): Object source

Returns an item given its DOM element

Params:

Name	Type	Attribute	Description
e	Object		the DOM element of the item

Return:

Object

Item details

public mouseMoveFunc(e: *) source

Params:

Name	Type	Attribute	Description
e	*

public render(): * source

Return:

public rowHeight(objectPattern: {"index": }): source

Helper for react virtuaized to get the row height given a row index

Params:

Name	Type	Attribute	Description
objectPattern	{"index": *}	default: {"index":null}

Return:

public select_ref_callback(reactComponent: Object) source

Set the select box ref.

Params:

Name	Type	Attribute	Description
reactComponent	Object		Selectbox react element

public setSelection(selections: Object[]) source

Set the currently selected time ranges (for the timebar to display)

Params:

Name	Type	Attribute	Description
selections	Object[]		Of the form `[[start, end], [start, end], ...]`

public setTimeMap(items: Object[], startDate: moment, endDate: moment) source

Sets the internal maps used by the component for looking up item & row data

Params:

Name	Type	Attribute	Description
items	Object[]		The items to be displayed in the grid
startDate	moment		The visible start date of the timeline
endDate	moment		The visible end date of the timeline

public setUpDragging(canSelect: , canDrag: , canResize: *) source

Params:

Name	Type	Attribute	Description
canSelect	*
canDrag	*
canResize	*

public throttledMouseMoveFunc(e: *) source

Event handler for onMouseMove. Only calls back if a new snap time is reached

Params:

Name	Type	Attribute	Description
e	*

public updateDimensions() source

Re-renders the grid when the window or container is resized

Timeline

Extends:

Static Member Summary

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Static Public Members

public static TIMELINE_MODES: object source

public static changeTypes: * source

public static defaultProps: * source

public static no_op: * source

public static propTypes: * source

Static Public Methods

public static isBitSet(bit: number, mask: number): boolean source

Params:

Return:

Public Constructors

public constructor() source

Public Members

public itemRowMap: {} source

public mouse_snapped_time: * source

public refreshGrid(config: Object): * source

public resizeTimeout: * source

public rowHeightCache: {} source

public rowItemMap: {} source

public selecting: boolean source

public state: {"selection": *, "cursorTime": *} source

Private Members

private _grid: * source

private _gridDomNode: * source

private _handleItemRowEvent: * source

private _itemInteractable: * source

private _selectBox: * source

private _selectRectangleInteractable: * source

Public Methods

public cellRenderer(width: number): * source

Params:

Return:

public changeGroup(item: object, curRow: number, newRow: number) source

Params:

public clearSelection() source

public componentDidMount() source

public componentDidUpdate(prevProps: *, prevState: *) source

Params:

public componentWillReceiveProps(nextProps: *) source

Params:

public componentWillUnmount() source

public getCursor(): * source

Return:

public getItem(id: number): Object source

Params:

Return:

public getTimelineWidth(totalWidth: number): number source

Params:

Return:

public grid_ref_callback(reactComponent: Object) source

Params:

public itemFromElement(e: Object): Object source

Params:

Return:

public mouseMoveFunc(e: *) source

Params:

public render(): * source

Return:

public rowHeight(objectPattern: {"index": *}): * source

Params:

Return:

public select_ref_callback(reactComponent: Object) source

Params:

public setSelection(selections: Object[]) source

Params:

public setTimeMap(items: Object[], startDate: moment, endDate: moment) source

Params:

public setUpDragging(canSelect: *, canDrag: *, canResize: *) source

Params:

public throttledMouseMoveFunc(e: *) source

Params:

public updateDimensions() source

public state: {"selection": , "cursorTime": } source

public componentDidUpdate(prevProps: , prevState: ) source

public rowHeight(objectPattern: {"index": }): source

public setUpDragging(canSelect: , canDrag: , canResize: *) source