Top10Filter
Top10Filter class
Represents the top N (percent or number of items) to filter by.
class Top10Filter;
Constructors
| Constructor | Description |
|---|---|
| constructor(Object) | Constructs from an Object convertible to this. |
Properties
| Property | Type | Description |
|---|---|---|
| isTop | boolean | Indicates whether or not to filter by top order |
| isPercent | boolean | Indicates whether or not to filter by percent value of the column |
| items | number | Gets and sets top or bottom value to use as the filter criteria. |
| criteria | Object | The actual cell value in the range which is used to perform the comparison for this filter. This is the cache value during the refresh process. |
Methods
| Method | Description |
|---|---|
| isTop() | @deprecated. Please use the ‘isTop’ property instead. Indicates whether or not to filter by top order |
| setIsTop(boolean) | @deprecated. Please use the ‘isTop’ property instead. Indicates whether or not to filter by top order |
| isPercent() | @deprecated. Please use the ‘isPercent’ property instead. Indicates whether or not to filter by percent value of the column |
| setIsPercent(boolean) | @deprecated. Please use the ‘isPercent’ property instead. Indicates whether or not to filter by percent value of the column |
| getItems() | @deprecated. Please use the ‘items’ property instead. Gets and sets top or bottom value to use as the filter criteria. |
| setItems(number) | @deprecated. Please use the ‘items’ property instead. Gets and sets top or bottom value to use as the filter criteria. |
| getCriteria() | @deprecated. Please use the ‘criteria’ property instead. The actual cell value in the range which is used to perform the comparison for this filter. This is the cache value during the refresh process. |
| setCriteria(Object) | @deprecated. Please use the ‘criteria’ property instead. The actual cell value in the range which is used to perform the comparison for this filter. This is the cache value during the refresh process. |
| isNull() | Checks whether the implementation object is null. |
| toObject() | Gets the Object. |
constructor(Object)
Constructs from an Object convertible to this.
constructor(obj: Object);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| obj | Object | The object. |
isTop
Indicates whether or not to filter by top order
isTop : boolean;
isPercent
Indicates whether or not to filter by percent value of the column
isPercent : boolean;
items
Gets and sets top or bottom value to use as the filter criteria.
items : number;
criteria
The actual cell value in the range which is used to perform the comparison for this filter. This is the cache value during the refresh process.
criteria : Object;
Remarks
NOTE: This member is now obsolete. Instead,please ignore this property. This property will be removed 12 months later since October 2025. Aspose apologizes for any inconvenience you may have experienced.
isTop()
@deprecated. Please use the ‘isTop’ property instead. Indicates whether or not to filter by top order
isTop() : boolean;
setIsTop(boolean)
@deprecated. Please use the ‘isTop’ property instead. Indicates whether or not to filter by top order
setIsTop(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
isPercent()
@deprecated. Please use the ‘isPercent’ property instead. Indicates whether or not to filter by percent value of the column
isPercent() : boolean;
setIsPercent(boolean)
@deprecated. Please use the ‘isPercent’ property instead. Indicates whether or not to filter by percent value of the column
setIsPercent(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getItems()
@deprecated. Please use the ‘items’ property instead. Gets and sets top or bottom value to use as the filter criteria.
getItems() : number;
setItems(number)
@deprecated. Please use the ‘items’ property instead. Gets and sets top or bottom value to use as the filter criteria.
setItems(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getCriteria()
@deprecated. Please use the ‘criteria’ property instead. The actual cell value in the range which is used to perform the comparison for this filter. This is the cache value during the refresh process.
getCriteria() : Object;
Remarks
NOTE: This member is now obsolete. Instead,please ignore this property. This property will be removed 12 months later since October 2025. Aspose apologizes for any inconvenience you may have experienced.
setCriteria(Object)
@deprecated. Please use the ‘criteria’ property instead. The actual cell value in the range which is used to perform the comparison for this filter. This is the cache value during the refresh process.
setCriteria(value: Object) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Object | The value to set. |
Remarks
NOTE: This member is now obsolete. Instead,please ignore this property. This property will be removed 12 months later since October 2025. Aspose apologizes for any inconvenience you may have experienced.
isNull()
Checks whether the implementation object is null.
isNull() : boolean;
toObject()
Gets the Object.
toObject() : Object;