This repository has been archived by the owner on Feb 12, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 11
/
kgallery_docs.html
595 lines (556 loc) · 38.7 KB
/
kgallery_docs.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="viewport" content="width=device-width; initial-scale=1.0" />
<link rel="stylesheet" href="/css/kopolo.css" />
<title>kGallery Documentation</title>
</head>
<body>
<div id="pagewrapper">
<header id='header' class='header'>
<a href="/" id='logo'><img src="/i/logo.png" alt='Kopolo_logo'/></a>
<div class='clear separator'></div>
</header>
<div id="content">
<div class="words_on_page">
<h1 class="main_name">kGallery Documentation</h1>
<div class="gradient"></div>
<div class="separator"></div>
<div class="demo_links">
<ul>
<li><span>Documentation</span></li>
<li><a href="https://github.com/andruhon/kGallery">Page on GitHub</a></li>
<li><a href="https://github.com/andruhon/kGallery/issues">Report bug</a></li>
<li><a href="https://github.com/andruhon/kGallery/tags">Download</a></li>
</ul>
<h3>kGallery demos</h3>
<ul>
<li><a href="example_slideshow_only.html">Slideshow only</a></li>
<li><a href="example_thumbnails_only.html">Thumbnails only</a></li>
<li><a href="example_typical.html">Typical usage</a></li>
<li><a href="example_vertical.html">Vertical thumbnails</a></li>
</ul>
</div>
<div class="clear"></div>
<div style="width: 95%;">
<h3>JavaScript and jQuery gallery which able to function efficiently with hundreds of photos.</h3>
<p>First significant advantage of this gallery is ability to work stable with hundreds of pictures or with huge pictures without freezing browser. This effect is achieved by retrieving the list of images from the external source (JSON or XML) and downloading pictures gradually while slideshow is playing, not all in once.</p>
<p>kGallery includes kSlideshow and kThumbnailPicker components, each of them could be used independently.</p>
<p><i>
Note that this gallery is supposed to work on server not on local computer. Most of browsers will refuse XHR request to JSON list of pictures which is located on local file system (such as file:///C:/gallery/files.json). Try to use <a href="https://github.com/andruhon/kSimpleSlides">kSimpleSlides</a> if you need just simple slideshow which works without JSON and XHR stuff.
</i></p>
<p>
Do not hesitate to contact author if you have any questions or enquiries about kGallery:<br />
Andrew Kondratev e-mail:<a href="mailto:andr@kopolo.ru">andr@kopolo.ru</a><br />
Andrew speaks Russian and English.
</p>
<h3>Usage</h3>
<ol>
<li>Prepare files to play in slideshow. Place them somewhere on your server. Make sure that files are available to view in browser.</li>
<li>Prepare JSON file with pictures list.<br />
JSON is JavaScript Object Notation, so JSON file is just text file which contains text with following structure:
<pre>
<span style='color:#800080; '>{</span> <span style='color:#800000; '>"</span><span style='color:#0000e6; '>items</span><span style='color:#800000; '>"</span><span style='color:#800080; '>:</span> <span style='color:#808030; '>[</span>
<span style='color:#800080; '>{</span>
<span style='color:#800000; '>"</span><span style='color:#0000e6; '>large</span><span style='color:#800000; '>"</span><span style='color:#800080; '>:</span><span style='color:#800000; '>"</span><span style='color:#0000e6; '>web_path_to_picture1.jpg </span><span style='color:#800000; '>"</span><span style='color:#808030; '>,</span>
<span style='color:#800000; '>"</span><span style='color:#0000e6; '>thumb</span><span style='color:#800000; '>"</span><span style='color:#800080; '>:</span><span style='color:#800000; '>"</span><span style='color:#0000e6; '>web_path_to_picture1_thumbnail.jpg</span><span style='color:#800000; '>"</span><span style='color:#808030; '>,</span>
<span style='color:#800000; '>"</span><span style='color:#0000e6; '>title</span><span style='color:#800000; '>"</span><span style='color:#800080; '>:</span><span style='color:#800000; '>"</span><span style='color:#0000e6; '>title for first picture</span><span style='color:#800000; '>"</span>
<span style='color:#800080; '>}</span><span style='color:#808030; '>,</span>
<span style='color:#800080; '>{</span>
<span style='color:#800000; '>"</span><span style='color:#0000e6; '>large</span><span style='color:#800000; '>"</span><span style='color:#800080; '>:</span><span style='color:#800000; '>"</span><span style='color:#0000e6; '>web_path_to_picture2.jpg </span><span style='color:#800000; '>"</span><span style='color:#808030; '>,</span>
<span style='color:#800000; '>"</span><span style='color:#0000e6; '>thumb</span><span style='color:#800000; '>"</span><span style='color:#800080; '>:</span><span style='color:#800000; '>"</span><span style='color:#0000e6; '>web_path_to_picture2_thumbnail.jpg</span><span style='color:#800000; '>"</span><span style='color:#808030; '>,</span>
<span style='color:#800000; '>"</span><span style='color:#0000e6; '>title</span><span style='color:#800000; '>"</span><span style='color:#800080; '>:</span><span style='color:#800000; '>"</span><span style='color:#0000e6; '>title for second</span><span style='color:#800000; '>"</span>
<span style='color:#800080; '>}</span>
<span style='color:#696969; '>/*, more items*/</span>
<span style='color:#808030; '>]</span><span style='color:#800080; '>}</span>
</pre>
<p>Save this file somwhere on your server with .json extension and make sure that it is available in your browser. Remember web path to this file, you need it for step 6 of this tutorial.</p>
</li>
<li>Include jQuery and kGallery into HTML of your page:
<pre>
<span style='color:#a65700; '><</span><span style='color:#5f5035; '>script</span> <span style='color:#274796; '>type</span><span style='color:#808030; '>=</span><span style='color:#0000e6; '>"</span><span style='color:#0000e6; '>text/javascript</span><span style='color:#0000e6; '>"</span> <span style='color:#274796; '>src</span><span style='color:#808030; '>=</span><span style='color:#0000e6; '>"</span><span style='color:#0000e6; '>http://code.jquery.com/jquery-1.7.2.min.js</span><span style='color:#0000e6; '>"</span><span style='color:#a65700; '>></span><span style='color:#a65700; '></</span><span style='color:#5f5035; '>script</span><span style='color:#a65700; '>></span>
<span style='color:#a65700; '><</span><span style='color:#5f5035; '>script</span> <span style='color:#274796; '>type</span><span style='color:#808030; '>=</span><span style='color:#0000e6; '>"</span><span style='color:#0000e6; '>text/javascript</span><span style='color:#0000e6; '>"</span> <span style='color:#274796; '>src</span><span style='color:#808030; '>=</span><span style='color:#0000e6; '>"</span><span style='color:#0000e6; '>js/kGallery-full.min.js</span><span style='color:#0000e6; '>"</span><span style='color:#a65700; '>></span><span style='color:#a65700; '></</span><span style='color:#5f5035; '>script</span>
</pre>
</li>
<li>Add some custom styles for your gallery:
<pre>
<<span style='color:#800000; font-weight:bold; '>style</span><span style='color:#808030; '>></span>
<span style='color:#696969; '>/* gallery wrapper dimensions */</span>
<span style='color:#808030; '>#</span>gallery-wrapper<span style='color:#800080; '>{</span> <span style='color:#bb7977; font-weight:bold; '>height</span><span style='color:#808030; '>:</span> <span style='color:#008c00; '>400</span><span style='color:#006600; '>px</span><span style='color:#800080; '>;</span> <span style='color:#bb7977; font-weight:bold; '>width</span><span style='color:#808030; '>:</span> <span style='color:#008c00; '>400</span><span style='color:#006600; '>px</span><span style='color:#800080; '>;</span> <span style='color:#bb7977; font-weight:bold; '>text-align</span><span style='color:#808030; '>:</span> <span style='color:#074726; '>center</span><span style='color:#800080; '>;</span> <span style='color:#800080; '>}</span>
<span style='color:#696969; '>/* slide dimensions */</span>
<span style='color:#808030; '>.</span>kSlideshowWrapper<span style='color:#808030; '>,</span> <span style='color:#808030; '>.</span>kSlideshowItemDiv<span style='color:#800080; '>{</span> <span style='color:#bb7977; font-weight:bold; '>width</span><span style='color:#808030; '>:</span> <span style='color:#008c00; '>400</span><span style='color:#006600; '>px</span><span style='color:#800080; '>;</span> <span style='color:#bb7977; font-weight:bold; '>height</span><span style='color:#808030; '>:</span> <span style='color:#008c00; '>267</span><span style='color:#006600; '>px</span><span style='color:#800080; '>;</span> <span style='color:#800080; '>}</span>
<span style='color:#696969; '>/* picture styles */</span>
<span style='color:#808030; '>.</span>kSlideshowItemDiv <span style='color:#800000; font-weight:bold; '>img</span><span style='color:#800080; '>{</span> <span style='color:#bb7977; font-weight:bold; '>z-index</span><span style='color:#808030; '>:</span> <span style='color:#008c00; '>400</span><span style='color:#800080; '>;</span> <span style='color:#800080; '>}</span>
<span style='color:#696969; '>/* thumbnails wrapper dimensions */</span>
<span style='color:#808030; '>.</span>kThumbnailsWrapper<span style='color:#800080; '>{</span> <span style='color:#bb7977; font-weight:bold; '>width</span><span style='color:#808030; '>:</span> <span style='color:#008c00; '>324</span><span style='color:#006600; '>px</span><span style='color:#800080; '>;</span> <span style='color:#bb7977; font-weight:bold; '>height</span><span style='color:#808030; '>:</span> <span style='color:#008c00; '>80</span><span style='color:#006600; '>px</span><span style='color:#800080; '>;</span> <span style='color:#bb7977; font-weight:bold; '>margin</span><span style='color:#808030; '>:</span> <span style='color:#008c00; '>10</span><span style='color:#006600; '>px</span> <span style='color:#074726; '>auto</span> <span style='color:#008c00; '>0</span> <span style='color:#074726; '>auto</span><span style='color:#800080; '>;</span> <span style='color:#800080; '>}</span>
<span style='color:#808030; '>.</span>kThumbnailsInnerWrapper<span style='color:#800080; '>{</span> <span style='color:#bb7977; font-weight:bold; '>height</span><span style='color:#808030; '>:</span> <span style='color:#008c00; '>80</span><span style='color:#006600; '>px</span><span style='color:#800080; '>;</span> <span style='color:#bb7977; font-weight:bold; '>width</span><span style='color:#808030; '>:</span> <span style='color:#008c00; '>324</span><span style='color:#006600; '>px</span><span style='color:#800080; '>;</span> <span style='color:#800080; '>}</span>
<span style='color:#696969; '>/* thumbnails page dimensions */</span>
<span style='color:#808030; '>.</span>kThumbnailsPage<span style='color:#800080; '>{</span> <span style='color:#bb7977; font-weight:bold; '>width</span><span style='color:#808030; '>:</span> <span style='color:#008c00; '>324</span><span style='color:#006600; '>px</span><span style='color:#800080; '>;</span> <span style='color:#bb7977; font-weight:bold; '>text-align</span><span style='color:#808030; '>:</span> <span style='color:#074726; '>left</span><span style='color:#800080; '>;</span> <span style='color:#800080; '>}</span>
<span style='color:#696969; '>/* thumbnail styles */</span>
<span style='color:#808030; '>.</span>kThumbnailsPage <span style='color:#800000; font-weight:bold; '>img</span><span style='color:#800080; '>{</span> <span style='color:#bb7977; font-weight:bold; '>padding</span><span style='color:#808030; '>:</span> <span style='color:#008c00; '>1</span><span style='color:#006600; '>px</span><span style='color:#800080; '>;</span> <span style='color:#bb7977; font-weight:bold; '>border</span><span style='color:#808030; '>:</span> <span style='color:#008c00; '>1</span><span style='color:#006600; '>px</span> <span style='color:#074726; '>solid</span> <span style='color:#797997; '>black</span><span style='color:#800080; '>;</span> <span style='color:#bb7977; font-weight:bold; '>margin</span><span style='color:#808030; '>:</span> <span style='color:#008c00; '>2</span><span style='color:#006600; '>px</span><span style='color:#800080; '>;</span> <span style='color:#800080; '>}</span>
<span style='color:#696969; '>/* selected thumbnail styles */</span>
<span style='color:#808030; '>.</span>kThumbnailsPage <span style='color:#808030; '>.</span>selectedThumbnail<span style='color:#800080; '>{</span> <span style='color:#bb7977; font-weight:bold; '>border-color</span><span style='color:#808030; '>:</span> <span style='color:#008c00; '>#</span><span style='color:#008000; '>aaaaff</span><span style='color:#800080; '>;</span> <span style='color:#800080; '>}</span>
</<span style='color:#800000; font-weight:bold; '>style</span><span style='color:#808030; '>></span>
</pre>
</li>
<li>Put gallery wrapper into HTML of your page
<pre>
<span style='color:#a65700; '><</span><span style='color:#5f5035; '>h2</span><span style='color:#a65700; '>></span>Plugin usage of kGallery<span style='color:#a65700; '></</span><span style='color:#5f5035; '>h2</span><span style='color:#a65700; '>></span>
<span style='color:#a65700; '><</span><span style='color:#5f5035; '>div</span> <span style='color:#274796; '>id</span><span style='color:#808030; '>=</span><span style='color:#0000e6; '>"</span><span style='color:#0000e6; '>gallery-wrapper</span><span style='color:#0000e6; '>"</span><span style='color:#a65700; '>></span><span style='color:#a65700; '></</span><span style='color:#5f5035; '>div</span><span style='color:#a65700; '>></span>
</pre>
</li>
<li>Init your kGallery
<pre>
<span style='color:#808030; '><</span>script type<span style='color:#808030; '>=</span><span style='color:#800000; '>"</span><span style='color:#0000e6; '>text/javascript</span><span style='color:#800000; '>"</span><span style='color:#808030; '>></span>
$<span style='color:#808030; '>(</span>document<span style='color:#808030; '>)</span><span style='color:#808030; '>.</span>ready<span style='color:#808030; '>(</span><span style='color:#800000; font-weight:bold; '>function</span><span style='color:#808030; '>(</span><span style='color:#808030; '>)</span> <span style='color:#800080; '>{</span>
<span style='color:#696969; '>//initializing plugin with url string</span>
$<span style='color:#808030; '>(</span><span style='color:#0000e6; '>'#gallery-wrapper'</span><span style='color:#808030; '>)</span><span style='color:#808030; '>.</span>kGallery<span style='color:#808030; '>(</span><span style='color:#0000e6; '>'web_path_to_your_pictures_list.json'</span><span style='color:#808030; '>)</span><span style='color:#800080; '>;</span>
<span style='color:#696969; '>/*</span>
<span style='color:#696969; '>    \\initializing plugin with options object</span>
<span style='color:#696969; '>    $('#gallery-wrapper').kGallery({</span>
<span style='color:#696969; '>        dataSource: 'web_path_to_your_pictures_list.json',</span>
<span style='color:#696969; '>        startItem: 2</span>
<span style='color:#696969; '>    });</span>
<span style='color:#696969; '>    */</span>
<span style='color:#696969; '>/*</span>
<span style='color:#696969; '>    \\initializing plugin with options object and array data-source</span>
<span style='color:#696969; '>    $('#gallery-wrapper').kGallery({</span>
<span style='color:#696969; '>        dataType: 'array',</span>
<span style='color:#696969; '>        dataSource:[{</span>
<span style='color:#696969; '>          "large":"img1.jpg",</span>
<span style='color:#696969; '>          "thumb":"img1_sml.jpg",</span>
<span style='color:#696969; '>          "title":"title!"</span>
<span style='color:#696969; '>        },</span>
<span style='color:#696969; '>        {</span>
<span style='color:#696969; '>          "large":"img2.jpg",</span>
<span style='color:#696969; '>          "thumb":"img2_sml.jpg",</span>
<span style='color:#696969; '>          "title":"title2!"</span>
<span style='color:#696969; '>        }],</span>
<span style='color:#696969; '>    });</span>
<span style='color:#696969; '>    */</span>
<span style='color:#696969; '>// you can check all possible settings below</span>
<span style='color:#800080; '>}</span><span style='color:#808030; '>)</span><span style='color:#800080; '>;</span>
<span style='color:#808030; '><</span><span style='color:#808030; '>/</span>script<span style='color:#808030; '>></span>
</pre>
</li>
</ol>
<h3>Notes</h3>
<p>kGallery will destroy previous kGallery instance if you try to initialize it on the wrapper with initialized instance</p>
<p>If you try to initialize gallery without options it will return kGallery instance initialized on this wrapper if it is initialized otherwise FALSE.</p>
<p>visit <a href="/for_webmasters/kgallery/example_typical.html">demos</a> section for live usage examples.</p>
</div>
<h3 id='kGallery_header'>kGallery</h3>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Default value</th>
<th>Data type</th>
</tr>
</thead>
<tbody>
<tr>
<td>wrapper</td>
<td>Gallery wrapper. If collection of elements is given, displays the same slideshow obeying same commands in all wrappers. Calls new kSlideshow to create independent slideshow. </td>
<td>#gallery-wrapper</td>
<td>string or $.object</td>
</tr>
<tr>
<td>dataSource</td>
<td>Url with the data for gallery (JSON usually), see jQuery.ajax() or JavaScript array (should replace dataType to array)</td>
<td>data.json</td>
<td>string | array</td>
</tr>
<tr>
<td>dataType</td>
<td>Data type, see jQuery.ajax() + 'array' option</td>
<td>json</td>
<td>string</td>
</tr>
<tr>
<td>startItem</td>
<td>index of initial slide</td>
<td>0</td>
<td>integer</td>
</tr>
<tr>
<td>slideshowOptions</td>
<td>Additional settings for <a href="#kSlideshow_header">kSlideshow</a></td>
<td></td>
<td>object</td>
</tr>
<tr>
<td>thumbnailPickerOptions</td>
<td>Additional settings for <a href="#kThumbnailPicker_header">kThumbnailPicker</a></td>
<td></td>
<td>object</td>
</tr>
<tr>
<td>wrapperClass</td>
<td>CSS class, which is added to gallery wrapper</td>
<td>kGallery</td>
<td>string</td>
</tr>
<tr>
<td>selectedThumbnailClass</td>
<td>CSS class, which is added to selected thumbnail</td>
<td>selectedThumbnail</td>
<td>string</td>
</tr>
<tr>
<td>afterInit</td>
<td>Function, which is called after initialization</td>
<td></td>
<td>function</td>
</tr>
<tr>
<td>beforeShow</td>
<td>Function, which is called before displaying of picture</td>
<td>function (itemIndex)</td>
<td>function</td>
</tr>
<tr>
<td>destroy</td>
<td>Function to destroy kGallery instance</td>
<td>function ()</td>
<td>function</td>
</tr>
</tbody>
</table>
<h3 id='kSlideshow_header'>kSlideshow (for Slideshow only)</h3>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Default value</th>
<th>Data type</th>
</tr>
</thead>
<tbody>
<tr>
<td>wrapper</td>
<td>Slideshow wrapper. If collection of elements is given, displays the same slideshow obeying same commands in all wrappers. Calls new kSlideshow to create independent slideshow</td>
<td>#slideshow-wrapper</td>
<td>string or $.object</td>
</tr>
<tr>
<td>dataSource</td>
<td>Url with the data for gallery (JSON usually), see jQuery.ajax() or JavaScript array (should replace dataType to array)</td>
<td>data.json</td>
<td>string | array</td>
</tr>
<tr>
<td>dataType</td>
<td>Data type, see jQuery.ajax() + 'array' option</td>
<td>json</td>
<td>string</td>
</tr>
<tr>
<td>autoPlay</td>
<td>Start slideshow playback automatically</td>
<td>true</td>
<td>boolean</td>
</tr>
<tr>
<td>startItem</td>
<td>index of initial slide</td>
<td>0</td>
<td>integer</td>
</tr>
<tr>
<td>preloadImagesCount</td>
<td>Number of preloading pictures. Gallery preloads {preloadImagesCount} pictures before and after current slide.</td>
<td>2</td>
<td>integer</td>
</tr>
<tr>
<td>nextAttempts</td>
<td>Number of attempts before flipping to the next slide (when slideshow is playing).If slide picture is not loaded yet kSlideshow prevents automatic flipping to the next slide {nextAttempts} times. if 0 or 1 is given, flipping automatically without waiting until picture is downloaded.</td>
<td>4</td>
<td>integer</td>
</tr>
<tr>
<td>interval</td>
<td>Interval between slides flipping, milliseconds</td>
<td>2000</td>
<td>integer</td>
</tr>
<tr>
<td>fadeDelay</td>
<td>Slides appearance speed, milliseconds</td>
<td>400</td>
<td>integer</td>
</tr>
<tr>
<td>itemDivClass</td>
<td>CSS class for slides wrappers (adds to item div)</td>
<td>kSlideshowItemDiv</td>
<td>string</td>
</tr>
<tr>
<td>enableControls</td>
<td>Create controls automatically</td>
<td>true</td>
<td>boolean</td>
</tr>
<tr>
<td>enableTitle</td>
<td>Turn on displaying of titles</td>
<td>true</td>
<td>boolean</td>
</tr>
<tr>
<td>enableAlt</td>
<td>Turn on adding of alt and title attributes to slideshow images</td>
<td>true</td>
<td>boolean</td>
</tr>
<tr>
<td>displayEmptyTitle</td>
<td>Always display title block even if title is empty</td>
<td>false</td>
<td>boolean</td>
</tr>
<tr>
<td>wrapperClass</td>
<td>CSS class for slideshow wrapper (adds to wrapper)</td>
<td>kSlideshowWrapper</td>
<td>string</td>
</tr>
<tr>
<td>playToggleClass</td>
<td>CSS class for "play/pause" toggle (adds to "play/pause" button)</td>
<td>kSlideshowPlayToggle</td>
<td>string</td>
</tr>
<tr>
<td>playClass</td>
<td>CSS class for "play" button (adds to "play/pause" button when slideshow is on the pause)</td>
<td>kSlideshowPlay</td>
<td>string</td>
</tr>
<tr>
<td>pauseClass</td>
<td>CSS class for "pause" button (adds to "play/pause" button when slideshow is playing)</td>
<td>kSlideshowPause</td>
<td>string</td>
</tr>
<tr>
<td>nextClass</td>
<td>CSS class for "next" button (adds to "next" button)</td>
<td>kSlideshowNext</td>
<td>string</td>
</tr>
<tr>
<td>prevClass</td>
<td>CSS class for "prev" button (adds to "prev" button)</td>
<td>kSlideshowPrev</td>
<td>string</td>
</tr>
<tr>
<td>titleClass</td>
<td>CSS class for title (adds to title block)</td>
<td>kSlideshowTitle</td>
<td>string</td>
</tr>
<tr>
<td>controlsInactiveClass</td>
<td>CSS class for inactive controls buttons (adds to inactive controls)</td>
<td>inactive</td>
<td>string</td>
</tr>
<tr>
<td>loadedClass</td>
<td>CSS class for downloaded pictures (adds to picture when downloading of it is finished)</td>
<td>loaded</td>
<td>string</td>
</tr>
<tr>
<td>afterInit</td>
<td>Function which called after initialization of a slidewhow</td>
<td></td>
<td>function</td>
</tr>
<tr>
<td>beforeShow</td>
<td>Function which called before displaying of a slide (node of a slide can be not created yet if this slide displayed first time). @param integer indexItem - index of current item</td>
<td>function (itemIndex)</td>
<td>function</td>
</tr>
<tr>
<td>beforeAnimation</td>
<td>Middleware event between beforeShow and afterShow. Function which is called before fadeIn animation when DOM node of slide is created already. @param integer indexItem - index of current item. @param object itemNode - DOM node of the slide.</td>
<td>function (itemIndex, itemNode)</td>
<td>function</td>
</tr>
<tr>
<td>afterShow</td>
<td>Function which is called when fadeIn animation of the slide is finished</td>
<td></td>
<td>function</td>
</tr>
<tr>
<td>onLoadingError</td>
<td>Function which is called on parsing data error</td>
<td>function (jqXHR, textStatus, errorThrown)</td>
<td>function</td>
</tr>
<tr>
<td>destroy</td>
<td>Function to destroy kSlideshow instance</td>
<td>function ()</td>
<td>function</td>
</tr>
</tbody>
</table>
<h3 id='kThumbnailPicker_header'>kThumbnailPicker (for Thumbnails only)</h3>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Default value</th>
<th>Data type</th>
</tr>
</thead>
<tbody>
<tr>
<td>wrapper</td>
<td>thumbnails wrappers</td>
<td>#thumbnails-wrapper</td>
<td>string or $.object</td>
</tr>
<tr>
<td>dataSource</td>
<td>Url with the data for gallery (JSON usually), see jQuery.ajax() or JavaScript array (should replace dataType to array)</td>
<td>data.json</td>
<td>string | array</td>
</tr>
<tr>
<td>dataType</td>
<td>Data type, see jQuery.ajax() + 'array' option</td>
<td>json</td>
<td>string</td>
</tr>
<tr>
<td>vertical</td>
<td>Vertical scrolling</td>
<td>false</td>
<td>boolean</td>
</tr>
<tr>
<td>itemsOnPage</td>
<td>Number of previews on page. Do not forget to set correct size for the wrapper and the innerWrapper, considering the width, height and number of items on page.</td>
<td>3</td>
<td>integer</td>
</tr>
<tr>
<td>preloadPagesCount</td>
<td>Number of preloading pages. Only thumbnails for next(and previous) {preloadPagesCount} pages are downloading, When you switching to the next page - thumbnails of next+{preloadPagesCount} page are downloading (if them are not downloaded yet)</td>
<td>2</td>
<td>integer</td>
</tr>
<tr>
<td>startItem</td>
<td>Index of initial slide. Index of initial page will be calculated automatically.</td>
<td>0</td>
<td>integer</td>
</tr>
<tr>
<td>wrapperClass</td>
<td>CSS class, which adds to the thumbnails wrapper</td>
<td>kThumbnailsWrapper</td>
<td>string</td>
</tr>
<tr>
<td>innerWrapperClass</td>
<td>CSS class, which adds to the thumbnails inner wrapper</td>
<td>kThumbnailsInnerWrapper</td>
<td>string</td>
</tr>
<tr>
<td>nextPageClass</td>
<td>CSS class, which adds to next page button</td>
<td>kThumbnailsNextPage</td>
<td>string</td>
</tr>
<tr>
<td>prevPageClass</td>
<td>CSS class, which adds to previous page button</td>
<td>kThumbnailsPrevPage</td>
<td>string</td>
</tr>
<tr>
<td>controlsInactiveClass</td>
<td>CSS class, which adds to inactive control elements</td>
<td>inactive</td>
<td>string</td>
</tr>
<tr>
<td>pageClass</td>
<td>CSS class, which adds to all thumbnails pages</td>
<td>kThumbnailsPage</td>
<td>string</td>
</tr>
<tr>
<td>enableControls</td>
<td>Enable auto creation of control elements for thumbnails</td>
<td>true</td>
<td>boolean</td>
</tr>
<tr>
<td>scrollingEffect</td>
<td>Animation effect for pages scrolling: 'slide' or 'fade'</td>
<td>slide</td>
<td>string</td>
</tr>
<tr>
<td>scrollingSpeed</td>
<td>Speed of scrolling, milliseconds</td>
<td>1000</td>
<td>integer</td>
</tr>
<tr>
<td>afterInit</td>
<td>Function, which is called after initialization of thumbnails</td>
<td></td>
<td>function</td>
</tr>
<tr>
<td>beforeShow</td>
<td>Function, which is called before changing of page. @param boolean nextOrPrev - true is passed if showPage called by instance.next or instance.prev methods.</td>
<td>function (nextOrPrev)</td>
<td>function</td>
</tr>
<tr>
<td>afterShow</td>
<td>Function, which is called after changing of page. @param boolean nextOrPrev - true is passed if showPage called by instance.next or instance.prev methods</td>
<td>function (nextOrPrev)</td>
<td>function</td>
</tr>
<tr>
<td>thumbnailClick</td>
<td>Function, which is called on thumbnail click. @param integer itemIndex - index of clicked thumbnail.</td>
<td>function (itemIndex)</td>
<td>function</td>
</tr>
<tr>
<td>destroy</td>
<td>Function to destroy kThumbnailPicker instance</td>
<td>function ()</td>
<td>function</td>
</tr>
</tbody>
</table>
</div> <!--end of .words_on_page-->
<div class="separator"></div>
</div> <!--end of #content-->
<div id='feedback_bottom'>
</div> <!--end of #feedback_bottom-->
</div> <!--end of #pagewrapper-->
</body>
</html>