JavaScripting

The definitive source of the best
JavaScript libraries, frameworks, and plugins.


  • ×

    OpenLayers 3
    Filed under 

    • 🔾83%Overall
    • 7,247
    • 2 hours
    • 🕩2357
    • 👥7

    OpenLayers

    OpenLayers is a high-performance, feature-packed library for creating interactive maps on the web. It can display map tiles, vector data and markers loaded from any source on any web page. OpenLayers has been developed to further the use of geographic information of all kinds. It is completely free, Open Source JavaScript, released under the BSD 2-Clause License.

    Getting Started

    Install the ol package:

    npm install ol
    

    Import just what you need for your application:

    import Map from 'ol/Map';
    import View from 'ol/View';
    import TileLayer from 'ol/layer/Tile';
    import XYZ from 'ol/source/XYZ';
    
    new Map({
      target: 'map',
      layers: [
        new TileLayer({
          source: new XYZ({
            url: 'https://{a-c}.tile.openstreetmap.org/{z}/{x}/{y}.png'
          })
        })
      ],
      view: new View({
        center: [0, 0],
        zoom: 2
      })
    });
    

    See the following examples for more detail on bundling OpenLayers with your application:

    Sponsors

    OpenLayers appreciates contributions of all kinds. We especially want to thank our fiscal sponsors who contribute to ongoing project maintenance.

    Pozi logo

    Pozi helps connect communities through spatial thinking. We love Openlayers and it forms a core part of our platform. https://pozi.com/ https://app.pozi.com/

    See our Open Collective page if you too are interested in becoming a regular sponsor.

    IntelliSense support and type checking for VS Code

    The ol package contains a src/ folder with JSDoc annotated sources. TypeScript can get type definitions from these sources with a jsconfig.json (when authoring in JavaScript) or tsconfig.json (when authoring in TypeScript) config file in the project root:

    jsconfig.json json { "compilerOptions": { "checkJs": true, "baseUrl": "./", "paths": { "ol": ["node_modules/ol/src"], "ol/*": ["node_modules/ol/src/*"] } }, "include": [ "**/*.js", "node_modules/ol/**/*.js" ], "typeAcquisition": { "exclude": ["ol"] } }
    tsconfig.json json { "compilerOptions": { "allowJs": true, "baseUrl": "./", "paths": { "ol": ["node_modules/ol/src"], "ol/*": ["node_modules/ol/src/*"] } }, "include": [ "**/*.ts", "node_modules/ol/**/*" ], "typeAcquisition": { "exclude": ["ol"] } }

    TypeScript users may want to use a third-party types package instead.

    Supported Browsers

    OpenLayers runs on all modern browsers that support HTML5 and ECMAScript 5. This includes Chrome, Firefox, Safari and Edge.

    For older browsers and platforms (Internet Explorer, Android 4.x, iOS v12 and older, Safari v12 and older), polyfills may be needed for the following browser features:

    Documentation

    Check out the hosted examples, the workshop or the API documentation.

    Bugs

    Please use the GitHub issue tracker for all bugs and feature requests. Before creating a new issue, do a quick search to see if the problem has been reported already.

    Contributing

    Please see our guide on contributing if you're interested in getting involved.

    Community

    Test Status

    Show All