Documentation: main / latest / 11.1.1
Examples: Demo application
Developer Guide: Developer Guide
We are happy to announce the second GeoStyler Code Sprint from 08.-12.05.2023. Be part of it! More infos on https://geostyler.org/ or on the GeoStyler discord: https://discord.gg/bABdhxrp?event=1103332326240424107
The GeoStyler is a generic styler for geodata*.
GeoStyler provides a set of UI Components for map styling. Just like a modular building block system all components can be stacked together to create a nice UI for your web applications. To simplify the setup, we also provide some high-level components (based on our building blocks) that already do the work for you. These include among many others Symbolizer Editors, RuleTables and a fully-fledged StyleEditor including filters and scaleDenominators.
Furthermore, GeoStyler allows for the translation between multiple styling formats, i.e. SLD, OpenLayers, QGIS, Mapbox. Since we are following the concept of micro packages, these translators (we call them parsers) can be used as standalone libraries, without the need to include the UI components as a dependency. Just take a look at StyleParser Implementations.
* geodata as a single dataset (layer) not a complete map appearance.
If you are missing any UI components, formats or even have a custom style format, feel free to open a PR. We are happy for any kind of contributions.
To see the GeoStyler in action have a look at the demo application. It demonstrates the GeoStyler UI components as a standalone application.
Every parser works as a standalone library, too. So you can easily translate between style formats.
For example a small SLD to OpenLayers-Style parser (untested code 😄):
import SLDParser from "geostyler-sld-parser";
import OpenLayersParser from "geostyle-openlayers-parser";
const sldParser = new SLDParser();
const olParser = new OpenLayersParser();
const sldToOL = async (sld) => {
const { output: geostylerStyle } = await sldParser.readStyle(someSld);
const { output: olStyle } = await olParser.writeStyle(geostylerStyle);
return olStyle;
};
export default sldToOl;Run
npm i geostylerfrom within your project directory to add GeoStyler as a dependency. Please be aware of the peerDependencies that come along with GeoStyler.
Components can be used as follows:
import {wanted-geostyler-compoment} from 'geostyler';
//... your component code
render() {
return (
<wanted-geostyler-component
foo=""
bar={}
/>
);
}Internally we are using our own style definition called GeoStyler Style (see TypeScript Declaration Files), which takes the best from SLD and Mapbox. We are not trying to establish just another standard, but we need an exchange format that is flexible and highly compatible with current styling standards. Understanding GeoStyler Style is only necessary for developers of the project, not for users! Our style parsers all read and write from and to GeoStyler Style to keep the complexity low. As a positive side effect this lets you translate from any supported style to any other supported style.
Imagine your previous project was based on QGIS and now you want to setup your own web application. With GeoStyler you can still use your QGIS styles and either save all future formats in qml as well, or you simply translate all your old styles to another format e.g. OpenLayers styles or SLD. It's simple as that!
To populate the UI with information from imported data we provide a set of data parsers (defined in GeoStyler Data). Currently, we support GeoJSON, Shapefile and WFS.
With these two formats there come two interfaces. You can implement these interfaces to create a parser. Compare the list of existing parsers below.
- SLD (github / npm)
- OpenLayers Style (github / npm)
- Mapbox Style (github / npm)
- MapServer Mapfiles (github / npm)
- QGIS Style [*.qml] (github / npm)
For our guidelines for contributions, please take a look at CONTRIBUTING.md.
The easiest way to develop UI components is to use styleguidist. Just run npm run styleguide and the interactive documenation will be running on http://localhost:6060.
For more complex developments such as integrations with different parsers, it might be helpful to npm link your local repository to the GeoStyler Demo. If you include your component into one of our high-level components, you will be able to directly see the new components in your browser. To do so, follow these steps:
git clone https://github.com/geostyler/geostyler.git
cd geostyler
npm i
npm link
npm run build
cd ..
git clone https://github.com/geostyler/geostyler-demo.git
cd geostyler-demo
npm i
npm link geostylerWhen working with npm link it may happen that some tools like webpack or typescript don't know how to resolve packages that are used in both packages (in this case geostyler and geostyler-style). So we have to configure this in the geostyler-demo:
Replace rootDir with rootDirs and add the linked packages to the rootDirs in tsconfig.json. If you link some parsers too just add them as well.
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -9,9 +9,12 @@
"allowJs": true,
"jsx": "react",
"moduleResolution": "node",
- "rootDir": ".",
"rootDirs": [
- "./src/"
+ "./src/",
+ "../geostyler",
],
"forceConsistentCasingInFileNames": true,
"noImplicitReturns": true,Then uncomment or add resolve aliases to the webpack config:
--- a/config/webpack.common.config.js
+++ b/config/webpack.common.config.js
@@ -35,7 +35,9 @@ module.exports = {
},
alias: {
react: require.resolve('react'),
- 'geostyler-style': path.resolve('node_modules', 'geostyler-style')
+ 'geostyler-style': path.resolve('node_modules', 'geostyler-style'),
+ 'geostyler-sld-parser': path.resolve('node_modules', 'geostyler-sld-parser'),
+ 'antd': path.resolve('node_modules', 'antd')
}
},
output: {npm run start
The GeoStyler Demo will then be served on localhost:3000. When doing changes to GeoStyler you have to rebuild the project via one of the following commands:
npm run build
npm run build-distChanges will automatically be updated in the browser. Please also provide tests and a minimal code example as <ComponentName>.example.md, if you add a new component, so the api documentation will always be up to date and other users can benefit from your work.
Invalid hook call error:
If the demo does not start but shows the above error, it means that geostyler-demo and geostyler are using different react sources. Please make sure to have the react alias in the webpack.common.config.js configured correctly.
If there is an issue with a UI component, you may need to do the same for the antd module and add the alias.
If you want to write your own style parser please take a look at the existing parsers for a consistent project setup. Developing them is a straighforward task, but don't forget: style parsers have to implement the GeoStyler Style interface.
If you want to work on an existing parser, do following steps to setup the project:
git clone <wanted-parser-repo>
cd <wanted-parser>
npm iParsers can be directly tested within their repositories, respectively. The best way to integrate your local changes into the UI/Demo is using npm link.
Run
npm linkfrom within your style parser repo and
npm link <wanted-parser>from within the GeoStyler Demo.
Developing GeoStyler data parsers follows the same pattern as described in Developing GeoStyler Style Parser, but keep in mind that data parsers have to implement the GeoStyler Data interface.
GeoStyler is released under the BSD 2-Clause license. Please see the file
LICENSE in the
root of this repository.