Function registerFilterType

  • registerFilterType(displayText, displaySymbol?, urlSuffix?, dataValueRequired?, multiValueSeparator?, longDisplayText?, minOccurs?, maxOccurs?, tableWise?, labkeySqlOperator?): IFilterType

  • Creates a FilterType object and stores it in the global URL Map used by Filter.getFilterTypeForURLSuffix

    Parameters

    • displayText: string

      The text to display in a filter menu

    • Optional displaySymbol: string

      The symbol to display in a filter menu

    • Optional urlSuffix: string

      The suffix used when adding the filter to a URL

    • Optional dataValueRequired: boolean

      Boolean used to indicate if a data value is required for the filter type

    • Optional multiValueSeparator: string

      The separator to use if multiple values are allowed for the filter type

    • Optional longDisplayText: string

      The text to display in a filter help menu

    • Optional minOccurs: number

      The minimum number of times the filter can be applied

    • Optional maxOccurs: number

      The maximum number of times the filter can be applied

    • Optional tableWise: boolean

      true if the filter applies to all columns on the table

    • Optional labkeySqlOperator: string

      The simple operator to use for generating labkey sql

    Returns IFilterType

Settings

Member Visibility

Theme

Generated using TypeDoc