Timeline

Timeline class

Summary description of Timeline View Due to MS Excel, Excel 2003 does not support Timeline

class Timeline;

Properties

Property	Type	Description
showHeader	boolean	Indicates whether to display the header of this timeline.
showSelectionLabel	boolean	Indicates whether to display the selction label.
showTimeLevel	boolean	Indicates whether to display the drop-down selection box of the time level.
showHorizontalScrollbar	boolean	Indicates whether to display the horizontal scroll bar.
startDate	Date	Gets and sets the start date of the timespan scrolling position of this Timeline.
currentLevel	TimelineLevelType	The current time level of the Timeline.
selectionLevel	TimelineLevelType	Gets and sets the time level at which the current selection was made for the Timeline.
caption	string	Gets or sets the caption of this Timeline.
shape	TimelineShape	Readonly. Returns the TimelineShape object associated with this Timeline.
name	string	Returns or sets the name of the specified Timeline
leftPixel	number	Returns or sets the horizontal offset of timeline shape from its left column, in pixels.
topPixel	number	Returns or sets the vertical offset of timeline shape from its top row, in pixels.
widthPixel	number	Returns or sets the width of the specified timeline, in pixels.
heightPixel	number	Returns or sets the height of the specified timeline, in pixels.

Methods

Method	Description
getShowHeader()	@deprecated. Please use the ‘showHeader’ property instead. Indicates whether to display the header of this timeline.
setShowHeader(boolean)	@deprecated. Please use the ‘showHeader’ property instead. Indicates whether to display the header of this timeline.
getShowSelectionLabel()	@deprecated. Please use the ‘showSelectionLabel’ property instead. Indicates whether to display the selction label.
setShowSelectionLabel(boolean)	@deprecated. Please use the ‘showSelectionLabel’ property instead. Indicates whether to display the selction label.
getShowTimeLevel()	@deprecated. Please use the ‘showTimeLevel’ property instead. Indicates whether to display the drop-down selection box of the time level.
setShowTimeLevel(boolean)	@deprecated. Please use the ‘showTimeLevel’ property instead. Indicates whether to display the drop-down selection box of the time level.
getShowHorizontalScrollbar()	@deprecated. Please use the ‘showHorizontalScrollbar’ property instead. Indicates whether to display the horizontal scroll bar.
setShowHorizontalScrollbar(boolean)	@deprecated. Please use the ‘showHorizontalScrollbar’ property instead. Indicates whether to display the horizontal scroll bar.
getStartDate()	@deprecated. Please use the ‘startDate’ property instead. Gets and sets the start date of the timespan scrolling position of this Timeline.
setStartDate(Date)	@deprecated. Please use the ‘startDate’ property instead. Gets and sets the start date of the timespan scrolling position of this Timeline.
getCurrentLevel()	@deprecated. Please use the ‘currentLevel’ property instead. The current time level of the Timeline.
setCurrentLevel(TimelineLevelType)	@deprecated. Please use the ‘currentLevel’ property instead. The current time level of the Timeline.
getSelectionLevel()	@deprecated. Please use the ‘selectionLevel’ property instead. Gets and sets the time level at which the current selection was made for the Timeline.
setSelectionLevel(TimelineLevelType)	@deprecated. Please use the ‘selectionLevel’ property instead. Gets and sets the time level at which the current selection was made for the Timeline.
getCaption()	@deprecated. Please use the ‘caption’ property instead. Gets or sets the caption of this Timeline.
setCaption(string)	@deprecated. Please use the ‘caption’ property instead. Gets or sets the caption of this Timeline.
getShape()	@deprecated. Please use the ‘shape’ property instead. Returns the TimelineShape object associated with this Timeline.
getName()	@deprecated. Please use the ’name’ property instead. Returns or sets the name of the specified Timeline
setName(string)	@deprecated. Please use the ’name’ property instead. Returns or sets the name of the specified Timeline
getLeftPixel()	@deprecated. Please use the ’leftPixel’ property instead. Returns or sets the horizontal offset of timeline shape from its left column, in pixels.
setLeftPixel(number)	@deprecated. Please use the ’leftPixel’ property instead. Returns or sets the horizontal offset of timeline shape from its left column, in pixels.
getTopPixel()	@deprecated. Please use the ’topPixel’ property instead. Returns or sets the vertical offset of timeline shape from its top row, in pixels.
setTopPixel(number)	@deprecated. Please use the ’topPixel’ property instead. Returns or sets the vertical offset of timeline shape from its top row, in pixels.
getWidthPixel()	@deprecated. Please use the ‘widthPixel’ property instead. Returns or sets the width of the specified timeline, in pixels.
setWidthPixel(number)	@deprecated. Please use the ‘widthPixel’ property instead. Returns or sets the width of the specified timeline, in pixels.
getHeightPixel()	@deprecated. Please use the ‘heightPixel’ property instead. Returns or sets the height of the specified timeline, in pixels.
setHeightPixel(number)	@deprecated. Please use the ‘heightPixel’ property instead. Returns or sets the height of the specified timeline, in pixels.
getSelectedDateTimeRange()	Gets the selected range of date time.
select(Date, Date, boolean)	Select item between the date time.
isNull()	Checks whether the implementation object is null.

