# wijmo.scheduler Module ## Content

wijmo.scheduler Module

Defines the FlexScheduler control and associated classes.

Type aliases

Classes

Interfaces

Enumerations

Functions

Type aliases

SchedulerAxisBinding

SchedulerAxisBinding: SchedulerTimeAxisBinding | SchedulerResourceAxisBinding

Defines a Scheduler axis binding driven by either time or a resource field.

SchedulerConflict

SchedulerConflict<T>: SchedulerTimeOverlapConflict<T> | SchedulerNonWorkingTimeConflict<T>

Describes one grouped Scheduler conflict.

Type parameters

  • T

SchedulerItemTemplateFunction

SchedulerItemTemplateFunction: Object

Represents a function that renders the HTML content of a Scheduler item.

param

The original event item and its matched resource data items.

param

The item element that can be updated directly.

returns

An HTML string to render, or null after updating the element directly.

SchedulerProjectionIntegrityLevel

SchedulerProjectionIntegrityLevel: "faithful" | "lossy" | "unsupported"

Integrity levels describe how faithfully a definition maps to current projector capabilities.

SchedulerTimeAxisVisibleCallback

SchedulerTimeAxisVisibleCallback: Object

Determines whether an expanded time value participates in the Scheduler layout.

param

Information about the time value being evaluated.

returns

True to render the value; otherwise, false.

SchedulerWorkDays

SchedulerWorkDays: SchedulerWorkHours[]

Defines the weekly working-time schedule consumed by FlexScheduler.workDays.

The value must contain exactly seven SchedulerWorkHours entries, indexed from Sunday (0) through Saturday (6). Each entry describes one weekday and contains SchedulerWorkHourRange values; use an empty SchedulerWorkHours entry for a non-working day. Assigning null to the entire FlexScheduler.workDays property disables the weekly rule and leaves working time unrestricted by this source.

Timed views consume the ranges to mark individual time cells, while summary views consume the same data to mark an entire weekday as working or not.

const workDays: SchedulerWorkDays = [
    [],
    [{ start: '09:00', end: '18:00' }],
    [{ start: '09:00', end: '18:00' }],
    [{ start: '09:00', end: '18:00' }],
    [{ start: '09:00', end: '18:00' }],
    [{ start: '09:00', end: '12:00' }],
    [],
];

SchedulerWorkHours

SchedulerWorkHours: SchedulerWorkHourRange[]

Defines the working-hour ranges for one day. Use an empty array to mark the day as non-working.

Functions

createSchedulerDefinitionPreset

  • Creates an independent definition for a built-in Scheduler view.

    Parameters

    Returns SchedulerDefinition

    The definition for the requested built-in Scheduler view, with key set to the specified viewType.

planSchedulerProjection

  • Evaluates whether a scheduler definition can be projected by the current renderers. The planner isolates capability checks from projection itself so projectors can assume the major constraints are already validated.

    Parameters

    Returns SchedulerProjectionPlan