filterButtonVisible Method

In This Topic

Gets or sets whether the sheet column's filter button is displayed.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new GC.Spread.Sheets.Filter.RowFilterBase(range);
var returnValue; // Type: any
returnValue = instance.filterButtonVisible(col, value);

function filterButtonVisible( 
   col : number,
   value : boolean
) : any;

Parameters

col: The column index of the filter button.
value: Whether the filter button is displayed.

Return Value

No parameter false if all filter buttons are invisible; otherwise, true. One parameter col false if the specified column filter button is invisible; otherwise, true. One parameter value GC.Spread.Sheets.Filter.RowFilterBase sets all filter buttons to be visible(true)/invisible(false). Two parameters col,value GC.Spread.Sheets.Filter.RowFilterBase sets the specified column filter button to be visible(true)/invisible(false).

Example

This example shows a filter button.

Javascript

//Create a custom condition.
        function CustomFilter(){
            GC.Spread.Sheets.ConditionalFormatting.Condition.apply(this, arguments);
            //this.conditionType("CustomFilter");
        };
        CustomFilter.prototype = new GC.Spread.Sheets.ConditionalFormatting.Condition();
        CustomFilter.prototype.evaluate = function (evaluator, row, col) {
            var value = evaluator.getValue(row, col);

            if (value !== null && value >= 10 && value <= 50) {
                //Return True only when the following conditions are satisfied.
                // (1)Values are entered.
                // (2)Values are not lower than 10.
                // (3)Values are not greater than 50.
                return true;
            } else {
                return false;
            }
        };

        $(function () {
            var workbook = new GC.Spread.Sheets.Workbook($("#ss")[0]);
            var activeSheet = workbook.getActiveSheet();
            activeSheet.setValue(0, 0, 10);
            activeSheet.setValue(1, 0, 100);
            activeSheet.setValue(2, 0, 50);
            activeSheet.setValue(3, 0, 40);
            activeSheet.setValue(4, 0, 80);
            activeSheet.setValue(5, 0, 1);
            activeSheet.setValue(6, 0, 65);
            activeSheet.setValue(7, 0, 20);
            activeSheet.setValue(8, 0, 30);
            activeSheet.setValue(9, 0, 35);

            $("#button1").click(function(){
                //Set a row Filter.
                var rowFilter = new GC.Spread.Sheets.Filter.HideRowFilter(new GC.Spread.Sheets.Range(0, 0, 7, 1));
                activeSheet.rowFilter(rowFilter);
                rowFilter.addFilterItem(0, new CustomFilter());
                rowFilter.filter(0);
                rowFilter.filterButtonVisible(0, true);
                alert(rowFilter.filterButtonVisible(0));
            });
        });

Reference

RowFilterBase type

Product Support Forum | Print this page