showHeader

Indicates whether to display the header of this timeline.

showHeader : boolean;

showSelectionLabel

Indicates whether to display the selction label.

showSelectionLabel : boolean;

showTimeLevel

Indicates whether to display the drop-down selection box of the time level.

showTimeLevel : boolean;

showHorizontalScrollbar

Indicates whether to display the horizontal scroll bar.

showHorizontalScrollbar : boolean;

startDate

Gets and sets the start date of the timespan scrolling position of this Timeline.

startDate : Date;

currentLevel

The current time level of the Timeline.

currentLevel : TimelineLevelType;

selectionLevel

Gets and sets the time level at which the current selection was made for the Timeline.

selectionLevel : TimelineLevelType;

caption

Gets or sets the caption of this Timeline.

caption : string;

shape

Readonly. Returns the TimelineShape object associated with this Timeline.

shape : TimelineShape;

name

Returns or sets the name of the specified Timeline

name : string;

leftPixel

Returns or sets the horizontal offset of timeline shape from its left column, in pixels.

leftPixel : number;

Remarks

NOTE: This member is now obsolete. Instead, please use Shape.Left property. This property will be removed 12 months later since May 2025. Aspose apologizes for any inconvenience you may have experienced.

topPixel

Returns or sets the vertical offset of timeline shape from its top row, in pixels.

topPixel : number;

Remarks

NOTE: This member is now obsolete. Instead, please use Shape.Top property. This property will be removed 12 months later since May 2025. Aspose apologizes for any inconvenience you may have experienced.

widthPixel

Returns or sets the width of the specified timeline, in pixels.

widthPixel : number;

Remarks

NOTE: This member is now obsolete. Instead, please use Shape.Width property. This property will be removed 12 months later since May 2025. Aspose apologizes for any inconvenience you may have experienced.

heightPixel

Returns or sets the height of the specified timeline, in pixels.

heightPixel : number;

Remarks

NOTE: This member is now obsolete. Instead, please use Shape.Height property. This property will be removed 12 months later since May 2025. Aspose apologizes for any inconvenience you may have experienced.

getShowHeader()

@deprecated. Please use the ‘showHeader’ property instead. Indicates whether to display the header of this timeline.

getShowHeader() : boolean;

setShowHeader(boolean)

@deprecated. Please use the ‘showHeader’ property instead. Indicates whether to display the header of this timeline.

