@yca/rest-admin
  1. Interfaces
  2. IParamsColFilter

File

src/interfaces/IParamsColFilter.ts

Index

Properties

Properties

custom
custom: function
Type : function
Optional
Defined in src/interfaces/IParamsColFilter.ts:47

Need this when type is 'custom'
fr
fr: any
Type : any
Optional
Defined in src/interfaces/IParamsColFilter.ts:34

Optional for type 'datetime-range'.
mode
mode: "contains" | "startsWith" | "endsWith" | "equals" | "in" | "range" | "id" | "number" | "custom"
Type : "contains" | "startsWith" | "endsWith" | "equals" | "in" | "range" | "id" | "number" | "custom"
Defined in src/interfaces/IParamsColFilter.ts:15

Filter mode
options
options: any
Type : any
Optional
Defined in src/interfaces/IParamsColFilter.ts:29

Need this when type is 'single' or 'multiple'
placeholder
placeholder: string
Type : string
Defined in src/interfaces/IParamsColFilter.ts:5

Placeholder
to
to: any
Type : any
Optional
Defined in src/interfaces/IParamsColFilter.ts:38

Optional for type 'datetime-range'.
type
type: "text" | "single" | "multiple" | "datetime-range"
Type : "text" | "single" | "multiple" | "datetime-range"
Defined in src/interfaces/IParamsColFilter.ts:10

Type of filter
yearRange
yearRange: string
Type : string
Optional
Defined in src/interfaces/IParamsColFilter.ts:42

Optional for type 'datetime-range'. default: 2016:2020

 
export interface IParamsColFilter {
  /**
   * Placeholder
   */
  placeholder: string;

  /**
   * Type of filter
   */
  type: 'text' | 'single' | 'multiple' | 'datetime-range';

  /**
   * Filter mode
   */
  mode:
    | 'contains'
    | 'startsWith'
    | 'endsWith'
    | 'equals'
    | 'in'
    | 'range'
    | 'id'
    | 'number'
    | 'custom';

  /**
   * Need this when type is 'single' or 'multiple'
   */
  options?: any;

  /**
   * Optional for type 'datetime-range'.
   */
  fr?: any;
  /**
   * Optional for type 'datetime-range'.
   */
  to?: any;
  /**
   * Optional for type 'datetime-range'. default: 2016:2020
   */
  yearRange?: string;

  /**
   * Need this when type is 'custom'
   */
  custom?: (x: string) => Promise<any>;
}

results matching ""

    No results matching ""