PivotFieldTop10AutoShowSettings

PivotFieldTop10AutoShowSettings class

Represents the Top 10 AutoShow settings for a pivot field.

class PivotFieldTop10AutoShowSettings;

Remarks

In xls : Implementing top 10 filters in Xls through Top 10 AutoShow In ooxml files: The underlying ooxml file format supports Top10 AutoShow, but Excel 2007 and later user interface only provides access via Top10 filter. If XLS compatibility is not required, it is recommended to use Top10 filter instead.

Properties

PropertyTypeDescription
isAutoShowbooleanIndicates whether an “Top 10 AutoShow” filter is applied to this field.
isTopbooleanIndicates whether the specified PivotTable field is autoshown ascending.
autoShowCountnumberRepresent the number of top or bottom items that are automatically shown in the specified PivotTable field.
rankBynumberSpecifies the index of data field for AutoShow ranking. Represents auto show field index. -1 means PivotField itself. It should be the index of the data fields.

Methods

MethodDescription
isAutoShow()@deprecated. Please use the ‘isAutoShow’ property instead. Indicates whether an “Top 10 AutoShow” filter is applied to this field.
setIsAutoShow(boolean)@deprecated. Please use the ‘isAutoShow’ property instead. Indicates whether an “Top 10 AutoShow” filter is applied to this field.
isTop()@deprecated. Please use the ‘isTop’ property instead. Indicates whether the specified PivotTable field is autoshown ascending.
setIsTop(boolean)@deprecated. Please use the ‘isTop’ property instead. Indicates whether the specified PivotTable field is autoshown ascending.
getAutoShowCount()@deprecated. Please use the ‘autoShowCount’ property instead. Represent the number of top or bottom items that are automatically shown in the specified PivotTable field.
setAutoShowCount(number)@deprecated. Please use the ‘autoShowCount’ property instead. Represent the number of top or bottom items that are automatically shown in the specified PivotTable field.
getRankBy()@deprecated. Please use the ‘rankBy’ property instead. Specifies the index of data field for AutoShow ranking. Represents auto show field index. -1 means PivotField itself. It should be the index of the data fields.
setRankBy(number)@deprecated. Please use the ‘rankBy’ property instead. Specifies the index of data field for AutoShow ranking. Represents auto show field index. -1 means PivotField itself. It should be the index of the data fields.
isNull()Checks whether the implementation object is null.

isAutoShow

Indicates whether an “Top 10 AutoShow” filter is applied to this field.

isAutoShow : boolean;

isTop

Indicates whether the specified PivotTable field is autoshown ascending.

isTop : boolean;

autoShowCount

Represent the number of top or bottom items that are automatically shown in the specified PivotTable field.

autoShowCount : number;

rankBy

Specifies the index of data field for AutoShow ranking. Represents auto show field index. -1 means PivotField itself. It should be the index of the data fields.

rankBy : number;

isAutoShow()

@deprecated. Please use the ‘isAutoShow’ property instead. Indicates whether an “Top 10 AutoShow” filter is applied to this field.

isAutoShow() : boolean;

setIsAutoShow(boolean)

@deprecated. Please use the ‘isAutoShow’ property instead. Indicates whether an “Top 10 AutoShow” filter is applied to this field.

setIsAutoShow(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

isTop()

@deprecated. Please use the ‘isTop’ property instead. Indicates whether the specified PivotTable field is autoshown ascending.

isTop() : boolean;

setIsTop(boolean)

@deprecated. Please use the ‘isTop’ property instead. Indicates whether the specified PivotTable field is autoshown ascending.

setIsTop(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getAutoShowCount()

@deprecated. Please use the ‘autoShowCount’ property instead. Represent the number of top or bottom items that are automatically shown in the specified PivotTable field.

getAutoShowCount() : number;

setAutoShowCount(number)

@deprecated. Please use the ‘autoShowCount’ property instead. Represent the number of top or bottom items that are automatically shown in the specified PivotTable field.

setAutoShowCount(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getRankBy()

@deprecated. Please use the ‘rankBy’ property instead. Specifies the index of data field for AutoShow ranking. Represents auto show field index. -1 means PivotField itself. It should be the index of the data fields.

getRankBy() : number;

setRankBy(number)

@deprecated. Please use the ‘rankBy’ property instead. Specifies the index of data field for AutoShow ranking. Represents auto show field index. -1 means PivotField itself. It should be the index of the data fields.

setRankBy(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;