ig.excel.TopOrBottomFilter
Dependencies
-
type
- .type( );
- Return Type:
- ig.excel.TopOrBottomFilterType
- Return Type Description:
- TopValues or BottomValues to filter in the top or bottom N value in the list of sorted values; TopPercentage or BottomPercentage to filter in the top or bottom N percentage of values in the list of sorted values.
Gets the type of the filter.
Exceptions
Exception Description ig.excel.InvalidEnumArgumentException The value assign is not defined in the TopOrBottomFilterType enumeration. See Also
-
type
- .type( value:ig.excel.TopOrBottomFilterType );
- Return Type:
- ig.excel.TopOrBottomFilterType
- Return Type Description:
- TopValues or BottomValues to filter in the top or bottom N value in the list of sorted values; TopPercentage or BottomPercentage to filter in the top or bottom N percentage of values in the list of sorted values.
Sets the type of the filter.
- value
- Type:ig.excel.TopOrBottomFilterType
Exceptions
Exception Description ig.excel.InvalidEnumArgumentException The value assign is not defined in the TopOrBottomFilterType enumeration. See Also
-
value
- .value( );
- Return Type:
- number
- Return Type Description:
- The number or percentage of items which should be filtered in.
Gets the number or percentage of value of values which should be filtered in.
Exceptions
Exception Description ig.ArgumentOutOfRangeException The value assigned is less than 1 or greater than 500. Remarks
When TopOrBottomFilter.type is TopValues or BottomValues, Value indicates the number of value which should be filtered in. When Type is TopPercentage or BottomPercentage, Value indicates percentage to filter in. For example, a Value of 15 and a Type of BottomPercentage will filter in the bottom 15 percent of values.
-
value
- .value( value:number );
- Return Type:
- number
- Return Type Description:
- The number or percentage of items which should be filtered in.
Sets the number or percentage of value of values which should be filtered in.
- value
- Type:number
Exceptions
Exception Description ig.ArgumentOutOfRangeException The value assigned is less than 1 or greater than 500. Remarks
When TopOrBottomFilter.type is TopValues or BottomValues, Value indicates the number of value which should be filtered in. When Type is TopPercentage or BottomPercentage, Value indicates percentage to filter in. For example, a Value of 15 and a Type of BottomPercentage will filter in the bottom 15 percent of values.