From e330b029d77c6d80e35b9ec6f0b9001d368f67e1 Mon Sep 17 00:00:00 2001 From: Pitchaya Boonsarngsuk <2285135b@student.gla.ac.uk> Date: Fri, 2 Feb 2018 10:13:37 +0000 Subject: [PATCH] =?UTF-8?q?=E0=B8=AD=E0=B8=B1=E0=B8=9B=E0=B9=80=E0=B8=94?= =?UTF-8?q?=E0=B8=95=20readme:=20=E0=B9=81=E0=B8=97=E0=B8=99=20HTML=20/?= =?UTF-8?q?=20=E0=B8=94=E0=B9=89=E0=B8=A7=E0=B8=A2=20*/**=20=E0=B8=82?= =?UTF-8?q?=E0=B8=AD=E0=B8=87=20markdown?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4540bd6..58e3613 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ In order for it to work properly, a distance function should be specified. Initializes the Neighbour and Sampling algorithm with default parameters. -# neighbourSampling.id([id]) [<>](src/neighbourSampling.js#L218 "Source") +# *neighbourSampling*.**id**([*id*]) [<>](src/neighbourSampling.js#L218 "Source") If *id* is specified, sets the node id accessor to the specified function and returns this force. If *id* is not specified, returns the current node id accessor, which defaults to the numeric *node*.index: @@ -74,19 +74,19 @@ function distance() { } ``` -# neighbourSampling.neighbourSize([neighbourSize]) [<>](src/neighbourSampling.js#L222 "Source") +# *neighbourSampling*.**neighbourSize**([*neighbourSize*]) [<>](src/neighbourSampling.js#L222 "Source") If *neighbourSize* is specified, sets the neighbour set size to the specified number and returns this force. If *neighbourSize* is not specified, returns the current value, which defaults to 6. -# neighbourSampling.sampleSize([sampleSize]) [<>](https://github.com/sReeper/d3-neighbour-sampling/blob/master/src/neighbourSampling.js#L226 "Source") +# *neighbourSampling*.**sampleSize**([*sampleSize*]) [<>](https://github.com/sReeper/d3-neighbour-sampling/blob/master/src/neighbourSampling.js#L226 "Source") If *sampleSize* is specified, sets the sample set size to the specified number and returns this force. If *sampleSize* is not specified, returns the current value, which defaults to 3. -# neighbourSampling.stress() [<>](https://github.com/sReeper/d3-neighbour-sampling/blob/master/src/neighbourSampling.js#L234 "Source") +# *neighbourSampling*.**stress**() [<>](https://github.com/sReeper/d3-neighbour-sampling/blob/master/src/neighbourSampling.js#L234 "Source") Returns the stress of the layout. -# neighbourSampling.velocity() [<>](https://github.com/sReeper/d3-neighbour-sampling/blob/master/src/neighbourSampling.js#L238 "Source") +# *neighbourSampling*.**velocity**() [<>](https://github.com/sReeper/d3-neighbour-sampling/blob/master/src/neighbourSampling.js#L238 "Source") Returns the average velocity of the iteration.