Изменения документа Для_разработчиков
Редактировал(а) Михаил Галич 26.11.2024, 12:16
<
>
отредактировано Михаил Галич
на 12.12.2023, 15:46
на 12.12.2023, 15:46
отредактировано Михаил Галич
на 13.12.2023, 12:44
на 13.12.2023, 12:44
Изменить комментарий:
К данной версии нет комментариев
Комментарий
-
Свойства страницы (1 изменено, 0 добавлено, 0 удалено)
Подробности
- Свойства страницы
-
- Содержимое
-
... ... @@ -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 ##//number//##====122 +==== id ==== 115 115 124 +Тип данных:## //number//## 125 + 116 116 id виджета, который можно узнать в Административной панели 117 117 118 118 == Возможные параметры WPInit == 119 119 120 -==== height :480 ##//number//##====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 ##//number//##====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' ##//string//##====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' ##//string//##====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##//boolean//##====182 +==== disableddates ==== 157 157 158 - Убираеткалендарь внутри виджета (и в //покупке// и в //пополнении//), в случаях, когда дата, на которую покупается/пополняется билет, не важна. По умолчанию false184 +Тип данных:##// Array<string>//## 159 159 160 - ====mindate:'01.01.2019'##//string//##====186 +По умолчанию:##// []//## 161 161 162 -Параметр минимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). mindate: '20.05.2018' покажет 20.05.2018 как самую первую дату, доступную к выбору в календаре, если она находится после текущего дня 188 +Параметр отключения дат в календаре (и в //покупке// и в //пополнении//). Делает невозможным выбор определённых дней в массиве дат. 189 +Пример использования: 163 163 164 -==== maxdate: '01.01.2020' ##//string//## ==== 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' ##//string//##====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', … ] ##//Array<string>//##====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, … ] ##//Array<number>//##====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, … ] ##//Array<number>//## ==== 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, … ] ##//Array<number>//## ==== 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 ##//number//## ==== 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}, … ] ##//Array<object>//##====290 +==== preorder ==== 217 217 292 +Тип данных:##// Array<object>//## 293 + 294 +По умолчанию:##// undefined//## 295 + 218 218 Параметр, позволяющий купить сразу несколько услуг и перейти к подтверждению покупки. 219 219 220 220 * id — id услуги к покупке ... ... @@ -242,121 +242,184 @@ 242 242 243 243 === Отображение === 244 244 245 -==== forcetab :'rewrite' ##//string//##====323 +==== forcetab ==== 246 246 325 +Тип данных:##// string//## 326 + 327 +По умолчанию:##// ''//## 328 + 247 247 Переключение на необходимую вкладку виджета («покупка услуг» или «пополнение услуг») при загрузке. По умолчанию открывается вкладка «покупка услуг». forcetab: 'rewrite' принудительно откроет «пополнение услуг». Обычно используется в комбинации с параметром ##onlytab## 248 248 249 -==== onlytab :'rewrite' ##//string//##====331 +==== onlytab ==== 250 250 333 +Тип данных:##// string //##//|## Array<string>##// 334 + 335 +По умолчанию:##// []//## 336 + 251 251 Скрытие других вкладок виджета («покупка услуг» или «пополнение услуг») при загрузке. Обычно используется в комбинации с параметром forcetab 252 252 253 -* onlytab: 'service' покажет только вкладку «покупка услуг». 254 -* onlytab: 'rewrite' покажет только вкладку «пополнение услуг». 339 +{{code language="javascript"}} 340 +onlytab: 'service' // покажет только вкладку «покупка услуг». 341 +onlytab: 'rewrite' // покажет только вкладку «пополнение услуг». 342 +onlytab: ['service', 'rewrite'] // покажет только вкладки «покупка услуг» и «пополнение услуг»; 343 +{{/code}} 255 255 256 -==== forcemedia :'E0012345678900' ##//string//##====345 +==== forcemedia ==== 257 257 347 +Тип данных:##// string//## 348 + 349 +По умолчанию:##// ''//## 350 + 258 258 Параметр, который вставяет строчку с носителем в поле носителя во вкладке «Пополнение услуг». Используется, например, для QR-кода нанесённого на носитель, чтобы быстро его пополнить. 259 259 260 - ==== nopromo:false ##//boolean//## ====353 +Пример: 261 261 355 +{{code language="javascript"}} 356 +forcemedia: 'E0012345678900' 357 +{{/code}} 358 + 359 +==== nopromo ==== 360 + 361 +Тип данных:##// boolean//## 362 + 363 +По умолчанию:##// false//## 364 + 262 262 Убирает вывод промокода на странице подтверждения заказа. 263 263 264 - Поумолчанию ##false##367 +==== terminal ==== 265 265 266 - ====terminal:true##//boolean//##====369 +Тип данных:##// boolean//## 267 267 371 +По умолчанию:##// false//## 372 + 268 268 Включение режима «терминал» для работы виджета. При этом режиме убирается возможность отослать заказ на SMS, а сам заказ распечатывается на принтере. 269 269 270 -==== cartmaxitems :5 ##//number//##====375 +==== cartmaxitems ==== 271 271 272 -(% class="wikigeneratedid" %) 273 -Ограничивает максимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60. 377 +Тип данных:##// number//## 274 274 379 +По умолчанию:##// 6//## 380 + 275 275 (% class="wikigeneratedid" %) 276 - Поумолчанию##6##382 +Ограничивает максимальное кол-во товаров в корзине. ##Минимальное значение 1. Максимальное значение 60.## 277 277 278 -==== cartminitems :2 ##//number//##====384 +==== cartminitems ==== 279 279 280 - Ограничиваетминимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60.386 +Тип данных:##// number//## 281 281 282 -По умолчанию 388 +По умолчанию:##// 1//## 283 283 284 - ====locale:'ru'##//string//##====390 +Ограничивает минимальное кол-во товаров в корзине. ##Минимальное значение 1. Максимальное значение 60.## 285 285 392 +==== locale ==== 393 + 394 +Тип данных:##// string//## 395 + 396 +По умолчанию:##// ''//## 397 + 286 286 Параметр локализации. Позволяет переключать между языками виджета, например 'ru' - русский язык, 'en' - английский язык. 287 287 288 -==== ordercomment :'Комментарий к заказу' ##//string//##====400 +==== ordercomment ==== 289 289 402 +Тип данных:##// string//## 403 + 404 +По умолчанию:##// ''//## 405 + 290 290 Опциональный комментарий к заказу. Максимальная длинна комментария 50 символов. 291 291 292 -==== disablemultipleseances :true ##//boolean//##====408 +==== disablemultipleseances ==== 293 293 410 +Тип данных:##// boolean//## 411 + 412 +По умолчанию:##// false//## 413 + 294 294 Параметр предотвращает добавление в корзину тарифов с различными сеансами. 295 295 Таким образом как только в корзине появится хоть один товар с сеансом "10:00 - 11:30", товары, у которых есть сеанс например "13:00 - 14:30" будет невозможно добавить в корзину. Товары без сеансов не будут затронуты. 296 -По умолчанию ##false## 297 297 298 -==== tariffsseancesfilter :true ##//boolean//##====417 +==== tariffsseancesfilter ==== 299 299 419 +Тип данных:##// boolean//## 420 + 421 +По умолчанию:##// false//## 422 + 300 300 [[image:https://info.moipass.ru/images/tariffsseancesfilter.png||alt="Example"]] 301 301 302 302 Включить отображение фильтра тарифов по сеансам. 303 303 304 - Поумолчанию ##false##427 +==== resetcart ==== 305 305 306 - ====resetcart:true##//boolean//##====429 +Тип данных:##// boolean//## 307 307 431 +По умолчанию:##// false//## 432 + 308 308 Автоматически очищать содержимое корзины. 309 309 310 - Поумолчанию ##false##435 +==== minimap ==== 311 311 312 - ====minimap:false##//boolean//##====437 +Тип данных:##// boolean//## 313 313 439 +По умолчанию:##// true//## 440 + 314 314 Отображать миникарту. 315 315 316 - Поумолчанию ##true##443 +==== minimapaspect ==== 317 317 318 - ====minimapaspect:0.5##//number//##====445 +Тип данных:##// number//## 319 319 447 +По умолчанию:##// 0.2//## 448 + 320 320 Размер миникарты относительной полного размера карты, а не контейнера, в которой она находится. 321 321 322 - Поумолчанию##0.2##451 +==== forceseanceid ==== 323 323 324 - ====forceseanceid:42##//number//##====453 +Тип данных:##// number//## 325 325 326 -Заставит виджет выбрать мероприятие арены по идентификатору платформы и не позволять вернуться к этапу выбора других мероприятий. 327 - 328 328 По умолчанию без указания идентификатора не учитывается. 329 329 330 - ====forcesectorid:42##//number//##====457 +Заставит виджет выбрать мероприятие арены по идентификатору платформы и не позволять вернуться к этапу выбора других мероприятий. 331 331 332 - Заставитвиджет выбрать сектор мероприятия поidи не позволять вернуться к этапу выбора других секторов.459 +==== forcesectorid ==== 333 333 461 +Тип данных:##// number//## 462 + 334 334 По умолчанию без указания идентификатора не учитывается. 335 335 465 +Заставит виджет выбрать сектор мероприятия по id и не позволять вернуться к этапу выбора других секторов. 466 + 336 336 ==== requiredloyalty: true ##//boolean//## ==== 337 337 469 +Тип данных:##// boolean//## 470 + 471 +По умолчанию:##// false//## 472 + 338 338 Включает обязательную регистриацию клиента в программе настроенной на объектке. 339 339 340 - Поумолчанию ##false##475 +==== personallessonsskillstariffs ==== 341 341 342 - ====personallessonsskillstariffs:[56, 57, … ]##//Array<number>//##====477 +Тип данных:##// Array<number> //##//|## object##// 343 343 479 +По умолчанию:##// []//## 480 + 344 344 Производит фильтрацию тарифов для индивидуальных занятий. Принимает массив идентификаторов. 345 345 346 - Поумолчанию##[]##483 +==== multidayslessonsskillstarif(% style="display:none" %) (%%)fs ==== 347 347 348 - ====multidayslessonsskillstariffs:[56, 57, … ]##//Array<number>//##====485 +Тип данных:##// Array<number> //##//|## object##// 349 349 487 +По умолчанию:##// []//## 488 + 350 350 Производит фильтрацию тарифов для многодневных занятий. Принимает массив идентификаторов. Параметр дополняет фильтрацию по параметру grouplessonsskillstariffs. 351 351 352 -По умолчанию ##[]## 353 - 354 354 ==== saletermstype: 'checkbox' ##//string//## ==== 355 355 356 - Перед оплатой проситпользователясогласиться с правилами в форме галочки или всплывающего окна493 +Тип данных:##// string//## 357 357 358 -* saletermstype: ##'checkbox'## потребует установку галочки для согласия. 359 -* saletermstype: ##'dialog'## покажет всплывающее окно с правилами, которые нужно принять. 360 -* saletermstype: ##'default'## принятие правил не требуется. 495 +По умолчанию:##// '//default//'//## 361 361 362 -По умолчанию ##'default'## 497 +Перед оплатой просит пользователя согласиться с правилами в форме галочки или всплывающего окна 498 + 499 +{{code language="javascript"}} 500 +saletermstype: 'checkbox' // потребует установку галочки для согласия. 501 +saletermstype: 'dialog' // покажет всплывающее окно с правилами, которые нужно принять. 502 +saletermstype: 'default' // принятие правил не требуется. 503 +{{/code}}