Wondering what’s next for npm?Check out our public roadmap! »

    overlap-area
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.0 • Public • Published

    Overlap Area

    npm version

    Find the Overlap Area.

    Demo / API / Main Project

    📄 API Documents

    ⚙️ Installation

    $ npm install overlap-area
    <script src="//daybrush.com/overlap-area/release/latest/dist/overlap-area.min.js"></script>

    🚀 How to use

    import { isInside, getOverlapPoints, getOverlapSize } from "overlap-area";
     
    const points1 = [
        [0, 0],
        [100, 0],
        [120, 100],
        [0, 100],
    ];
    const points2 = [
        [100, 0],
        [150, 0],
        [150, 100],
        [100, 100],
    ];
     
    // true
    console.log(isInside([50, 50], points1));
    // false
    console.log(isInside([50, 50], points2));
     
    // [100, 0], [120, 100], [100, 100]
    console.log(getOverlapPoints(points1, points2));
     
    // 1000
    console.log(getOverlapSize(points1, points2));

    ⭐️ Show Your Support

    Please give a ⭐️ if this project helped you!

    👏 Contributing

    If you have any questions or requests or want to contribute to overlap-area or other packages, please write the issue or give me a Pull Request freely.

    Special thanks to PMY

    🐞 Bug Report

    If you find a bug, please report to us opening a new Issue on GitHub.

    📝 License

    This project is MIT licensed.

    MIT License
    
    Copyright (c) 2020 Daybrush
    
    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:
    
    The above copyright notice and this permission notice shall be included in all
    copies or substantial portions of the Software.
    
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    SOFTWARE.
    

    Install

    npm i overlap-area

    DownloadsWeekly Downloads

    5,706

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    174 kB

    Total Files

    25

    Last publish

    Collaborators

    • avatar