[
{
"path": ".gitignore",
"content": "node_modules/\npackage-lock.json\n.cache\n.vscode/\n"
},
{
"path": ".npmignore",
"content": "node_modules/\npackage-lock.json/\n.cache\nexperiments/\nassets/\ndocs/\nexamples/\nwebpack.config.dev.js\nwebpack.config.prod.js\nsrc/\n.vscode/"
},
{
"path": ".prettierrc",
"content": "{\n \"trailingComma\": \"es5\",\n \"tabWidth\": 4,\n \"semi\": false,\n \"singleQuote\": true,\n \"printWidth\": 120,\n \"bracketSpacing\": true,\n \"bracketSameLine\": false\n}\n"
},
{
"path": "LICENSE",
"content": "EUROPEAN UNION PUBLIC LICENCE v. 1.2 \r\nEUPL © the European Union 2007, 2016 \r\n\r\nThis European Union Public Licence (the ‘EUPL’) applies to the Work (as defined below) which is provided under the \r\nterms of this Licence. Any use of the Work, other than as authorised under this Licence is prohibited (to the extent such \r\nuse is covered by a right of the copyright holder of the Work). \r\nThe Work is provided under the terms of this Licence when the Licensor (as defined below) has placed the following \r\nnotice immediately following the copyright notice for the Work: \r\n Licensed under the EUPL \r\nor has expressed by any other means his willingness to license under the EUPL. \r\n\r\n1.Definitions \r\nIn this Licence, the following terms have the following meaning: \r\n— ‘The Licence’:this Licence. \r\n— ‘The Original Work’:the work or software distributed or communicated by the Licensor under this Licence, available \r\nas Source Code and also as Executable Code as the case may be. \r\n— ‘Derivative Works’:the works or software that could be created by the Licensee, based upon the Original Work or \r\nmodifications thereof. This Licence does not define the extent of modification or dependence on the Original Work \r\nrequired in order to classify a work as a Derivative Work; this extent is determined by copyright law applicable in \r\nthe country mentioned in Article 15. \r\n— ‘The Work’:the Original Work or its Derivative Works. \r\n— ‘The Source Code’:the human-readable form of the Work which is the most convenient for people to study and \r\nmodify. \r\n— ‘The Executable Code’:any code which has generally been compiled and which is meant to be interpreted by \r\na computer as a program. \r\n— ‘The Licensor’:the natural or legal person that distributes or communicates the Work under the Licence. \r\n— ‘Contributor(s)’:any natural or legal person who modifies the Work under the Licence, or otherwise contributes to \r\nthe creation of a Derivative Work. \r\n— ‘The Licensee’ or ‘You’:any natural or legal person who makes any usage of the Work under the terms of the \r\nLicence. \r\n— ‘Distribution’ or ‘Communication’:any act of selling, giving, lending, renting, distributing, communicating, \r\ntransmitting, or otherwise making available, online or offline, copies of the Work or providing access to its essential \r\nfunctionalities at the disposal of any other natural or legal person. \r\n\r\n2.Scope of the rights granted by the Licence \r\nThe Licensor hereby grants You a worldwide, royalty-free, non-exclusive, sublicensable licence to do the following, for \r\nthe duration of copyright vested in the Original Work: \r\n— use the Work in any circumstance and for all usage, \r\n— reproduce the Work, \r\n— modify the Work, and make Derivative Works based upon the Work, \r\n— communicate to the public, including the right to make available or display the Work or copies thereof to the public \r\nand perform publicly, as the case may be, the Work, \r\n— distribute the Work or copies thereof, \r\n— lend and rent the Work or copies thereof, \r\n— sublicense rights in the Work or copies thereof. \r\nThose rights can be exercised on any media, supports and formats, whether now known or later invented, as far as the \r\napplicable law permits so. \r\nIn the countries where moral rights apply, the Licensor waives his right to exercise his moral right to the extent allowed \r\nby law in order to make effective the licence of the economic rights here above listed. \r\nThe Licensor grants to the Licensee royalty-free, non-exclusive usage rights to any patents held by the Licensor, to the \r\nextent necessary to make use of the rights granted on the Work under this Licence. \r\n\r\n3.Communication of the Source Code \r\nThe Licensor may provide the Work either in its Source Code form, or as Executable Code. If the Work is provided as \r\nExecutable Code, the Licensor provides in addition a machine-readable copy of the Source Code of the Work along with \r\neach copy of the Work that the Licensor distributes or indicates, in a notice following the copyright notice attached to \r\nthe Work, a repository where the Source Code is easily and freely accessible for as long as the Licensor continues to \r\ndistribute or communicate the Work. \r\n\r\n4.Limitations on copyright \r\nNothing in this Licence is intended to deprive the Licensee of the benefits from any exception or limitation to the \r\nexclusive rights of the rights owners in the Work, of the exhaustion of those rights or of other applicable limitations \r\nthereto. \r\n\r\n5.Obligations of the Licensee \r\nThe grant of the rights mentioned above is subject to some restrictions and obligations imposed on the Licensee. Those \r\nobligations are the following: \r\n\r\nAttribution right: The Licensee shall keep intact all copyright, patent or trademarks notices and all notices that refer to \r\nthe Licence and to the disclaimer of warranties. The Licensee must include a copy of such notices and a copy of the \r\nLicence with every copy of the Work he/she distributes or communicates. The Licensee must cause any Derivative Work \r\nto carry prominent notices stating that the Work has been modified and the date of modification. \r\n\r\nCopyleft clause: If the Licensee distributes or communicates copies of the Original Works or Derivative Works, this \r\nDistribution or Communication will be done under the terms of this Licence or of a later version of this Licence unless \r\nthe Original Work is expressly distributed only under this version of the Licence — for example by communicating \r\n‘EUPL v. 1.2 only’. The Licensee (becoming Licensor) cannot offer or impose any additional terms or conditions on the \r\nWork or Derivative Work that alter or restrict the terms of the Licence. \r\n\r\nCompatibility clause: If the Licensee Distributes or Communicates Derivative Works or copies thereof based upon both \r\nthe Work and another work licensed under a Compatible Licence, this Distribution or Communication can be done \r\nunder the terms of this Compatible Licence. For the sake of this clause, ‘Compatible Licence’ refers to the licences listed \r\nin the appendix attached to this Licence. Should the Licensee's obligations under the Compatible Licence conflict with \r\nhis/her obligations under this Licence, the obligations of the Compatible Licence shall prevail. \r\n\r\nProvision of Source Code: When distributing or communicating copies of the Work, the Licensee will provide \r\na machine-readable copy of the Source Code or indicate a repository where this Source will be easily and freely available \r\nfor as long as the Licensee continues to distribute or communicate the Work. \r\nLegal Protection: This Licence does not grant permission to use the trade names, trademarks, service marks, or names \r\nof the Licensor, except as required for reasonable and customary use in describing the origin of the Work and \r\nreproducing the content of the copyright notice. \r\n\r\n6.Chain of Authorship \r\nThe original Licensor warrants that the copyright in the Original Work granted hereunder is owned by him/her or \r\nlicensed to him/her and that he/she has the power and authority to grant the Licence. \r\nEach Contributor warrants that the copyright in the modifications he/she brings to the Work are owned by him/her or \r\nlicensed to him/her and that he/she has the power and authority to grant the Licence. \r\nEach time You accept the Licence, the original Licensor and subsequent Contributors grant You a licence to their contributions \r\nto the Work, under the terms of this Licence. \r\n\r\n7.Disclaimer of Warranty \r\nThe Work is a work in progress, which is continuously improved by numerous Contributors. It is not a finished work \r\nand may therefore contain defects or ‘bugs’ inherent to this type of development. \r\nFor the above reason, the Work is provided under the Licence on an ‘as is’ basis and without warranties of any kind \r\nconcerning the Work, including without limitation merchantability, fitness for a particular purpose, absence of defects or \r\nerrors, accuracy, non-infringement of intellectual property rights other than copyright as stated in Article 6 of this \r\nLicence. \r\nThis disclaimer of warranty is an essential part of the Licence and a condition for the grant of any rights to the Work. \r\n\r\n8.Disclaimer of Liability \r\nExcept in the cases of wilful misconduct or damages directly caused to natural persons, the Licensor will in no event be \r\nliable for any direct or indirect, material or moral, damages of any kind, arising out of the Licence or of the use of the \r\nWork, including without limitation, damages for loss of goodwill, work stoppage, computer failure or malfunction, loss \r\nof data or any commercial damage, even if the Licensor has been advised of the possibility of such damage. However, \r\nthe Licensor will be liable under statutory product liability laws as far such laws apply to the Work. \r\n\r\n9.Additional agreements \r\nWhile distributing the Work, You may choose to conclude an additional agreement, defining obligations or services \r\nconsistent with this Licence. However, if accepting obligations, You may act only on your own behalf and on your sole \r\nresponsibility, not on behalf of the original Licensor or any other Contributor, and only if You agree to indemnify, \r\ndefend, and hold each Contributor harmless for any liability incurred by, or claims asserted against such Contributor by \r\nthe fact You have accepted any warranty or additional liability. \r\n\r\n10.Acceptance of the Licence \r\nThe provisions of this Licence can be accepted by clicking on an icon ‘I agree’ placed under the bottom of a window \r\ndisplaying the text of this Licence or by affirming consent in any other similar way, in accordance with the rules of \r\napplicable law. Clicking on that icon indicates your clear and irrevocable acceptance of this Licence and all of its terms \r\nand conditions. \r\nSimilarly, you irrevocably accept this Licence and all of its terms and conditions by exercising any rights granted to You \r\nby Article 2 of this Licence, such as the use of the Work, the creation by You of a Derivative Work or the Distribution \r\nor Communication by You of the Work or copies thereof. \r\n\r\n11.Information to the public \r\nIn case of any Distribution or Communication of the Work by means of electronic communication by You (for example, \r\nby offering to download the Work from a remote location) the distribution channel or media (for example, a website) \r\nmust at least provide to the public the information requested by the applicable law regarding the Licensor, the Licence \r\nand the way it may be accessible, concluded, stored and reproduced by the Licensee. \r\n\r\n12.Termination of the Licence \r\nThe Licence and the rights granted hereunder will terminate automatically upon any breach by the Licensee of the terms \r\nof the Licence. \r\nSuch a termination will not terminate the licences of any person who has received the Work from the Licensee under \r\nthe Licence, provided such persons remain in full compliance with the Licence. \r\n\r\n13.Miscellaneous \r\nWithout prejudice of Article 9 above, the Licence represents the complete agreement between the Parties as to the \r\nWork. \r\nIf any provision of the Licence is invalid or unenforceable under applicable law, this will not affect the validity or \r\nenforceability of the Licence as a whole. Such provision will be construed or reformed so as necessary to make it valid \r\nand enforceable. \r\nThe European Commission may publish other linguistic versions or new versions of this Licence or updated versions of \r\nthe Appendix, so far this is required and reasonable, without reducing the scope of the rights granted by the Licence. \r\nNew versions of the Licence will be published with a unique version number. \r\nAll linguistic versions of this Licence, approved by the European Commission, have identical value. Parties can take \r\nadvantage of the linguistic version of their choice. \r\n\r\n14.Jurisdiction \r\nWithout prejudice to specific agreement between parties, \r\n— any litigation resulting from the interpretation of this License, arising between the European Union institutions, \r\nbodies, offices or agencies, as a Licensor, and any Licensee, will be subject to the jurisdiction of the Court of Justice \r\nof the European Union, as laid down in article 272 of the Treaty on the Functioning of the European Union, \r\n— any litigation arising between other parties and resulting from the interpretation of this License, will be subject to \r\nthe exclusive jurisdiction of the competent court where the Licensor resides or conducts its primary business. \r\n\r\n15.Applicable Law \r\nWithout prejudice to specific agreement between parties, \r\n— this Licence shall be governed by the law of the European Union Member State where the Licensor has his seat, \r\nresides or has his registered office, \r\n— this licence shall be governed by Belgian law if the Licensor has no seat, residence or registered office inside \r\na European Union Member State. \r\n\r\n\r\n Appendix \r\n\r\n‘Compatible Licences’ according to Article 5 EUPL are: \r\n— GNU General Public License (GPL) v. 2, v. 3 \r\n— GNU Affero General Public License (AGPL) v. 3 \r\n— Open Software License (OSL) v. 2.1, v. 3.0 \r\n— Eclipse Public License (EPL) v. 1.0 \r\n— CeCILL v. 2.0, v. 2.1 \r\n— Mozilla Public Licence (MPL) v. 2 \r\n— GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3 \r\n— Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for works other than software \r\n— European Union Public Licence (EUPL) v. 1.1, v. 1.2 \r\n— Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong Reciprocity (LiLiQ-R+).\r\n\r\nThe European Commission may update this Appendix to later versions of the above licences without producing \r\na new version of the EUPL, as long as they provide the rights granted in Article 2 of this Licence and protect the \r\ncovered Source Code from exclusive appropriation. \r\nAll other changes or additions to this Appendix require the production of a new EUPL version. \r\n"
},
{
"path": "README.md",
"content": "# Gridviz\n\n\n\n\n[](http://www.awesomeofficialstatistics.org)\n\n\n ![](\"docs/img/gif/gridviz-annotated.gif\")
\n
\n\n[Gridviz](https://github.com/eurostat/gridviz/) is a JavaScript library for visualizing gridded data (or any tabular dataset with x/y coordinates for that matter) in the browser using a large variety of [cartographic styles and techniques](https://github.com/eurostat/gridviz/blob/master/docs/gallery.md). Unlike traditional raster-based web mapping tools, Gridviz renders everything client-side, on the fly.\n\n## Styles\n\n[Visit the style gallery](https://github.com/eurostat/gridviz/blob/master/docs/gallery.md) to see the different customisable styles available for visualizing gridded data with gridviz.\n\n[![](\"docs/img/overviews/ov_accessibility.png\")
](https://eurostat.github.io/gridviz/docs/reference#shapecolorsize-style)\n[![](\"docs/img/overviews/ov_side_cat.png\")
](https://eurostat.github.io/gridviz/docs/reference#side-category-style)\n[![](\"docs/img/overviews/ov_age_balance.png\")
](https://eurostat.github.io/gridviz/docs/reference#shapecolorsize-style)\n[![](\"docs/img/overviews/ov_dark.png\")
](https://eurostat.github.io/gridviz/docs/reference#square-color-webgl-style)\n[![](\"docs/img/overviews/ov_kersmoo.png\")
](https://eurostat.github.io/gridviz/docs/reference#kernel-smoothing)\n[![](\"docs/img/overviews/ov_tanaka_dark.png\")
](https://eurostat.github.io/gridviz/docs/reference#tanaka-style)\n[![](\"docs/img/overviews/ov_joyplot_shade.png\")
](https://eurostat.github.io/gridviz/docs/reference#joyplot-style)\n[![](\"docs/img/overviews/ov_lego.png\")
](https://eurostat.github.io/gridviz/docs/reference#lego-style)\n[![](\"docs/img/overviews/ov_text_elevation.png\")
](https://eurostat.github.io/gridviz/docs/reference#text-style)\n[![](\"docs/img/overviews/ov_dotdensity.png\")
](https://eurostat.github.io/gridviz/docs/reference#dot-density-style)\n[![](\"docs/img/overviews/ov_joyplot.png\")
](https://eurostat.github.io/gridviz/docs/reference#joyplot-style)\n\n## Live Demos\n\n- [**Europe** - 1km resolution - Census total population](https://ec.europa.eu/assets/estat/E/E4/gisco/website/grid_map/index.html)\n- [**Europe** - 1km resolution - Census population composition](https://ec.europa.eu/assets/estat/E/E4/gisco/website/census_2021_grid_map/index.html)\n- [**Europe** - 100m resolution - Accessibility to basic services](https://ec.europa.eu/assets/estat/E/E4/gisco/accessibility_maps/healthcare_education/index.html)\n- [**Europe** - 100m resolution - Relief](https://eurostat.github.io/gridviz/examples/demos/EUR_relief.html)\n- [**Germany** - 100m resolution - Zensus 2011](https://eurostat.github.io/gridviz/examples/demos/DE.html)\n- [**France** - 200m resolution - INSEE Filosofi](https://eurostat.github.io/gridviz/examples/demos/FR.html). Focus on [total population](https://eurostat.github.io/gridviz/examples/demos/FR_pop.html) and [income](https://eurostat.github.io/gridviz/examples/demos/FR_income.html).\n- [**Norway** - 250m resolution - SSB](https://eurostat.github.io/gridviz/examples/demos/NO.html)\n- [**Croatia** - 1km resolution - DZS 2015 grid](https://eurostat.github.io/gridviz/examples/demos/HR.html)\n- [**Belgium** population](https://eurostat.github.io/gridviz/examples/basics/mixed_resolution_BE.html), as mixed resolution layer.\n\n## Installation\n\n### Node.js\n\n```Shell\nnpm install gridviz\n```\n\nthen\n\n```javascript\nimport * as gridviz from 'gridviz'\n```\n\nOr you can cherry-pick only the modules that you need, for example:\n\n```javascript\nimport { Map, SquareColorWebGLStyle } from 'gridviz'\n```\n\n### Basic example\n\nHere’s a basic example that loads a CSV file of a European population grid (5km resolution):\n\n```javascript\n//define map with initial view\nconst map = new gridviz.Map(document.getElementById('map'), { x: 4500000, y: 2900000, z: 3000 })\n\n//define dataset\nconst dataset = new gridviz.CSVGrid(\n map,\n 'https://raw.githubusercontent.com/eurostat/gridviz/master/assets/csv/Europe/pop_2018_10km.csv',\n 10000\n)\n\n//define color for each cell\nconst colorFunction = (cell) => {\n if (cell.population > 150000) return '#993404'\n else if (cell.population > 60000) return '#d95f0e'\n else if (cell.population > 20000) return '#fe9929'\n else if (cell.population > 6000) return '#fec44f'\n else if (cell.population > 1500) return '#fee391'\n else return '#ffffd4'\n}\n\n//define style\nconst style = new gridviz.ShapeColorSizeStyle({ color: colorFunction })\n\n//add layer to map\nmap.layers = [new gridviz.GridLayer(dataset, [style])]\n```\n\nSee the **[documentation page](https://eurostat.github.io/gridviz/docs/reference)** for more information.\n\n### standalone\n\n```javascript\n\n```\n\n## Documentation\n\nSee the **[gridviz documentation page](./docs/reference.md)**.\n\n## Grid tiling\n\nIn order to visualize large grids efficiently, you can produce tiled grids in a [tiled grid format](https://eurostat.github.io/gridviz/docs/tiledformat) with **[GridTiler](https://github.com/eurostat/gridtiler)**.\n\n## About\n\n| | |\n| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| _contributors_ | [![](\"https://github.com/jgaffuri.png\")
](https://github.com/jgaffuri) [![](\"https://github.com/JoeWDavies.png\")