Zum Hauptinhalt springen

calendar

Beschreibung​

Die Schnittstelle für das Arbeitskalender-Objekt

calendar: Calendar

Details​

Lesen Sie den Work Time Calculation Artikel für detaillierte Informationen zu Arbeitskalendern.

Das calendar-Objekt besitzt die folgenden Methoden und Eigenschaften:

Methoden​

  • setWorkTime (config): boolean - setzt die Arbeitszeit für das Gantt-Diagramm
    • config: - (object) - das Konfigurationsobjekt eines Zeitabschnitts:
      • day? - (string | number) - optional, eine Zahl des Wochentags [0 (Sonntag) - 6 (Samstag)]. Hinweis: Es können jeweils nur 1 Tag festgelegt werden
      • date? - (Date) - optional, ein bestimmtes Datum, das als Arbeitstag oder freier Tag festgelegt wird
      • hours? - (string[] | number[] | boolean) - optional, ein Array von Arbeitsstunden als 'von'-'bis'-Paare. 'false'-Wert setzt einen Ruhetag, 'true' (Standardwert) wendet die Standardstunden an (["8:00-17:00"])
      • customWeeks? - (object) - optional, ein Objekt mit verschiedenen Arbeitszeitregeln für unterschiedliche Zeiträume. Das Objekt kann eine Menge von Schlüssel-Wert-Paaren enthalten, wobei der Schlüssel der Name des Zeitabschnitts ist und der Wert ein Objekt mit Attributlisten ist.
        • [timespan: string] - (object) - der Zeitabschnitt mit den Arbeitszeiteinstellungen. Der Name dieses Objekts wird als Name des Zeitabschnitts verwendet
          • from - (Date) - das Datum, an dem der Zeitabschnitt beginnen soll
          • to - (Date) - das Datum, an dem der Zeitabschnitt abgeschlossen werden soll
          • hours? - (string[] | number[]) - optional, ein Array von Arbeitsstunden als 'von'-'bis'-Paare. 'false'-Wert setzt einen Ruhetag, 'true' (Standardwert) wendet die Standardstunden an (["8:00-17:00"])
          • days? - (WorkDaysTuple | boolean) - optional, ein Array von 7 Wochentagen (von 0 - Sonntag, bis 6 - Samstag), wobei 1/true für einen Arbeitstag und 0/false - ein Nicht-Arbeitstag steht.
calendar.setWorkTime({ hours:["9:00-18:00"] });
calendar.setWorkTime({ hours:["9:00-18:00"] });
calendar.setWorkTime({ day: 5, hours: ["9:00-18:00"] });
calendar.setWorkTime({ day: 5, hours: false });
calendar.setWorkTime({ date: new Date(2025, 5, 6), hours: ["9:00-18:00"] });
calendar.setWorkTime({ date: new Date(2025, 5, 6), hours: false });
calendar.setWorkTime({ hours: false });
calendar.setWorkTime({
  customWeeks: {
    winter: {
      from: new Date(2025, 11, 1),
      to: new Date(2026, 2, 1),
      hours: ["8:00-13:00", "14:00-16:00"],
      days: [1, 1, 1, 1, 1, 0, 0]
    },
    summer: {
      from: new Date(2026, 5, 1),
      to: new Date(2026, 7, 1),
      hours: ["10:00-13:00", "14:00-16:00"],
      days: [1, 1, 0, 1, 1, 0, 0]
    }
  }
});
calendar.setWorkTime({
  customWeeks: {
    winter: {
      from: new Date(2025, 11, 1),
      to: new Date(2026, 2, 1),
      hours: ["8:00-13:00", "14:00-16:00"],
      days: [1, ["8:00-13:00"], 1, 1, ["14:00-16:00"], 0, 0]
    },
    summer: {
      from: new Date(2026, 5, 1),
      to: new Date(2026, 7, 1),
      hours: ["10:00-13:00", "14:00-16:00"],
      days: false
    }
  }
});
  • unsetWorkTime (config): void - setzt eine Arbeitszeit im Gantt-Diagramm zurück
    • config - (object) - das Konfigurationsobjekt eines Zeitabschnitts:
      • day? - (string | number) - optional, eine Zahl des Wochentags [0 (Sonntag) - 6 (Samstag)]. Hinweis: Es können jeweils nur 1 Tag festgelegt werden
      • date? - (Date) - optional, ein bestimmtes Datum, das als Arbeitstag oder freier Tag festgelegt wird
      • hours? - (string[] | number[] | boolean) - optional, ein Array von Arbeitsstunden als 'von'-'bis'-Paare. 'false' Wert setzt die Arbeitszeit zurück, 'true' (Standardwert) wendet die Standardstunden an (["8:00-17:00"])
