Skip to content

Commit 89b6bbf

Browse files
committed
Split property docs into related subsections
1 parent 1c67e63 commit 89b6bbf

File tree

1 file changed

+42
-30
lines changed

1 file changed

+42
-30
lines changed

README.md

Lines changed: 42 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -46,182 +46,183 @@ which is fired asynchronously. This allows multiple properties to be changed
4646
with only one invocation fired, reducing overhead and potentially expensive
4747
DOM transactions.
4848

49+
<!-- TODO: Use a real documentation language instead of Markdown -->
4950

50-
### `transform`
51-
**Type:** [`Array`][]
52-
**Read-only**
53-
54-
A 3x3 affine transform matrix composed from the current values of the
55-
instance's [`pan`][] and [`zoom`][] properties.
51+
### Panning
5652

57-
58-
### `pan`
53+
#### `pan`
5954
**Default:** `[0, 0]`
6055
**Type:** [`Array`][]
6156
**Fires callbacks:** [`updatePan`][], [`update`][]
6257

6358
An array containing the values of [`panX`][] and [`panY`][].
6459

6560

66-
### `panX`
61+
#### `panX`
6762
**Default:** `0`
6863
**Type:** [`Number`][]
6964
**Fires callbacks:** [`updatePan`][], [`update`][]
7065

7166
Horizontal pan offset.
7267

7368

74-
### `panY`
69+
#### `panY`
7570
**Default:** `0`
7671
**Type:** [`Number`][]
7772
**Fires callbacks:** [`updatePan`][], [`update`][]
7873

7974
Vertical pan offset.
8075

8176

82-
### `minPanX`
77+
#### `minPanX`
8378
**Default:** [`Number.NEGATIVE_INFINITY`][]
8479
**Type:** [`Number`][]
8580

8681
Minimum possible [`panX`][] value.
8782

8883

89-
### `minPanY`
84+
#### `minPanY`
9085
**Default:** [`Number.NEGATIVE_INFINITY`][]
9186
**Type:** [`Number`][]
9287

9388
Minimum possible [`panY`][] value.
9489

9590

96-
### `maxPanX`
91+
#### `maxPanX`
9792
**Default:** [`Number.POSITIVE_INFINITY`][]
9893
**Type:** [`Number`][]
9994

10095
Maximum possible [`panX`][] value.
10196

10297

103-
### `maxPanY`
98+
#### `maxPanY`
10499
**Default:** [`Number.POSITIVE_INFINITY`][]
105100
**Type:** [`Number`][]
106101

107102
Maximum possible [`panY`][] value.
108103

109104

110-
### `origin`
105+
### Transform origin
106+
107+
#### `origin`
111108
**Default:** `[0, 0]`
112109
**Type:** [`Array`][]
113110
**Fires callbacks:** [`updateOrigin`][], [`update`][]
114111

115112
An array containing the values of [`originX`][] and [`originY`][].
116113

117114

118-
### `originX`
115+
#### `originX`
119116
**Default:** `0`
120117
**Type:** [`Number`][]
121118
**Fires callbacks:** [`updateOrigin`][], [`update`][]
122119

123120
Horizontal ordinate of transformation centre.
124121

125122

126-
### `originY`
123+
#### `originY`
127124
**Default:** `0`
128125
**Type:** [`Number`][]
129126
**Fires callbacks:** [`updateOrigin`][], [`update`][]
130127

131128
Vertical ordinate of transformation centre.
132129

133130

134-
### `minOriginX`
131+
#### `minOriginX`
135132
**Default:** [`Number.NEGATIVE_INFINITY`][]
136133
**Type:** [`Number`][]
137134

138135
Minimum possible [`originX`][] value.
139136

140137

141-
### `minOriginY`
138+
#### `minOriginY`
142139
**Default:** [`Number.NEGATIVE_INFINITY`][]
143140
**Type:** [`Number`][]
144141

145142
Minimum possible [`originY`][] value.
146143

147144

148-
### `maxOriginX`
145+
#### `maxOriginX`
149146
**Default:** [`Number.POSITIVE_INFINITY`][]
150147
**Type:** [`Number`][]
151148

152149
Maximum possible [`originX`][] value.
153150

154151

155-
### `maxOriginY`
152+
#### `maxOriginY`
156153
**Default:** [`Number.POSITIVE_INFINITY`][]
157154
**Type:** [`Number`][]
158155

159156
Maximum possible [`originY`][] value.
160157

161158

162-
### `zoom`
159+
### Zooming
160+
161+
#### `zoom`
163162
**Default:** `1.0`
164163
**Type:** [`Number`][]
165164
**Fires callbacks:** [`updateZoom`][], [`update`][]
166165

167166
Magnification amount, expressed as a positive multiplier.
168167

169168

170-
### `minZoom`
169+
#### `minZoom`
171170
**Default:** `0`
172171
**Type:** [`Number`][]
173172

174173
Minimum possible [`zoom`][] value.
175174

176175

177-
### `maxZoom`
176+
#### `maxZoom`
178177
**Default:** [`Number.POSITIVE_INFINITY`][]
179178
**Type:** [`Number`][]
180179

181180
Maximum possible [`zoom`][] value.
182181

183182

184-
### `update`
183+
### Callbacks
184+
185+
#### `update`
185186
**Default:** `() => {}` (noop)
186187
**Type:** [`Function`][]
187188
**Arguments:** None
188189

189190
Callback to trigger each time a property is modified.
190191

191192

192-
### `updateOrigin`
193+
#### `updateOrigin`
193194
**Default:** `() => {}` (noop)
194195
**Type:** [`Function`][]
195196
**Arguments:** `[fromX, fromY]`, `[toX, toY]`
196197

197198
Callback to trigger each time [`originX`][] or [`originY`][] are modified.
198199

199200

200-
### `updatePan`
201+
#### `updatePan`
201202
**Default:** `() => {}` (noop)
202203
**Type:** [`Function`][]
203204
**Arguments:** `[fromX, fromY]`, `[toX, toY]`
204205

205206
Callback to trigger each time [`panX`][] or [`panY`][] are modified.
206207

207208

208-
### `updateZoom`
209+
#### `updateZoom`
209210
**Default:** `() => {}` (noop)
210211
**Type:** [`Function`][]
211212
**Arguments:** `from`, `to`
212213

213214
Callback to trigger each time [`zoom`][] is modified.
214215

215216

216-
### `updateDelay`
217+
#### `updateDelay`
217218
**Default:** `0`
218219
**Type:** [`Number`][]
219220

220221
Milliseconds to delay callbacks by whenever properties change.
221222
Used by the class's [`debounce`][] method when throttling callback functions.
222223

223224

224-
### `updateEarly`
225+
#### `updateEarly`
225226
**Default:** `true`
226227
**Type:** [`Boolean`][]
227228

@@ -231,6 +232,17 @@ is assigned a value greater than zero, and when multiple successive updates
231232
are expected (such as during a click-and-drag operation).
232233

233234

235+
### Misc
236+
237+
#### `transform`
238+
**Type:** [`Array`][]
239+
**Read-only**
240+
241+
A 3x3 affine transform matrix composed from the current values of the
242+
instance's [`pan`][] and [`zoom`][] properties.
243+
244+
245+
234246

235247
Methods
236248
-------

0 commit comments

Comments
 (0)