TimelineCollection

TimelineCollection class

Specifies the collection of all the Timeline objects on the specified worksheet. Due to MS Excel, Excel 2003 does not support Timeline.

class TimelineCollection;

Methods

Method	Description
get(number)	Gets the Timeline by index.
get(string)	Gets the Timeline by Timeline’s name.
add(PivotTable, number, number, string)	Add a new Timeline using PivotTable as data source
add(PivotTable, string, string)	Add a new Timeline using PivotTable as data source
add(PivotTable, number, number, number)	Add a new Timeline using PivotTable as data source
add(PivotTable, string, number)	Add a new Timeline using PivotTable as data source
add(PivotTable, number, number, PivotField)	Add a new Timeline using PivotTable as data source
add(PivotTable, string, PivotField)	Add a new Timeline using PivotTable as data source

get(number)

Gets the Timeline by index.

get(index: number) : Timeline;

Parameters:

Parameter	Type	Description
index	number

Returns

Timeline

get(string)

Gets the Timeline by Timeline’s name.

get(name: string) : Timeline;

Parameters:

Parameter	Type	Description
name	string

Returns

Timeline

add(PivotTable, number, number, string)

Add a new Timeline using PivotTable as data source

add(pivot: PivotTable, row: number, column: number, baseFieldName: string) : number;

Parameters:

Parameter	Type	Description
pivot	PivotTable	PivotTable object
row	number	Row index of the cell in the upper-left corner of the Timeline range.
column	number	Column index of the cell in the upper-left corner of the Timeline range.
baseFieldName	string	The name of PivotField in PivotTable.BaseFields

Returns

The new add Timeline index

add(PivotTable, string, string)

Add a new Timeline using PivotTable as data source

add(pivot: PivotTable, destCellName: string, baseFieldName: string) : number;

Parameters:

Parameter	Type	Description
pivot	PivotTable	PivotTable object
destCellName	string	The cell name in the upper-left corner of the Timeline range.
baseFieldName	string	The name of PivotField in PivotTable.BaseFields

Returns

The new add Timeline index

add(PivotTable, number, number, number)

Add a new Timeline using PivotTable as data source

add(pivot: PivotTable, row: number, column: number, baseFieldIndex: number) : number;

Parameters:

Parameter	Type	Description
pivot	PivotTable	PivotTable object
row	number	Row index of the cell in the upper-left corner of the Timeline range.
column	number	Column index of the cell in the upper-left corner of the Timeline range.
baseFieldIndex	number	The index of PivotField in PivotTable.BaseFields

Returns

The new add Timeline index

add(PivotTable, string, number)

Add a new Timeline using PivotTable as data source

add(pivot: PivotTable, destCellName: string, baseFieldIndex: number) : number;

Parameters:

Parameter	Type	Description
pivot	PivotTable	PivotTable object
destCellName	string	The cell name in the upper-left corner of the Timeline range.
baseFieldIndex	number	The index of PivotField in PivotTable.BaseFields

Returns

The new add Timeline index

add(PivotTable, number, number, PivotField)

Add a new Timeline using PivotTable as data source

add(pivot: PivotTable, row: number, column: number, baseField: PivotField) : number;

Parameters:

Parameter	Type	Description
pivot	PivotTable	PivotTable object
row	number	Row index of the cell in the upper-left corner of the Timeline range.
column	number	Column index of the cell in the upper-left corner of the Timeline range.
baseField	PivotField	The PivotField in PivotTable.BaseFields

Returns

The new add Timeline index

add(PivotTable, string, PivotField)

Add a new Timeline using PivotTable as data source

add(pivot: PivotTable, destCellName: string, baseField: PivotField) : number;

Parameters:

Parameter	Type	Description
pivot	PivotTable	PivotTable object
destCellName	string	The cell name in the upper-left corner of the Timeline range.
baseField	PivotField	The PivotField in PivotTable.BaseFields

Returns

The new add Timeline index