constructor

• new FixedValuesFilter(a): FixedValuesFilter

• Parameters

  • a: IFilterable

  Returns FixedValuesFilter

Static $t

calendarType

• get calendarType(): CalendarType

• Gets or sets the calendar type used to interpret values in the [[dateGroups]] collection.

  Throws

  [[InvalidEnumArgumentException]] The value assigned is not defined in the [[calendarType]] enumeration.

  Returns CalendarType

• set calendarType(a): void

• Parameters

  • a: CalendarType

  Returns void

includeBlanks

• get includeBlanks(): boolean

• Gets or sets the value which indicates whether blank cells should be filtered in.

  Throws

  [[InvalidOperationException]] The value is set to False and both [[dateGroups]] and [[displayValues]] contain no values. This would prevent the filter from including any values, which is not allowed for a [[FixedValuesFilter]].

  Returns boolean

• set includeBlanks(a): void

• Parameters

  • a: boolean

  Returns void

dateGroups

• dateGroups(index, value?): FixedDateGroup

• Gets or sets the fixed date group at the specified index.

  Throws

  [[ArgumentOutOfRangeException]] 'index' is less than 0 or greater than or equal to [[count]].

  Throws

  [[ArgumentNullException]] The value assigned is null.

  Throws

  [[ArgumentException]] The value assigned is already in the collection.

  Parameters

  • index: number

    The 0-based index of the value to get or set.

  • Optional value: FixedDateGroup

  Returns FixedDateGroup

• dateGroups(): FixedDateGroupCollection

• Gets the collection of fixed date groups which should be filtered in.

  See

  [[displayValues]]

  Returns FixedDateGroupCollection

displayValues

• displayValues(index, value?): string

• Gets or sets the display text value at the specified index.

  Throws

  [[ArgumentOutOfRangeException]] 'index' is less than 0 or greater than or equal to [[count]].

  Throws

  [[ArgumentNullException]] The value assigned is null.

  Throws

  [[ArgumentException]] The value assigned matches another value in the collection. Values are compared case-insensitively.

  Parameters

  • index: number

    The 0-based index of the value to get or set.

  • Optional value: string

  Returns string

• displayValues(): DisplayValueCollection

• Gets the collection of cell text values which should be filtered in.

  Text values are compared case-insensitively.

  Note: If any text values are longer than 255 characters in length and the workbook is saved in one of the 2003 formats, the correct rows will be hidden in the saved file, but the filter may be missing from the column or reapplying the filter may hide some of the matching cells.

  See

  • [[dateGroups]]
  • [[WorksheetCell.getText]]
  • [[WorksheetRow.getCellText]]

  Returns DisplayValueCollection