setShowHeader(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getShowSelectionLabel()

@deprecated. Please use the ‘showSelectionLabel’ property instead. Indicates whether to display the selction label.

getShowSelectionLabel() : boolean;

setShowSelectionLabel(boolean)

@deprecated. Please use the ‘showSelectionLabel’ property instead. Indicates whether to display the selction label.

setShowSelectionLabel(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getShowTimeLevel()

@deprecated. Please use the ‘showTimeLevel’ property instead. Indicates whether to display the drop-down selection box of the time level.

getShowTimeLevel() : boolean;

setShowTimeLevel(boolean)

@deprecated. Please use the ‘showTimeLevel’ property instead. Indicates whether to display the drop-down selection box of the time level.

setShowTimeLevel(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getShowHorizontalScrollbar()

@deprecated. Please use the ‘showHorizontalScrollbar’ property instead. Indicates whether to display the horizontal scroll bar.

getShowHorizontalScrollbar() : boolean;

setShowHorizontalScrollbar(boolean)

@deprecated. Please use the ‘showHorizontalScrollbar’ property instead. Indicates whether to display the horizontal scroll bar.

setShowHorizontalScrollbar(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getStartDate()

@deprecated. Please use the ‘startDate’ property instead. Gets and sets the start date of the timespan scrolling position of this Timeline.

getStartDate() : Date;

setStartDate(Date)

@deprecated. Please use the ‘startDate’ property instead. Gets and sets the start date of the timespan scrolling position of this Timeline.

setStartDate(value: Date) : void;

Parameters:

Parameter	Type	Description
value	Date	The value to set.

getCurrentLevel()

@deprecated. Please use the ‘currentLevel’ property instead. The current time level of the Timeline.

getCurrentLevel() : TimelineLevelType;

Returns

TimelineLevelType

setCurrentLevel(TimelineLevelType)

@deprecated. Please use the ‘currentLevel’ property instead. The current time level of the Timeline.

setCurrentLevel(value: TimelineLevelType) : void;

Parameters:

Parameter	Type	Description
value	TimelineLevelType	The value to set.

getSelectionLevel()

@deprecated. Please use the ‘selectionLevel’ property instead. Gets and sets the time level at which the current selection was made for the Timeline.

getSelectionLevel() : TimelineLevelType;

Returns

TimelineLevelType

setSelectionLevel(TimelineLevelType)

@deprecated. Please use the ‘selectionLevel’ property instead. Gets and sets the time level at which the current selection was made for the Timeline.

setSelectionLevel(value: TimelineLevelType) : void;

Parameters:

Parameter	Type	Description
value	TimelineLevelType	The value to set.

getCaption()

@deprecated. Please use the ‘caption’ property instead. Gets or sets the caption of this Timeline.

getCaption() : string;

setCaption(string)

@deprecated. Please use the ‘caption’ property instead. Gets or sets the caption of this Timeline.

setCaption(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getShape()

@deprecated. Please use the ‘shape’ property instead. Returns the TimelineShape object associated with this Timeline.

getShape() : TimelineShape;

Returns

TimelineShape

getName()

@deprecated. Please use the ’name’ property instead. Returns or sets the name of the specified Timeline

getName() : string;

setName(string)

@deprecated. Please use the ’name’ property instead. Returns or sets the name of the specified Timeline

setName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getLeftPixel()

@deprecated. Please use the ’leftPixel’ property instead. Returns or sets the horizontal offset of timeline shape from its left column, in pixels.

getLeftPixel() : number;

Remarks

setLeftPixel(number)

@deprecated. Please use the ’leftPixel’ property instead. Returns or sets the horizontal offset of timeline shape from its left column, in pixels.

setLeftPixel(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

getTopPixel()

@deprecated. Please use the ’topPixel’ property instead. Returns or sets the vertical offset of timeline shape from its top row, in pixels.

getTopPixel() : number;

Remarks

setTopPixel(number)

@deprecated. Please use the ’topPixel’ property instead. Returns or sets the vertical offset of timeline shape from its top row, in pixels.

setTopPixel(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

getWidthPixel()

@deprecated. Please use the ‘widthPixel’ property instead. Returns or sets the width of the specified timeline, in pixels.

getWidthPixel() : number;

Remarks

setWidthPixel(number)

@deprecated. Please use the ‘widthPixel’ property instead. Returns or sets the width of the specified timeline, in pixels.

setWidthPixel(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

getHeightPixel()

@deprecated. Please use the ‘heightPixel’ property instead. Returns or sets the height of the specified timeline, in pixels.

getHeightPixel() : number;

Remarks

setHeightPixel(number)

@deprecated. Please use the ‘heightPixel’ property instead. Returns or sets the height of the specified timeline, in pixels.

setHeightPixel(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

getSelectedDateTimeRange()

Gets the selected range of date time.

getSelectedDateTimeRange() : Date[];

Returns

Date[]

select(Date, Date, boolean)

Select item between the date time.

select(start: Date, end: Date, calculate: boolean) : void;

Parameters:

Parameter	Type	Description
start	Date	The start date time
end	Date	The end date time
calculate	boolean	Indicates whether to calculate relative pivot tables

Remarks

Timeline.CurrentLevel must be set before calling this method. If this method is called, Timeline.SelectionLevel will be Timeline.CurrentLevel.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;