DayPilot.Scheduler.rows.filterParam

The rows.filterParam property returns the current row filtering parameter previously supplied using rows.filter().

Available since 2020.1.4264.

Declaration

DayPilot.Scheduler.rows.filterParam

Notes

It returns the value passed to rows.filter() as a parameter.

The same value is also available in onRowFilter as args.filterParam, so you can use any custom filter structure that fits your application.

Examples

JavaScript

const dp = new DayPilot.Scheduler("dp", {
  onRowFilter: (args) => {
    const query = (args.filterParam?.text || "").toLowerCase();
    args.visible = args.row.name.toLowerCase().includes(query);
  },
  // rows.filterParam: inspect the current filter value after rows.filter() is called
  // ...
});
dp.init();

dp.rows.filter({ text: "room" });
console.log(dp.rows.filterParam);

Angular

<daypilot-scheduler [config]="config"></daypilot-scheduler>

config: DayPilot.SchedulerConfig = {
  onRowFilter: (args) => {
    const query = (args.filterParam?.text || "").toLowerCase();
    args.visible = args.row.name.toLowerCase().includes(query);
  },
  // ...
};

// using a component reference named scheduler
this.scheduler.control.rows.filter({ text: "room" });
console.log(this.scheduler.control.rows.filterParam);

React

import { useRef } from "react";

const schedulerRef = useRef();

const onRowFilter = (args) => {
  const query = (args.filterParam?.text || "").toLowerCase();
  args.visible = args.row.name.toLowerCase().includes(query);
};

<DayPilotScheduler
  ref={schedulerRef}
  onRowFilter={onRowFilter}
  {/* ... */}
/>

schedulerRef.current.control.rows.filter({ text: "room" });
console.log(schedulerRef.current.control.rows.filterParam);

Vue

<script setup>
import { ref } from "vue";

const schedulerRef = ref(null);

const onRowFilter = (args) => {
  const query = (args.filterParam?.text || "").toLowerCase();
  args.visible = args.row.name.toLowerCase().includes(query);
};
</script>

<template>
  <DayPilotScheduler
    ref="schedulerRef"
    :onRowFilter="onRowFilter"
    <!-- ... -->
  />
</template>

schedulerRef.value.control.rows.filter({ text: "room" });
console.log(schedulerRef.value.control.rows.filterParam);

See Also

DayPilot.Scheduler.rows.filter()

DayPilot.Scheduler.onRowFilter

DayPilot.Scheduler Class