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
|
<?php
$title = "noUiSlider - Handles and Slider Values";
$description = "";
$canonical = "nouislider/pips/"
?>
<h1>Adding a scale/pips to a slider</h1>
<section>
<div class="view">
<p>The <code>pips</code> feature allows the generation of points along the slider.</p>
<p>Five options can be set: <code>mode</code> to determine where to place pips, <code>values</code> as additional options for <code>mode</code>, <code>stepped</code> to round pip values to the slider stepping, <code>density</code> to pre-scale the number of pips, and <code>filter</code> to manually modify pip size.</p>
<p>The <code>density</code> value controls how many pips are placed on one percent of the slider range. With the default value of <code>1</code>, there is one pip per percent. For a value of <code>2</code>, a pip is placed for every 2 percent. A value below one will place more than one pip per percentage.</p>
</div>
</section>
<h2>API exposure</h2>
<section>
<div class="view">
<p>Pips can be created when setting up a slider, or by calling <code>pips()</code> in the API. This can be used to update or remove pips after slider creation.</p>
</div>
<div class="side">
<?php code('pips-usage'); ?>
</div>
</section>
<?php sect('range'); ?>
<h2>Range</h2>
<section>
<div class="view">
<p>The <code>range</code> mode uses the slider range to determine where the pips should be. A pip is generated for every range-segment specified.</p>
<h4 class="before-example">Left-to-Right (default):</h4>
<div class="example">
<div class="pips-range" id="pips-range"></div>
</div>
<h4 class="before-example">Right-to-Left:</h4>
<div class="example">
<div class="pips-range" id="pips-range-rtl"></div>
</div>
<h4 class="before-example">Vertical and vertical, bottom-to-top:</h4>
<div class="example vertical" style="width: 150px; float: left">
<div class="pips-range" id="pips-range-vertical"></div>
</div>
<div class="example vertical" style="width: 150px">
<div class="pips-range" id="pips-range-vertical-rtl"></div>
</div>
<?php run('range'); ?>
</div>
<div class="side">
<?php code('range'); ?>
</div>
</section>
<?php sect('steps'); ?>
<h2>Steps</h2>
<section>
<div class="view">
<p>Like <code>range</code>, the <code>steps</code> mode uses the slider range. In <code>steps</code> mode, a pip is generated for every step. The <code>filter</code> option can be used to filter the generated pips.</p>
<p>The <code>filter</code> function must return:</p>
<ul>
<li><code>-1</code> (no pip at all)</li>
<li><code>0</code> (no value)</li>
<li><code>1</code> (large value)</li>
<li><code>2</code> (small value)</li>
</ul>
<br>
<p>Arguments to the <code>filter</code> function are the value (<code>number</code>) and the type (<code>0</code>, <code>1</code> or <code>2</code> like above).</p>
<p>Here, large values are used for every step divisible by a thousand (<code>1000</code>, <code>2000</code>, <code>3000</code>), and small values for every step divisible by 500 (<code>2500</code>, <code>3500</code>, <code>4500</code>).</p>
<p>Pips supports a <code>format</code> option in the same way the slider itself does. Refer to the <a href="../number-formatting/">documentation on number formatting</a> for more information.</p>
<p>Pips are written as HTML. When using user-supplied values in the format option, they might need to be escaped.</p>
</div>
<div class="side">
<?php code('steps'); ?>
</div>
</section>
<section>
<h4 class="before-example">Slider with filtered steps:</h4>
<div class="example">
<div id="pips-steps"></div>
<?php run('steps'); ?>
</div>
</section>
<?php sect('positions'); ?>
<h2>Positions</h2>
<section>
<div class="view">
<p>In <code>positions</code> mode, pips are generated at percentage-based positions on the slider.<p>
</p>Optionally, the <code>stepped</code> option can be set to <code>true</code> to match the pips to the slider steps.</p>
<div class="example">
<div id="pips-positions"></div>
<?php run('positions'); ?>
</div>
<h4 class="before-example">Stepped positions:</h4>
<div class="example">
<div id="pips-positions-stepped"></div>
<?php run('positions-stepped'); ?>
</div>
<p>The positions mode places pips at exactly the provided positions (in percentages) on the slider. For the example, 25% is 1813 on the slider.</p>
<p>If <code>stepped: true</code> is set, the provided percentages are rounded to the nearest user-selectable step on the slider. As 25% is in the <code>'10%': [500, 500]</code> segment of the range, the step value that applies is 500, so the 1813 pip is rounded to the nearest step at 2000.</p>
</div>
<div class="side">
<?php code('positions'); ?>
<?php code('positions-stepped'); ?>
</div>
</section>
<?php sect('count'); ?>
<h2>Count</h2>
<section>
<div class="view">
<p>The <code>count</code> mode can be used to generate a fixed number of pips. As with <code>positions</code> mode, the <code>stepped</code> option can be used.</p>
<div class="example">
<div id="pips-count"></div>
<?php run('count'); ?>
</div>
<h4 class="before-example">Stepped count:</h4>
<div class="example">
<div id="pips-count-stepped"></div>
<?php run('count-stepped'); ?>
</div>
</div>
<div class="side">
<?php code('count'); ?>
<?php code('count-stepped'); ?>
</div>
</section>
<?php sect('values'); ?>
<h2>Values</h2>
<section>
<div class="view">
<p>The <code>values</code> mode is similar to <code>positions</code>, but it accepts values instead of percentages. The <code>stepped</code> option can be used for this mode.</p>
<div class="example">
<div id="pips-values"></div>
<?php run('values'); ?>
</div>
<h4 class="before-example">Stepped values:</h4>
<p>Note how overlapping pips are merged with the <code>stepped</code> option set.</p>
<div class="example">
<div id="pips-values-stepped"></div>
<?php run('values-stepped'); ?>
</div>
</div>
<div class="side">
<?php code('values'); ?>
<?php code('values-stepped'); ?>
</div>
</section>
|
