Interface IFilterType

interface IFilterType {
    getDisplaySymbol: (() => string);
    getDisplayText: (() => string);
    getLabKeySqlOperator: (() => string);
    getLongDisplayText: (() => string);
    getMultiValueFilter: (() => IFilterType);
    getMultiValueMaxOccurs: (() => number);
    getMultiValueMinOccurs: (() => number);
    getMultiValueSeparator: (() => string);
    getOpposite: (() => IFilterType);
    getSingleValueFilter: (() => IFilterType);
    getURLParameterValue: ((value) => any);
    getURLSuffix: (() => string);
    isDataValueRequired: (() => boolean);
    isMultiValued: (() => boolean);
    isTableWise: (() => boolean);
    parseValue: ((value) => any);
    validate: ((value, jsonType, columnName) => any);
}

Properties

getDisplaySymbol: (() => string)

Type declaration

    • (): string
    • Returns string

getDisplayText: (() => string)

Type declaration

    • (): string
    • Returns string

getLabKeySqlOperator: (() => string)

Get the LabKey SQL operator for simple filter types (=, >=, <>)

Type declaration

    • (): string
    • Returns string

getLongDisplayText: (() => string)

Type declaration

    • (): string
    • Returns string

getMultiValueFilter: (() => IFilterType)

Type declaration

getMultiValueMaxOccurs: (() => number)

Type declaration

    • (): number
    • Returns number

getMultiValueMinOccurs: (() => number)

Type declaration

    • (): number
    • Returns number

getMultiValueSeparator: (() => string)

Type declaration

    • (): string
    • Returns string

getOpposite: (() => IFilterType)

Type declaration

getSingleValueFilter: (() => IFilterType)

Type declaration

getURLParameterValue: ((value) => any)

Get the (unencoded) value that will be put on the URL.

Type declaration

    • (value): any
    • Parameters

      • value: any

      Returns any

getURLSuffix: (() => string)

Type declaration

    • (): string
    • Returns string

isDataValueRequired: (() => boolean)

Type declaration

    • (): boolean
    • Returns boolean

isMultiValued: (() => boolean)

Type declaration

    • (): boolean
    • Returns boolean

isTableWise: (() => boolean)

Type declaration

    • (): boolean
    • Returns boolean

parseValue: ((value) => any)

Split a filter String or Array value appropriately for this filter type.

Type declaration

    • (value): any
    • Parameters

      • value: string | any[]

      Returns any

Returns

For multi-valued filter types, an Array of values, otherwise the original filter value.

validate: ((value, jsonType, columnName) => any)

Type declaration

    • (value, jsonType, columnName): any
    • Parameters

      • value: any
      • jsonType: string
      • columnName: string

      Returns any

Generated using TypeDoc