SpreadJS 13
GC.Spread.Sheets.Filter Namespace / HideRowFilter class / filterDialogVisibleInfo Method
The visible info for row filter.
Whether to show the sort by value area in filter dialog.
Whether to show the sort by color area in filter dialog.
Whether to show the filter by color area in filter dialog.
Whether to show the filter by value area in filter dialog.
Whether to show the list filter in filter dialog.
In This Topic
    filterDialogVisibleInfo Method
    In This Topic
    Gets or sets the visible info for the row filter.
    Syntax
    var instance = new GC.Spread.Sheets.Filter.HideRowFilter(range);
    var value; // Type: any
    value = instance.filterDialogVisibleInfo(visibleInfo,
                                             visibleInfo.sortByValue,
                                             visibleInfo.sortByColor,
                                             visibleInfo.filterByColor,
                                             visibleInfo.filterByValue,
                                             visibleInfo.listFilterArea);
    function filterDialogVisibleInfo( 
       visibleInfo : Object,
       (optional) visibleInfo.sortByValue : boolean,
       (optional) visibleInfo.sortByColor : boolean,
       (optional) visibleInfo.filterByColor : boolean,
       (optional) visibleInfo.filterByValue : boolean,
       (optional) visibleInfo.listFilterArea : boolean
    ) : any;

    Parameters

    visibleInfo
    The visible info for row filter.
    visibleInfo.sortByValue
    Whether to show the sort by value area in filter dialog.
    visibleInfo.sortByColor
    Whether to show the sort by color area in filter dialog.
    visibleInfo.filterByColor
    Whether to show the filter by color area in filter dialog.
    visibleInfo.filterByValue
    Whether to show the filter by value area in filter dialog.
    visibleInfo.listFilterArea
    Whether to show the list filter in filter dialog.

    Return Value

    If no value is set filter dialog visible info; otherwise, returns the HideRowFilter.
    Example
    //This example creates a row filter.
     sheet.rowFilter(new GC.Spread.Sheets.Filter.HideRowFilter(new GC.Spread.Sheets.Range(1,1,10,3)));
     var filter = sheet.rowFilter();
     filter.filterDialogVisibleInfo({
              sortByValue : false,
              sortByColor : true,
              filterByColor : true,
              filterByValue : true,
              listFilterArea : false
          })
    See Also