Edit

Share via

ExcelScript.DynamicFilterCriteria enum

  • Reference
Package:
ExcelScript

Remarks

Examples

/**
 * This script applies a filter to a table that filters it 
 * to only show rows with dates from the previous month.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the table named "ReportTable".
  const table = workbook.getTable("ReportTable");

  // Get the column with the header "Date".
  const dateColumn = table.getColumnByName("Date");

  // Apply a dynamic filter to the column. 
  // `lastMonth` will only show rows with a date from the previous month.
  dateColumn.getFilter().applyDynamicFilter(ExcelScript.DynamicFilterCriteria.lastMonth);
}

Fields

aboveAverage
allDatesInPeriodApril
allDatesInPeriodAugust
allDatesInPeriodDecember
allDatesInPeriodFebruary
allDatesInPeriodJanuary
allDatesInPeriodJuly
allDatesInPeriodJune
allDatesInPeriodMarch
allDatesInPeriodMay
allDatesInPeriodNovember
allDatesInPeriodOctober
allDatesInPeriodQuarter1
allDatesInPeriodQuarter2
allDatesInPeriodQuarter3
allDatesInPeriodQuarter4
allDatesInPeriodSeptember
belowAverage
lastMonth
lastQuarter
lastWeek
lastYear
nextMonth
nextQuarter
nextWeek
nextYear
thisMonth
thisQuarter
thisWeek
thisYear
today
tomorrow
unknown
yearToDate
yesterday