├── .nvmrc ├── .gitignore ├── .browserslistrc ├── .babelrc ├── examples ├── save-as-svg.js ├── save-as-png.js ├── destsvg-example.html ├── custom-points-example.html ├── basic-web-example.html ├── transparency-example.html └── color-function-example.html ├── src ├── utils │ ├── getScalingRatio.js │ ├── geom.js │ ├── mulberry32.js │ ├── debugRender.js │ ├── colorFunctions.js │ └── colorbrewer.js ├── trianglify.node.test.js ├── pattern.js ├── trianglify.js ├── trianglify.browser.test.js └── __snapshots__ │ ├── trianglify.node.test.js.snap │ └── trianglify.browser.test.js.snap ├── .github └── workflows │ └── build.yml ├── changelog.txt ├── CONTRIBUTING.md ├── rollup.config.js ├── package.json ├── Readme.md └── LICENSE /.nvmrc: -------------------------------------------------------------------------------- 1 | v12 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | dist 3 | -------------------------------------------------------------------------------- /.browserslistrc: -------------------------------------------------------------------------------- 1 | defaults 2 | not IE 11 3 | not IE_Mob 11 4 | maintained node versions 5 | -------------------------------------------------------------------------------- /.babelrc: -------------------------------------------------------------------------------- 1 | { 2 | "plugins": ["@babel/plugin-proposal-class-properties"], 3 | "presets": [ 4 | ["@babel/preset-env"] 5 | ] 6 | } 7 | -------------------------------------------------------------------------------- /examples/save-as-svg.js: -------------------------------------------------------------------------------- 1 | // Basic command-line example 2 | // Usage: node save-as-svg.js 3 | var fs = require('fs') 4 | var trianglify = require('../dist/trianglify.js') 5 | 6 | // Generate a pattern and render to an SVG node tree 7 | const svg = trianglify({ 8 | width: 1920, 9 | height: 1080, 10 | cellSize: Math.random() * 200 + 40, 11 | xColors: 'random', 12 | variance: Math.random() 13 | }).toSVG() 14 | 15 | // Save the string to a file 16 | fs.writeFileSync('trianglify.svg', svg.toString()) 17 | -------------------------------------------------------------------------------- /src/utils/getScalingRatio.js: -------------------------------------------------------------------------------- 1 | export default function (ctx) { 2 | // adapted from https://gist.github.com/callumlocke/cc258a193839691f60dd 3 | const backingStoreRatio = ( 4 | ctx.webkitBackingStorePixelRatio || 5 | ctx.mozBackingStorePixelRatio || 6 | ctx.msBackingStorePixelRatio || 7 | ctx.oBackingStorePixelRatio || 8 | ctx.backingStorePixelRatio || 1 9 | ) 10 | 11 | const devicePixelRatio = (typeof window !== 'undefined' && window.devicePixelRatio) || 1 12 | const drawRatio = devicePixelRatio / backingStoreRatio 13 | return drawRatio 14 | } 15 | -------------------------------------------------------------------------------- /src/utils/geom.js: -------------------------------------------------------------------------------- 1 | // Given an array of coordinates representing a triangle, find the centroid 2 | // of the triangle and return it as an {x, y} object 3 | // Accepts a single [[x, y], [x, y], [x, y]] argument 4 | export const getCentroid = d => { 5 | return { 6 | x: (d[0][0] + d[1][0] + d[2][0]) / 3, 7 | y: (d[0][1] + d[1][1] + d[2][1]) / 3 8 | } 9 | } 10 | 11 | export const getTopmostVertexIndex = (vertexIndices, points) => ( 12 | vertexIndices.reduce( 13 | (topmost, i) => (points[i][1] < points[topmost][1] ? i : topmost), 14 | vertexIndices[0] 15 | ) 16 | ) 17 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: build 2 | 3 | on: 4 | push: 5 | branches: [ master ] 6 | pull_request: 7 | branches: [ master ] 8 | types: [synchronize] 9 | 10 | jobs: 11 | test: 12 | runs-on: ubuntu-latest 13 | strategy: 14 | matrix: 15 | node-version: [10.x, 12.x, 13.x] 16 | 17 | steps: 18 | - uses: actions/checkout@v2 19 | - name: Use Node.js ${{ matrix.node-version }} 20 | uses: actions/setup-node@v1 21 | with: 22 | node-version: ${{ matrix.node-version }} 23 | - run: npm ci # install dependencies in cleanroom 24 | - run: npm run ci # run the "ci" script defined in package.json 25 | -------------------------------------------------------------------------------- /examples/save-as-png.js: -------------------------------------------------------------------------------- 1 | // Basic command-line example 2 | // Usage: node save-as-png.js 3 | var fs = require('fs') 4 | var trianglify = require('../dist/trianglify.js') 5 | 6 | // Generate a pattern and then grab the PNG data uri 7 | const canvas = trianglify({ 8 | width: 1920, 9 | height: 1080, 10 | cellSize: Math.random() * 200 + 40, 11 | xColors: 'random', 12 | variance: Math.random() 13 | }).toCanvas() 14 | 15 | // Save the buffer to a file. See the node-canvas docs for a full 16 | // list of all the things you can do with this Canvas object: 17 | // https://github.com/Automattic/node-canvas 18 | const file = fs.createWriteStream('trianglify.png') 19 | canvas.createPNGStream().pipe(file) 20 | -------------------------------------------------------------------------------- /changelog.txt: -------------------------------------------------------------------------------- 1 | v4 2 | - ground-up port to ES2015 3 | - support for node-canvas 2.6 4 | - comprehensive test suite 5 | - support for rendering wireframe patterns (no fill, just stroke) 6 | - colorFunction has a new method signature that allows for more powerful customization 7 | - new built-in colorFunctions: 'sparkle' and 'shadows' 8 | - all-new example code, see examples directory 9 | - all option keys are now camelCase, not snake_case 10 | - antialiasing issues resolved for both SVG and Canvas rendering engines (#87, #30, #76) 11 | - canvas rendering is now retina-ready by default 12 | - removed dependency on seedrandom 13 | - removed dependency on jsdom 14 | 15 | v3 16 | - close paths when rendering to canvas (thanks @Allidylls) 17 | - bump a few dependencies for security 18 | -------------------------------------------------------------------------------- /src/utils/mulberry32.js: -------------------------------------------------------------------------------- 1 | // Fast seeded RNG adapted from the public-domain implementation 2 | // by @byrc: https://github.com/bryc/code/blob/master/jshash/PRNGs.md 3 | // 4 | // Usage: 5 | // const randFn = mulberry32('string seed') 6 | // const randomNumber = randFn() // [0, 1] random float 7 | export default function mulberry32 (seed) { 8 | if (!seed) { seed = Math.random().toString(36) } // support no-seed usage 9 | var a = xmur3(seed)() 10 | return function () { 11 | a |= 0; a = a + 0x6D2B79F5 | 0 12 | var t = Math.imul(a ^ a >>> 15, 1 | a) 13 | t = t + Math.imul(t ^ t >>> 7, 61 | t) ^ t 14 | return ((t ^ t >>> 14) >>> 0) / 4294967296 15 | } 16 | } 17 | 18 | function xmur3 (str) { 19 | for (var i = 0, h = 1779033703 ^ str.length; i < str.length; i++) { 20 | h = Math.imul(h ^ str.charCodeAt(i), 3432918353) 21 | h = h << 13 | h >>> 19 22 | } 23 | return function () { 24 | h = Math.imul(h ^ h >>> 16, 2246822507) 25 | h = Math.imul(h ^ h >>> 13, 3266489909) 26 | return (h ^= h >>> 16) >>> 0 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing Guidelines 2 | 3 | Pull requests and issues are welcome! For all contributions, please: 4 | 5 | 1. Read the [Readme](Readme.md) 6 | 2. Search the existing [issues](https://github.com/qrohlf/trianglify/issues?q=is%3Aissue+) and [pull requests](https://github.com/qrohlf/trianglify/pulls?q=is%3Apr) to make sure your contribution isn't a duplicate 7 | 8 | ## Issues 9 | 10 | If you're submitting a bug, please include the enivronment (browser/node) and relevant environment version(s) that you have encountered the bug in. 11 | 12 | ## Pull Requests 13 | 14 | *Important: if you are submitting a pull request that does not address an open issue in the issue tracker, it would be a very good idea to create an issue to discuss your proposed changes/additions before working on them.* 15 | 16 | 1. Fork the repo on GitHub. 17 | 2. Install dependencies with `npm install` 18 | 2. Create a topic branch and make your changes. 19 | 3. Run `npm run ci` to test your code and compile it to trianglify.min.js. 20 | 4. Submit a pull request to merge your topic branch into `master`. 21 | -------------------------------------------------------------------------------- /src/utils/debugRender.js: -------------------------------------------------------------------------------- 1 | export const debugRender = (opts, points) => { 2 | const doc = window.document 3 | const svg = window.document.createElementNS('http://www.w3.org/2000/svg', 'svg') 4 | svg.setAttribute('width', opts.width + 400) 5 | svg.setAttribute('height', opts.height + 400) 6 | 7 | points.forEach(p => { 8 | const circle = doc.createElementNS('http://www.w3.org/2000/svg', 'circle') 9 | circle.setAttribute('cx', p[0]) 10 | circle.setAttribute('cy', p[1]) 11 | circle.setAttribute('r', 2) 12 | svg.appendChild(circle) 13 | }) 14 | 15 | const bounds = doc.createElementNS('http://www.w3.org/2000/svg', 'rect') 16 | bounds.setAttribute('x', 0) 17 | bounds.setAttribute('y', 0) 18 | bounds.setAttribute('width', opts.width) 19 | bounds.setAttribute('height', opts.height) 20 | bounds.setAttribute('stroke-width', 1) 21 | bounds.setAttribute('stroke', 'blue') 22 | bounds.setAttribute('fill', 'none') 23 | svg.appendChild(bounds) 24 | 25 | svg.setAttribute('viewBox', `-100 -100 ${opts.width + 200} ${opts.height + 200}`) 26 | return svg 27 | } 28 | -------------------------------------------------------------------------------- /examples/destsvg-example.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | Trianglify Basic Example 8 | 22 | 23 | 24 | 25 | 28 | 29 | 41 | 42 | 43 | -------------------------------------------------------------------------------- /rollup.config.js: -------------------------------------------------------------------------------- 1 | import commonjs from '@rollup/plugin-commonjs' 2 | import resolve from '@rollup/plugin-node-resolve' 3 | import babel from '@rollup/plugin-babel' 4 | import { terser } from 'rollup-plugin-terser' 5 | import bundleSize from 'rollup-plugin-bundle-size' 6 | import pkg from './package.json' 7 | 8 | export default [ 9 | { // build for node & module bundlers 10 | input: 'src/trianglify.js', 11 | external: ['chroma-js', 'delaunator', 'canvas'], 12 | plugins: [babel({ babelHelpers: 'bundled' }), bundleSize()], 13 | output: { file: pkg.main, format: 'cjs' } 14 | }, 15 | { 16 | // build minified bundle to be used standalone for browser use 17 | // note: // chroma.js weighs 40k minified, a smaller solution would be nice 18 | input: 'src/trianglify.js', 19 | plugins: [terser({ output: { comments: false } }), resolve({ browser: true }), commonjs(), babel({ babelHelpers: 'bundled' }), bundleSize()], 20 | output: { file: 'dist/trianglify.bundle.js', format: 'umd', name: 'trianglify' } 21 | }, 22 | { 23 | // build non-minified bundle to be used for debugging 24 | input: 'src/trianglify.js', 25 | plugins: [resolve({ browser: true }), commonjs(), babel({ babelHelpers: 'bundled' }), bundleSize()], 26 | output: { file: 'dist/trianglify.bundle.debug.js', format: 'umd', name: 'trianglify' } 27 | } 28 | ] 29 | -------------------------------------------------------------------------------- /examples/custom-points-example.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | Trianglify custom points example 8 | 16 | 17 | 18 | 19 | 49 | 50 | 51 | -------------------------------------------------------------------------------- /src/trianglify.node.test.js: -------------------------------------------------------------------------------- 1 | /** 2 | * @jest-environment node 3 | */ 4 | /* eslint-env jest */ 5 | // Here, we test the node-specific functionality of Trianglify. 6 | const trianglify = require('../dist/trianglify.js') 7 | const { Canvas } = require('canvas') 8 | const Pattern = trianglify.Pattern 9 | 10 | describe('Pattern generation', () => { 11 | test('return a Pattern given valid options', () => { 12 | expect(trianglify({ height: 100, width: 100 })).toBeInstanceOf(Pattern) 13 | }) 14 | 15 | test('should be random by default', () => { 16 | const pattern1 = trianglify() 17 | const pattern2 = trianglify() 18 | expect(pattern1.toSVG()).not.toEqual(pattern2.toSVG()) 19 | }) 20 | 21 | test('should match snapshot for non-breaking version bumps', () => { 22 | expect(trianglify({ seed: 'snapshotText' }).toSVG().toString()).toMatchSnapshot() 23 | }) 24 | }) 25 | 26 | describe('Pattern outputs in a node environment', () => { 27 | describe('#toSVG', () => { 28 | const pattern = trianglify() 29 | const svgTree = pattern.toSVG() 30 | 31 | test('returns a synthetic tree of object literals', () => { 32 | expect(Object.keys(svgTree)).toEqual(['tagName', 'attrs', 'children', 'toString']) 33 | }) 34 | }) 35 | 36 | describe('#toCanvas', () => { 37 | const pattern = trianglify() 38 | const canvas = pattern.toCanvas() 39 | test('returns a node-canvas Canvas object', () => { 40 | expect(canvas).toBeInstanceOf(Canvas) 41 | expect(canvas.createPNGStream).toBeInstanceOf(Function) 42 | }) 43 | }) 44 | }) 45 | -------------------------------------------------------------------------------- /examples/basic-web-example.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | Trianglify Basic Example 8 | 22 | 23 | 24 | 27 | 28 | 51 | 52 | 53 | -------------------------------------------------------------------------------- /src/utils/colorFunctions.js: -------------------------------------------------------------------------------- 1 | import chroma from 'chroma-js' 2 | // Built in color functions provided for your convenience. 3 | // 4 | // Usage example: 5 | // 6 | // const pattern = trianglify({ 7 | // width: 300, 8 | // height: 200, 9 | // colorFunction: trianglify.colorFunctions.sparkle(0.2) 10 | // }) 11 | // 12 | // the snippet above gives you a trianglify pattern with a 20% random 13 | // jitter applied to the x and y gradient scales 14 | 15 | // Linear interpolation of two gradients, one for the x and one for the y 16 | // axis. This is the default Trianglify color function. 17 | // The bias parameter controls how prevalent the y axis is versus the x axis 18 | export const interpolateLinear = (bias = 0.5) => 19 | ({ xPercent, yPercent, xScale, yScale, opts }) => 20 | chroma.mix(xScale(xPercent), yScale(yPercent), bias, opts.colorSpace) 21 | 22 | // Give the pattern a 'sparkle' effect by introducing random noise into the 23 | // x and y gradients, making for higher contrast between cells. 24 | export const sparkle = (jitterFactor = 0.15) => 25 | ({ xPercent, yPercent, xScale, yScale, opts, random }) => { 26 | const jitter = () => (random() - 0.5) * jitterFactor 27 | const a = xScale(xPercent + jitter()) 28 | const b = yScale(yPercent + jitter()) 29 | return chroma.mix(a, b, 0.5, opts.colorSpace) 30 | } 31 | 32 | // This is similar to the sparkle effect, but instead of swapping colors around 33 | // it darkens cells by a random amount. The shadowIntensity parameter controls 34 | // how dark the darkest shadows are. 35 | export const shadows = (shadowIntensity = 0.8) => { 36 | return ({ xPercent, yPercent, xScale, yScale, opts, random }) => { 37 | const a = xScale(xPercent) 38 | const b = yScale(yPercent) 39 | const color = chroma.mix(a, b, 0.5, opts.colorSpace) 40 | return color.darken(shadowIntensity * random()) 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "trianglify", 3 | "version": "4.1.1", 4 | "description": "Trianglify is a javascript library for generating colorful triangle meshes that can be used as SVG images and CSS backgrounds.", 5 | "main": "dist/trianglify.js", 6 | "scripts": { 7 | "lint": "standard", 8 | "test": "jest", 9 | "build": "rollup -c", 10 | "dev": "rollup -c -w", 11 | "publish-beta": "npm run build && npm publish --tag next", 12 | "ci": "npm run lint && npm run build && npm run test" 13 | }, 14 | "dependencies": { 15 | "chroma-js": "^2.1.0", 16 | "delaunator": "^4.0.1", 17 | "canvas": "^2.6.1" 18 | }, 19 | "directories": { 20 | "example": "examples" 21 | }, 22 | "repository": { 23 | "type": "git", 24 | "url": "git://github.com/qrohlf/trianglify.git" 25 | }, 26 | "keywords": [ 27 | "svg", 28 | "canvas", 29 | "visualization", 30 | "pattern", 31 | "lowpoly" 32 | ], 33 | "standard": { 34 | "parser": "babel-eslint", 35 | "ignore": [ 36 | "dist", 37 | "**/vendor/**" 38 | ] 39 | }, 40 | "jest": { 41 | "setupFiles": [ 42 | "jest-canvas-mock" 43 | ] 44 | }, 45 | "author": "Quinn Rohlf ", 46 | "license": "GPL-3.0", 47 | "bugs": { 48 | "url": "https://github.com/qrohlf/trianglify/issues" 49 | }, 50 | "homepage": "https://github.com/qrohlf/trianglify", 51 | "devDependencies": { 52 | "@babel/plugin-proposal-class-properties": "^7.8.3", 53 | "@babel/plugin-syntax-class-properties": "^7.8.3", 54 | "@babel/preset-env": "^7.9.6", 55 | "@rollup/plugin-babel": "^5.0.0", 56 | "@rollup/plugin-commonjs": "^11.1.0", 57 | "@rollup/plugin-node-resolve": "^7.1.3", 58 | "babel-eslint": "^10.1.0", 59 | "jest": "^25.5.4", 60 | "jest-canvas-mock": "^2.2.0", 61 | "rollup": "^2.7.2", 62 | "rollup-plugin-bundle-size": "^1.0.3", 63 | "rollup-plugin-terser": "^5.3.0", 64 | "standard": "^14.3.3" 65 | } 66 | } 67 | -------------------------------------------------------------------------------- /src/utils/colorbrewer.js: -------------------------------------------------------------------------------- 1 | /* 2 | * colorbrewer.js 3 | * 4 | * Colorbrewer colors, by Cindy Brewer 5 | */ 6 | 7 | export default { 8 | YlGn: ['#ffffe5', '#f7fcb9', '#d9f0a3', '#addd8e', '#78c679', '#41ab5d', '#238443', '#006837', '#004529'], 9 | YlGnBu: ['#ffffd9', '#edf8b1', '#c7e9b4', '#7fcdbb', '#41b6c4', '#1d91c0', '#225ea8', '#253494', '#081d58'], 10 | GnBu: ['#f7fcf0', '#e0f3db', '#ccebc5', '#a8ddb5', '#7bccc4', '#4eb3d3', '#2b8cbe', '#0868ac', '#084081'], 11 | BuGn: ['#f7fcfd', '#e5f5f9', '#ccece6', '#99d8c9', '#66c2a4', '#41ae76', '#238b45', '#006d2c', '#00441b'], 12 | PuBuGn: ['#fff7fb', '#ece2f0', '#d0d1e6', '#a6bddb', '#67a9cf', '#3690c0', '#02818a', '#016c59', '#014636'], 13 | PuBu: ['#fff7fb', '#ece7f2', '#d0d1e6', '#a6bddb', '#74a9cf', '#3690c0', '#0570b0', '#045a8d', '#023858'], 14 | BuPu: ['#f7fcfd', '#e0ecf4', '#bfd3e6', '#9ebcda', '#8c96c6', '#8c6bb1', '#88419d', '#810f7c', '#4d004b'], 15 | RdPu: ['#fff7f3', '#fde0dd', '#fcc5c0', '#fa9fb5', '#f768a1', '#dd3497', '#ae017e', '#7a0177', '#49006a'], 16 | PuRd: ['#f7f4f9', '#e7e1ef', '#d4b9da', '#c994c7', '#df65b0', '#e7298a', '#ce1256', '#980043', '#67001f'], 17 | OrRd: ['#fff7ec', '#fee8c8', '#fdd49e', '#fdbb84', '#fc8d59', '#ef6548', '#d7301f', '#b30000', '#7f0000'], 18 | YlOrRd: ['#ffffcc', '#ffeda0', '#fed976', '#feb24c', '#fd8d3c', '#fc4e2a', '#e31a1c', '#bd0026', '#800026'], 19 | YlOrBr: ['#ffffe5', '#fff7bc', '#fee391', '#fec44f', '#fe9929', '#ec7014', '#cc4c02', '#993404', '#662506'], 20 | Purples: ['#fcfbfd', '#efedf5', '#dadaeb', '#bcbddc', '#9e9ac8', '#807dba', '#6a51a3', '#54278f', '#3f007d'], 21 | Blues: ['#f7fbff', '#deebf7', '#c6dbef', '#9ecae1', '#6baed6', '#4292c6', '#2171b5', '#08519c', '#08306b'], 22 | Greens: ['#f7fcf5', '#e5f5e0', '#c7e9c0', '#a1d99b', '#74c476', '#41ab5d', '#238b45', '#006d2c', '#00441b'], 23 | Oranges: ['#fff5eb', '#fee6ce', '#fdd0a2', '#fdae6b', '#fd8d3c', '#f16913', '#d94801', '#a63603', '#7f2704'], 24 | Reds: ['#fff5f0', '#fee0d2', '#fcbba1', '#fc9272', '#fb6a4a', '#ef3b2c', '#cb181d', '#a50f15', '#67000d'], 25 | Greys: ['#ffffff', '#f0f0f0', '#d9d9d9', '#bdbdbd', '#969696', '#737373', '#525252', '#252525', '#000000'], 26 | PuOr: ['#7f3b08', '#b35806', '#e08214', '#fdb863', '#fee0b6', '#f7f7f7', '#d8daeb', '#b2abd2', '#8073ac', '#542788', '#2d004b'], 27 | BrBG: ['#543005', '#8c510a', '#bf812d', '#dfc27d', '#f6e8c3', '#f5f5f5', '#c7eae5', '#80cdc1', '#35978f', '#01665e', '#003c30'], 28 | PRGn: ['#40004b', '#762a83', '#9970ab', '#c2a5cf', '#e7d4e8', '#f7f7f7', '#d9f0d3', '#a6dba0', '#5aae61', '#1b7837', '#00441b'], 29 | PiYG: ['#8e0152', '#c51b7d', '#de77ae', '#f1b6da', '#fde0ef', '#f7f7f7', '#e6f5d0', '#b8e186', '#7fbc41', '#4d9221', '#276419'], 30 | RdBu: ['#67001f', '#b2182b', '#d6604d', '#f4a582', '#fddbc7', '#f7f7f7', '#d1e5f0', '#92c5de', '#4393c3', '#2166ac', '#053061'], 31 | RdGy: ['#67001f', '#b2182b', '#d6604d', '#f4a582', '#fddbc7', '#ffffff', '#e0e0e0', '#bababa', '#878787', '#4d4d4d', '#1a1a1a'], 32 | RdYlBu: ['#a50026', '#d73027', '#f46d43', '#fdae61', '#fee090', '#ffffbf', '#e0f3f8', '#abd9e9', '#74add1', '#4575b4', '#313695'], 33 | Spectral: ['#9e0142', '#d53e4f', '#f46d43', '#fdae61', '#fee08b', '#ffffbf', '#e6f598', '#abdda4', '#66c2a5', '#3288bd', '#5e4fa2'], 34 | RdYlGn: ['#a50026', '#d73027', '#f46d43', '#fdae61', '#fee08b', '#ffffbf', '#d9ef8b', '#a6d96a', '#66bd63', '#1a9850', '#006837'] 35 | } 36 | -------------------------------------------------------------------------------- /examples/transparency-example.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | Trianglify transparency example 8 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 127 | 128 | 129 | -------------------------------------------------------------------------------- /examples/color-function-example.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | Trianglify Basic Example 8 | 28 | 29 | 30 | 33 | 34 | 123 | 124 | 125 | -------------------------------------------------------------------------------- /src/pattern.js: -------------------------------------------------------------------------------- 1 | import { createCanvas } from 'canvas' // this is a simple shim in browsers 2 | import getScalingRatio from './utils/getScalingRatio' 3 | const isBrowser = (typeof window !== 'undefined' && typeof document !== 'undefined') 4 | const doc = isBrowser && document 5 | 6 | // utility for building up SVG node trees with the DOM API 7 | const sDOM = (tagName, attrs = {}, children, existingRoot) => { 8 | const elem = existingRoot || doc.createElementNS('http://www.w3.org/2000/svg', tagName) 9 | Object.keys(attrs).forEach( 10 | k => attrs[k] !== undefined && elem.setAttribute(k, attrs[k]) 11 | ) 12 | children && children.forEach(c => elem.appendChild(c)) 13 | return elem 14 | } 15 | 16 | // serialize attrs object to XML attributes. Assumes everything is already 17 | // escaped (safe input). 18 | const serializeAttrs = attrs => ( 19 | Object.entries(attrs) 20 | .filter(([_, v]) => v !== undefined) 21 | .map(([k, v]) => `${k}='${v}'`) 22 | .join(' ') 23 | ) 24 | 25 | // minimal XML-tree builder for use in Node 26 | const sNode = (tagName, attrs = {}, children) => ({ 27 | tagName, 28 | attrs, 29 | children, 30 | toString: () => `<${tagName} ${serializeAttrs(attrs)}>${children ? children.join('') : ''}` 31 | }) 32 | 33 | export default class Pattern { 34 | constructor (points, polys, opts) { 35 | this.points = points 36 | this.polys = polys 37 | this.opts = opts 38 | } 39 | 40 | _toSVG = (serializer, destSVG, _svgOpts = {}) => { 41 | const s = serializer 42 | const defaultSVGOptions = { includeNamespace: true, coordinateDecimals: 1 } 43 | const svgOpts = { ...defaultSVGOptions, ..._svgOpts } 44 | const { points, opts, polys } = this 45 | const { width, height } = opts 46 | 47 | // only round points if the coordinateDecimals option is non-negative 48 | // set coordinateDecimals to -1 to disable point rounding 49 | const roundedPoints = (svgOpts.coordinateDecimals < 0) ? points : points.map( 50 | p => p.map(x => +x.toFixed(svgOpts.coordinateDecimals)) 51 | ) 52 | 53 | const paths = polys.map((poly) => { 54 | const xys = poly.vertexIndices.map(i => `${roundedPoints[i][0]},${roundedPoints[i][1]}`) 55 | const d = 'M' + xys.join('L') + 'Z' 56 | const hasStroke = opts.strokeWidth > 0 57 | // shape-rendering crispEdges resolves the antialiasing issues, at the 58 | // potential cost of some visual degradation. For the best performance 59 | // *and* best visual rendering, use Canvas. 60 | return s('path', { 61 | d, 62 | fill: opts.fill ? poly.color.css() : undefined, 63 | stroke: hasStroke ? poly.color.css() : undefined, 64 | 'stroke-width': hasStroke ? opts.strokeWidth : undefined, 65 | 'stroke-linejoin': hasStroke ? 'round' : undefined, 66 | 'shape-rendering': opts.fill ? 'crispEdges' : undefined 67 | }) 68 | }) 69 | 70 | const svg = s( 71 | 'svg', 72 | { 73 | xmlns: svgOpts.includeNamespace ? 'http://www.w3.org/2000/svg' : undefined, 74 | width, 75 | height 76 | }, 77 | paths, 78 | destSVG 79 | ) 80 | 81 | return svg 82 | } 83 | 84 | toSVGTree = (svgOpts) => this._toSVG(sNode, null, svgOpts) 85 | 86 | toSVG = isBrowser 87 | ? (destSVG, svgOpts) => this._toSVG(sDOM, destSVG, svgOpts) 88 | : (destSVG, svgOpts) => this.toSVGTree(svgOpts) 89 | 90 | toCanvas = (destCanvas, _canvasOpts = {}) => { 91 | const defaultCanvasOptions = { 92 | scaling: isBrowser ? 'auto' : false, 93 | applyCssScaling: !!isBrowser 94 | } 95 | const canvasOpts = { ...defaultCanvasOptions, ..._canvasOpts } 96 | const { points, polys, opts } = this 97 | 98 | const canvas = destCanvas || createCanvas(opts.width, opts.height) // doc.createElement('canvas') 99 | const ctx = canvas.getContext('2d') 100 | 101 | if (canvasOpts.scaling) { 102 | const drawRatio = canvasOpts.scaling === 'auto' 103 | ? getScalingRatio(ctx) 104 | : canvasOpts.scaling 105 | 106 | if (drawRatio !== 1) { 107 | // set the 'real' canvas size to the higher width/height 108 | canvas.width = opts.width * drawRatio 109 | canvas.height = opts.height * drawRatio 110 | 111 | if (canvasOpts.applyCssScaling) { 112 | // ...then scale it back down with CSS 113 | canvas.style.width = opts.width + 'px' 114 | canvas.style.height = opts.height + 'px' 115 | } 116 | } else { 117 | // this is a normal 1:1 device: don't apply scaling 118 | canvas.width = opts.width 119 | canvas.height = opts.height 120 | if (canvasOpts.applyCssScaling) { 121 | canvas.style.width = '' 122 | canvas.style.height = '' 123 | } 124 | } 125 | ctx.scale(drawRatio, drawRatio) 126 | } 127 | 128 | const drawPoly = (poly, fill, stroke) => { 129 | const vertexIndices = poly.vertexIndices 130 | ctx.lineJoin = 'round' 131 | ctx.beginPath() 132 | ctx.moveTo(points[vertexIndices[0]][0], points[vertexIndices[0]][1]) 133 | ctx.lineTo(points[vertexIndices[1]][0], points[vertexIndices[1]][1]) 134 | ctx.lineTo(points[vertexIndices[2]][0], points[vertexIndices[2]][1]) 135 | ctx.closePath() 136 | if (fill) { 137 | ctx.fillStyle = fill.color.css() 138 | ctx.fill() 139 | } 140 | if (stroke) { 141 | ctx.strokeStyle = stroke.color.css() 142 | ctx.lineWidth = stroke.width 143 | ctx.stroke() 144 | } 145 | } 146 | 147 | if (opts.fill && opts.strokeWidth < 1) { 148 | // draw background strokes at edge bounds to solve for white gaps due to 149 | // canvas antialiasing. See https://stackoverflow.com/q/19319963/381299 150 | polys.forEach(poly => drawPoly(poly, null, { color: poly.color, width: 2 })) 151 | } 152 | 153 | // draw visible fills and strokes 154 | polys.forEach(poly => drawPoly( 155 | poly, 156 | opts.fill && { color: poly.color }, 157 | (opts.strokeWidth > 0) && { color: poly.color, width: opts.strokeWidth } 158 | )) 159 | 160 | return canvas 161 | } 162 | } 163 | -------------------------------------------------------------------------------- /src/trianglify.js: -------------------------------------------------------------------------------- 1 | /* 2 | * Trianglify.js 3 | * by @qrohlf 4 | * 5 | * Licensed under the GPLv3 6 | */ 7 | 8 | import Delaunator from 'delaunator' 9 | // TODO - evaluate smaller alternatives 10 | // (chroma bloats bundle by 40k, minified) 11 | import chroma from 'chroma-js' 12 | 13 | import colorbrewer from './utils/colorbrewer' 14 | import Pattern from './pattern' 15 | import mulberry32 from './utils/mulberry32' 16 | import * as geom from './utils/geom' 17 | import * as colorFunctions from './utils/colorFunctions' 18 | 19 | const defaultOptions = { 20 | width: 600, 21 | height: 400, 22 | cellSize: 75, 23 | variance: 0.75, 24 | seed: null, 25 | xColors: 'random', 26 | yColors: 'match', 27 | palette: colorbrewer, 28 | colorSpace: 'lab', 29 | colorFunction: colorFunctions.interpolateLinear(0.5), 30 | fill: true, 31 | strokeWidth: 0, 32 | points: null 33 | } 34 | 35 | // This function does the "core" render-independent work: 36 | // 37 | // 1. Parse and munge options 38 | // 2. Setup cell geometry 39 | // 3. Generate random points within cell geometry 40 | // 4. Use the Delaunator library to run the triangulation 41 | // 5. Do color interpolation to establish the fundamental coloring of the shapes 42 | export default function trianglify (_opts = {}) { 43 | Object.keys(_opts).forEach(k => { 44 | if (defaultOptions[k] === undefined) { 45 | throw TypeError(`Unrecognized option: ${k}`) 46 | } 47 | }) 48 | const opts = { ...defaultOptions, ..._opts } 49 | 50 | if (!(opts.height > 0)) { 51 | throw TypeError(`invalid height: ${opts.height}`) 52 | } 53 | if (!(opts.width > 0)) { 54 | throw TypeError(`invalid width: ${opts.width}`) 55 | } 56 | 57 | // standard randomizer, used for point gen and layout 58 | const rand = mulberry32(opts.seed) 59 | 60 | const randomFromPalette = () => { 61 | if (opts.palette instanceof Array) { 62 | return opts.palette[Math.floor(rand() * opts.palette.length)] 63 | } 64 | const keys = Object.keys(opts.palette) 65 | return opts.palette[keys[Math.floor(rand() * keys.length)]] 66 | } 67 | 68 | // The first step here is to set up our color scales for the X and Y axis. 69 | // First, munge the shortcut options like 'random' or 'match' into real color 70 | // arrays. Then, set up a Chroma scale in the appropriate color space. 71 | const processColorOpts = (colorOpt) => { 72 | switch (true) { 73 | case Array.isArray(colorOpt): 74 | return colorOpt 75 | case !!opts.palette[colorOpt]: 76 | return opts.palette[colorOpt] 77 | case colorOpt === 'random': 78 | return randomFromPalette() 79 | default: 80 | throw TypeError(`Unrecognized color option: ${colorOpt}`) 81 | } 82 | } 83 | 84 | const xColors = processColorOpts(opts.xColors) 85 | const yColors = opts.yColors === 'match' 86 | ? xColors 87 | : processColorOpts(opts.yColors) 88 | 89 | const xScale = chroma.scale(xColors).mode(opts.colorSpace) 90 | const yScale = chroma.scale(yColors).mode(opts.colorSpace) 91 | 92 | // Our next step is to generate a pseudo-random grid of {x, y} points, 93 | // (or to simply utilize the points that were passed to us) 94 | const points = opts.points || getPoints(opts, rand) 95 | 96 | // Once we have the points array, run the triangulation 97 | var geomIndices = Delaunator.from(points).triangles 98 | // ...and then generate geometry and color data: 99 | 100 | // use a different (salted) randomizer for the color function so that 101 | // swapping out color functions doesn't change the pattern geometry itself 102 | const salt = 42 103 | const cRand = mulberry32(opts.seed ? opts.seed + salt : null) 104 | const polys = [] 105 | 106 | for (let i = 0; i < geomIndices.length; i += 3) { 107 | // convert shallow array-packed vertex indices into 3-tuples 108 | const vertexIndices = [ 109 | geomIndices[i], 110 | geomIndices[i + 1], 111 | geomIndices[i + 2] 112 | ] 113 | 114 | // grab a copy of the actual vertices to use for calculations 115 | const vertices = vertexIndices.map(i => points[i]) 116 | 117 | const { width, height } = opts 118 | const norm = num => Math.max(0, Math.min(1, num)) 119 | const centroid = geom.getCentroid(vertices) 120 | const xPercent = norm(centroid.x / width) 121 | const yPercent = norm(centroid.y / height) 122 | 123 | const color = opts.colorFunction({ 124 | centroid, // centroid of polygon, non-normalized 125 | xPercent, // x-coordinate of centroid, normalized to [0, 1] 126 | yPercent, // y-coordinate of centroid, normalized to [0, 1] 127 | vertexIndices, // vertex indices of the polygon 128 | vertices, // [x, y] vertices of the polygon 129 | xScale, // x-colors scale for the pattern 130 | yScale, // y-colors scale for the pattern 131 | points, // array of generated points for the pattern 132 | opts, // options used to initialize the pattern 133 | random: cRand // seeded randomization function for use by color functions 134 | }) 135 | 136 | polys.push({ 137 | vertexIndices, 138 | centroid, 139 | color // chroma color object 140 | }) 141 | } 142 | 143 | return new Pattern(points, polys, opts) 144 | } 145 | 146 | const getPoints = (opts, random) => { 147 | const { width, height, cellSize, variance } = opts 148 | 149 | // pad by 2 cells outside the visible area on each side to ensure we fully 150 | // cover the 'artboard' 151 | const colCount = Math.floor(width / cellSize) + 4 152 | const rowCount = Math.floor(height / cellSize) + 4 153 | 154 | // determine bleed values to ensure that the grid is centered within the 155 | // artboard 156 | const bleedX = ((colCount * cellSize) - width) / 2 157 | const bleedY = ((rowCount * cellSize) - height) / 2 158 | 159 | // apply variance to cellSize to get cellJitter in pixels 160 | const cellJitter = cellSize * variance 161 | const getJitter = () => (random() - 0.5) * cellJitter 162 | 163 | const pointCount = colCount * rowCount 164 | 165 | const halfCell = cellSize / 2 166 | 167 | const points = Array(pointCount).fill(null).map((_, i) => { 168 | const col = i % colCount 169 | const row = Math.floor(i / colCount) 170 | 171 | // [x, y, z] 172 | return [ 173 | -bleedX + col * cellSize + halfCell + getJitter(), 174 | -bleedY + row * cellSize + halfCell + getJitter() 175 | ] 176 | }) 177 | 178 | return points 179 | } 180 | 181 | // tweak some of the exports here 182 | trianglify.utils = { 183 | mix: chroma.mix, 184 | colorbrewer 185 | } 186 | 187 | trianglify.colorFunctions = colorFunctions 188 | trianglify.Pattern = Pattern 189 | trianglify.defaultOptions = defaultOptions 190 | -------------------------------------------------------------------------------- /src/trianglify.browser.test.js: -------------------------------------------------------------------------------- 1 | /** 2 | * @jest-environment jsdom 3 | */ 4 | /* eslint-env jest */ 5 | // Because Trianglify is authored using ES modules syntax (which Rollup likes) 6 | // it can't be unit-tested on a per-file basis using Jest without maintaining 7 | // a separate compiler configuration for test files. 8 | // 9 | // In the interest of sanity, this means that instead of unit-testing Trianglify, 10 | // I'm importing the built `dist` files and running a set of integration tests 11 | // against the public API only. 12 | // 13 | // I hope to start unit-testing in the future, when native support for ES modules 14 | // lands in Node and Jest (See https://github.com/facebook/jest/issues/9430) 15 | 16 | // pull in the transpiled, browser-bundle version of trianglify. 17 | // this is needed so that we get the browser-targeted Canvas shim, and 18 | // NOT the node library 19 | const trianglify = require('../dist/trianglify.bundle.debug.js') 20 | const Pattern = trianglify.Pattern 21 | 22 | describe('Public API', () => { 23 | test('default export should be a function', () => { 24 | expect(trianglify).toBeInstanceOf(Function) 25 | }) 26 | 27 | test('should export the colorbrewer palette', () => { 28 | expect(trianglify.utils.colorbrewer).toBeDefined() 29 | expect(trianglify.utils.colorbrewer.YlGn).toBeDefined() 30 | }) 31 | 32 | test('should export the mix utility', () => { 33 | expect(trianglify.utils.mix).toBeDefined() 34 | expect(trianglify.utils.mix).toBeInstanceOf(Function) 35 | }) 36 | 37 | test('should export the color function generators', () => { 38 | expect(trianglify.colorFunctions.interpolateLinear).toBeDefined() 39 | expect(trianglify.colorFunctions.interpolateLinear).toBeInstanceOf(Function) 40 | expect(trianglify.colorFunctions.sparkle).toBeInstanceOf(Function) 41 | expect(trianglify.colorFunctions.shadows).toBeInstanceOf(Function) 42 | }) 43 | }) 44 | 45 | describe('Options Parsing', () => { 46 | test('should throw an error on unrecognized options', () => { 47 | expect( 48 | () => trianglify({ height: 100, width: 100, bad_option: true }) 49 | ).toThrow() 50 | }) 51 | 52 | test('should throw an error on invalid dimensions', () => { 53 | expect( 54 | () => trianglify({ height: 100, width: -1 }) 55 | ).toThrow() 56 | 57 | expect( 58 | () => trianglify({ height: -1, width: 100 }) 59 | ).toThrow() 60 | }) 61 | }) 62 | 63 | describe('Pattern generation', () => { 64 | test('return a Pattern given valid options', () => { 65 | expect(trianglify({ height: 100, width: 100 })).toBeInstanceOf(Pattern) 66 | }) 67 | 68 | test('should use default options when invoked', () => { 69 | const pattern = trianglify() 70 | expect(pattern.opts).toEqual(trianglify.defaultOptions) 71 | }) 72 | 73 | test('should override opts with user-provided options', () => { 74 | const pattern = trianglify({ height: 100, width: 100, cellSize: 1234 }) 75 | expect(pattern.opts.cellSize).toEqual(1234) 76 | }) 77 | 78 | test('should accept the random color option without erroring', () => { 79 | expect(() => { 80 | trianglify({ xColors: 'random' }) 81 | trianglify({ yColors: 'random' }) 82 | }).not.toThrow() 83 | }) 84 | 85 | test('should accept the match color option without erroring', () => { 86 | expect(() => { 87 | trianglify({ xColors: 'random', yColors: 'match' }) 88 | }).not.toThrow() 89 | }) 90 | 91 | test('should accept a named colorbrewer palette without erroring', () => { 92 | expect(() => { 93 | trianglify({ xColors: 'RdBu' }) 94 | trianglify({ yColors: 'OrRd' }) 95 | }).not.toThrow() 96 | }) 97 | 98 | test('should error on a names palette that does not exist', () => { 99 | expect(() => { 100 | trianglify({ xColors: 'Foo' }) 101 | trianglify({ yColors: 'Bar' }) 102 | }).toThrow() 103 | }) 104 | 105 | test('should generate well-formed geometry', () => { 106 | const pattern = trianglify({ height: 100, width: 100, cellSize: 20 }) 107 | // we care about pattern.points and pattern.polys here 108 | expect(pattern.points).toBeInstanceOf(Array) 109 | // assert that points is an array of [x, y] tuples 110 | pattern.points.forEach(point => { 111 | expect(point).toBeInstanceOf(Array) 112 | expect(point).toHaveLength(2) 113 | }) 114 | 115 | // asset the polys looks right 116 | expect(pattern.polys).toBeInstanceOf(Array) 117 | pattern.polys.forEach(poly => { 118 | expect(poly).toBeInstanceOf(Object) 119 | expect(Object.keys(poly)).toEqual(['vertexIndices', 'centroid', 'color']) 120 | }) 121 | }) 122 | 123 | test('should be random by default', () => { 124 | const pattern1 = trianglify() 125 | const pattern2 = trianglify() 126 | expect(pattern1.toSVG()).not.toEqual(pattern2.toSVG()) 127 | }) 128 | 129 | test('should be deterministic when seeded', () => { 130 | const pattern1 = trianglify({ seed: 'deadbeef' }) 131 | const pattern2 = trianglify({ seed: 'deadbeef' }) 132 | expect(pattern1.toSVG()).toEqual(pattern2.toSVG()) 133 | }) 134 | 135 | test('should match snapshot for non-breaking version bumps', () => { 136 | expect(trianglify({ seed: 'snapshotText' }).toSVG()).toMatchSnapshot() 137 | }) 138 | }) 139 | 140 | describe('Pattern outputs in browser environment', () => { 141 | describe('#toSVG', () => { 142 | test('returns a well-formed SVG node', () => { 143 | const pattern = trianglify() 144 | const svgDOM = pattern.toSVG() 145 | expect(svgDOM.tagName).toEqual('svg') 146 | expect(svgDOM.children).toBeInstanceOf(global.HTMLCollection) 147 | Array.from(svgDOM.children).forEach(node => { 148 | expect(node.tagName).toEqual('path') 149 | }) 150 | expect(svgDOM.children).toHaveLength(pattern.polys.length) 151 | }) 152 | 153 | test('supports rendering to the destSVG target', () => { 154 | const destSVG = document.createElementNS('http://www.w3.org/2000/svg', 'svg') 155 | expect(destSVG.children).toHaveLength(0) 156 | const pattern = trianglify({ seed: 'destSVG works' }) 157 | // side-effect-ful render to destSVG 158 | pattern.toSVG(destSVG) 159 | expect(destSVG.children).toHaveLength(pattern.polys.length) 160 | expect(destSVG).toMatchSnapshot() 161 | }) 162 | }) 163 | 164 | describe('#toSVGTree', () => { 165 | const pattern = trianglify({ seed: 'foobar' }) 166 | const svgTree = pattern.toSVGTree() 167 | 168 | test('returns a synthetic tree of object literals', () => { 169 | expect(Object.keys(svgTree)).toEqual(['tagName', 'attrs', 'children', 'toString']) 170 | }) 171 | 172 | test('serializes to an SVG string', () => { 173 | expect(svgTree.toString()).toMatchSnapshot() 174 | }) 175 | }) 176 | 177 | describe('#toCanvas', () => { 178 | test('returns a Canvas node', () => { 179 | const pattern = trianglify() 180 | const canvas = pattern.toCanvas() 181 | expect(canvas).toBeInstanceOf(global.HTMLElement) 182 | expect(canvas.tagName).toEqual('CANVAS') 183 | // there's not really any way to test the canvas contents here 184 | }) 185 | }) 186 | }) 187 | -------------------------------------------------------------------------------- /Readme.md: -------------------------------------------------------------------------------- 1 | # Trianglify 2 | 3 | 4 | Trianglify is a library that I wrote to generate nice SVG background images like this one: 5 | 6 | ![](https://cloud.githubusercontent.com/assets/347189/6771063/f8b0af46-d090-11e4-8d4c-6c7ef5bd9d37.png) 7 | 8 | # Contents 9 | [📦 Getting Trianglify](#-getting-trianglify) 10 | [🏎 Quickstart](#-quickstart) 11 | [⚖️ Licensing](#%EF%B8%8F-licensing) 12 | [📖 API](#-api) 13 | [🎨 Configuration](#-configuration) 14 | 15 | # 📦 Getting Trianglify 16 | 17 | You can grab Trianglify with npm/yarn (recommended): 18 | 19 | ``` 20 | npm install --save trianglify 21 | ``` 22 | 23 | Include it in your application via the unpkg CDN: 24 | 25 | ``` 26 | 27 | ``` 28 | 29 | Or download a .zip from the [**releases page**](https://github.com/qrohlf/trianglify/releases). 30 | 31 | 32 | # 🏎 Quickstart 33 | 34 | **Browsers** 35 | ```html 36 | 37 | 44 | ``` 45 | 46 | **Node** 47 | ```js 48 | const trianglify = require('trianglify') 49 | const fs = require('fs') 50 | 51 | const canvas = trianglify({ 52 | width: 1920, 53 | height: 1080 54 | }).toCanvas() 55 | 56 | const file = fs.createWriteStream('trianglify.png') 57 | canvas.createPNGStream().pipe(file) 58 | ``` 59 | 60 | You can see the [`examples/`](./examples) folder for more usage examples. 61 | 62 | The https://trianglify.io/ GUI is a good place to play around with the various configuration parameters and see their effect on the generated output, live. 63 | 64 | # ⚖️ Licensing 65 | 66 | The source code of Trianglify is licensed under version 3 of the GNU General Public License ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.html)). This means that any websites, apps, or other projects that include the Trianglify javascript library need to be released under a compatible open-source license. If you are interested in using Trianglify in a closed-source project, please email qr@qrohlf.com to purchase a commercial license. 67 | 68 | **However**, it's worth noting that you own the copyright to the output image files which you create using Trianglify, just like you own the copyright to an image created using something like [GIMP](https://www.gimp.org/). If you just want to use an image file that was generated using Trianglify in your project, and do not plan to distribute the Trianglify source code or compiled versions of it, you do not need to worry about the license restrictions described above. 69 | 70 | 71 | # 📖 API 72 | 73 | Trianglify is primarily used by calling the `trianglify` function, which returns a `trianglify.Pattern` object. 74 | 75 | ```js 76 | // load the library, either via a window global (browsers) or require call (node) 77 | // in es-module environments, you can `import trianglify from 'trianglify'` as well 78 | const trianglify = window.trianglify || require('trianglify') 79 | 80 | const options = { height: 400, width: 600 } 81 | const pattern = trianglify(options) 82 | console.log(pattern instanceof trianglify.Pattern) // true 83 | ``` 84 | 85 | ## pattern 86 | 87 | This object holds the generated geometry and colors, and exposes a number of methods for rendering this geometry to the DOM or a Canvas. 88 | 89 | 90 | **`pattern.opts`** 91 | 92 | Object containing the options used to generate the pattern. 93 | 94 | 95 | **`pattern.points`** 96 | 97 | The pseudo-random point grid used for the pattern geometry, in the following format: 98 | 99 | ```js 100 | [ 101 | [x, y], 102 | [x, y], 103 | [x, y], 104 | // and so on... 105 | ] 106 | ``` 107 | 108 | 109 | **`pattern.polys`** 110 | 111 | The array of colored polygons that make up the pattern, in the following format: 112 | 113 | ```js 114 | // {x, y} center of the first polygon in the pattern 115 | pattern.polys[0].centroid 116 | 117 | // [i, i, i] three indexes into the pattern.points array, 118 | // defining the shape corners 119 | pattern.polys[0].vertexIndices 120 | 121 | // Chroma.js color object defining the color of the polygon 122 | pattern.polys[0].color 123 | ``` 124 | 125 | 126 | **`pattern.toSVG(destSVG?, svgOpts?)`** 127 | 128 | Rendering function for SVG. In browser or browser-like (e.g. JSDOM) environments, this will return a SVGElement DOM node. In node environments, this will return a lightweight node tree structure that can be serialized to a valid SVG string using the `toString()` function. 129 | 130 | If an existing svg element is passed as the `destSVG`, this function will render the pattern to the pre-existing element instead of creating a new one. 131 | 132 | The `svgOpts` option allows for some svg-specific customizations to the output: 133 | 134 | ```js 135 | const svgOpts = { 136 | // Include or exclude the xmlns='http://www.w3.org/2000/svg' attribute on 137 | // the root tag. See https://github.com/qrohlf/trianglify/issues/41 138 | // for additional details on why this is sometimes important 139 | includeNamespace: true, 140 | // Controls how many decimals to round coordinate values to. 141 | // You can set this to -1 to disable rounding. Default is 1. 142 | coordinateDecimals: 1 143 | } 144 | ``` 145 | 146 | 147 | **`pattern.toSVGTree(svgOpts?)`** 148 | 149 | Alternate rendering function for SVG. Returns a lightweight node tree structure that can be seralized to a valid SVG string using the `toString()` function. In node environments, this is an alias for 150 | `pattern.toSVG()`. 151 | 152 | 153 | **`pattern.toCanvas(destCanvas?, canvasOpts?)`** 154 | 155 | Rendering function for canvas. In browser and browser-like environments, returns a Canvas HTMLElement node. In node environments, this will return a node-canvas object which follows [a superset of the Web Canvas API](https://github.com/Automattic/node-canvas#documentation). 156 | 157 | If an existing canvas element is passed as the `destCanvas`, this function will render the pattern to the pre-existing element instead of creating a new one. 158 | 159 | To use this in a node.js environment, the optional dependency [node-canvas](https://github.com/Automattic/node-canvas) needs to be installed as a dependency of your project `npm install -save canvas`. 160 | 161 | The `canvasOpts` option allows for some canvas-specific customizations to the output: 162 | 163 | ```js 164 | const canvasOpts = { 165 | // determines how the canvas is rendered on high-DPI (aka "retina") devices. 166 | // - 'auto' will automatically render the canvas at the appropriate scale ratio 167 | // for pixel-perfect display. 168 | // - a numeric value will render the canvas at that specific scale factor 169 | // for example, 2.0 will render it at 2x resolution, wheras 0.5 will render 170 | // at half resolution 171 | // - 'false' will disable scaling, and the canvas will be rendered at the 172 | // exact resolution specified by `width, height` 173 | scaling: 'auto', 174 | // if the canvas is rendered at a different resolution than the {width, height} 175 | // trianglify will apply some inline style attributes to scale it back to 176 | // the requested {width, height} options. Set applyCssScaling to false to 177 | // disable this behavior. 178 | applyCssScaling: true 179 | } 180 | ``` 181 | 182 | # 🎨 Configuration 183 | 184 | Trianglify is configured by an options object passed in as the only argument. The following option keys are supported, see below for a complete description of what each option does. 185 | 186 | ```js 187 | const defaultOptions = { 188 | width: 600, 189 | height: 400, 190 | cellSize: 75, 191 | variance: 0.75, 192 | seed: null, 193 | xColors: 'random', 194 | yColors: 'match', 195 | fill: true, 196 | palette: trianglify.colorbrewer, 197 | colorSpace: 'lab', 198 | colorFunction: trianglify.colorFunctions.interpolateLinear(0.5), 199 | strokeWidth: 0, 200 | points: null 201 | } 202 | ``` 203 | 204 | **`width`** 205 | 206 | Integer, defaults to `600`. Specify the width in pixels of the pattern to generate. 207 | 208 | **`height`** 209 | 210 | Integer, defaults to `400`. Specify the height in pixels of the pattern to generate. 211 | 212 | **`cellSize`** 213 | 214 | Integer, defaults to `75`. Specify the size in pixels of the mesh used to generate triangles. Larger values will result in coarser patterns, smaller values will result in finer patterns. Note that very small values may dramatically increase the runtime of Trianglify. 215 | 216 | **`variance`** 217 | 218 | Decimal value between 0 and 1 (inclusive), defaults to `0.75`. Specify the amount of randomness used when generating triangles. You may set this higher than 1, but doing so may result in patterns that include "gaps" at the edges. 219 | 220 | **`seed`** 221 | 222 | String, defaults to `null`. Seeds the random number generator to create repeatable patterns. When set to null, the RNG will be seeded with random values from the environment. An example usage would be passing in blog post titles as the seed to generate unique but consistient trianglify patterns for every post on a blog site. 223 | 224 | **`xColors`** 225 | 226 | False, string, or array of CSS-formatted colors, default is `'random'`. Specify the color gradient used on the x axis. 227 | 228 | Valid string values are 'random', or the name of a [colorbrewer palette](http://bl.ocks.org/mbostock/5577023) (i.e. 'YlGnBu' or 'RdBu'). When set to 'random', a gradient will be randomly selected from the colorbrewer library. 229 | 230 | Valid array values should specify the color stops in any CSS format (i.e. `['#000000', '#4CAFE8', '#FFFFFF']`). 231 | 232 | **`yColors`** 233 | 234 | False, string or array of CSS-formatted colors, default is `'match'`. When set to 'match' the x-axis color gradient will be used on both axes. Otherwise, accepts the same options as xColors. 235 | 236 | **`palette`** 237 | 238 | The array of color combinations to pick from when using `random` for the xColors or yColors. See [`src/utils/colorbrewer.js`](./src/utils/colorbrewer.js) for the format of this data. 239 | 240 | **`colorSpace`** 241 | 242 | String, defaults to `'lab'`. Set the color space used for generating gradients. Supported values are rgb, hsv, hsl, hsi, lab and hcl. See this [blog post](https://vis4.net/blog/posts/avoid-equidistant-hsv-colors/) for some background on why this matters. 243 | 244 | **`colorFunction`** 245 | 246 | Specify a custom function for coloring triangles, defaults to `null`. Accepts a function to override the standard gradient coloring, which is passed a variety of data about the pattern and each polygon and must return a Chroma.js color object. 247 | 248 | See [`examples/color-function-example.html`](./examples/color-function-example.html) and [`src/utils/colorFunctions.js`](./src/utils/colorFunctions.js) for more information about the built-in color functions, and how to write custom color functions. 249 | 250 | **`fill`** 251 | 252 | Boolean, defaults to `true`. Specifies whether the polygons generated by Trianglify should be filled in. 253 | 254 | **`strokeWidth`** 255 | 256 | Number, defaults to 0. Specify the width of the strokes used to outline the polygons. This can be used in conjunction with `fill: false` to generate weblike patterns. 257 | 258 | **`points`** 259 | 260 | Array of points ([x, y]) to triangulate, defaults to null. When not specified an array randomised points is generated filling the space. Points must be within the coordinate space defined by `width` and `height`. See [`examples/custom-points-example.html`](./examples/custom-points-example.html) for a demonstration of how this option can be used to generate circular trianglify patterns. 261 | -------------------------------------------------------------------------------- /src/__snapshots__/trianglify.node.test.js.snap: -------------------------------------------------------------------------------- 1 | // Jest Snapshot v1, https://goo.gl/fbAQLP 2 | 3 | exports[`Pattern generation should match snapshot for non-breaking version bumps 1`] = `""`; 4 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | -------------------------------------------------------------------------------- /src/__snapshots__/trianglify.browser.test.js.snap: -------------------------------------------------------------------------------- 1 | // Jest Snapshot v1, https://goo.gl/fbAQLP 2 | 3 | exports[`Pattern generation should match snapshot for non-breaking version bumps 1`] = ` 4 | 9 | 14 | 19 | 24 | 29 | 34 | 39 | 44 | 49 | 54 | 59 | 64 | 69 | 74 | 79 | 84 | 89 | 94 | 99 | 104 | 109 | 114 | 119 | 124 | 129 | 134 | 139 | 144 | 149 | 154 | 159 | 164 | 169 | 174 | 179 | 184 | 189 | 194 | 199 | 204 | 209 | 214 | 219 | 224 | 229 | 234 | 239 | 244 | 249 | 254 | 259 | 264 | 269 | 274 | 279 | 284 | 289 | 294 | 299 | 304 | 309 | 314 | 319 | 324 | 329 | 334 | 339 | 344 | 349 | 354 | 359 | 364 | 369 | 374 | 379 | 384 | 389 | 394 | 399 | 404 | 409 | 414 | 419 | 424 | 429 | 434 | 439 | 444 | 449 | 454 | 459 | 464 | 469 | 474 | 479 | 484 | 489 | 494 | 499 | 504 | 509 | 514 | 519 | 524 | 529 | 534 | 539 | 544 | 549 | 554 | 559 | 564 | 569 | 574 | 579 | 584 | 589 | 594 | 599 | 604 | 609 | 614 | 619 | 624 | 629 | 634 | 639 | 644 | 649 | 654 | 659 | 664 | 669 | 674 | 679 | 684 | 689 | 694 | 699 | 704 | 709 | 714 | 719 | 724 | 729 | 734 | 739 | 744 | 749 | 754 | 759 | 764 | 769 | 774 | 779 | 784 | 789 | 794 | 799 | 804 | 809 | 814 | 819 | 824 | 829 | 834 | 839 | 844 | 849 | 854 | 859 | 864 | 869 | 874 | 879 | 884 | 889 | 894 | 899 | 904 | 909 | 914 | 919 | 924 | 929 | 934 | 939 | 944 | 949 | 954 | 959 | 964 | 969 | 974 | 979 | 984 | 989 | 994 | 999 | 1004 | 1009 | 1014 | 1015 | `; 1016 | 1017 | exports[`Pattern outputs in browser environment #toSVG supports rendering to the destSVG target 1`] = ` 1018 | 1023 | 1028 | 1033 | 1038 | 1043 | 1048 | 1053 | 1058 | 1063 | 1068 | 1073 | 1078 | 1083 | 1088 | 1093 | 1098 | 1103 | 1108 | 1113 | 1118 | 1123 | 1128 | 1133 | 1138 | 1143 | 1148 | 1153 | 1158 | 1163 | 1168 | 1173 | 1178 | 1183 | 1188 | 1193 | 1198 | 1203 | 1208 | 1213 | 1218 | 1223 | 1228 | 1233 | 1238 | 1243 | 1248 | 1253 | 1258 | 1263 | 1268 | 1273 | 1278 | 1283 | 1288 | 1293 | 1298 | 1303 | 1308 | 1313 | 1318 | 1323 | 1328 | 1333 | 1338 | 1343 | 1348 | 1353 | 1358 | 1363 | 1368 | 1373 | 1378 | 1383 | 1388 | 1393 | 1398 | 1403 | 1408 | 1413 | 1418 | 1423 | 1428 | 1433 | 1438 | 1443 | 1448 | 1453 | 1458 | 1463 | 1468 | 1473 | 1478 | 1483 | 1488 | 1493 | 1498 | 1503 | 1508 | 1513 | 1518 | 1523 | 1528 | 1533 | 1538 | 1543 | 1548 | 1553 | 1558 | 1563 | 1568 | 1573 | 1578 | 1583 | 1588 | 1593 | 1598 | 1603 | 1608 | 1613 | 1618 | 1623 | 1628 | 1633 | 1638 | 1643 | 1648 | 1653 | 1658 | 1663 | 1668 | 1673 | 1678 | 1683 | 1688 | 1693 | 1698 | 1703 | 1708 | 1713 | 1718 | 1723 | 1728 | 1733 | 1738 | 1743 | 1748 | 1753 | 1758 | 1763 | 1768 | 1773 | 1778 | 1783 | 1788 | 1793 | 1798 | 1803 | 1808 | 1813 | 1818 | 1823 | 1828 | 1833 | 1838 | 1843 | 1848 | 1853 | 1858 | 1863 | 1868 | 1873 | 1878 | 1883 | 1888 | 1893 | 1898 | 1903 | 1908 | 1913 | 1918 | 1923 | 1928 | 1933 | 1938 | 1943 | 1948 | 1953 | 1958 | 1963 | 1968 | 1973 | 1978 | 1983 | 1988 | 1993 | 1998 | 2003 | 2008 | 2013 | 2018 | 2023 | 2028 | 2029 | `; 2030 | 2031 | exports[`Pattern outputs in browser environment #toSVGTree serializes to an SVG string 1`] = `""`; 2032 | --------------------------------------------------------------------------------