canvas-fit

WebJar for canvas-fit

License

License

MIT
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

canvas-fit
Last Version

Last Version

1.5.0
Release Date

Release Date

Type

Type

jar
Description

Description

canvas-fit
WebJar for canvas-fit
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

https://github.com/hughsk/canvas-fit

Download canvas-fit

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/canvas-fit/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>canvas-fit</artifactId>
    <version>1.5.0</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/canvas-fit/
implementation 'org.webjars.npm:canvas-fit:1.5.0'
// https://jarcasting.com/artifacts/org.webjars.npm/canvas-fit/
implementation ("org.webjars.npm:canvas-fit:1.5.0")
'org.webjars.npm:canvas-fit:jar:1.5.0'
<dependency org="org.webjars.npm" name="canvas-fit" rev="1.5.0">
  <artifact name="canvas-fit" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='canvas-fit', version='1.5.0')
)
libraryDependencies += "org.webjars.npm" % "canvas-fit" % "1.5.0"
[org.webjars.npm/canvas-fit "1.5.0"]

Dependencies

compile (1)

Group / Artifact Type Version
org.webjars.npm : element-size jar [1.1.1,2)

Project Modules

There are no modules declared in this project.

canvas-fit stable

Small module for fitting a canvas element within the bounds of its parent. Useful, for example, for making a canvas fill the screen. Works with SVG elements too!

Usage

NPM

resize = fit(canvas[, parent[, scale]])

Creates a resize function for your canvas element. Calling this function will resize the canvas to fit its parent element.

Here's a simple example to make your canvas update its dimensions when resizing the window:

var fit = require('canvas-fit')
var canvas = document.createElement('canvas')

window.addEventListener('resize', fit(canvas), false)

You might want to override the parent element that the canvas should be fitting within: in which case, pass that element in as your second argument:

window.addEventListener('resize'
  , fit(canvas, window)
  , false
)

You can also set the scale of the canvas element relative to its styled size on the page using the scale argument – for example, passing in window.devicePixelRatio here will scale the canvas resolution up on retina displays.

resize.scale = <Number>

Dynamically change the canvas' target scale. Note that you still need to manually trigger a resize after doing this.

resize.parent = <DOMElement>

Dynamically change the canvas' parent element. Note that you still need to manually trigger a resize after doing this.

resize.parent = () => [width, height]

Instead of filling a given element, explicitly set the width and height of the canvas. Note that this value will still be scaled up according to resize.scale

resize.parent = function() {
  return [ window.innerWidth - 300, window.innerHeight ]
}

License

MIT. See LICENSE.md for details.

Versions

Version
1.5.0