Изменения документа Для_разработчиков
Редактировал(а) Михаил Галич 26.11.2024, 12:16
<
>
отредактировано Михаил Галич
на 12.12.2023, 12:30
на 12.12.2023, 12:30
отредактировано Михаил Галич
на 14.12.2023, 13:07
на 14.12.2023, 13:07
Изменить комментарий:
Alphabetical order for "display" group of settings
Комментарий
-
Свойства страницы (1 изменено, 0 добавлено, 0 удалено)
-
Объекты (0 изменено, 2 добавлено, 0 удалено)
Подробности
- Свойства страницы
-
- Содержимое
-
... ... @@ -2,7 +2,7 @@ 2 2 3 3 = Инструкция для подключения = 4 4 5 -Назначение данного раздела — описать способы взаимодействия с виджетом Веб-платформы по задуманому вами сценарию. Типичный процесс подключения, открытия и отслеживания виджета выглядит так: 5 +Назначение данного раздела — описать способы взаимодействия с виджетом Веб-платформы по задуманному вами сценарию. Типичный процесс подключения, открытия и отслеживания виджета выглядит так: 6 6 7 7 ~1. Подключите скрипт ##external.script.js## к вашему сайту. Его адрес будет доступен **после добавления сайта** в процессе настройки в **администраторской панели Веб-Платформы**, так же как и параметр ##id## для подключения 8 8 ... ... @@ -41,7 +41,9 @@ 41 41 42 42 ===== Минимальный способ инициализации: ===== 43 43 44 -* WPInit({ id: 1 }) 44 +{{code language="javascript"}} 45 +WPInit({ id: 1 }) 46 +{{/code}} 45 45 46 46 ===== Пример передаваемых данных: ===== 47 47 ... ... @@ -58,7 +58,7 @@ 58 58 59 59 == WPOpen({params}) == 60 60 61 -Функция открытия виджета в каком-либо блоке, используется при инициализации виджета с type: 'instant' 63 +Функция открытия виджета в каком-либо блоке, используется при инициализации виджета с ##type: 'instant'## 62 62 63 63 ===== Пример передаваемых данных: ===== 64 64 ... ... @@ -71,11 +71,17 @@ 71 71 72 72 == WPOpenModal({params}) == 73 73 74 -Функция открытия виджета в модальном окне, используется при инициализации виджета с type: 'modal' 76 +Функция открытия виджета в модальном окне, используется при инициализации виджета с ##type: 'modal'## 75 75 76 76 ===== Пример передаваемых данных: ===== 77 77 78 -{{{// показ виджета на нажатие кнопки с id "OpenButton" var OpenButton = document.getElementById('OpenButton'); OpenButton.onclick = function() { WPOpenModal({ tariffsid: [27, 28] }) }}}} 80 +{{code language="javascript"}} 81 +// показ виджета на нажатие кнопки с id "OpenButton" 82 +var OpenButton = document.getElementById('OpenButton'); 83 +OpenButton.onclick = function () { 84 + WPOpenModal({ tariffsid: [27, 28] }); 85 +}; 86 +{{/code}} 79 79 80 80 == WPChange({status, data}) == 81 81 ... ... @@ -83,10 +83,10 @@ 83 83 84 84 ===== Примеры передаваемых данных: ===== 85 85 86 -* { status:'starting' } — виджет в процессе запуска, в этот момент определяется, что он должен в данный момент отображать 87 -* { status:'started' } — виджет на начальном экране, где показывается список услуг для покупки 88 -* { status:'reserved', data: { order_id: 2 } } — виджет находится на стадии забронированного заказ, в data передаётся id 89 -* { status:'completed', data: { order_id: 2 } } — виджет находится на стадии оплаченного заказ, в data передаётся id заказа 94 +* ##{ status:'starting' }## — виджет в процессе запуска, в этот момент определяется, что он должен в данный момент отображать 95 +* ##{ status:'started' }## — виджет на начальном экране, где показывается список услуг для покупки 96 +* ##{ status:'reserved', data: { order_id: 2 } }## — виджет находится на стадии забронированного заказ, в data передаётся id 97 +* ##{ status:'completed', data: { order_id: 2 } }## — виджет находится на стадии оплаченного заказ, в data передаётся id заказа 90 90 91 91 ===== Пример работы с данными: ===== 92 92 ... ... @@ -111,35 +111,53 @@ 111 111 112 112 == Обязательные параметры WPInit == 113 113 114 -==== id :1====122 +==== id ==== 115 115 124 +Тип данных:## //number//## 125 + 116 116 id виджета, который можно узнать в Административной панели 117 117 118 118 == Возможные параметры WPInit == 119 119 120 -==== height :480====130 +==== height ==== 121 121 132 +Тип данных:## //number //##//|## boolean##// 133 + 134 +По умолчанию:##// false//## 135 + 122 122 Высота виджета в пикселях, по умолчанию: 123 123 124 124 * 480px, если виджет запущен как type: 'modal' 125 125 * 100%, если виджет запущен как type: 'instant' 126 126 127 -==== width :640====141 +==== width ==== 128 128 143 +Тип данных:## //number //##//|## boolean##// 144 + 145 +По умолчанию:##// false//## 146 + 129 129 Ширина виджета в пикселях, по умолчанию: 130 130 131 131 * 640px, если виджет запущен как type: 'modal' 132 132 * 100%, если виджет запущен как type: 'instant' 133 133 134 -==== type :'modal'====152 +==== type ==== 135 135 136 - Способоткрытия виджета, по умолчанию'instant':154 +Тип данных:## //string//## 137 137 156 +По умолчанию:##// 'instant'//## 157 + 158 +Способ открытия виджета 159 + 138 138 * 'instant' Открытие виджета на месте, где был вызов виджета (на месте тэга script), либо в блоке place, если он указан в параметрах виджета при инициализации 139 139 * 'modal' Открытие виджета в модальном окне 140 140 141 -==== place :'#place'====163 +==== place ==== 142 142 165 +Тип данных:## //string //##//|## boolean##// 166 + 167 +По умолчанию:##// false//## 168 + 143 143 Идентификатор элемента DOM, в который необходимо поместить виджет, например: #widget. Используется совместно с type: 'instant' 144 144 145 145 (% class="box warningmessage" %) ... ... @@ -153,60 +153,108 @@ 153 153 154 154 === Календарь и даты === 155 155 156 -==== nocalendar: false ====182 +==== disableddates ==== 157 157 158 - Убираеткалендарь внутри виджета (и в //покупке// и в //пополнении//), в случаях, когда дата, на которую покупается/пополняется билет, не важна. По умолчанию false184 +Тип данных:##// Array<string>//## 159 159 160 - ====mindate:'01.01.2019' ====186 +По умолчанию:##// []//## 161 161 162 -Параметр минимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). mindate: '20.05.2018' покажет 20.05.2018 как самую первую дату, доступную к выбору в календаре, если она находится после текущего дня 188 +Параметр отключения дат в календаре (и в //покупке// и в //пополнении//). Делает невозможным выбор определённых дней в массиве дат. 189 +Пример использования: 163 163 164 -==== maxdate: '01.01.2020' ==== 191 +{{code language="javascript"}} 192 +disableddates: ['23.02.2018', '08.03.2018'] 193 +{{/code}} 165 165 166 - Параметрмаксимальной отображаемойдатыв календаре (и в //покупке// и в //пополнении//). maxdate: '20.05.2018'покажет20.05.2018каксамую последнююдату,доступную квыборув календаре.195 +уберёт даты 23.02.2018 и 08.03.2018 из возможных для выбора дат в календаре. 167 167 168 -==== forcedate :'12.06.2019'====197 +==== forcedate ==== 169 169 199 +Тип данных:##// string//## 200 + 201 +По умолчанию:##// undefined//## 202 + 170 170 Параметр для открывания виджета с указанной сразу датой (и в //покупке// и в //пополнении//). forcedate: '20.05.2018' покажет услуги к продаже на дату 20.05.2018. 171 171 172 -==== disableddates:['23.02.2019', … ]====205 +==== maxdate ==== 173 173 174 -Параметр отключения дат в календаре (и в //покупке// и в //пополнении//). Делает невозможным выбор определённых дней в массиве дат. 175 -Пример использования: 207 +Тип данных:##// string//## 176 176 177 -{{code language="javascript"}} 178 -disableddates: ['23.02.2018', '08.03.2018'] 179 -{{/code}} 209 +По умолчанию:##// undefined//## 180 180 181 - уберёт даты 23.02.2018и08.03.2018извозможныхдлявыборадатв календаре.211 +Параметр максимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). maxdate: '20.05.2018' покажет 20.05.2018 как самую последнюю дату, доступную к выбору в календаре. 182 182 213 +==== mindate ==== 214 + 215 +Тип данных:##// string//## 216 + 217 +По умолчанию:##// undefined//## 218 + 219 +Параметр минимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). mindate: '20.05.2018' покажет 20.05.2018 как самую первую дату, доступную к выбору в календаре, если она находится после текущего дня 220 + 221 +==== nocalendar ==== 222 + 223 +Тип данных:## //boolean//## 224 + 225 +По умолчанию:##// false//## 226 + 227 +Убирает календарь внутри виджета (и в //покупке// и в //пополнении//), в случаях, когда дата, на которую покупается/пополняется билет, не важна. 228 + 183 183 ---- 184 184 185 185 === Услуги, пакеты услуг, группы услуг === 186 186 187 -==== tariffsid :[29, 30, … ]====233 +==== tariffsid ==== 188 188 235 +Тип данных:##// Array<number> //##//|## boolean##// 236 + 237 +По умолчанию:##// []//## 238 + 189 189 Тарифы, которые следует показать на вкладке «Покупка услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него. 240 + 190 190 Пример использования: 191 -tariffsid: [29, 30] покажет тарифы с id 29 и 30 во вкладке «Покупка услуг». 192 -tariffsid: false уберёт все тарифы с первой страницы 193 193 194 -==== rtariffsid: [56, 57, … ] ==== 243 +{{code language="javascript"}} 244 +tariffsid: [29, 30] // покажет тарифы с id 29 и 30 во вкладке «Покупка услуг». 245 +tariffsid: false // уберёт все тарифы с первой страницы 246 +{{/code}} 195 195 248 +==== rtariffsid ==== 249 + 250 +Тип данных:##// Array<number> //##//|## boolean##// 251 + 252 +По умолчанию:##// []//## 253 + 196 196 Тарифы, которые следует показать после ввода карты во вкладке «Пополнение услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него. 255 + 197 197 Пример использования: 198 -rtariffsid: [56, 57] покажет тарифы с id 56 и 57 после ввода карты во вкладке «Пополнение услуг» 199 -tariffsid: false уберёт все тарифы с первой страницы 200 200 201 -==== bundlesid: [4, 5, … ] ==== 258 +{{code language="javascript"}} 259 +rtariffsid: [56, 57] // покажет тарифы с id 56 и 57 после ввода карты во вкладке «Пополнение услуг» 260 +rtariffsid: false // уберёт все тарифы во вкладке «Пополнение услуг» 261 +{{/code}} 202 202 263 +==== bundlesid ==== 264 + 265 +Тип данных:##// Array<number> //##//|## boolean##// 266 + 267 +По умолчанию:##// []//## 268 + 203 203 Пакеты услуг, которые следует показать на первой странице. По умолчанию массив пуст и не показывает отдельно никакие из пакетов услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать пакеты услуг, доступные только для него. 270 + 204 204 Пример использования: 205 -bundlesid: [4, 5] покажет пакеты услуг с id 4 и 5 в момент открытия виджета. 206 -bundlesid: false уберёт все пакеты услуг с первой страницы 207 207 208 -==== groupid: 12 ==== 273 +{{code language="javascript"}} 274 +bundlesid: [4, 5] // покажет пакеты услуг с id 4 и 5 в момент открытия виджета. 275 +bundlesid: false // уберёт все пакеты услуг с первой страницы 276 +{{/code}} 209 209 278 +==== groupid ==== 279 + 280 +Тип данных:##// number//## 281 + 282 +По умолчанию:##// undefined//## 283 + 210 210 Параметр, который форсирует показ определённой группы услуг ппс. groupid: 5 покажет только одну группу с id 5 в виджете. 211 211 212 212 ---- ... ... @@ -213,8 +213,12 @@ 213 213 214 214 === Предзаказ === 215 215 216 -==== preorder :[{id: 57, date: '06.06.2019', count: 1}, … ]====290 +==== preorder ==== 217 217 292 +Тип данных:##// Array<object>//## 293 + 294 +По умолчанию:##// undefined//## 295 + 218 218 Параметр, позволяющий купить сразу несколько услуг и перейти к подтверждению покупки. 219 219 220 220 * id — id услуги к покупке ... ... @@ -240,98 +240,182 @@ 240 240 }) 241 241 {{/code}} 242 242 321 +---- 322 + 243 243 === Отображение === 244 244 245 -==== forcetab: 'rewrite'====325 +==== cartmaxitems ==== 246 246 247 - Переключение на необходимую вкладку виджета («покупкауслуг» или «пополнение услуг») при загрузке. По умолчанию открывается вкладка«покупка услуг». forcetab: 'rewrite' принудительно откроет «пополнение услуг». Обычно используется в комбинации с параметром onlytab327 +Тип данных:##// number//## 248 248 249 - ====onlytab:'rewrite' ====329 +По умолчанию:##// 6//## 250 250 251 -Скрытие других вкладок виджета («покупка услуг» или «пополнение услуг») при загрузке. Обычно используется в комбинации с параметром forcetab 331 +(% class="wikigeneratedid" %) 332 +Ограничивает максимальное кол-во товаров в корзине. ##Минимальное значение 1. Максимальное значение 60.## 252 252 253 -* onlytab: 'service' покажет только вкладку «покупка услуг». 254 -* onlytab: 'rewrite' покажет только вкладку «пополнение услуг». 334 +==== cartminitems ==== 255 255 256 - ====forcemedia: 'E0012345678900' ====336 +Тип данных:##// number//## 257 257 338 +По умолчанию:##// 1//## 339 + 340 +Ограничивает минимальное кол-во товаров в корзине. ##Минимальное значение 1. Максимальное значение 60.## 341 + 342 +==== disablemultipleseances ==== 343 + 344 +Тип данных:##// boolean//## 345 + 346 +По умолчанию:##// false//## 347 + 348 +Параметр предотвращает добавление в корзину тарифов с различными сеансами. 349 +Таким образом как только в корзине появится хоть один товар с сеансом "10:00 - 11:30", товары, у которых есть сеанс например "13:00 - 14:30" будет невозможно добавить в корзину. Товары без сеансов не будут затронуты. 350 + 351 +==== forcemedia ==== 352 + 353 +Тип данных:##// string//## 354 + 355 +По умолчанию:##// ''//## 356 + 258 258 Параметр, который вставяет строчку с носителем в поле носителя во вкладке «Пополнение услуг». Используется, например, для QR-кода нанесённого на носитель, чтобы быстро его пополнить. 259 259 260 - ==== nopromo:false ====359 +Пример: 261 261 262 -Убирает вывод промокода на странице подтверждения заказа. По умолчанию false 361 +{{code language="javascript"}} 362 +forcemedia: 'E0012345678900' 363 +{{/code}} 263 263 264 -==== terminal: true ==== 265 265 266 -Включение режима «терминал» для работы виджета. При этом режиме убирается возможность отослать заказ на SMS, а сам заказ распечатывается на принтере. 267 267 268 -==== cartmaxitems:5====367 +==== forceseanceid ==== 269 269 270 -(% class="wikigeneratedid" %) 271 -Ограничивает максимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60. По умолчанию 6 369 +Тип данных:##// number//## 272 272 273 - ====cartminitems:2====371 +По умолчанию без указания идентификатора не учитывается. 274 274 275 - Ограничивает минимальноекол-вотоваровв корзине.Минимальноезначение1. Максимальноезначение60. По умолчанию 1373 +Заставит виджет выбрать мероприятие арены по идентификатору платформы и не позволять вернуться к этапу выбора других мероприятий. 276 276 277 -==== locale: 'ru'====375 +==== forcesectorid ==== 278 278 377 +Тип данных:##// number//## 378 + 379 +По умолчанию без указания идентификатора не учитывается. 380 + 381 +Заставит виджет выбрать сектор мероприятия по id и не позволять вернуться к этапу выбора других секторов. 382 + 383 +==== forcetab ==== 384 + 385 +Тип данных:##// string//## 386 + 387 +По умолчанию:##// ''//## 388 + 389 +Переключение на необходимую вкладку виджета («покупка услуг» или «пополнение услуг») при загрузке. По умолчанию открывается вкладка «покупка услуг». forcetab: 'rewrite' принудительно откроет «пополнение услуг». Обычно используется в комбинации с параметром ##onlytab## 390 + 391 +==== locale ==== 392 + 393 +Тип данных:##// string//## 394 + 395 +По умолчанию:##// ''//## 396 + 279 279 Параметр локализации. Позволяет переключать между языками виджета, например 'ru' - русский язык, 'en' - английский язык. 280 280 281 -==== ordercomment:'Комментарий к заказу'====399 +==== minimap ==== 282 282 283 - Опциональныйкомментарий к заказу. Максимальнаядлиннакомментария 50 символов.401 +Тип данных:##// boolean//## 284 284 285 - ====disablemultipleseances:====403 +По умолчанию:##// true//## 286 286 287 -Параметр предотвращает добавление в корзину тарифов с различными сеансами. 288 -Таким образом как только в корзине появится хоть один товар с сеансом "10:00 - 11:30", товары, у которых есть сеанс например "13:00 - 14:30" будет невозможно добавить в корзину. Товары без сеансов не будут затронуты. 289 -По умолчанию false 405 +Отображать миникарту. 290 290 291 -==== tariffsseancesfilter:true====407 +==== minimapaspect ==== 292 292 293 - [[image:https://info.moipass.ru/images/tariffsseancesfilter.png||alt="Example"]]409 +Тип данных:##// number//## 294 294 295 - Включить отображение фильтра тарифов по сеансам.По умолчаниюfalse411 +По умолчанию:##// 0.2//## 296 296 297 - ====resetcart:true====413 +Размер миникарты относительной полного размера карты, а не контейнера, в которой она находится. 298 298 299 - Автоматическиочищатьсодержимоекорзины.По умолчаниюfalse415 +==== multidayslessonsskillstarif(% style="display:none" %) (%%)fs ==== 300 300 301 - ====minimap:false====417 +Тип данных:##// Array<number> //##//|## object##// 302 302 303 - Отображать миникарту.По умолчаниюtrue419 +По умолчанию:##// []//## 304 304 305 - ====minimapaspect: 0.5 ====421 +Производит фильтрацию тарифов для многодневных занятий. Принимает массив идентификаторов. Параметр дополняет фильтрацию по параметру grouplessonsskillstariffs. 306 306 307 - Размерминикартыотносительной полного размера карты, а не контейнера, в которой она находится. По умолчанию 0.2423 +==== nopromo ==== 308 308 309 - ====forceseanceid: 42 ====425 +Тип данных:##// boolean//## 310 310 311 - Заставит виджет выбрать мероприятиеарены по идентификаторуплатформы и не позволять вернуться к этапу выбора других мероприятий. Без указания идентификатора не учитывается.427 +По умолчанию:##// false//## 312 312 313 - ====forcesectorid:42====429 +Убирает вывод промокода на странице подтверждения заказа. 314 314 315 - Заставитвиджетвыбрать сектор мероприятия по id и не позволять вернуться к этапу выбора других секторов. Без указания идентификатора не учитывается.431 +==== onlytab ==== 316 316 317 - ====requiredloyalty:true ====433 +Тип данных:##// string //##//|## Array<string>##// 318 318 319 - Включает обязательную регистриацию клиента в программе настроенной на объектке.По умолчаниюfalse435 +По умолчанию:##// []//## 320 320 321 - ====personallessonsskillstariffs:[56,57,…]====437 +Скрытие других вкладок виджета («покупка услуг» или «пополнение услуг») при загрузке. Обычно используется в комбинации с параметром forcetab 322 322 323 -Производит фильтрацию тарифов для индивидуальных занятий. Принимает массив идентификаторов. По умолчанию [] 439 +{{code language="javascript"}} 440 +onlytab: 'service' // покажет только вкладку «покупка услуг». 441 +onlytab: 'rewrite' // покажет только вкладку «пополнение услуг». 442 +onlytab: ['service', 'rewrite'] // покажет только вкладки «покупка услуг» и «пополнение услуг»; 443 +{{/code}} 324 324 325 -==== multidayslessonsskillstariffs:[56, 57, … ]====445 +==== ordercomment ==== 326 326 327 - Производитфильтрацию тарифовдля многодневныхзанятий. Принимает массив идентификаторов. Параметр дополняет фильтрацию по параметру grouplessonsskillstariffs. По умолчанию []447 +Тип данных:##// string//## 328 328 329 - ====saletermstype:checkbox'====449 +По умолчанию:##// ''//## 330 330 451 +Опциональный комментарий к заказу. Максимальная длинна комментария 50 символов. 452 + 453 +==== personallessonsskillstariffs ==== 454 + 455 +Тип данных:##// Array<number> //##//|## object##// 456 + 457 +По умолчанию:##// []//## 458 + 459 +Производит фильтрацию тарифов для индивидуальных занятий. Принимает массив идентификаторов. 460 + 461 +==== resetcart ==== 462 + 463 +Тип данных:##// boolean//## 464 + 465 +По умолчанию:##// false//## 466 + 467 +Автоматически очищать содержимое корзины. 468 + 469 +==== requiredloyalty ==== 470 + 471 +Тип данных:##// boolean//## 472 + 473 +По умолчанию:##// false//## 474 + 475 +Включает обязательную регистриацию клиента в программе настроенной на объектке. 476 + 477 +==== saletermstype ==== 478 + 479 +Тип данных:##// string//## 480 + 481 +По умолчанию:##// '//default//'//## 482 + 331 331 Перед оплатой просит пользователя согласиться с правилами в форме галочки или всплывающего окна 332 332 333 -* saletermstype: 'checkbox' потребует установку галочки для согласия. 334 -* saletermstype: 'dialog' покажет всплывающее окно с правилами, которые нужно принять. 335 -* saletermstype: 'default' принятие правил не требуется. 485 +{{code language="javascript"}} 486 +saletermstype: 'checkbox' // потребует установку галочки для согласия. 487 +saletermstype: 'dialog' // покажет всплывающее окно с правилами, которые нужно принять. 488 +saletermstype: 'default' // принятие правил не требуется. 489 +{{/code}} 336 336 337 -По умолчанию 'default' 491 +==== tariffsseancesfilter ==== 492 + 493 +Тип данных:##// boolean//## 494 + 495 +По умолчанию:##// false//## 496 + 497 +[[image:https://info.moipass.ru/images/tariffsseancesfilter.png||alt="Example"]] 498 + 499 +Включить отображение фильтра тарифов по сеансам.
- XWiki.XWikiRights[0]
-
- allow
-
... ... @@ -1,0 +1,1 @@ 1 +Разрешить - levels
-
... ... @@ -1,0 +1,1 @@ 1 +view - users
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.XWikiGuest
- XWiki.XWikiRights[1]
-
- allow
-
... ... @@ -1,0 +1,1 @@ 1 +Запретить - levels
-
... ... @@ -1,0 +1,1 @@ 1 +delete,script,edit,comment - users
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.XWikiGuest