diff --git a/README.md b/README.md index b940995..aae5d24 100644 --- a/README.md +++ b/README.md @@ -24,3 +24,179 @@ var simulation = d3_force.forceSimulation(nodes); ## API Reference … + +### Simulation + +… + +# d3.forceSimulation([nodes]) + +… + +# simulation.start() + +… + +# simulation.stop() + +… + +# simulation.tick() + +… + +# simulation.nodes([nodes]) + +… + +# simulation.alphaMin([alpha]) + +… + +# simulation.alphaDecay([decay]) + +… + +# simulation.drag([drag]) + +… + +# simulation.force(name[, force]) + +… + +# simulation.on(typenames, [callback]) + +… + +### Forces + +… + +# force(alpha) + +… + +# force.initialize(nodes) + +… + +#### Centering + +… + +# d3.forceCenter([x, y]) + +… + +# center.x([x]) + +… + +# center.y([y]) + +… + +#### Circle Collision + +… + +# d3.forceCollide([radius]) + +… + +# collide.radius([radius]) + +… + +# collide.strength([strength]) + +… + +#### Containment + +… + +# d3.forceContain([radius[, x, y]]) + +… + +# contain.radius([radius]) + +… + +# contain.x([x]) + +… + +# contain.y([y]) + +… + +#### Links + +… + +# d3.forceLink([links]) + +… + +# link.links([links]) + +… + +# link.id([id]) + +… + +# link.strength([strength]) + +… + +# link.distance([distance]) + +… + +#### Many-Body + +… + +# d3.forceManyBody() + +… + +# manyBody.strength([strength]) + +… + +# manyBody.theta([theta]) + +… + +# manyBody.distanceMin([distance]) + +… + +# manyBody.distanceMax([distance]) + +… + +#### Positioning + +… + +# d3.forcePosition([x, y]) + +… + +# position.strength([strength]) + +… + +# position.x([x]) + +… + +# position.y([y]) + +…