Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

bbox

Package Overview
Dependencies
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

bbox

Find bounding box dimensions either within or surrounding arbitrary containers

  • 0.4.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
68
increased by33.33%
Maintainers
1
Weekly downloads
 
Created
Source

Bounding Box (BBox)

Find bounding box dimensions either within or surrounding arbitrary containers

Installation

Available as a node package. To install use

$ npm install bbox

Methods

The following methods are available

  • create
  • fit
  • surround

Use

create

BBox.create(x0, y0, x1, y1)

OR

BBox.create(width, height)

Creates a frozen bbox object with both position and dimensions. When using dimensions the box has undefined location but can still be used for its aspect ratio.

var BBox = require('bbox');

var fixed = BBox.create(1, 1, 4, 4);
// => {x0: 1, y0: 1, x1: 4, y1: 4, width: 3, height: 3}

var floating = BBox.create(2, 3);
// => {width: 2, height: 3, x0: undefined, y0: undefined, x1: undefined, y1: undefined}
fit

BBox.fit(container, aspect)

Creates the largest box with the same aspect ratio as aspect that will fit within container. The box is centered within container. Note container requires a fixed bbox but aspect may be fixed or floating.

var container = BBox.create(0, 0, 100, 100);
var aspect = BBox.create(250, 500);

BBox.fit(container, aspect);
// => {x0: 25, y0: 0, x1: 75, y1: 100, width: 50, height: 100}
surround

BBox.surround(container, aspect)

Creates the smallest box with the same aspect ratio as aspect that will surround container. The box is centered around container. Note container requires a fixed bbox but aspect may be fixed or floating.

var container = BBox.create(0, 0, 100, 100);
var aspect = BBox.create(250, 500);

BBox.surround(container, aspect);
// => {x0: 0, y0: -50, x1: 100, y1: 150, width: 100, height: 200}

Keywords

FAQs

Package last updated on 22 Aug 2014

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc