
## Timeline class

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

```javascript
class Timeline;
```


## Properties

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

## Methods

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


### showHeader {#showHeader--}

Indicates whether to display the header of this timeline.

```javascript
showHeader : boolean;
```


### showSelectionLabel {#showSelectionLabel--}

Indicates whether to display the selction label.

```javascript
showSelectionLabel : boolean;
```


### showTimeLevel {#showTimeLevel--}

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

```javascript
showTimeLevel : boolean;
```


### showHorizontalScrollbar {#showHorizontalScrollbar--}

Indicates whether to display the horizontal scroll bar.

```javascript
showHorizontalScrollbar : boolean;
```


### startDate {#startDate--}

Gets and sets the start date of the timespan scrolling position of this [Timeline](../timeline/).

```javascript
startDate : Date;
```


### currentLevel {#currentLevel--}

The current time level of the Timeline.

```javascript
currentLevel : TimelineLevelType;
```


### selectionLevel {#selectionLevel--}

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

```javascript
selectionLevel : TimelineLevelType;
```


### caption {#caption--}

Gets or sets the caption of this Timeline.

```javascript
caption : string;
```


### shape {#shape--}

Readonly. Returns the [TimelineShape](../timelineshape/) object associated with this Timeline.

```javascript
shape : TimelineShape;
```


### name {#name--}

Returns or sets the name of the specified Timeline

```javascript
name : string;
```


### leftPixel {#leftPixel--}

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

