Zum Hauptinhalt springen

addMarkedTimespan

Description​

Markiert Daten und kann mit bestimmten Einstellungen diese blockieren (ermöglicht das Anwenden benutzerdefinierter Styles auf die Grenzen)

addMarkedTimespan: (config: any) => number

Parameters​

  • config - (required) object - Das Konfigurationsobjekt, das den zu markierenden oder blockierenden Zeitraum definiert

Returns​

  • id - (number) - Die ID des hinzugefügten Zeitraums

Example​

//markiert Daten
scheduler.addMarkedTimespan({  
    days:  5,               // markiert jeden Freitag
    zones: "fullday",       // markiert den ganzen Tag
    css:   "gray_section"   // angewandte CSS-Klasse
});
scheduler.updateView();

//markiert und blockiert Daten
scheduler.addMarkedTimespan({  
    days:  5,
    zones: "fullday",
    css:   "gray_section",
    type:  "dhx_time_block" //dies ist ein fester Wert
});
scheduler.updateView();

Details​

Diese Methode ist seit Version 3.5 verfügbar.

Hinweis

Die Methode erfordert, dass das limit Plugin aktiviert ist.

Hinweis

Beachten Sie, dass das Markieren (Blockieren) nicht sofort nach dem Aufruf dieser Methode wirksam wird. Sie müssen updateView aufrufen, um die Änderungen anzuwenden.


Eigenschaften des Konfigurationsobjekts​

Das Konfigurationsobjekt kann die folgenden Eigenschaften enthalten:

Eigenschaft

Beschreibung

start_date ein Date-Objekt, das den Beginn der Einschränkung definiert
//verhindert das Erstellen von Events ab dem 3. Mai 2012 bis 'end_date' 
start_date:new Date(2012,4,3)
end_date ein Date-Objekt, das das Ende der Einschränkung definiert
//verhindert das Erstellen von Events von 'start_date' 
// bis zum 3. September 2012
end_date:new Date(2012,8,3)
days zu beschränkende Tage
days:[0, 2, 6] //beschränkt Sonntag, Dienstag und Samstag
days:"fullweek" //beschränkt die gesamte Woche
days:new Date(2012,6,1) //blockiert den 1. Juli 2012
zonesdie zu beschränkenden Zeitperioden (in Minuten)
//zwei Beschränkungsblöcke: 04:00-08:00 und 12:00-15:00
zones:[4*60,8*60,12*60,15*60] 
zones:"fullday" //beschränkt den ganzen Tag
cssder anzuwendende CSS-Klassenname
css:"gray" //zeichnet ein DIV mit der CSS-Klasse 'gray'
htmlHTML-Inhalt, der innerhalb des markierten Bereichs angezeigt wird
//zeichnet ein DIV mit diesem Text über dem markierten Bereich  
html:"<b>Blocked</b>"
typegibt den Typ des Zeitraums an. Wird 'dhx_time_block' gesetzt, erfolgt eine Blockierung. Jeder andere Wert markiert den Zeitraum nur ohne Blockierung.
type: "dhx_time_block" //Zeitraum wird markiert und blockiert
invert_zonesgibt an, ob die Zeitfenster (in 'zones' gesetzt) invertiert werden sollen (Standard ist false)
//ergibt zwei Beschränkungsblöcke: 00:00-08:00 und 17:00-24:00
zones: [8*60, 17*60], invert_zones: true 
//ergibt zwei Beschränkungsblöcke: 00:00-08:00 und 17:00-24:00
zones: [0, 8*60, 17*60, 24*60], invert_zones: false
sectionsbeschränkt die Blockierung auf bestimmte Items in bestimmten Views.
Die Daten werden nur in den angegebenen View(s) blockiert.
//blockiert Daten nur für das Item mit id=5 im Unit-View 
//und Items mit den IDs 2 und 3 im Timeline-View 
sections: { unit: 5, timeline: [2,3]}

Akzeptable Kombinationen von Konfigurationseigenschaften​

Hinweis

Beachten Sie, dass days und zones zusammen verwendet werden müssen, ebenso wie start_date und end_date als Paar, um das Blockierungsintervall zu definieren. Diese Paare dürfen nicht anders kombiniert werden. Zum Beispiel können Sie zones nicht mit start_date kombinieren oder days gleichzeitig mit start_date und end_date verwenden.

Deshalb gibt es zwei gültige Eigenschaftskombinationen:

Eigenschaftensatz

Beispiel

  • days
  • zones
  • invert_zones
  • css
  • html
  • type
  • sections
var config ={
    days:  1, 
    zones: [9*60, 15*60], 
    css: "cssClassName", 
    sections: {
         unit: 5
    }
}

  • start_date
  • end_date
  • css
  • html
  • type
  • sections
var config ={
    start_date: new Date(2013,7,13),
    end_date:   new Date(2013,7,14),
    css: "cssClassName",
    sections: {
         unit: 5
    }
}

Vergleich von markTimespan() und addMarkedTimespan()​

addMarkedTimespan

markTimespan

erfordert den Aufruf von updateView, um ein DIV für den Zeitraum zu rendern

zeichnet automatisch ein DIV für den Zeitraum

die Zeitspanne(n) bleiben unbegrenzt bestehen

Zeiträume werden sofort nach jeder internen Aktualisierung in der App ausgeblendet

gibt die ID der konfigurierten Zeitspanne(n) zurück

gibt ein DIV-Element oder ein Array von DIVs zurück

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