Настройки виджета списка событий
Общий список возможных настроек виджета списка событий:
debug?: boolean; // Вывод отладочной информации
// в консоль браузера
enableGA?: boolean; // Включить коды счетчика
// GoogleAnalytics
display: string; // Как отображать виджет. "iframe" — в виде формы
// на странице. "popup" — в попапе поверх страницы.
initialRoute?: string; // Экран, с которого начинается отображение
// виджета. Как правило "main" (по умолчанию)
// или "button".
hidePreloading?: boolean; // Не показывать индикатор загрузки.
iframe: {
width?: any; // Ширина виджета
height?: any; // Высота виджета
autoHeight?: boolean; // Режим автоподбора высоты
name?:string; // Параметр name тега iframe
src?:string; // Параметр src тега iframe
target?:JQuery;
fill?:boolean;
background?:string; // Параметр background тега iframe
// (цвет или "transparent")
useVkResize?: boolean; // Использовать ли API Вконтакте
// для изменения размера виджета
};
popup: {
margins?: number[];
width?: number;
tint?: boolean; // Затенять ли остальную страницу
// (по умолчанию — true)
padding?: number;
addCss?: Object; // Дополнительные стили в виде пар
// свойство—значение.
triggerSelector?: string; // Селектор внешней ссылки или кнопки,
// по клику на которые открывается попап
// должен искаться jQuery. Подойдет
// что-то типа ".aButton" или "#theLink"
autoShrink?: bool; // Ужимать ли виджет на маленьких экранах
minViewport?: number; // Минимальная ширина, до которой ужимается
// виджет на маленьких экранах
noClose?: boolean; // Показывать ли крестик для закрытия
// попапа (по умолчанию — true)
outerClose?: boolean; // Выносить ли крестик за край виджета
// (false)
closeColor?: string; // Цвет крестика ("black")
closeCss?: Object; // Дополнительные стили крестика.
// (список пар свойство — значение)
};
requestOptions?: ApiEventListRequest; // Настройки списка событий
// см. раздел ниже
eventInfoView: {
mode: string; // "inside"|"redirect"|"popup"|"auto"
autoMinWidth: number;
popup?: PopupParams;
};
buttonTexts: {
free: string; // Текст на кнопке перехода
// к бесплатному событию
paid: string; // То же для платного события
}
eventRegisterSettings?: EventRegisterSettings;
// Настройки отображения одиночного события.
// Можно использовать практически все параметры,
// описанные для виджета регистрации
coloring: {
tintAlpha: number;
randomColor: {
s: number[];
l: number[];
}
}
bindEvents?: any; // Повесить обработчики на события.
// См. раздел «Встроить свое поведение в виджет»
overrideTemplates?: any; // Переопределить шаблоны
// См. «Сверстать по своему макету»
noScrollToWidgetOnViewChange?: boolean; // не скроллить страницу до верха
// виджета при смене его состояния
// (напр., переход от анкеты
// к оплате)
loadCSS?: string[]; // Загрузка дополнительных стилей.
// См. «Перекрасить с помощью CSS»
skipBaseCSS?: boolean; // Не загружать базовые стили виджета
disableBootstrap?: boolean; // Не загружать стили библиотеки Bootstrap
locale?: string; // Язык виджета. Доступны значения "ru" или "en".
// Про дополнительные значения — см. раздел
// «Изменить тексты и локализовать».
Настройки взяты из наших исходников на TypeScript, но вы можете использовать их просто как шпаргалку.
Настройки списка событий
Ниже перечислены возможные свойства параметра requestOptions
.
categories_include?: string; // Нужные категории (id через запятую)
categories_exclude?: string; // Ненужные категории (те, что нужно исключить)
cities_include?: string; // Нужные города (названия через запятую)
cities_exclude?: string; // Ненужные города
orgs_include?: string; // Цифровые id организаций TimePad через запятую.
// Если у вас есть несколько организаций, вы можете
// показывать все их события в одном виджете
// По умолчанию берется id организации,
// из админки которой взят код вставки.
orgs_exclude?: string; // Ненужные организации. Впрочем, в стандартном
// виджете списка событий организации этим параметром
// воспользоваться не получится, потому что в списке
// `orgs_include` всегда будет как минимум id этой
// самой организации.
price_range?: string; // Диапазон цен на билеты. `,100` — до ста рублей,
// `,0` — бесплатные, `50,300` — от 50 до 300 рублей
date_start?:string; // Минимальная дата начала события
// Значение параметра игнорируется, если задан параметр date_range
// или параметр sort установлен в smart.
date_end?:string; // Максимальная дата начала события
// Значение параметра игнорируется, если задан параметр date_range
// или параметр sort установлен в smart.
date_range?: string; // Диапазон дат. Напр.,
// `2013-01-05,2013-02-01`. По умолчанию: `today,`
// Важно знать, что если событие уже началось, дата
// начала оказывается в прошлом, и по умолчанию виджет
// списка событий его не покаывает. Это можно
// исправить, задав свой диапазон дат.
// Значение параметра игнорируется, если параметр sort установлен в smart.
is_approved?: boolean; // Проверены ли модератором. true/false, 1/0,
// "true"/"false", "yes"/"no", "on"/"off".
// Значение по умолчанию — null, и при нем
// виджет выводит все события.
// Значение параметра игнорируется при заданном параметре moderated.
keywords_include?: string; // Слова, которые должны содержаться в названии события
keywords_exclude?: string; // Слова, которые не должны содержаться в названии события
skip?: number; // Пагинация: сколько событий пропустить
count?: number; // Пагинация: сколько отобразить (по умолчанию 9)
sort?: string; // Поле, по которому сортировать. По умолчанию `uid`.
// Возможные поля: name, date_start, city, created_at, uid, smart.
// По умолчанию: `smart`.
order?: string; // Направление сортировки: `asc`, `desc`.
rand?: boolean; // Выбирать случайные события из подходящих под условия.
// `true|false`, по умолчнаию `false`.
// Если параметр установлен в true, значение параметра sort будет проигнорированно
events_include?: string; // id событий (через запятую), которые должны
// отображаться в списке
events_exclude?: string; // id событий, которые там не должны отображаться
moderated?: boolean; // Отображать отмодерированную информацию о событиях
// (изменённую модератором на timepad.ru)
// вместо оригинальной (написанной организатором).
// `true|false`, по умолчнаию `false`.
// Также `moderated=false` разрешает показ
// неотмодериованных и отклоненных событий.
fields_include?: string // В отличие от всех предыдущих _include,
// задает не критерий выбора, а набор полей,
// которые сервер передаст в массив событий
// (`model.events`). По умолчанию —
// "eventreg_widget_customization_id,reg_open,
// price_min,poster_rgb_color"
// Удалять поля не стоит, а вот добавить новые
// может понадобится для кастомизации.