Giter Club home page Giter Club logo

pixi-graphpaper's Introduction

Pixi Graph Paper

Ruled graph paper, PIXI.Sprite instance able to be added to the display list via addChild().

pixi-graph-paper

Getting Started

To install, execute:

npm i pixi-graphpaper

Then, import into a project as:

import { GraphPaper } from "pixi-graphpaper";

Usage

By default, a dark theme graph paper will be applied in a 1000 x 1000 pixel grid, with:

  • Major grid every 100-pixels
  • Intermediate grid every 50-pixels
  • Minor grid every 10-pixels

Instantiate and add to the display list:

import { GraphPaper } from "pixi-graphpaper";

let paper = new GraphPaper();
stage.addChild(paper);

Options may be passed to the constructor:

let paper = new GraphPaper({
  graphWidth: 2000,
  graphHeight: 2000,
});

Or, set via properties:

let paper = new GraphPaper();

paper.graphWidth = 2000;
paper.graphHeight = 2000;

Properties

The following properties may be set on a GraphPaper instance:

Type Param Description
number backgroundFillAlpha Opacity of the background fill
number backgroundFillColor Color of the background
boolean backgroundVisible Whether background is visible
number graphHeight Width of the graph
number graphWidth Height of the graph
number intermediateGridSize Grid size of intermediate lines between major and minor rules
boolean intermediateGridVisible Whether intermediate grid rule is visible
number intermediateStrokeAlpha Opacity of the intermediate rule stroke
number intermediateStrokeColor Color of the intermediate rule stroke
number intermediateStrokeWidth Width of the intermediate rule stroke
number majorGridSize Grid size of the major rule
boolean majorGridVisible Whether major grid rule is visible
number majorStrokeAlpha Opacity of the major rule stroke
number majorStrokeColor Color of the major rule stroke
number majorStrokeWidth Width of the major rule stroke
number minorGridSize Grid size of the minor rule
boolean minorGridVisible Whether minor grid rule is visible
number minorStrokeAlpha Opacity of the minor rule stroke
number minorStrokeColor Color of the minor rule stroke
number minorStrokeWidth Width of the minor rule stroke

Graph Paper Styles

Optionally, there are built-in styles via the GraphStyle class.

blueprint

Apply via the constructor:

import { GraphPaper, GraphStyle } from "pixi-graphpaper";

let paper = new GraphPaper({
  ...GraphStyle.BLUEPRINT,
  graphWidth: 2000,
  graphHeight: 2000,
});

pixi-graphpaper's People

Contributors

jasonsturges avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.