API Reference Documents

[WeiFei365]

AWESOME!

Is there any documents for the API/methods you exports:

export {
    fmin,
    minimizeConjugateGradient,
    bisect
} from "./src/fmin";
export {
    intersectionArea,
    circleCircleIntersection,
    circleOverlap,
    circleArea,
    distance,
    circleIntegral
} from "./src/circleintersection";
export {
    venn,
    greedyLayout,
    scaleSolution,
    normalizeSolution,
    bestInitialLayout,
    lossFunction,
    disjointCluster,
    distanceFromIntersectArea
} from "./src/layout";
export {
    VennDiagram,
    wrapText,
    computeTextCentres,
    computeTextCentre,
    sortAreas,
    circlePath,
    circleFromPath,
    intersectionAreaPath
} from "./src/diagram";

so many APIs, but i dont know how to use it, do you have any documents, I will appreciate that, thanks!

[benfred]

thanks!

I might add some more documentation in the future - but in the meantime you can ignore most of those exported functions. Most of these functions are only exported to make testing easier (like the normalization test or the comparison to venneuler)- and don't need to be used directly.

In the meatime, the examples folder and the README both have a bunch of usage examples on how to use the main VennDiagram object.

I've also moved all functions from src/fmin.js into their own unconstrained function minimization library just now, so those are no longer being exported.