dojox/grid/enhanced/plugins/Filter.js

• Provides:

  • dojox.grid.enhanced.plugins.Filter

• Requires:

  • dojox.grid.enhanced._Plugin in common
  • dojox.grid.enhanced.plugins.Dialog in common
  • dojox.grid.enhanced.plugins.filter.FilterLayer in common
  • dojox.grid.enhanced.plugins.filter.FilterBar in common
  • dojox.grid.enhanced.plugins.filter.FilterDefDialog in common
  • dojox.grid.enhanced.plugins.filter.FilterStatusTip in common
  • dojox.grid.enhanced.plugins.filter.ClearFilterConfirm in common

• dojox.grid.enhanced.plugins.Filter

  • type

    Function

  • chains:
    • dojox.grid.enhanced._Plugin: (prototype)
    • dojox.grid.enhanced._Plugin: (call)
  • parameters:
    • grid
    • args
  • summary

    Provide filter functionality for grid.
    
    Acceptable plugin parameters:
    1. itemsName: string
    the name shown on the filter bar.
    2. statusTipTimeout: number
    when does the status tip show.
    3. ruleCount: number
    default to 3, should not change to more. The Claro theme limits it.
    4. disabledConditions: object
    If you don't need all of the conditions provided for a data type,
    you can explicitly declare them here:
    e.g.: disabledConditions: {string: ["contains", "is"], number: ["equalto"], ...}
    5. isServerSide: boolean
    Whether to use server side filtering. Default to false.
    6. isStateful: boolean
    If isServerSide is true, set the server side filter to be stateful or not. default to false.
    7. url: string
    If using stateful, this is the url to send commands. default to store.url.
    
    Acceptable cell parameters defined in layout:
    1. filterable: boolean
    The column is not filterable only when this is set to false explicitly.
    2. datatype: string
    The data type of this column. Can be "string", "number", "date", "time", "boolean".
    Default to "string".
    3. autoComplete: boolean
    If need auto-complete in the ComboBox for String type, set this to true.
    4. dataTypeArgs: object
    Some arguments helping convert store data to something the filter UI understands.
    Different data type arguments can be provided to different data types.
    For date/time, this is a dojo.date.locale.__FormatOptions, so the DataTimeBox can understand the store data.
    For boolean, this object contains:
    trueLabel: string
    A label to display in the filter definition dialog for true value. Default to "True".
    falseLable: string
    A label to display in the filter definition dialog for false value. Default to "False".
    5. disabledConditions: object
    If you don't need all of the conditions provided by the filter UI on this column, you can explicitly say it out here.
    e.g.: disabledConditions: ["contains", "is"]
    This will disable the "contains" condition for this column, if this column is of string type.
    For full set of conditions, please refer to dojox.grid.enhanced.plugins.filter.FilterDefDialog._setupData.

  • example

    	<div dojoType="dojox.grid.EnhancedGrid" plugins="{GridFilter: true}" ...></div>
    	or provide some parameters:
    	<div dojoType="dojox.grid.EnhancedGrid" plugins="{GridFilter: {itemsName: 'songs'}}" ...></div>
    	Customize columns for filter:
    	var layout = [
    		...
    		//define a column to be un-filterable in layout/structure
    		{field: "Genre", filterable: false, ...}
    		//define a column of type string and supports autoComplete when you type in filter conditions.
    		{field: "Writer", datatype: "string", autoCommplete: true, ...}
    		//define a column of type date and the data in store has format: "yyyy/M/d"
    		{field: "Publish Date", datatype: "date", dataTypeArgs: {datePattern: "yyyy/M/d"}, ...}
    		//disable some conditions for a column
    		{field: "Track", disabledConditions: ["equalto","notequalto"], ...}
    		...
    	];

• dojox.grid.enhanced.plugins.Filter.name

  • type

    String

  • summary

    plugin name

• dojox.grid.enhanced.plugins.Filter.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • grid
    • args
  • summary

    See constructor of dojox.grid.enhanced._Plugin.

• dojox.grid.enhanced.plugins.Filter.destroy

  • type

    Function

• dojox.grid.enhanced.plugins.Filter.filterBar

  • type

    Object

• dojox.grid.enhanced.plugins.Filter.clearFilterDialog

  • type

    Object

• dojox.grid.enhanced.plugins.Filter.filterStatusTip

  • type

    Object

• dojox.grid.enhanced.plugins.Filter.filterDefDialog

  • type

    Object

• dojox.grid.enhanced.plugins.Filter.grid

  • type

    Object

• dojox.grid.enhanced.plugins.Filter.nls

  • type

    Object

• dojox.grid.enhanced.plugins.Filter.args

  • type

    Object

• dojox.grid.enhanced.plugins.Filter._wrapStore

  • type

    Function

• dojox.grid.enhanced.plugins.Filter.onSetStore

  • parameters:
    • store
  • type

    Function

• dojox.grid.enhanced.plugins.Filter._clientFilterGetter

  • parameters:
    • datarow: (typeof data)

      item

    • cell: (typeof cell)
    • rowIndex: (typeof int)
  • summary

    Define the grid-specific way to get data from a row.
    Argument "cell" is provided by FilterDefDialog when defining filter expressions.
    Argument "rowIndex" is provided by FilterLayer when checking a row.
    FilterLayer also provides a forth argument: "store", which is grid.store,
    but we don't need it here.

  • type

    Function

• dojox.grid.enhanced.plugins

  • alias - dojox.grid.enhanced.plugins

• dojox.grid.enhanced.plugins.filter

  • alias - dojox.grid.enhanced.plugins.filter

• dojox.grid.enhanced

  • type

    Object

• dojox.grid

  • type

    Object

• dojox

  • type

    Object