Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
binary-pixel-map
Advanced tools
A library written in TypeScript for creating and editing a binary 2D pixel map, made for usage with small monochrome displays, for example on a Raspberry Pi or Arduino.
This library is based on oled-js
and oled-font-5x7
by noopkat.
yarn add binary-pixel-map
import { PixelMap, Pixel } from 'binary-pixel-map';
// Create a new pixel map with a width of 54, height of 18.
const map = new PixelMap(54, 18);
// Draw "Hello, world!" on the map.
map.text(1, 1, 'Hello,');
map.text(1, 10, 'world!');
// Enable the top left and bottom right pixel.
map.set(0, 0, Pixel.ON);
map.set(53, 17, Pixel.ON);
console.log(map.toString());
The example above will output the following:
PixelMap { x - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- x - - - x - - - - - - - - - - - - x x - - - - - - x x - - - - - - - - - - - - - - - - - - - - - - - - - -
- x - - - x - - - - - - - - - - - - - x - - - - - - - x - - - - - - - - - - - - - - - - - - - - - - - - - -
- x - - - x - - - - x x x - - - - - - x - - - - - - - x - - - - - - x x x - - - - - - - - - - - - - - - - -
- x x x x x - - - x - - - x - - - - - x - - - - - - - x - - - - - x - - - x - - - - - - - - - - - - - - - -
- x - - - x - - - x x x x x - - - - - x - - - - - - - x - - - - - x - - - x - - - - x x - - - - - - - - - -
- x - - - x - - - x - - - - - - - - - x - - - - - - - x - - - - - x - - - x - - - - - x - - - - - - - - - -
- x - - - x - - - - x x x - - - - - x x x - - - - - x x x - - - - - x x x - - - - - x - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - x x - - - - - - - - - x - - - - - x - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - x - - - - - - - - - x - - - - - x - - - - - - - - - -
- x - - - x - - - - x x x - - - - x - x x - - - - - - x - - - - - - x x - x - - - - - x - - - - - - - - - -
- x - - - x - - - x - - - x - - - x x - - x - - - - - x - - - - - x - - x x - - - - - x - - - - - - - - - -
- x - x - x - - - x - - - x - - - x - - - - - - - - - x - - - - - x - - - x - - - - - x - - - - - - - - - -
- x - x - x - - - x - - - x - - - x - - - - - - - - - x - - - - - x - - - x - - - - - - - - - - - - - - - -
- - x - x - - - - - x x x - - - - x - - - - - - - - x x x - - - - - x x x x - - - - - x - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - x }
new PixelMap(width: number, height: number);
get(x: number, y: number): PixelStatus;
Get the value of the pixel at [x, y].
getAll(): PixelStatus[][];
Get all pixels.
set(x: number, y: number, status: PixelStatus): void;
Set the value of the pixel at [x, y];
clear(): void;
Clear the whole map.
fill(status: PixelStatus): void;
Fill the map with enabled (ON) or disabled (OFF) pixels.
line(x0: number, y0: number, x1: number, y1: number, status: PixelStatus = Pixel.ON): void;
Draw a line from [x0, y0] to [x1, y1] using Bresenham's line algorithm.
rectangle(x: number, y: number, width: number, height: number, outline: boolean = false, status: PixelStatus = Pixel.ON): void;
Draw a rectangle at [x, y] with the size [width, height]. If outline
is set to true, only an outline will be drawn. Otherwise the rectangle will be filled.
text(x: number, y: number, content: string, size: number = 1, spacing: number = 2, wrap: boolean = true): void;
Draw text at [x, y] with size size
. The standard size (size = 1
) for letters is 5 x 7.
copy(from: PixelMap, x: number = 0, y: number = 0): void;
Copy another pixel map onto the current pixel map at [x, y].
async image(path: string | Buffer, x: number = 0, y: number = 0, maxWidth?: number, maxHeight?: number): Promise<void>;
Copy an image onto the pixel map. path
can be a file path or image buffer. Supported file types are: PNG, JPEG, WebP, GIF, SVG and TIFF.
toArray(): PixelStatus[];
Get the map as sequence of all rows. Can be useful for displaying the map on a display.
toString(): string;
Get the map as string. Can be useful for debugging.
import { Pixel } from 'binary-pixel-map';
type PixelStatus = boolean;
Used as alternative to booleans. You can still use regular booleans if you prefer.
Alternative way of writing true
.
Alternative way of writing false
.
FAQs
A library for creating and editing a binary 2D pixel map
We found that binary-pixel-map demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
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.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.