Top10
Top10 class
Describe the Top10 conditional formatting rule. This conditional formatting rule highlights cells whose values fall in the top N or bottom N bracket, as specified.
class Top10;
Constructors
| Constructor | Description |
|---|---|
| constructor() | Default Constructor. |
Properties
| Property | Type | Description |
|---|---|---|
| isPercent | boolean | Get or set whether a “top/bottom n” rule is a “top/bottom n percent” rule. Default value is false. |
| isBottom | boolean | Get or set whether a “top/bottom n” rule is a “bottom n” rule. Default value is false. |
| rank | number | Get or set the value of “n” in a “top/bottom n” conditional formatting rule. If IsPercent is true, the value must between 0 and 100. Otherwise it must between 0 and 1000. Default value is 10. |
Methods
| Method | Description |
|---|---|
| isPercent() | @deprecated. Please use the ‘isPercent’ property instead. Get or set whether a “top/bottom n” rule is a “top/bottom n percent” rule. Default value is false. |
| setIsPercent(boolean) | @deprecated. Please use the ‘isPercent’ property instead. Get or set whether a “top/bottom n” rule is a “top/bottom n percent” rule. Default value is false. |
| isBottom() | @deprecated. Please use the ‘isBottom’ property instead. Get or set whether a “top/bottom n” rule is a “bottom n” rule. Default value is false. |
| setIsBottom(boolean) | @deprecated. Please use the ‘isBottom’ property instead. Get or set whether a “top/bottom n” rule is a “bottom n” rule. Default value is false. |
| getRank() | @deprecated. Please use the ‘rank’ property instead. Get or set the value of “n” in a “top/bottom n” conditional formatting rule. If IsPercent is true, the value must between 0 and 100. Otherwise it must between 0 and 1000. Default value is 10. |
| setRank(number) | @deprecated. Please use the ‘rank’ property instead. Get or set the value of “n” in a “top/bottom n” conditional formatting rule. If IsPercent is true, the value must between 0 and 100. Otherwise it must between 0 and 1000. Default value is 10. |
| isNull() | Checks whether the implementation object is null. |
constructor()
Default Constructor.
constructor();
isPercent
Get or set whether a “top/bottom n” rule is a “top/bottom n percent” rule. Default value is false.
isPercent : boolean;
isBottom
Get or set whether a “top/bottom n” rule is a “bottom n” rule. Default value is false.
isBottom : boolean;
rank
Get or set the value of “n” in a “top/bottom n” conditional formatting rule. If IsPercent is true, the value must between 0 and 100. Otherwise it must between 0 and 1000. Default value is 10.
rank : number;
isPercent()
@deprecated. Please use the ‘isPercent’ property instead. Get or set whether a “top/bottom n” rule is a “top/bottom n percent” rule. Default value is false.
isPercent() : boolean;
setIsPercent(boolean)
@deprecated. Please use the ‘isPercent’ property instead. Get or set whether a “top/bottom n” rule is a “top/bottom n percent” rule. Default value is false.
setIsPercent(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
isBottom()
@deprecated. Please use the ‘isBottom’ property instead. Get or set whether a “top/bottom n” rule is a “bottom n” rule. Default value is false.
isBottom() : boolean;
setIsBottom(boolean)
@deprecated. Please use the ‘isBottom’ property instead. Get or set whether a “top/bottom n” rule is a “bottom n” rule. Default value is false.
setIsBottom(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getRank()
@deprecated. Please use the ‘rank’ property instead. Get or set the value of “n” in a “top/bottom n” conditional formatting rule. If IsPercent is true, the value must between 0 and 100. Otherwise it must between 0 and 1000. Default value is 10.
getRank() : number;
setRank(number)
@deprecated. Please use the ‘rank’ property instead. Get or set the value of “n” in a “top/bottom n” conditional formatting rule. If IsPercent is true, the value must between 0 and 100. Otherwise it must between 0 and 1000. Default value is 10.
setRank(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;