# GC.Spread.Pivot.PivotTableTimelineSlicer

## Content

# Class: PivotTableTimelineSlicer

[Spread](../modules/GC.Spread).[Pivot](../modules/GC.Spread.Pivot).PivotTableTimelineSlicer

## Table of contents

### Constructors

- [constructor](GC.Spread.Pivot.PivotTableTimelineSlicer#constructor)

### Methods

- [allowMove](GC.Spread.Pivot.PivotTableTimelineSlicer#allowmove)
- [allowResize](GC.Spread.Pivot.PivotTableTimelineSlicer#allowresize)
- [captionName](GC.Spread.Pivot.PivotTableTimelineSlicer#captionname)
- [connectPivotTable](GC.Spread.Pivot.PivotTableTimelineSlicer#connectpivottable)
- [disableResizingAndMoving](GC.Spread.Pivot.PivotTableTimelineSlicer#disableresizingandmoving)
- [disconnectPivotTable](GC.Spread.Pivot.PivotTableTimelineSlicer#disconnectpivottable)
- [dynamicMove](GC.Spread.Pivot.PivotTableTimelineSlicer#dynamicmove)
- [dynamicSize](GC.Spread.Pivot.PivotTableTimelineSlicer#dynamicsize)
- [endColumn](GC.Spread.Pivot.PivotTableTimelineSlicer#endcolumn)
- [endColumnOffset](GC.Spread.Pivot.PivotTableTimelineSlicer#endcolumnoffset)
- [endRow](GC.Spread.Pivot.PivotTableTimelineSlicer#endrow)
- [endRowOffset](GC.Spread.Pivot.PivotTableTimelineSlicer#endrowoffset)
- [getAllConnectedPivotTables](GC.Spread.Pivot.PivotTableTimelineSlicer#getallconnectedpivottables)
- [getAllPivotTables](GC.Spread.Pivot.PivotTableTimelineSlicer#getallpivottables)
- [getConnectedPivotTableNameList](GC.Spread.Pivot.PivotTableTimelineSlicer#getconnectedpivottablenamelist)
- [height](GC.Spread.Pivot.PivotTableTimelineSlicer#height)
- [isConnectedPivotTable](GC.Spread.Pivot.PivotTableTimelineSlicer#isconnectedpivottable)
- [isLocked](GC.Spread.Pivot.PivotTableTimelineSlicer#islocked)
- [isSelected](GC.Spread.Pivot.PivotTableTimelineSlicer#isselected)
- [isVisible](GC.Spread.Pivot.PivotTableTimelineSlicer#isvisible)
- [level](GC.Spread.Pivot.PivotTableTimelineSlicer#level)
- [name](GC.Spread.Pivot.PivotTableTimelineSlicer#name)
- [nameInFormula](GC.Spread.Pivot.PivotTableTimelineSlicer#nameinformula)
- [position](GC.Spread.Pivot.PivotTableTimelineSlicer#position)
- [refresh](GC.Spread.Pivot.PivotTableTimelineSlicer#refresh)
- [scrollPosition](GC.Spread.Pivot.PivotTableTimelineSlicer#scrollposition)
- [sheet](GC.Spread.Pivot.PivotTableTimelineSlicer#sheet)
- [showHeader](GC.Spread.Pivot.PivotTableTimelineSlicer#showheader)
- [showHorizontalScrollbar](GC.Spread.Pivot.PivotTableTimelineSlicer#showhorizontalscrollbar)
- [showSelectionLabel](GC.Spread.Pivot.PivotTableTimelineSlicer#showselectionlabel)
- [showTimeLevel](GC.Spread.Pivot.PivotTableTimelineSlicer#showtimelevel)
- [sourceName](GC.Spread.Pivot.PivotTableTimelineSlicer#sourcename)
- [startColumn](GC.Spread.Pivot.PivotTableTimelineSlicer#startcolumn)
- [startColumnOffset](GC.Spread.Pivot.PivotTableTimelineSlicer#startcolumnoffset)
- [startRow](GC.Spread.Pivot.PivotTableTimelineSlicer#startrow)
- [startRowOffset](GC.Spread.Pivot.PivotTableTimelineSlicer#startrowoffset)
- [style](GC.Spread.Pivot.PivotTableTimelineSlicer#style)
- [width](GC.Spread.Pivot.PivotTableTimelineSlicer#width)
- [x](GC.Spread.Pivot.PivotTableTimelineSlicer#x)
- [y](GC.Spread.Pivot.PivotTableTimelineSlicer#y)

## Constructors

### <a id="constructor" name="constructor"></a> constructor

• **new PivotTableTimelineSlicer**()

Represents a pivot timeline slicer.

## Methods

### <a id="allowmove" name="allowmove"></a> allowMove

▸ **allowMove**(`value?`): `any`

Gets or sets the allowMove of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `boolean` |

#### Returns

`any`

If no value is set, returns the allowMove of the slicer; otherwise, returns the slicer.

___

### <a id="allowresize" name="allowresize"></a> allowResize

▸ **allowResize**(`value?`): `any`

Gets or sets the allowResize of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `boolean` |

#### Returns

`any`

If no value is set, returns the allowResize of the slicer; otherwise, returns the slicer.

___

### <a id="captionname" name="captionname"></a> captionName

▸ **captionName**(`value?`): `any`

Gets or sets the captionName of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `string` |

#### Returns

`any`

If no value is set, returns the captionName of the slicer; otherwise, returns the slicer.

___

### <a id="connectpivottable" name="connectpivottable"></a> connectPivotTable

▸ **connectPivotTable**(`ptName`): `void`

Connect pivot table with the slicer

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `ptName` | `string` | name of pivot table |

#### Returns

`void`

___

### <a id="disableresizingandmoving" name="disableresizingandmoving"></a> disableResizingAndMoving

▸ **disableResizingAndMoving**(`value?`): `any`

Gets or sets the disableResizingAndMoving of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `boolean` |

#### Returns

`any`

If no value is set, returns the disableResizingAndMoving of the slicer; otherwise, returns the slicer.

___

### <a id="disconnectpivottable" name="disconnectpivottable"></a> disconnectPivotTable

▸ **disconnectPivotTable**(`ptName`): `void`

Disconnect pivot table with the slicer

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `ptName` | `string` | name of pivot table |

#### Returns

`void`

___

### <a id="dynamicmove" name="dynamicmove"></a> dynamicMove

▸ **dynamicMove**(`value?`): `any`

Gets or sets the dynamicMove of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `boolean` |

#### Returns

`any`

If no value is set, returns the dynamicMove of the slicer; otherwise, returns the slicer.

___

### <a id="dynamicsize" name="dynamicsize"></a> dynamicSize

▸ **dynamicSize**(`value?`): `any`

Gets or sets the dynamicSize of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `boolean` |

#### Returns

`any`

If no value is set, returns the dynamicSize of the slicer; otherwise, returns the slicer.

___

### <a id="endcolumn" name="endcolumn"></a> endColumn

▸ **endColumn**(`value?`): `any`

Gets or sets the endColumn of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `number` |

#### Returns

`any`

If no value is set, returns the endColumn of the slicer; otherwise, returns the slicer.

___

### <a id="endcolumnoffset" name="endcolumnoffset"></a> endColumnOffset

▸ **endColumnOffset**(`value?`): `any`

Gets or sets the endColumnOffset of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `number` |

#### Returns

`any`

If no value is set, returns the endColumnOffset of the slicer; otherwise, returns the slicer.

___

### <a id="endrow" name="endrow"></a> endRow

▸ **endRow**(`value?`): `any`

Gets or sets the endRow of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `number` |

#### Returns

`any`

If no value is set, returns the endRow of the slicer; otherwise, returns the slicer.

___

### <a id="endrowoffset" name="endrowoffset"></a> endRowOffset

▸ **endRowOffset**(`value?`): `any`

Gets or sets the endRowOffset of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `number` |

#### Returns

`any`

If no value is set, returns the endRowOffset of the slicer; otherwise, returns the slicer.

___

### <a id="getallconnectedpivottables" name="getallconnectedpivottables"></a> getAllConnectedPivotTables

▸ **getAllConnectedPivotTables**(): [`PivotTable`](GC.Spread.Pivot.PivotTable-1)[]

get all connected PivotTables

#### Returns

[`PivotTable`](GC.Spread.Pivot.PivotTable-1)[]

PivotTables connected with the slicer.

___

### <a id="getallpivottables" name="getallpivottables"></a> getAllPivotTables

▸ **getAllPivotTables**(): [`PivotTable`](GC.Spread.Pivot.PivotTable-1)[]

get all PivotTables whether connected or not.

#### Returns

[`PivotTable`](GC.Spread.Pivot.PivotTable-1)[]

PivotTables whose source is same as the slicer.

___

### <a id="getconnectedpivottablenamelist" name="getconnectedpivottablenamelist"></a> getConnectedPivotTableNameList

▸ **getConnectedPivotTableNameList**(): `string`[]

get all connected PivotTables' name.

#### Returns

`string`[]

name list of PivotTables connected with the slicer.

___

### <a id="height" name="height"></a> height

▸ **height**(`value?`): `any`

Gets or sets the height of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `number` |

#### Returns

`any`

If no value is set, returns the height of the slicer; otherwise, returns the slicer.

___

### <a id="isconnectedpivottable" name="isconnectedpivottable"></a> isConnectedPivotTable

▸ **isConnectedPivotTable**(`ptName`): `boolean`

Check whether pivot table connect with the slicer

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `ptName` | `string` | name of pivot table |

#### Returns

`boolean`

___

### <a id="islocked" name="islocked"></a> isLocked

▸ **isLocked**(`value?`): `any`

Gets or sets the isLocked of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `boolean` |

#### Returns

`any`

If no value is set, returns the isLocked of the slicer; otherwise, returns the slicer.

___

### <a id="isselected" name="isselected"></a> isSelected

▸ **isSelected**(`value?`): `any`

Gets or sets the isSelected of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `boolean` |

#### Returns

`any`

If no value is set, returns the isSelected of the slicer; otherwise, returns the slicer.

___

### <a id="isvisible" name="isvisible"></a> isVisible

▸ **isVisible**(`value?`): `any`

Gets or sets the isVisible of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `boolean` |

#### Returns

`any`

If no value is set, returns the isVisible of the slicer; otherwise, returns the slicer.

___

### <a id="level" name="level"></a> level

▸ **level**(`value?`): `any`

Gets or sets the level of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | [`TimelineLevel`](../enums/GC.Spread.Sheets.Slicers.TimelineLevel) |

#### Returns

`any`

If no value is set, returns the level of the slicer; otherwise, returns the slicer.

___

### <a id="name" name="name"></a> name

▸ **name**(`value?`): `any`

Gets or sets the name of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `string` |

#### Returns

`any`

If no value is set, returns the name of the slicer; otherwise, returns the slicer.

___

### <a id="nameinformula" name="nameinformula"></a> nameInFormula

▸ **nameInFormula**(): `string`

Gets the nameInFormula of the slicer.

#### Returns

`string`

returns the nameInFormula of the slicer.

___

### <a id="position" name="position"></a> position

▸ **position**(`value?`): `any`

Gets or sets the position of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | [`Point`](GC.Spread.Sheets.Point) |

#### Returns

`any`

If no value is set, returns the position of the slicer; otherwise, returns the slicer.

___

### <a id="refresh" name="refresh"></a> refresh

▸ **refresh**(): `void`

Refresh the slicer.

#### Returns

`void`

___

### <a id="scrollposition" name="scrollposition"></a> scrollPosition

▸ **scrollPosition**(`value?`): `any`

Gets or sets the scrollPosition of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `Date` |

#### Returns

`any`

If no value is set, returns the scrollPosition of the slicer; otherwise, returns the slicer.

___

### <a id="sheet" name="sheet"></a> sheet

▸ **sheet**(): [`Worksheet`](GC.Spread.Sheets.Worksheet)

Get the worksheet of the slicer.

#### Returns

[`Worksheet`](GC.Spread.Sheets.Worksheet)

returns the worksheet of the slicer.

___

### <a id="showheader" name="showheader"></a> showHeader

▸ **showHeader**(`value?`): `any`

Gets or sets the showHeader of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `boolean` |

#### Returns

`any`

If no value is set, returns the showHeader of the slicer; otherwise, returns the slicer.

___

### <a id="showhorizontalscrollbar" name="showhorizontalscrollbar"></a> showHorizontalScrollbar

▸ **showHorizontalScrollbar**(`value?`): `any`

Gets or sets the showHorizontalScrollbar of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `boolean` |

#### Returns

`any`

If no value is set, returns the showHorizontalScrollbar of the slicer; otherwise, returns the slicer.

___

### <a id="showselectionlabel" name="showselectionlabel"></a> showSelectionLabel

▸ **showSelectionLabel**(`value?`): `any`

Gets or sets the showSelectionLabel of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `boolean` |

#### Returns

`any`

If no value is set, returns the showSelectionLabel of the slicer; otherwise, returns the slicer.

___

### <a id="showtimelevel" name="showtimelevel"></a> showTimeLevel

▸ **showTimeLevel**(`value?`): `any`

Gets or sets the showTimeLevel of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `boolean` |

#### Returns

`any`

If no value is set, returns the showTimeLevel of the slicer; otherwise, returns the slicer.

___

### <a id="sourcename" name="sourcename"></a> sourceName

▸ **sourceName**(): `string`

Get the sourceName of the slicer.

#### Returns

`string`

returns the sourceName of the slicer.

___

### <a id="startcolumn" name="startcolumn"></a> startColumn

▸ **startColumn**(`value?`): `any`

Gets or sets the startColumn of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `number` |

#### Returns

`any`

If no value is set, returns the startColumn of the slicer; otherwise, returns the slicer.

___

### <a id="startcolumnoffset" name="startcolumnoffset"></a> startColumnOffset

▸ **startColumnOffset**(`value?`): `any`

Gets or sets the startColumnOffset of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `number` |

#### Returns

`any`

If no value is set, returns the startColumnOffset of the slicer; otherwise, returns the slicer.

___

### <a id="startrow" name="startrow"></a> startRow

▸ **startRow**(`value?`): `any`

Gets or sets the startRow of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `number` |

#### Returns

`any`

If no value is set, returns the startRow of the slicer; otherwise, returns the slicer.

___

### <a id="startrowoffset" name="startrowoffset"></a> startRowOffset

▸ **startRowOffset**(`value?`): `any`

Gets or sets the startRowOffset of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `number` |

#### Returns

`any`

If no value is set, returns the startRowOffset of the slicer; otherwise, returns the slicer.

___

### <a id="style" name="style"></a> style

▸ **style**(`value?`): `any`

Gets or sets the style of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | [`TimelineStyle`](GC.Spread.Sheets.Slicers.TimelineStyle) |

#### Returns

`any`

If no style is set, returns the style of the slicer; otherwise, returns the slicer.

___

### <a id="width" name="width"></a> width

▸ **width**(`value?`): `any`

Gets or sets the width of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `number` |

#### Returns

`any`

If no value is set, returns the width of the slicer; otherwise, returns the slicer.

___

### <a id="x" name="x"></a> x

▸ **x**(`value?`): `any`

Gets or sets the x of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `number` |

#### Returns

`any`

If no value is set, returns the x of the slicer; otherwise, returns the slicer.

___

### <a id="y" name="y"></a> y

▸ **y**(`value?`): `any`

Gets or sets the y of the slicer.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value?` | `number` |

#### Returns

`any`

If no value is set, returns the y of the slicer; otherwise, returns the slicer.