Перейти к основному содержимому

markTimespan

Description​

Подсвечивает или блокирует определённые дату(ы), применяя либо стиль по умолчанию, либо кастомный стиль. Подсветка снимается сразу после любого внутреннего обновления в приложении. Это может быть полезно для выделения определённых дат.

markTimespan: (config: any) => any[]

Parameters​

  • config - (required) object - подробности конфигурации для выделяемого или блокируемого диапазона времени

Returns​

  • divs - (array) - возвращается массив HTML-элементов

Example​

//подсветить определённые даты
scheduler.markTimespan({  
    days:  5,               // подсвечивает каждую пятницу  
    zones: "fullday",       // подсвечивает весь день
    css:   "gray_section"   // применяемый CSS класс
});

//подсветить и заблокировать определённые даты
scheduler.markTimespan({  
    days:  5,
    zones: "fullday",
    css:   "gray_section",
    type:  "dhx_time_block" // фиксированное значение для блокировки диапазона времени
});

Details​

примечание

Этот метод доступен начиная с версии 3.5.

примечание

Этот метод требует включения плагина limit.

Свойства объекта конфигурации​

Объект конфигурации поддерживает следующие свойства:

Свойство

Описание

start_date объект Date, указывающий начало ограничения
// запрещает создание событий начиная с 3 мая 2012 до 'end_date' 
start_date:new Date(2012,4,3)
end_date объект Date, указывающий конец ограничения
// запрещает создание событий с 'start_date' до 3 сентября 2012
end_date:new Date(2012,8,3)
days дни, к которым применяется ограничение
days:[0, 2, 6] // ограничивает воскресенье, вторник и субботу
days:"fullweek" // ограничивает всю неделю
days:new Date(2012,6,1) // блокирует 1 июля 2012
zones временные интервалы в минутах, к которым применяется ограничение
zones:[4*60,8*60,12*60,15*60] // два ограниченных интервала: 04:00-08:00, 12:00-15:00
zones:"fullday" // ограничивает весь день
css имя CSS класса для применения 
css:"gray" // создаёт DIV с применённым CSS классом 'gray'
html HTML содержимое для отображения внутри выделенного диапазона 
html:"<b>Blocked</b>" // добавляет этот текст внутри DIV для выделенного диапазона
type задаёт тип диапазона времени. Установка в 'dhx_time_block' блокирует диапазон. Любое другое значение лишь подсвечивает диапазон без блокировки 
type: "dhx_time_block" // подсвечивает и блокирует диапазон времени
invert_zones определяет, следует ли инвертировать временные зоны (установленные в 'zones'), по умолчанию false 
// результат: два ограниченных интервала: 00:00-08:00, 17:00-24:00
zones: [8*60, 17*60], invert_zones: true 
// результат: два ограниченных интервала: 00:00-08:00, 17:00-24:00
zones: [0, 8*60, 17*60, 24*60], invert_zones: false
sections ограничивает блокировку конкретными элементами в определённых представлениях. Блокировка применяется только в этих связанных представлениях
// блокирует даты только для элемента с id=5 в представлении Units 
// и для элементов с id 2 и 3 в представлении Timeline 
sections: { unit: 5, timeline: [2,3]}

Допустимые комбинации свойств config​

примечание

Имейте в виду, что days, zones и start_date, end_date образуют пары для определения интервала блокировки и не должны смешиваться иначе. Например, нельзя использовать zones вместе с start_date или одновременно сочетать days с обоими start_date и end_date.

Существует два валидных набора свойств, которые можно использовать:

Набор свойств

Пример

  • 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(2012,7,13),
    end_date:   new Date(2012,7,14),
    css: "cssClassName",
    sections: {
         unit: 5
    }
}

Сравнение markTimespan() и addMarkedTimespan()​

addMarkedTimespan

markTimespan

требует вызова метода updateView для отрисовки DIV для диапазона времени

автоматически отрисовывает DIV для диапазона времени

диапазон(ы) времени остаются видимыми постоянно

диапазон(ы) времени скрываются сразу после любого внутреннего обновления в приложении

возвращает ID созданного(ых) диапазона(ов) времени

возвращает DIV или массив DIV-элементов

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