```javascript
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 {#topPixel--}

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

```javascript
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 {#widthPixel--}

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

```javascript
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 {#heightPixel--}

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

```javascript
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() {#getShowHeader--}

<b>@deprecated.</b> Please use the 'showHeader' property instead. Indicates whether to display the header of this timeline.

```javascript
getShowHeader() : boolean;
```


### setShowHeader(boolean) {#setShowHeader-boolean-}

<b>@deprecated.</b> Please use the 'showHeader' property instead. Indicates whether to display the header of this timeline.

```javascript
setShowHeader(value: boolean) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |

### getShowSelectionLabel() {#getShowSelectionLabel--}

<b>@deprecated.</b> Please use the 'showSelectionLabel' property instead. Indicates whether to display the selction label.

```javascript
getShowSelectionLabel() : boolean;
```


### setShowSelectionLabel(boolean) {#setShowSelectionLabel-boolean-}

<b>@deprecated.</b> Please use the 'showSelectionLabel' property instead. Indicates whether to display the selction label.

```javascript
setShowSelectionLabel(value: boolean) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |

### getShowTimeLevel() {#getShowTimeLevel--}

<b>@deprecated.</b> Please use the 'showTimeLevel' property instead. Indicates whether to display the drop-down selection box of the time level.

```javascript
getShowTimeLevel() : boolean;
```


### setShowTimeLevel(boolean) {#setShowTimeLevel-boolean-}

<b>@deprecated.</b> Please use the 'showTimeLevel' property instead. Indicates whether to display the drop-down selection box of the time level.

```javascript
setShowTimeLevel(value: boolean) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |

### getShowHorizontalScrollbar() {#getShowHorizontalScrollbar--}

<b>@deprecated.</b> Please use the 'showHorizontalScrollbar' property instead. Indicates whether to display the horizontal scroll bar.

```javascript
getShowHorizontalScrollbar() : boolean;
```


### setShowHorizontalScrollbar(boolean) {#setShowHorizontalScrollbar-boolean-}

<b>@deprecated.</b> Please use the 'showHorizontalScrollbar' property instead. Indicates whether to display the horizontal scroll bar.

```javascript
setShowHorizontalScrollbar(value: boolean) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |

### getStartDate() {#getStartDate--}

<b>@deprecated.</b> Please use the 'startDate' property instead. Gets and sets the start date of the timespan scrolling position of this [Timeline](../timeline/).

```javascript
getStartDate() : Date;
```


### setStartDate(Date) {#setStartDate-date-}

<b>@deprecated.</b> Please use the 'startDate' property instead. Gets and sets the start date of the timespan scrolling position of this [Timeline](../timeline/).

```javascript
setStartDate(value: Date) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Date | The value to set. |

### getCurrentLevel() {#getCurrentLevel--}

<b>@deprecated.</b> Please use the 'currentLevel' property instead. The current time level of the Timeline.

```javascript
getCurrentLevel() : TimelineLevelType;
```


**Returns**

[TimelineLevelType](../timelineleveltype/)

### setCurrentLevel(TimelineLevelType) {#setCurrentLevel-timelineleveltype-}

<b>@deprecated.</b> Please use the 'currentLevel' property instead. The current time level of the Timeline.

```javascript
setCurrentLevel(value: TimelineLevelType) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [TimelineLevelType](../timelineleveltype/) | The value to set. |

### getSelectionLevel() {#getSelectionLevel--}

<b>@deprecated.</b> Please use the 'selectionLevel' property instead. Gets and sets the time level at which the current selection was made for the Timeline.

```javascript
getSelectionLevel() : TimelineLevelType;
```


**Returns**

[TimelineLevelType](../timelineleveltype/)

### setSelectionLevel(TimelineLevelType) {#setSelectionLevel-timelineleveltype-}

<b>@deprecated.</b> Please use the 'selectionLevel' property instead. Gets and sets the time level at which the current selection was made for the Timeline.

```javascript
setSelectionLevel(value: TimelineLevelType) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [TimelineLevelType](../timelineleveltype/) | The value to set. |

### getCaption() {#getCaption--}

<b>@deprecated.</b> Please use the 'caption' property instead. Gets or sets the caption of this Timeline.

```javascript
getCaption() : string;
```


### setCaption(string) {#setCaption-string-}

<b>@deprecated.</b> Please use the 'caption' property instead. Gets or sets the caption of this Timeline.

```javascript
setCaption(value: string) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | string | The value to set. |

### getShape() {#getShape--}

<b>@deprecated.</b> Please use the 'shape' property instead. Returns the [TimelineShape](../timelineshape/) object associated with this Timeline.

```javascript
getShape() : TimelineShape;
```


**Returns**

[TimelineShape](../timelineshape/)

### getName() {#getName--}

<b>@deprecated.</b> Please use the 'name' property instead. Returns or sets the name of the specified Timeline

```javascript
getName() : string;
```


### setName(string) {#setName-string-}

<b>@deprecated.</b> Please use the 'name' property instead. Returns or sets the name of the specified Timeline

```javascript
setName(value: string) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | string | The value to set. |

### getLeftPixel() {#getLeftPixel--}

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

```javascript
getLeftPixel() : 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.

### setLeftPixel(number) {#setLeftPixel-number-}

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

```javascript
setLeftPixel(value: number) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | number | The value to set. |

**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.

### getTopPixel() {#getTopPixel--}

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

```javascript
getTopPixel() : 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.

### setTopPixel(number) {#setTopPixel-number-}

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

```javascript
setTopPixel(value: number) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | number | The value to set. |

**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.

### getWidthPixel() {#getWidthPixel--}

<b>@deprecated.</b> Please use the 'widthPixel' property instead. Returns or sets the width of the specified timeline, in pixels.

```javascript
getWidthPixel() : 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.

### setWidthPixel(number) {#setWidthPixel-number-}

<b>@deprecated.</b> Please use the 'widthPixel' property instead. Returns or sets the width of the specified timeline, in pixels.

```javascript
setWidthPixel(value: number) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | number | The value to set. |

**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.

### getHeightPixel() {#getHeightPixel--}

<b>@deprecated.</b> Please use the 'heightPixel' property instead. Returns or sets the height of the specified timeline, in pixels.

```javascript
getHeightPixel() : 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.

### setHeightPixel(number) {#setHeightPixel-number-}

<b>@deprecated.</b> Please use the 'heightPixel' property instead. Returns or sets the height of the specified timeline, in pixels.

```javascript
setHeightPixel(value: number) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | number | The value to set. |

**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.

### getSelectedDateTimeRange() {#getSelectedDateTimeRange--}

Gets the selected range of date time.

```javascript
getSelectedDateTimeRange() : Date[];
```


**Returns**

Date[]

### select(Date, Date, boolean) {#select-date-date-boolean-}

Select item between the date time.

```javascript
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](../timeline.currentlevel/) must be set before calling this method. If this method is called, [Timeline.SelectionLevel](../timeline.selectionlevel/) will be [Timeline.CurrentLevel](../timeline.currentlevel/).

### isNull() {#isNull--}

Checks whether the implementation object is null.

```javascript
isNull() : boolean;
```