calendar.unsetWorkTime({ hours: ["9:00-18:00"] });
calendar.unsetWorkTime({ day: "5", hours: ["9:00-18:00"] });
calendar.unsetWorkTime({ day: 5, hours: false });
calendar.unsetWorkTime({ date: new Date(2025, 5, 6), hours: true });
  • isWorkTime (config, time_unit): boolean - prüft, ob das angegebene Datum Arbeitszeit ist
    • config - (Date | object) - entweder ein Datum zum Prüfen oder das Konfigurationsobjekt eines Zeitabschnitts:
      • date - (Date) - ein Datum zum Prüfen
      • unit? - (string) - optional, eine Zeiteinheit: "minute", "hour", "day", "week", "month", "year"
    • time_unit? - (string) - optional, eine Zeiteinheit: "minute", "hour", "day", "week", "month", "year". Nicht nötig, wenn der erste Parameter als Objekt angegeben wird
const calendar = gantt.getTaskCalendar(task);
if (calendar.isWorkTime({date: date})){
    alert("worktime of task" + task.text);
}

calendar.isWorkTime(new Date(2025, 5, 6));
calendar.isWorkTime(new Date(2025, 5, 6), "hour");
calendar.isWorkTime({ date: new Date(2025, 5, 6), unit: "hour" });
  • getClosestWorkTime (config): Date - gibt die nächste Arbeitszeit zurück
    • config - (Date | object) - das Konfigurationsobjekt:
      • date - (Date) - ein Datum, für das die nächste Arbeitszeit ermittelt wird
      • dir? - (string) - optional, gibt die Richtung der nächsten Zeit an: "future" oder "past"
      • unit? - (string) - optional, eine Zeiteinheit, in der die nächste Arbeitszeit gesucht wird
calendar.getClosestWorkTime(new Date(2025, 5, 6));
calendar.getClosestWorkTime({ 
    date: new Date(2025, 5, 6), 
    unit: "hour",
    dir: "past" 
});
  • calculateEndDate (config, duration, unit): Date - berechnet das Enddatum einer Aufgabe
    • config - (Date | object) - entweder das Datum, an dem eine Aufgabe beginnen soll, oder das configuration object eines Zeitabschnitts:
      • start_date - (Date) - das Datum, an dem eine Aufgabe beginnen soll
      • duration - (number) - die Dauer einer Aufgabe
      • unit? - (string) - optional, die Zeiteinheit der Dauer: "minute", "hour", "day", "week", "month", "year"
    • duration? - (number) - optional, die Dauer einer Aufgabe. Nicht nötig, wenn der erste Parameter als Objekt angegeben wird
    • unit? - (string) - optional, die Zeiteinheit der Dauer. Nicht nötig, wenn der erste Parameter als Objekt angegeben wird
calendar.calculateEndDate(new Date(2025, 5, 6), 2, "hour");
calendar.calculateEndDate({ 
    start_date: new Date(2025, 5, 6), 
    duration: 2, 
    unit: "hour" 
});
  • calculateDuration (config, end): number - berechnet die Dauer einer Aufgabe
    • config - (Date | object) - entweder das Datum, an dem eine Aufgabe beginnt, oder das configuration object eines Zeitabschnitts:
      • start_date - (Date) - das Datum, an dem eine Aufgabe beginnen soll
      • end_date - (Date) - das Datum, an dem eine Aufgabe beendet werden soll
    • end? - (Date) - das Datum, an dem eine Aufgabe beendet werden soll. Nicht nötig, wenn der erste Parameter als Objekt angegeben wird
calendar.calculateDuration(new Date(2025, 5, 6), new Date(2025, 5, 17));
calendar.calculateDuration({ 
    start_date: new Date(2025, 5, 6), 
    end_date: new Date(2025, 5, 17) 
});

Eigenschaften​

  • id - (string | number) - die ID des Kalenders einer Aufgabe
Need help?
Got a question about the documentation? Reach out to our technical support team for help and guidance. For custom component solutions, visit the Services page.
Need more help?Contact Support