Skip to content

Commit 52f5ef1

Browse files
bohnackerbohnacker
committed
updated reference
1 parent ac3c95a commit 52f5ef1

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

‎README.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ For a more detailed explanation of this project read [this](https://hartmut-bohn
1212

1313
`new StretchTransform()` create an empty StretchTransform.
1414

15-
#### addAnchor
15+
### addAnchor
1616

1717
Adds an Anchor.
1818

@@ -21,7 +21,7 @@ Adds an Anchor.
2121
- `x` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** X coordinate for origin and target position
2222
- `y` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Y coordinate for origin and target position
2323

24-
#### addAnchor
24+
### addAnchor
2525

2626
Adds an Anchor.
2727

@@ -32,7 +32,7 @@ Adds an Anchor.
3232
- `xTarget` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** X coordinate for target position
3333
- `yTarget` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Y coordinate for target position
3434

35-
#### addAnchor
35+
### addAnchor
3636

3737
Adds an Anchor.
3838

@@ -41,41 +41,41 @@ Adds an Anchor.
4141
- `pOrigin` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** Array [x, y] for origin position
4242
- `pTarget` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** Array [x, y] for target position
4343

44-
#### addAnchor
44+
### addAnchor
4545

4646
Adds an Anchor.
4747

4848
*Parameters*
4949

5050
- `p` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** Array [x, y] that will be used for origin and target position
5151

52-
#### removeAnchor
52+
### removeAnchor
5353

5454
Removes an Anchor.
5555

5656
*Parameters*
5757

5858
- `anchor` **Anchor** Anchor to remove
5959

60-
#### removeAnchor
60+
### removeAnchor
6161

6262
Removes an Anchor.
6363

6464
*Parameters*
6565

6666
- `i` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Index of the anchor
6767

68-
#### getAnchorCount
68+
### getAnchorCount
6969

7070
Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** of anchors added to the MultiTransform
7171

72-
#### getAnchor
72+
### getAnchor
7373

7474
*Parameters*
7575

7676
- `i` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Index of the anchor to return.
7777

78-
#### getAnchorByPos
78+
### getAnchorByPos
7979

8080
*Parameters*
8181

@@ -86,7 +86,7 @@ Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refer
8686
Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Index of the found anchor or -1 if nothing was found at the
8787
specified position
8888

89-
#### getAnchorByOriginPos
89+
### getAnchorByOriginPos
9090

9191
*Parameters*
9292

@@ -97,7 +97,7 @@ Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refer
9797
Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Index of the found anchor or -1 if nothing was found at the
9898
specified position
9999

100-
#### getAnchorByTargetPos
100+
### getAnchorByTargetPos
101101

102102
*Parameters*
103103

@@ -108,41 +108,41 @@ Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refer
108108
Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Index of the found anchor or -1 if nothing was found at the
109109
specified position
110110

111-
#### setAnchorOrigin
111+
### setAnchorOrigin
112112

113113
*Parameters*
114114

115115
- `i` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Index of the anchor.
116116
- `x` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** New x coordinate of the origin position.
117117
- `y` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** New y coordinate of the origin position.
118118

119-
#### setAnchorTarget
119+
### setAnchorTarget
120120

121121
*Parameters*
122122

123123
- `i` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Index of the anchor.
124124
- `x` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** New x coordinate of the target position.
125125
- `y` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** New y coordinate of the target position.
126126

127-
#### setWeightingMode
127+
### setWeightingMode
128128

129129
*Parameters*
130130

131131
- `weightingMode` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** String, either 'simple' or 'directional'.
132132

133-
#### isSimple
133+
### isSimple
134134

135135
Returns **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true, if weightingMode is SIMPLE
136136

137-
#### isDirectional
137+
### isDirectional
138138

139139
Returns **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true, if weightingMode is DIRECTIONAL
140140

141-
#### getWeightingExponent1
141+
### getWeightingExponent1
142142

143143
Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)**
144144

145-
#### setWeightingExponent1
145+
### setWeightingExponent1
146146

147147
Exponent of the weighting function. Defines how the relations from one anchor
148148
to all others are cumulated. The closer the other anchor lies, the
@@ -152,11 +152,11 @@ stronger it is weighted.
152152

153153
- `val` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Usually something between 0 and 2. Default = 1.
154154

155-
#### getWeightingExponent2
155+
### getWeightingExponent2
156156

157157
Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)**
158158

159-
#### setWeightingExponent2
159+
### setWeightingExponent2
160160

161161
Exponent of the weighting function when applying all anchor matrices to a
162162
point.
@@ -165,11 +165,11 @@ point.
165165

166166
- `val` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Usually 1 or higher. Default = 2.
167167

168-
#### getWeightingExponent3
168+
### getWeightingExponent3
169169

170170
Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)**
171171

172-
#### setWeightingExponent3
172+
### setWeightingExponent3
173173

174174
Exponent of the weighting function that factors in, if the direction
175175
from anchor to point and from one anchor to another is quite similar.
@@ -179,7 +179,7 @@ Only applicable when weightingMode is DIRECTIONAL.
179179

180180
- `val` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Usually something between 0 and 2. Default = 1.
181181

182-
#### transform
182+
### transform
183183

184184
Main function of the class. Transforms a point on the plane and returns
185185
its new position.
@@ -191,7 +191,7 @@ its new position.
191191

192192
Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** Transformed point as an Array [x, y]
193193

194-
#### transform
194+
### transform
195195

196196
Main function of the class. Transforms a point on the plane and returns
197197
its new position.
@@ -202,7 +202,7 @@ its new position.
202202

203203
Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** Transformed point as an Array [x, y]
204204

205-
#### updateAnchorMatrices
205+
### updateAnchorMatrices
206206

207207
It's usually not necessary to call this method. If anchors and parameters
208208
are always set with the given methods (setAnchorOrigin(), ...), this

0 commit comments

Comments
 (0)