v7.3.0

ScheduleTooltip
Feature

Feature that displays a tooltip containing the time at the mouse position when hovering empty parts of the schedule.

To hide the schedule tooltip, just disable this feature:

const scheduler = new Scheduler({
    features : {
        scheduleTooltip : false
    }
});

You can also output a message along with the default time indicator (to indicate resource availability etc)

const scheduler = new Scheduler({
   features : {
      scheduleTooltip : {
          getText(date, event, resource) {
              return 'Hovering ' + resource.name;
          }
      }
  }
});

To take full control over the markup shown in the tooltip you can override the generateTipContent method:

const scheduler = new Scheduler({
    features : {
        scheduleTooltip : {
            generateTipContent({ date, event, resourceRecord }) {
                return `
                    <dl>
                        <dt>Date</dt><dd>${date}</dd>
                        <dt>Resource</dt><dd>${resourceRecord.name}</dd>
                    </dl>
                `;
            }
        }
    }
});

Configuration properties from the feature are passed down into the resulting Tooltip instance.

const scheduler = new Scheduler({
    features : {
        scheduleTooltip : {
            // Don't show the tip until the mouse has been over the schedule for three seconds
            hoverDelay : 3000
        }
    }
});

This feature is enabled by default in Scheduler and disabled in ResourceUtilization. For info on enabling it, see GridFeatures.

See also

No results

Configs

Configs are options you supply in a configuration object when creating an instance of this class
  • Set to true to hide this tooltip when hovering non-working time. Defaults to false for Scheduler, true for SchedulerPro

Properties

Properties are getters/setters or publicly accessible variables on this class

Functions

Functions are methods available for calling on the class
    • getHoverTipHtml( )
      private
      DEPRECATED
      Deprecated:

      Use generateTipContent instead. Gets html to display in hover tooltip (tooltip displayed on empty parts of scheduler)

    • onInternalPaint( )
      private

      Set up drag and drop and hover tooltip.

    id: scheduleTooltip

    Source path

    Scheduler/feature/ScheduleTooltip.js

    Demo

    examples/basic

    Contents