calendar

die Schnittstelle für das Arbeitskalender-Objekt

object calendar;

Details

Für weitere Details zu Arbeitskalendern siehe den Artikel Arbeitszeitberechnung.

Das calendar-Objekt umfasst die folgenden Methoden und Eigenschaften:

Methoden

setWorkTime (config): boolean - definiert die Arbeitszeiten für das Gantt-Diagramm
- config - (object) - das Konfigurationsobjekt, das den Zeitraum beschreibt:
  - day? - (string | number) - optional, eine Wochentagsnummer [0 (Sonntag) - 6 (Samstag)]. Es kann jeweils nur ein Tag gesetzt werden
  - date? - (Date) - optional, ein spezifisches Datum, das als Arbeitstag oder Nicht-Arbeitstag markiert wird
  - hours? - (string[] | number[] | boolean) - optional, ein Array von Arbeitszeiten als 'von'-'bis' Paare. 'false' markiert einen freien Tag, 'true' (Standard) verwendet die Standardarbeitszeit (["8:00-17:00"])
  - customWeeks? - (object) - optional, ein Objekt, das unterschiedliche Arbeitszeitregeln für verschiedene Zeiträume definiert. Es enthält Schlüssel:Wert-Paare, wobei der Schlüssel der Name des Zeitraums ist und der Wert ein Objekt mit folgenden Attributen:
    - [timespan: string] - (object) - der Zeitraum mit Arbeitszeiteinstellungen. Der Schlüsselname wird als Name des Zeitraums verwendet
      - from - (Date) - Startdatum des Zeitraums
      - to - (Date) - Enddatum des Zeitraums
      - hours? - (string[] | number[]) - optional, ein Array von Arbeitszeiten als 'von'-'bis' Paare. 'false' markiert einen freien Tag, 'true' (Standard) verwendet die Standardarbeitszeit (["8:00-17:00"])
      - days? - (WorkDaysTuple | boolean) - optional, ein Array mit 7 Elementen, die die Wochentage repräsentieren (0 - Sonntag, 6 - Samstag), wobei 1/true ein Arbeitstag und 0/false ein freier Tag ist.

calendar.setWorkTime({ hours:["9:00-18:00"] });

unsetWorkTime (config): void - entfernt eine Arbeitszeit-Einstellung aus dem Gantt-Diagramm
- config - (object) - das Konfigurationsobjekt, das den Zeitraum beschreibt:
  - day? - (string | number) - optional, eine Wochentagsnummer [0 (Sonntag) - 6 (Samstag)]. Es kann jeweils nur ein Tag gesetzt werden
  - date? - (Date) - optional, ein spezifisches Datum, das als Arbeitstag oder Nicht-Arbeitstag markiert wird
  - hours? - (string[] | number[] | boolean) - optional, ein Array von Arbeitszeiten als 'von'-'bis' Paare. 'false' markiert einen freien Tag, 'true' (Standard) verwendet die Standardarbeitszeit (["8:00-17:00"])

calendar.unsetWorkTime({ hours:["9:00-18:00"] });

isWorkTime (config, time_unit): boolean - bestimmt, ob das angegebene Datum Arbeitszeit ist
- config - (Date | object) - entweder ein Date-Objekt zur Prüfung oder das Konfigurationsobjekt, das den Zeitraum beschreibt:
  - date - (Date) - das zu prüfende Datum
  - unit? - (string) - optional, Zeiteinheit: "minute", "hour", "day", "week", "month", "year"
  - task? - (Task) - optional, das Task-Objekt, dessen Dauer berücksichtigt werden soll
- time_unit? - (string) - optional, die Zeiteinheit: "minute", "hour", "day", "week", "month", "year". Nicht erforderlich, wenn der erste Parameter ein Objekt ist

var calendar = gantt.getTaskCalendar(task);
if (calendar.isWorkTime({date: date})){
    alert("worktime of task" + task.text);
}

getClosestWorkTime (config): Date - findet die nächstgelegene Arbeitszeit
- config - (Date | object) - das Konfigurationsobjekt:
  - date - (Date) - das Datum, für das die nächste Arbeitszeit gefunden werden soll
  - dir? - (string) - optional, Suchrichtung: "future" oder "past"
  - unit? - (string) - optional, Zeiteinheit für die Suche
  - task? - (Task) - optional, das Task-Objekt, dessen Kalender verwendet werden soll

calendar.getClosestWorkTime({
    date:new Date(2013,0,1), 
    dir:"future", 
    unit:"hour"
});

calculateEndDate (config, duration, unit): Date - berechnet das Enddatum einer Aufgabe
- config - (Date | object) - entweder das Startdatum der Aufgabe oder das Konfigurationsobjekt, das den Zeitraum beschreibt:
  - start_date - (Date) - das Startdatum der Aufgabe
  - duration - (number) - die Dauer der Aufgabe
  - unit? - (string) - optional, die Zeiteinheit der Dauer: "minute", "hour", "day", "week", "month", "year"
  - task? - (Task) - optional, das Task-Objekt, dessen Dauer berechnet werden soll
- duration? - (number) - optional, die Dauer der Aufgabe. Nicht nötig, wenn der erste Parameter ein Objekt ist
- unit? - (string) - optional, die Zeiteinheit der Dauer. Nicht nötig, wenn der erste Parameter ein Objekt ist

var end_date = calendar.calculateEndDate({start_date:date, duration:duration});

calculateDuration (config, end): number - berechnet die Dauer einer Aufgabe
- config - (Date | object) - entweder das Startdatum der Aufgabe oder das Konfigurationsobjekt, das den Zeitraum beschreibt:
  - start_date - (Date) - das Startdatum der Aufgabe
  - end_date - (Date) - das Enddatum der Aufgabe
  - task? - (Task) - optional, das Task-Objekt, dessen Dauer berechnet werden soll
- end? - (Date) - das Enddatum der Aufgabe. Nicht nötig, wenn der erste Parameter ein Objekt ist

calendar.calculateDuration(new Date(2013,02,15), new Date(2013,02,25));

Eigenschaften

id - (string | number) - die Kennung des Kalenders der Aufgabe