DayPilot.Scheduler.onBeforeTimeHeaderExport

The onBeforeTimeHeaderExport event handler fires during image export (JPEG, PNG, SVG) and direct printing. It lets you provide alternative text and styling for exported JavaScript Scheduler time header cells when HTML output is not available.

Declaration

DayPilot.Scheduler.onBeforeTimeHeaderExport(args)

Parameters

• args.areas (array of DayPilot.Area Properties) - active areas included in the exported time header cell

• args.backColor (string) - background color of the time header cell (available since 8.3.2737)

• args.fontColor (string) - font color (available since 2020.3.4645)

• args.fontFamily (string) - font family (available since 2020.3.4645)

• args.fontSize (string) - font size (available since 2020.3.4645)

• args.fontStyle ("normal" | "italic" | "bold") - font style (available since 2020.3.4645)

• args.format (string) - target format passed to DayPilot.Scheduler.exportAs() (read-only); available since 2025.1.6393

• args.header.start (DayPilot.Date) - start of the exported header cell

• args.header.end (DayPilot.Date) - end of the exported header cell

• args.header.level (number) - header level, using a zero-based row index

• args.header.text (string) - default header text

• args.header.html (string) - customized HTML used during normal browser rendering

• args.text (string) - exported text; by default it is initialized from the customized HTML

Notes

Use this event when the browser-rendered header contains HTML but the exported output should use plain text or format-specific styling instead. Image export does not render HTML directly, so args.text is the place to provide an export-friendly alternative.

The same export pipeline is used for direct printing. Check args.format if you need different output for individual formats selected using DayPilot.Scheduler.exportAs().

Examples

JavaScript

const dp = new DayPilot.Scheduler("dp", {
  onBeforeTimeHeaderExport: (args) => {
    args.text = args.header.text;
  },
  // ...
});
dp.init();

Angular

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

config: DayPilot.SchedulerConfig = {
  onBeforeTimeHeaderExport: (args) => {
    args.text = args.header.text;
  },
  // ...
};

React

<DayPilotScheduler
  onBeforeTimeHeaderExport={onBeforeTimeHeaderExport}
  {/* ... */}
/>

const onBeforeTimeHeaderExport = (args) => {
  args.text = args.header.text;
};

Vue

<DayPilotScheduler
  @beforeTimeHeaderExport="onBeforeTimeHeaderExport"
  <!-- ... -->
/>

const onBeforeTimeHeaderExport = (args) => {
  args.text = args.header.text;
};

See Also

Client-Side Export [doc.daypilot.org]

DayPilot.Scheduler.onBeforeTimeHeaderRender

DayPilot.Scheduler.exportAs()

DayPilot.Scheduler Class