Compare commits
5 Commits
docs
...
v4.6.0-bet
| Author | SHA1 | Date | |
|---|---|---|---|
|
43637e2de8 | ||
|
|
0d1dead5c1 | ||
|
|
9c1561a496 | ||
|
|
84fd7477ed | ||
|
|
23ccd0e56e |
@@ -1,60 +0,0 @@
|
|||||||
version: 2
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
docker:
|
|
||||||
- image: circleci/node:latest-browsers
|
|
||||||
|
|
||||||
working_directory: ~/repo
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- checkout
|
|
||||||
|
|
||||||
- restore_cache:
|
|
||||||
keys:
|
|
||||||
- v1-dependencies-{{ checksum "package.json" }}
|
|
||||||
- v1-dependencies-
|
|
||||||
|
|
||||||
- run:
|
|
||||||
name: Install Dependencies
|
|
||||||
command: npm install
|
|
||||||
|
|
||||||
- save_cache:
|
|
||||||
paths:
|
|
||||||
- node_modules
|
|
||||||
key: v1-dependencies-{{ checksum "package.json" }}
|
|
||||||
|
|
||||||
- run:
|
|
||||||
name: Run Tests
|
|
||||||
command: npm test
|
|
||||||
|
|
||||||
- store_artifacts:
|
|
||||||
path: coverage/
|
|
||||||
destination: coverage
|
|
||||||
|
|
||||||
- store_artifacts:
|
|
||||||
path: rendering/cases/
|
|
||||||
destination: rendering
|
|
||||||
|
|
||||||
- run:
|
|
||||||
name: Build Examples
|
|
||||||
command: npm run build-examples
|
|
||||||
|
|
||||||
- store_artifacts:
|
|
||||||
path: build/examples
|
|
||||||
destination: examples
|
|
||||||
|
|
||||||
- run:
|
|
||||||
name: Build API Docs
|
|
||||||
command: npm run apidoc
|
|
||||||
|
|
||||||
- store_artifacts:
|
|
||||||
path: build/apidoc
|
|
||||||
destination: apidoc
|
|
||||||
|
|
||||||
- run:
|
|
||||||
name: Build Website
|
|
||||||
command: npm run build-site
|
|
||||||
|
|
||||||
- store_artifacts:
|
|
||||||
path: public
|
|
||||||
destination: website
|
|
||||||
@@ -11,3 +11,7 @@ insert_final_newline = true
|
|||||||
[*.md]
|
[*.md]
|
||||||
indent_size = 2
|
indent_size = 2
|
||||||
trim_trailing_whitespace = false
|
trim_trailing_whitespace = false
|
||||||
|
|
||||||
|
[Makefile]
|
||||||
|
indent_style = tab
|
||||||
|
indent_size = 4
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
examples/Jugl.js
|
examples/Jugl.js
|
||||||
examples/resources/
|
examples/resources/
|
||||||
build/package/**/*webgl*
|
build/package/**/*webgl*
|
||||||
config/jsdoc/api/template/static/scripts/
|
|
||||||
8
.github/ISSUE_TEMPLATE.md
vendored
Normal file
8
.github/ISSUE_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
Thank you for your interest in making OpenLayers better!
|
||||||
|
|
||||||
|
To keep this project manageable for maintainers, we ask you to please check all boxes below before submitting an issue.
|
||||||
|
|
||||||
|
- [ ] I am submitting a bug or feature request, not a usage question. Go to https://stackoverflow.com/questions/tagged/openlayers for questions.
|
||||||
|
- [ ] I have searched GitHub to see if a similar bug or feature request has already been reported.
|
||||||
|
- [ ] I have verified that the issue is present in the latest version of OpenLayers (see 'LATEST' on https://openlayers.org/).
|
||||||
|
- [ ] If reporting a bug, I have created a [CodePen](https://codepen.io) or prepared a stack trace (using the latest version and unminified code, so e.g. `ol-debug.js`, not `ol.js`) that shows the issue.
|
||||||
19
.github/ISSUE_TEMPLATE/bug_report.md
vendored
19
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -1,19 +0,0 @@
|
|||||||
---
|
|
||||||
name: Bug report
|
|
||||||
about: Create a report to help us improve
|
|
||||||
labels:
|
|
||||||
- bug
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Describe the bug**
|
|
||||||
A clear and concise description of what the bug is.
|
|
||||||
|
|
||||||
**To Reproduce**
|
|
||||||
Steps to reproduce the behavior:
|
|
||||||
1. Go to '...'
|
|
||||||
2. Click on '....'
|
|
||||||
3. See error
|
|
||||||
|
|
||||||
**Expected behavior**
|
|
||||||
A clear and concise description of what you expected to happen.
|
|
||||||
13
.github/ISSUE_TEMPLATE/feature_request.md
vendored
13
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@@ -1,13 +0,0 @@
|
|||||||
---
|
|
||||||
name: Feature request
|
|
||||||
about: Suggest an idea for this project
|
|
||||||
labels:
|
|
||||||
- feature request
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Is your feature request related to a problem? Please describe.**
|
|
||||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
|
||||||
|
|
||||||
**Describe the solution you'd like**
|
|
||||||
A clear and concise description of what you want to happen.
|
|
||||||
16
.github/PULL_REQUEST_TEMPLATE.md
vendored
16
.github/PULL_REQUEST_TEMPLATE.md
vendored
@@ -1,13 +1,9 @@
|
|||||||
<!--
|
|
||||||
Thank you for your interest in making OpenLayers better!
|
Thank you for your interest in making OpenLayers better!
|
||||||
|
|
||||||
Before submitting a pull request, it is best to open an issue describing the bug you are fixing or the feature you are proposing to add.
|
In order to get your proposed changes merged into the master branch, we ask you to please make sure the following boxes are checked *before* submitting your pull request.
|
||||||
|
|
||||||
Here are some other tips that make pull requests easier to review:
|
- [ ] This pull request addresses an issue that has been marked with the 'Pull request accepted' label & I have added the link to that issue.
|
||||||
|
- [ ] It contains one or more small, incremental, logically separate commits, with no merge commits.
|
||||||
* Commits in the branch are small and logically separated (with no unnecessary merge commits).
|
- [ ] I have used clear commit messages.
|
||||||
* Commit messages are clear.
|
- [ ] Existing tests pass for me locally & I have added or updated tests for new or changed functionality.
|
||||||
* Existing tests pass, new functionality is covered by new tests, and fixes have regression tests.
|
- [ ] The work herein is covered by a valid [Contributor License Agreement (CLA)](https://github.com/openlayers/cla).
|
||||||
|
|
||||||
Thanks
|
|
||||||
-->
|
|
||||||
|
|||||||
4
.gitignore
vendored
4
.gitignore
vendored
@@ -1,6 +1,4 @@
|
|||||||
/build/
|
/build/
|
||||||
/coverage/
|
/coverage/
|
||||||
/dist/
|
/dist/
|
||||||
node_modules/
|
/node_modules/
|
||||||
/.cache/
|
|
||||||
/public/
|
|
||||||
|
|||||||
1
.npmignore
Normal file
1
.npmignore
Normal file
@@ -0,0 +1 @@
|
|||||||
|
/build/
|
||||||
22
.travis.yml
Normal file
22
.travis.yml
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
sudo: false
|
||||||
|
language: node_js
|
||||||
|
node_js:
|
||||||
|
- '8'
|
||||||
|
cache:
|
||||||
|
directories:
|
||||||
|
- node_modules
|
||||||
|
before_script:
|
||||||
|
- rm src/ol/renderer/webgl/*shader.js
|
||||||
|
- rm src/ol/renderer/webgl/*shader/locations.js
|
||||||
|
script: make ci
|
||||||
|
after_success:
|
||||||
|
- cat coverage/lcov.info | coveralls
|
||||||
|
branches:
|
||||||
|
only:
|
||||||
|
- master
|
||||||
|
addons:
|
||||||
|
hosts:
|
||||||
|
- travis.dev
|
||||||
|
jwt:
|
||||||
|
# This is the encrypted SAUCE_ACCESS_KEY
|
||||||
|
secure: bb2Ibzu9RLe6ZlIG7JVcuH7IoLMxa/i3LTM7t8mbsPjVOGs5ycyJ7M9MbvqB/F2EzbeV4XB2c9ufI4TkaLYceY5kdWjfZVN8iasr+GFqKMv1uR4i6bpu8KmHJ+blxwfY1QOQ/cGwEx+fbeycMtpTc3Y3GyXaPlCQLhbZvesMg88=
|
||||||
@@ -31,7 +31,12 @@ This page describes what you need to know to contribute code to OpenLayers as a
|
|||||||
|
|
||||||
## Contributor License Agreement
|
## Contributor License Agreement
|
||||||
|
|
||||||
Your contribution will be under our [license](https://raw.githubusercontent.com/openlayers/openlayers/master/LICENSE.md) as per [GitHub's terms of service](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license).
|
Before accepting a contribution, we ask that you provide us a Contributor
|
||||||
|
License Agreement. If you are making your contribution as part of work for
|
||||||
|
your employer, please follow the guidelines on submitting a [Corporate
|
||||||
|
Contributor License Agreement](https://raw.github.com/openlayers/cla/master/ccla.txt). If you are
|
||||||
|
making your contribution as an individual, you can submit a digital [Individual
|
||||||
|
Contributor License Agreement](https://docs.google.com/spreadsheet/viewform?formkey=dGNNVUJEMXF2dERTU0FXM3JjNVBQblE6MQ).
|
||||||
|
|
||||||
|
|
||||||
## Pull request guidelines
|
## Pull request guidelines
|
||||||
@@ -42,7 +47,7 @@ Your pull request must:
|
|||||||
|
|
||||||
* Follow OpenLayers's coding style.
|
* Follow OpenLayers's coding style.
|
||||||
|
|
||||||
* Pass the integration tests run automatically by the CircleCI Continuous
|
* Pass the integration tests run automatically by the Travis Continuous
|
||||||
Integration system.
|
Integration system.
|
||||||
|
|
||||||
* Address a single issue or add a single item of functionality.
|
* Address a single issue or add a single item of functionality.
|
||||||
@@ -55,6 +60,66 @@ Your pull request must:
|
|||||||
* Be possible to merge automatically.
|
* Be possible to merge automatically.
|
||||||
|
|
||||||
|
|
||||||
|
### The `check` build target
|
||||||
|
|
||||||
|
It is strongly recommended that you run
|
||||||
|
|
||||||
|
$ make check
|
||||||
|
|
||||||
|
before every commit. This will catch many problems quickly, and it is much
|
||||||
|
faster than waiting for the Travis CI integration tests to run.
|
||||||
|
|
||||||
|
The `check` build target runs a number of quick tests on your code. These
|
||||||
|
include:
|
||||||
|
|
||||||
|
* Lint
|
||||||
|
* Compile
|
||||||
|
* Tests
|
||||||
|
|
||||||
|
|
||||||
|
### Follow OpenLayers's coding style
|
||||||
|
|
||||||
|
OpenLayers follows [Google's JavaScript Style
|
||||||
|
Guide](https://google.github.io/styleguide/javascriptguide.xml).
|
||||||
|
This is checked using [ESLint](http://eslint.org/), you
|
||||||
|
can run the linter locally on your machine before committing using the `lint`
|
||||||
|
target:
|
||||||
|
|
||||||
|
$ make lint
|
||||||
|
|
||||||
|
In addition to fixing problems identified by the linter, please also follow the
|
||||||
|
style of the existing OpenLayers code, which includes:
|
||||||
|
|
||||||
|
* Always wrap the body of `for`, `if`, and `while` statements in braces.
|
||||||
|
|
||||||
|
* Class methods should be in alphabetical order.
|
||||||
|
|
||||||
|
* `var` declarations should not span multiple lines. If you cannot fit all
|
||||||
|
the declarations in a single line, then start a new `var` declaration on a
|
||||||
|
new line. Within a single line, variables should be declared in
|
||||||
|
alphabetical order.
|
||||||
|
|
||||||
|
* Do not use assignments inside expressions.
|
||||||
|
|
||||||
|
* Use uppercase for `@const` variables.
|
||||||
|
|
||||||
|
### Configure your editor
|
||||||
|
|
||||||
|
If possible, configure your editor to follow the coding conventions of the
|
||||||
|
library. A `.editorconfig` file is included at the root of the repository that
|
||||||
|
can be used to configure whitespace and charset handling in your editor. See
|
||||||
|
that file for a description of the conventions. The [EditorConfig](
|
||||||
|
http://editorconfig.org/#download) site links to plugins for various editors.
|
||||||
|
|
||||||
|
### Pass the integration tests run automatically by the Travis CI system
|
||||||
|
|
||||||
|
The integration tests contain a number of automated checks to ensure that the
|
||||||
|
code follows the OpenLayers style and does not break tests or examples. You
|
||||||
|
can run the integration tests locally using the `ci` target:
|
||||||
|
|
||||||
|
$ make ci
|
||||||
|
|
||||||
|
|
||||||
### Address a single issue or add a single item of functionality
|
### Address a single issue or add a single item of functionality
|
||||||
|
|
||||||
Please submit separate pull requests for separate issues. This allows each to
|
Please submit separate pull requests for separate issues. This allows each to
|
||||||
@@ -108,3 +173,33 @@ Occasionally other changes to `master` might mean that your pull request cannot
|
|||||||
be merged automatically. In this case you may need to rebase your branch on a
|
be merged automatically. In this case you may need to rebase your branch on a
|
||||||
more recent `master`, resolve any conflicts, and `git push --force` to update
|
more recent `master`, resolve any conflicts, and `git push --force` to update
|
||||||
your branch so that it can be merged automatically.
|
your branch so that it can be merged automatically.
|
||||||
|
|
||||||
|
## Building on Windows
|
||||||
|
|
||||||
|
Most developers build on Linux. Building on Windows is possible under Cygwin.
|
||||||
|
When installing Cygwin from https://www.cygwin.com/, include the developer
|
||||||
|
tools to get GNU make.
|
||||||
|
|
||||||
|
First (before npm install), to avoid file permission problems between Windows
|
||||||
|
and Cygwin, edit Cygwin's /etc/fstab file to disable ACLs like this
|
||||||
|
`none /cygdrive cygdrive binary,noacl,posix=0,user 0 0`
|
||||||
|
|
||||||
|
Python is normally installed with Cygwin so need not be installed separately.
|
||||||
|
By default Cygwin will use its own version of Python rather than Window's,
|
||||||
|
so the Python modules should be installed for Cygwin's Python.
|
||||||
|
|
||||||
|
The build targets `check-deps`, `serve`, `lint`, `build`, `test`, `check` and
|
||||||
|
`host-examples` described above should all work. `host-examples` takes quite a
|
||||||
|
while to run. If a target does not run properly first time, try it again.
|
||||||
|
|
||||||
|
Currently, Firefox fails to run http://localhost:3000/build/examples
|
||||||
|
from make serve, but Chrome and Internet Explorer will.
|
||||||
|
|
||||||
|
Microsoft Visual Studio's javascript debugger may be used to debug the
|
||||||
|
build/hosted/your-branch/examples. It will be convenient to set
|
||||||
|
build/hosted/your-branch/examples/index.html as the startup page.
|
||||||
|
|
||||||
|
Your OpenLayers source tree need not be under the Cygwin root.
|
||||||
|
if you checkout to c:/openlayers then you can build under Cygwin at /cygdrive/c/openlayers .
|
||||||
|
However, keep the path to the OpenLayers files short otherwise you may see
|
||||||
|
`ENAMETOOLONG` errors.
|
||||||
|
|||||||
100
DEVELOPING.md
100
DEVELOPING.md
@@ -5,9 +5,9 @@
|
|||||||
You will obviously start by
|
You will obviously start by
|
||||||
[forking](https://github.com/openlayers/openlayers/fork) the OpenLayers repository.
|
[forking](https://github.com/openlayers/openlayers/fork) the OpenLayers repository.
|
||||||
|
|
||||||
### CircleCI
|
### Travis CI
|
||||||
|
|
||||||
The CircleCI hook is enabled on the Github repository. This means every pull request
|
The Travis CI hook is enabled on the Github repository. This means every pull request
|
||||||
is run through a full test suite to ensure it compiles and passes the tests. Failing
|
is run through a full test suite to ensure it compiles and passes the tests. Failing
|
||||||
pull requests will not be merged.
|
pull requests will not be merged.
|
||||||
|
|
||||||
@@ -15,32 +15,103 @@ pull requests will not be merged.
|
|||||||
|
|
||||||
The minimum requirements are:
|
The minimum requirements are:
|
||||||
|
|
||||||
|
* GNU Make
|
||||||
* Git
|
* Git
|
||||||
* [Node.js](http://nodejs.org/) (version 8 and above)
|
* [Node.js](http://nodejs.org/) (version 8 and above)
|
||||||
|
* Python 2.6 or 2.7
|
||||||
|
* Java 7 (JRE and JDK)
|
||||||
|
|
||||||
The executables `git` and `node` should be in your `PATH`.
|
The executables `git`, `node`, and `java` should be in your `PATH`.
|
||||||
|
|
||||||
|
You can check your configuration by running:
|
||||||
|
|
||||||
|
$ make check-deps
|
||||||
|
|
||||||
To install the Node.js dependencies run
|
To install the Node.js dependencies run
|
||||||
|
|
||||||
$ npm install
|
$ npm install
|
||||||
|
|
||||||
|
## Working with the build tool
|
||||||
|
|
||||||
|
As an OpenLayers developer you will use `make` to run build targets defined in the
|
||||||
|
`Makefile` located at the root of the repository. The `Makefile` includes
|
||||||
|
targets for running the linter, the compiler, the tests, etc.
|
||||||
|
|
||||||
|
The usage of `make` is as follows:
|
||||||
|
|
||||||
|
$ make <target>
|
||||||
|
|
||||||
|
where `<target>` is the name of the build target you want to execute. For
|
||||||
|
example:
|
||||||
|
|
||||||
|
$ make test
|
||||||
|
|
||||||
|
The main build targets are `serve`, `lint`, `build`, `test`, and `check`. The
|
||||||
|
latter is a meta-target that basically runs `lint`, `build`, and `test`.
|
||||||
|
|
||||||
|
The `serve` target starts a node-based web server, which we will refer to as the *dev server*. You'll need to start that server for running the examples and the tests in a browser. More information on that further down.
|
||||||
|
|
||||||
|
Other targets include `apidoc` and `ci`. The latter is the target used on Travis CI. See OpenLayers's [Travis configuration file](https://github.com/openlayers/openlayers/blob/master/.travis.yml).
|
||||||
|
|
||||||
|
## Running the `check` target
|
||||||
|
|
||||||
|
The `check` target is to be run before pushing code to GitHub and opening pull
|
||||||
|
requests. Branches that don't pass `check` won't pass the integration tests,
|
||||||
|
and have therefore no chance of being merged into `master`.
|
||||||
|
|
||||||
|
To run the `check` target:
|
||||||
|
|
||||||
|
$ make check
|
||||||
|
|
||||||
|
If you want to run the full suite of integration tests, see "Running the integration
|
||||||
|
tests" below.
|
||||||
|
|
||||||
## Running examples
|
## Running examples
|
||||||
|
|
||||||
To run the examples you first need to start the dev server:
|
To run the examples you first need to start the dev server:
|
||||||
|
|
||||||
$ npm run serve-examples
|
$ make serve
|
||||||
|
|
||||||
Then, load <http://localhost:8080/> in your browser.
|
Then, just point your browser <http://localhost:3000/build/examples> in your browser. For example <http://localhost:3000/build/examples/side-by-side.html>.
|
||||||
|
|
||||||
|
Run examples against the `ol.js` standalone build:
|
||||||
|
|
||||||
|
The examples can also be run against the `ol.js` standalone build, just like
|
||||||
|
the examples [hosted](https://openlayers.org/en/master/examples/) on GitHub.
|
||||||
|
Start by executing the `host-examples` build target:
|
||||||
|
|
||||||
|
$ make host-examples
|
||||||
|
|
||||||
|
After running `host-examples` you can now open the examples index page in the browser: <http://localhost:3000/build/hosted/master/examples/>. (This assumes that you still have the dev server running.)
|
||||||
|
|
||||||
|
Append `?mode=raw` to make the example work in full debug mode. In raw mode the OpenLayers and Closure Library scripts are loaded individually by the Closure Library's `base.js` script (which the example page loads and executes before any other script).
|
||||||
|
|
||||||
## Running tests
|
## Running tests
|
||||||
|
|
||||||
To run the tests once:
|
To run the tests in a browser start the dev server (`make serve`) and open <http://localhost:3000/test/index.html> in the browser.
|
||||||
|
|
||||||
$ npm test
|
To run the tests on the console (headless testing with PhantomJS) use the `test` target:
|
||||||
|
|
||||||
To run the tests continuously during development:
|
$ make test
|
||||||
|
|
||||||
$ npm run karma
|
See also the test-specific [README](../master/test/README.md).
|
||||||
|
|
||||||
|
## Running the integration tests
|
||||||
|
|
||||||
|
When you submit a pull request the [Travis continuous integration
|
||||||
|
server](https://travis-ci.org/) will run a full suite of tests, including
|
||||||
|
building all versions of the library and checking that all of the examples
|
||||||
|
work. You will receive an email with the results, and the status will be
|
||||||
|
displayed in the pull request.
|
||||||
|
|
||||||
|
To run the full suite of integration tests use the `ci` target:
|
||||||
|
|
||||||
|
$ make ci
|
||||||
|
|
||||||
|
Running the full suite of integration tests currently takes 5-10 minutes.
|
||||||
|
|
||||||
|
This makes sure that your commit won't break the build. It also runs JSDoc3 to
|
||||||
|
make sure that there are no invalid API doc directives.
|
||||||
|
|
||||||
## Adding examples
|
## Adding examples
|
||||||
|
|
||||||
@@ -52,3 +123,14 @@ implies creating two or three files in this directory, an `.html` file, a `.js`
|
|||||||
file, and, optionally, a `.css` file.
|
file, and, optionally, a `.css` file.
|
||||||
|
|
||||||
You can use `simple.js` and `simple.html` as templates for new examples.
|
You can use `simple.js` and `simple.html` as templates for new examples.
|
||||||
|
|
||||||
|
### Use of the `goog` namespace in examples
|
||||||
|
|
||||||
|
Short story: the OpenLayers examples should not use the `goog` namespace, except
|
||||||
|
for `goog.require`.
|
||||||
|
|
||||||
|
Longer story: we want that the OpenLayers examples work in multiple modes, with the
|
||||||
|
standalone lib (which has implications of the symbols and properties we
|
||||||
|
export), and compiled together with the OpenLayers library.
|
||||||
|
|
||||||
|
Compiling the examples together with the library makes it mandatory to declare dependencies with `goog.require` statements.
|
||||||
|
|||||||
39
LICENSE.md
39
LICENSE.md
@@ -1,25 +1,26 @@
|
|||||||
BSD 2-Clause License
|
Copyright 2005-present OpenLayers Contributors. All rights reserved.
|
||||||
|
|
||||||
Copyright 2005-present, OpenLayers Contributors
|
Redistribution and use in source and binary forms, with or without modification,
|
||||||
All rights reserved.
|
are permitted provided that the following conditions are met:
|
||||||
|
|
||||||
Redistribution and use in source and binary forms, with or without
|
|
||||||
modification, are permitted provided that the following conditions are met:
|
|
||||||
|
|
||||||
1. Redistributions of source code must retain the above copyright notice, this
|
1. Redistributions of source code must retain the above copyright notice, this
|
||||||
list of conditions and the following disclaimer.
|
list of conditions and the following disclaimer.
|
||||||
|
|
||||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||||
this list of conditions and the following disclaimer in the documentation
|
this list of conditions and the following disclaimer in the documentation and/or
|
||||||
and/or other materials provided with the distribution.
|
other materials provided with the distribution.
|
||||||
|
|
||||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
THIS SOFTWARE IS PROVIDED BY OPENLAYERS CONTRIBUTORS ``AS IS'' AND ANY EXPRESS
|
||||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
|
||||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
SHALL COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
||||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
||||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
||||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
|
||||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
|
||||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
The views and conclusions contained in the software and documentation are those
|
||||||
|
of the authors and should not be interpreted as representing official policies,
|
||||||
|
either expressed or implied, of OpenLayers Contributors.
|
||||||
|
|||||||
280
Makefile
Normal file
280
Makefile
Normal file
@@ -0,0 +1,280 @@
|
|||||||
|
OS := $(shell uname)
|
||||||
|
BRANCH := $(shell git rev-parse --abbrev-ref HEAD)
|
||||||
|
|
||||||
|
SRC_GLSL := $(shell find src -type f -name '*.glsl')
|
||||||
|
SRC_SHADER_JS := $(patsubst %shader.glsl,%shader.js,$(SRC_GLSL))
|
||||||
|
SRC_SHADERLOCATIONS_JS := $(patsubst %shader.glsl,%shader/locations.js,$(SRC_GLSL))
|
||||||
|
SRC_JS := $(filter-out $(SRC_SHADER_JS) $(SRC_SHADERLOCATIONS_JS),$(shell find src -name '*.js'))
|
||||||
|
SRC_JSDOC = $(shell find src -type f -name '*.jsdoc')
|
||||||
|
|
||||||
|
EXAMPLES := $(shell find examples -type f)
|
||||||
|
EXAMPLES_HTML := $(filter-out examples/index.html,$(shell find examples -maxdepth 1 -type f -name '*.html'))
|
||||||
|
EXAMPLES_JS := $(patsubst %.html,%.js,$(EXAMPLES_HTML))
|
||||||
|
|
||||||
|
BUILD_EXAMPLES := $(subst examples,build/examples,$(EXAMPLES)) build/examples/index.js
|
||||||
|
|
||||||
|
BUILD_HOSTED := build/hosted/$(BRANCH)
|
||||||
|
BUILD_HOSTED_EXAMPLES := $(addprefix $(BUILD_HOSTED)/,$(EXAMPLES))
|
||||||
|
BUILD_HOSTED_EXAMPLES_JS := $(addprefix $(BUILD_HOSTED)/,$(EXAMPLES_JS))
|
||||||
|
|
||||||
|
UNPHANTOMABLE_EXAMPLES = examples/shaded-relief.html examples/raster.html examples/region-growing.html examples/color-manipulation.html
|
||||||
|
CHECK_EXAMPLE_TIMESTAMPS = $(patsubst examples/%.html,build/timestamps/check-%-timestamp,$(filter-out $(UNPHANTOMABLE_EXAMPLES),$(EXAMPLES_HTML)))
|
||||||
|
|
||||||
|
TASKS_JS := $(shell find tasks -name '*.js')
|
||||||
|
|
||||||
|
ifeq (CYGWIN,$(findstring CYGWIN,$(OS)))
|
||||||
|
CLOSURE_LIB = $(shell cygpath -u $(shell node -e 'process.stdout.write(require("closure-util").getLibraryPath())'))
|
||||||
|
else
|
||||||
|
CLOSURE_LIB = $(shell node -e 'process.stdout.write(require("closure-util").getLibraryPath())')
|
||||||
|
endif
|
||||||
|
|
||||||
|
ifeq ($(OS),Darwin)
|
||||||
|
STAT_COMPRESSED = stat -f ' compressed: %z bytes'
|
||||||
|
STAT_UNCOMPRESSED = stat -f 'uncompressed: %z bytes'
|
||||||
|
else
|
||||||
|
STAT_COMPRESSED = stat -c ' compressed: %s bytes'
|
||||||
|
STAT_UNCOMPRESSED = stat -c 'uncompressed: %s bytes'
|
||||||
|
endif
|
||||||
|
|
||||||
|
.PHONY: default
|
||||||
|
default: help
|
||||||
|
|
||||||
|
.PHONY: help
|
||||||
|
help:
|
||||||
|
@echo
|
||||||
|
@echo "The most common targets are:"
|
||||||
|
@echo
|
||||||
|
@echo "- install Install node dependencies"
|
||||||
|
@echo "- serve Start dev server for running examples and tests"
|
||||||
|
@echo "- test Run unit tests in the console"
|
||||||
|
@echo "- check Perform a number of checks on the code"
|
||||||
|
@echo "- clean Remove generated files"
|
||||||
|
@echo "- help Display this help message"
|
||||||
|
@echo
|
||||||
|
@echo "Other less frequently used targets are:"
|
||||||
|
@echo
|
||||||
|
@echo "- build Build ol.js, ol-debug.js, ol.js.map and ol.css"
|
||||||
|
@echo "- ci Run the full continuous integration process"
|
||||||
|
@echo "- apidoc Build the API documentation using JSDoc"
|
||||||
|
@echo "- cleanall Remove all the build artefacts"
|
||||||
|
@echo "- check-deps Check if the required dependencies are installed"
|
||||||
|
@echo
|
||||||
|
|
||||||
|
.PHONY: apidoc
|
||||||
|
apidoc: build/timestamps/jsdoc-$(BRANCH)-timestamp
|
||||||
|
|
||||||
|
.PHONY: build
|
||||||
|
build: build/ol.css build/ol.js build/ol-debug.js build/ol.js.map
|
||||||
|
|
||||||
|
.PHONY: check
|
||||||
|
check: build/ol.js test
|
||||||
|
|
||||||
|
.PHONY: check-examples
|
||||||
|
check-examples: $(CHECK_EXAMPLE_TIMESTAMPS)
|
||||||
|
|
||||||
|
.PHONY: check-deps
|
||||||
|
check-deps: EXECUTABLES = git node python java
|
||||||
|
check-deps:
|
||||||
|
@for exe in $(EXECUTABLES) ;\
|
||||||
|
do \
|
||||||
|
which $${exe} > /dev/null && \
|
||||||
|
echo "Program $${exe} OK" || \
|
||||||
|
echo "Program $${exe} MISSING!" ;\
|
||||||
|
done ;\
|
||||||
|
|
||||||
|
.PHONY: ci
|
||||||
|
ci: build test package compile-examples check-examples apidoc
|
||||||
|
|
||||||
|
.PHONY: compile-examples
|
||||||
|
compile-examples: build/compiled-examples/all.combined.js
|
||||||
|
|
||||||
|
.PHONY: clean
|
||||||
|
clean:
|
||||||
|
rm -f build/timestamps/check-*-timestamp
|
||||||
|
rm -f build/ol.css
|
||||||
|
rm -f build/ol.js
|
||||||
|
rm -f build/ol.js.map
|
||||||
|
rm -f build/ol-debug.js
|
||||||
|
rm -rf build/examples
|
||||||
|
rm -rf build/compiled-examples
|
||||||
|
rm -rf build/package
|
||||||
|
rm -rf $(BUILD_HOSTED)
|
||||||
|
|
||||||
|
.PHONY: cleanall
|
||||||
|
cleanall:
|
||||||
|
rm -rf build
|
||||||
|
|
||||||
|
.PHONY: css
|
||||||
|
css: build/ol.css
|
||||||
|
|
||||||
|
.PHONY: examples
|
||||||
|
examples: $(BUILD_EXAMPLES)
|
||||||
|
|
||||||
|
.PHONY: install
|
||||||
|
install: build/timestamps/node-modules-timestamp
|
||||||
|
|
||||||
|
.PHONY: npm-install
|
||||||
|
npm-install: build/timestamps/node-modules-timestamp
|
||||||
|
|
||||||
|
.PHONY: shaders
|
||||||
|
shaders: $(SRC_SHADER_JS $(SRC_SHADERLOCATIONS_JS)
|
||||||
|
|
||||||
|
.PHONY: serve
|
||||||
|
serve:
|
||||||
|
node tasks/serve.js
|
||||||
|
|
||||||
|
.PHONY: test
|
||||||
|
test: build/timestamps/node-modules-timestamp
|
||||||
|
npm test
|
||||||
|
|
||||||
|
.PHONY: host-examples
|
||||||
|
host-examples: $(BUILD_HOSTED_EXAMPLES) \
|
||||||
|
$(BUILD_HOSTED)/build/ol.js \
|
||||||
|
$(BUILD_HOSTED)/build/ol-debug.js \
|
||||||
|
$(BUILD_HOSTED)/css/ol.css \
|
||||||
|
$(BUILD_HOSTED)/examples/loader.js \
|
||||||
|
$(BUILD_HOSTED)/examples/index.js \
|
||||||
|
$(BUILD_HOSTED)/build/ol-deps.js
|
||||||
|
|
||||||
|
.PHONY: host-libraries
|
||||||
|
host-libraries: build/timestamps/node-modules-timestamp
|
||||||
|
@rm -rf $(BUILD_HOSTED)/closure-library
|
||||||
|
@mkdir -p $(BUILD_HOSTED)/closure-library
|
||||||
|
@cp -r $(CLOSURE_LIB)/* $(BUILD_HOSTED)/closure-library/
|
||||||
|
@rm -rf $(BUILD_HOSTED)/ol/ol
|
||||||
|
@mkdir -p $(BUILD_HOSTED)/ol/ol
|
||||||
|
@cp -r src/ol/* $(BUILD_HOSTED)/ol/ol/
|
||||||
|
@rm -rf $(BUILD_HOSTED)/ol.ext
|
||||||
|
@mkdir -p $(BUILD_HOSTED)/ol.ext
|
||||||
|
@cp -r build/ol.ext/* $(BUILD_HOSTED)/ol.ext/
|
||||||
|
|
||||||
|
$(BUILD_EXAMPLES): $(EXAMPLES) package.json
|
||||||
|
@mkdir -p $(@D)
|
||||||
|
@node tasks/build-examples.js
|
||||||
|
|
||||||
|
build/timestamps/check-%-timestamp: $(BUILD_HOSTED)/examples/%.html \
|
||||||
|
$(BUILD_HOSTED)/examples/%.js \
|
||||||
|
$(filter $(BUILD_HOSTED)/examples/resources/%,$(BUILD_HOSTED_EXAMPLES)) \
|
||||||
|
$(filter $(BUILD_HOSTED)/examples/data/%,$(BUILD_HOSTED_EXAMPLES)) \
|
||||||
|
$(BUILD_HOSTED)/examples/loader.js \
|
||||||
|
$(BUILD_HOSTED)/build/ol.js \
|
||||||
|
$(BUILD_HOSTED)/css/ol.css
|
||||||
|
@mkdir -p $(@D)
|
||||||
|
node tasks/check-example.js $<
|
||||||
|
@touch $@
|
||||||
|
|
||||||
|
build/compiled-examples/all.js: $(EXAMPLES_JS)
|
||||||
|
@mkdir -p $(@D)
|
||||||
|
@python bin/combine-examples.py $^ > $@
|
||||||
|
|
||||||
|
build/compiled-examples/all.combined.js: config/examples-all.json build/compiled-examples/all.js \
|
||||||
|
$(SRC_JS) $(SRC_SHADER_JS) $(SRC_SHADERLOCATIONS_JS) \
|
||||||
|
build/timestamps/node-modules-timestamp
|
||||||
|
@mkdir -p $(@D)
|
||||||
|
node tasks/build.js $< $@
|
||||||
|
|
||||||
|
build/compiled-examples/%.json: config/example.json build/examples/%.js \
|
||||||
|
build/timestamps/node-modules-timestamp
|
||||||
|
@mkdir -p $(@D)
|
||||||
|
@sed -e 's|{{id}}|$*|' $< > $@
|
||||||
|
|
||||||
|
build/compiled-examples/%.combined.js: build/compiled-examples/%.json \
|
||||||
|
$(SRC_JS) $(SRC_SHADER_JS) $(SRC_SHADERLOCATIONS_JS)\
|
||||||
|
build/timestamps/node-modules-timestamp
|
||||||
|
@mkdir -p $(@D)
|
||||||
|
node tasks/build.js $< $@
|
||||||
|
|
||||||
|
build/timestamps/jsdoc-$(BRANCH)-timestamp: config/jsdoc/api/index.md \
|
||||||
|
config/jsdoc/api/conf.json $(SRC_JS) \
|
||||||
|
$(SRC_SHADER_JS) $(SRC_SHADERLOCATIONS_JS) \
|
||||||
|
$(shell find config/jsdoc/api/template -type f) \
|
||||||
|
build/timestamps/node-modules-timestamp
|
||||||
|
@mkdir -p $(@D)
|
||||||
|
@rm -rf $(BUILD_HOSTED)/apidoc
|
||||||
|
./node_modules/.bin/jsdoc config/jsdoc/api/index.md -c config/jsdoc/api/conf.json --package package.json -d $(BUILD_HOSTED)/apidoc
|
||||||
|
@touch $@
|
||||||
|
|
||||||
|
$(BUILD_HOSTED_EXAMPLES_JS): $(BUILD_HOSTED)/examples/%.js: build/examples/%.js
|
||||||
|
@mkdir -p $(@D)
|
||||||
|
@python bin/split-example.py $< $(@D)
|
||||||
|
|
||||||
|
$(BUILD_HOSTED)/examples/loader.js: bin/loader_hosted_examples.js
|
||||||
|
@mkdir -p $(@D)
|
||||||
|
@cp $< $@
|
||||||
|
|
||||||
|
$(BUILD_HOSTED)/examples/%: build/examples/%
|
||||||
|
@mkdir -p $(@D)
|
||||||
|
@cp $< $@
|
||||||
|
|
||||||
|
$(BUILD_HOSTED)/build/ol.js: build/ol.js
|
||||||
|
@mkdir -p $(@D)
|
||||||
|
@cp $< $@
|
||||||
|
|
||||||
|
$(BUILD_HOSTED)/build/ol-debug.js: build/ol-debug.js
|
||||||
|
@mkdir -p $(@D)
|
||||||
|
@cp $< $@
|
||||||
|
|
||||||
|
$(BUILD_HOSTED)/css/ol.css: build/ol.css
|
||||||
|
@mkdir -p $(@D)
|
||||||
|
@cp $< $@
|
||||||
|
|
||||||
|
$(BUILD_HOSTED)/build/ol-deps.js: host-libraries
|
||||||
|
@mkdir -p $(@D)
|
||||||
|
@python $(CLOSURE_LIB)/closure/bin/build/depswriter.py \
|
||||||
|
--root_with_prefix "src ../../../ol" \
|
||||||
|
--root_with_prefix "build/ol.ext ../../../ol.ext" \
|
||||||
|
--root $(BUILD_HOSTED)/closure-library/closure/goog \
|
||||||
|
--root_with_prefix "$(BUILD_HOSTED)/closure-library/third_party ../../third_party" \
|
||||||
|
--output_file $@
|
||||||
|
|
||||||
|
build/timestamps/node-modules-timestamp: package.json
|
||||||
|
@mkdir -p $(@D)
|
||||||
|
npm install
|
||||||
|
@touch $@
|
||||||
|
|
||||||
|
build/ol.css: css/ol.css build/timestamps/node-modules-timestamp
|
||||||
|
@mkdir -p $(@D)
|
||||||
|
@echo "Running cleancss..."
|
||||||
|
@./node_modules/.bin/cleancss $< > $@
|
||||||
|
|
||||||
|
build/ol.js: config/ol.json $(SRC_JS) $(SRC_SHADER_JS) $(SRC_SHADERLOCATIONS_JS) \
|
||||||
|
build/timestamps/node-modules-timestamp
|
||||||
|
@mkdir -p $(@D)
|
||||||
|
node tasks/build.js $< $@
|
||||||
|
@$(STAT_UNCOMPRESSED) $@
|
||||||
|
@cp $@ /tmp/
|
||||||
|
@gzip /tmp/ol.js
|
||||||
|
@$(STAT_COMPRESSED) /tmp/ol.js.gz
|
||||||
|
@rm /tmp/ol.js.gz
|
||||||
|
|
||||||
|
build/ol.js.map: config/ol.json $(SRC_JS) $(SRC_SHADER_JS) $(SRC_SHADERLOCATIONS_JS) \
|
||||||
|
build/timestamps/node-modules-timestamp
|
||||||
|
@mkdir -p $(@D)
|
||||||
|
node tasks/build.js $< $@
|
||||||
|
|
||||||
|
build/ol-debug.js: config/ol-debug.json $(SRC_JS) $(SRC_SHADER_JS) $(SRC_SHADERLOCATIONS_JS) \
|
||||||
|
build/timestamps/node-modules-timestamp
|
||||||
|
@mkdir -p $(@D)
|
||||||
|
node tasks/build.js $< $@
|
||||||
|
@$(STAT_UNCOMPRESSED) $@
|
||||||
|
@cp $@ /tmp/
|
||||||
|
@gzip /tmp/ol-debug.js
|
||||||
|
@$(STAT_COMPRESSED) /tmp/ol-debug.js.gz
|
||||||
|
@rm /tmp/ol-debug.js.gz
|
||||||
|
|
||||||
|
%shader.js: %shader.glsl src/ol/webgl/shader.mustache tasks/glslunit.js build/timestamps/node-modules-timestamp
|
||||||
|
@node tasks/glslunit.js --input $< | ./node_modules/.bin/mustache - src/ol/webgl/shader.mustache > $@
|
||||||
|
|
||||||
|
%shader/locations.js: %shader.glsl src/ol/webgl/shaderlocations.mustache tasks/glslunit.js build/timestamps/node-modules-timestamp
|
||||||
|
@mkdir -p $(@D)
|
||||||
|
@node tasks/glslunit.js --input $< | ./node_modules/.bin/mustache - src/ol/webgl/shaderlocations.mustache > $@
|
||||||
|
|
||||||
|
.PHONY: package
|
||||||
|
package:
|
||||||
|
@rm -rf build/package
|
||||||
|
@cp -r package build
|
||||||
|
@cd ./src && cp -r ol/* ../build/package
|
||||||
|
@rm build/package/typedefs.js
|
||||||
|
@cp css/ol.css build/package
|
||||||
|
./node_modules/.bin/jscodeshift --transform transforms/module.js build/package
|
||||||
|
npm run lint-package
|
||||||
73
README.md
73
README.md
@@ -1,69 +1,24 @@
|
|||||||
# OpenLayers
|
# OpenLayers
|
||||||
|
|
||||||
[OpenLayers](https://openlayers.org/) 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](https://opensource.org/licenses/BSD-2-Clause).
|
[](http://travis-ci.org/#!/openlayers/openlayers)
|
||||||
|
[](https://greenkeeper.io/)
|
||||||
|
[](https://coveralls.io/github/openlayers/openlayers?branch=master)
|
||||||
|
[](http://osgeo.org/)
|
||||||
|
|
||||||
|
[OpenLayers](https://openlayers.org/) 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 2-clause BSD License (also known as the FreeBSD).
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
Install the [`ol` package](https://www.npmjs.com/package/ol):
|
Use one of the following methods to use OpenLayers in your project:
|
||||||
|
|
||||||
```
|
* For use with webpack, Rollup, Browserify, or other module bundlers, install the [`ol` package](https://www.npmjs.com/package/ol):
|
||||||
npm install ol
|
```
|
||||||
```
|
npm install ol
|
||||||
|
```
|
||||||
|
|
||||||
Import just what you need for your application:
|
* If you just want to add a `<script>` tag to test things out, you can link directly to one of the full builds from [cdnjs](https://cdnjs.com/libraries/openlayers) (not recommended for production)
|
||||||
|
|
||||||
```js
|
* For use with Closure Library (rare), install the [`openlayers` package](https://npmjs.com/package/openlayers) and read the [tutorial](http://openlayers.org/en/latest/doc/tutorials/closure.html).
|
||||||
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:
|
|
||||||
|
|
||||||
* Using [Rollup](https://github.com/openlayers/ol-rollup)
|
|
||||||
* Using [Webpack](https://github.com/openlayers/ol-webpack)
|
|
||||||
* Using [Parcel](https://github.com/openlayers/ol-parcel)
|
|
||||||
* Using [Browserify](https://github.com/openlayers/ol-browserify)
|
|
||||||
|
|
||||||
## 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` config file in the project root:
|
|
||||||
```js
|
|
||||||
{
|
|
||||||
"compilerOptions": {
|
|
||||||
"checkJs": true,
|
|
||||||
// Point to the JSDoc typed sources when using modules from the ol package
|
|
||||||
"baseUrl": "./",
|
|
||||||
"paths": {
|
|
||||||
"ol": ["node_modules/ol/src"],
|
|
||||||
"ol/*": ["node_modules/ol/src/*"]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"include": [
|
|
||||||
"**/*.js",
|
|
||||||
"node_modules/ol/**/*.js"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
Project template with this configuration: https://gist.github.com/9a7253cb4712e8bf38d75d8ac898e36c.
|
|
||||||
|
|
||||||
Note that the above only works when authoring in plain JavaScript. For similar configurations with a `tsconfig.json` in TypeScript projects, your mileage may vary.
|
|
||||||
|
|
||||||
## Supported Browsers
|
## Supported Browsers
|
||||||
|
|
||||||
@@ -85,5 +40,3 @@ Please see our guide on [contributing](CONTRIBUTING.md) if you're interested in
|
|||||||
|
|
||||||
- Need help? Find it on [Stack Overflow using the tag 'openlayers'](http://stackoverflow.com/questions/tagged/openlayers)
|
- Need help? Find it on [Stack Overflow using the tag 'openlayers'](http://stackoverflow.com/questions/tagged/openlayers)
|
||||||
- Follow [@openlayers](https://twitter.com/openlayers) on Twitter
|
- Follow [@openlayers](https://twitter.com/openlayers) on Twitter
|
||||||
|
|
||||||
[](https://circleci.com/gh/openlayers/openlayers/tree/master)
|
|
||||||
|
|||||||
33
bin/check-example.js
Normal file
33
bin/check-example.js
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
//
|
||||||
|
// A PhantomJS script used to check that the hosted examples load
|
||||||
|
// without errors. This script is executed by the build tool's
|
||||||
|
// check-examples target.
|
||||||
|
//
|
||||||
|
var args = require('system').args;
|
||||||
|
if (args.length != 2) {
|
||||||
|
phantom.exit(2);
|
||||||
|
}
|
||||||
|
var examplePath = args[1];
|
||||||
|
var page = require('webpage').create();
|
||||||
|
page.onError = function(msg, trace) {
|
||||||
|
var msgStack = ['JavaScript ERROR: ' + msg];
|
||||||
|
if (trace) {
|
||||||
|
msgStack.push('TRACE:');
|
||||||
|
trace.forEach(function(t) {
|
||||||
|
msgStack.push(' -> ' + t.file + ': ' + t.line + (t.function ? ' (in function "' + t.function + '")' : ''));
|
||||||
|
});
|
||||||
|
}
|
||||||
|
console.error(msgStack.join('\n'));
|
||||||
|
phantom.exit(1);
|
||||||
|
};
|
||||||
|
page.open(examplePath, function(s) {
|
||||||
|
var exitCode = 0;
|
||||||
|
if (s != 'success') {
|
||||||
|
exitCode = 1;
|
||||||
|
console.error('PAGE LOAD ERROR');
|
||||||
|
}
|
||||||
|
phantom.exit(exitCode);
|
||||||
|
});
|
||||||
|
page.onConsoleMessage = function(msg) {
|
||||||
|
console.log('console:', msg);
|
||||||
|
};
|
||||||
27
bin/combine-examples.py
Executable file
27
bin/combine-examples.py
Executable file
@@ -0,0 +1,27 @@
|
|||||||
|
#!/usr/bin/python
|
||||||
|
|
||||||
|
import re
|
||||||
|
import sys
|
||||||
|
|
||||||
|
|
||||||
|
def main(argv):
|
||||||
|
examples = {}
|
||||||
|
requires = set()
|
||||||
|
for filename in argv[1:]:
|
||||||
|
lines = open(filename, 'rU').readlines()
|
||||||
|
if len(lines) > 0 and lines[0].startswith('// NOCOMPILE'):
|
||||||
|
continue
|
||||||
|
requires.update(line for line in lines if line.startswith('goog.require'))
|
||||||
|
examples[filename] = [line for line in lines if not line.startswith('goog.require')]
|
||||||
|
for require in sorted(requires):
|
||||||
|
sys.stdout.write(require)
|
||||||
|
for filename in sorted(examples.keys()):
|
||||||
|
sys.stdout.write('// ' + filename + '\n')
|
||||||
|
sys.stdout.write('(function(){\n')
|
||||||
|
for line in examples[filename]:
|
||||||
|
sys.stdout.write(line)
|
||||||
|
sys.stdout.write('})();\n')
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
sys.exit(main(sys.argv))
|
||||||
180
bin/example-screenshot.js
Normal file
180
bin/example-screenshot.js
Normal file
@@ -0,0 +1,180 @@
|
|||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This script is supposed to be executed via phantomjs. It will generate
|
||||||
|
* screenshots of the html files in the directory specified by a commandline
|
||||||
|
* option when these files are served through a webserver which can also be
|
||||||
|
* specified. The screenshots will be in the current working directory.
|
||||||
|
*
|
||||||
|
* Example usage:
|
||||||
|
*
|
||||||
|
* user@host:~/openlayers/bin $ phantomjs example-screenshot.js \
|
||||||
|
* http://localhost:8000/openlayers/examples/ \
|
||||||
|
* ../examples
|
||||||
|
*
|
||||||
|
* The above command will generate `*.png` files in `examples/` for all html
|
||||||
|
* files that are served through `http://localhost:8000/openlayers/examples/`.
|
||||||
|
*
|
||||||
|
* So if there is a file `my-humpty-example.html` inside of the relative folder
|
||||||
|
* `../examples/` which is being served through the webserver so that
|
||||||
|
* `http://localhost:8000/openlayers/examples/my-humpty-example.html` is a valid and
|
||||||
|
* reachable URL, this script will generate a screenshot and store it as
|
||||||
|
* `my-humpty-example.html.png`.
|
||||||
|
*
|
||||||
|
* The query string `?mode=raw` will be appended to the generated URL.
|
||||||
|
*
|
||||||
|
* Known limitations:
|
||||||
|
*
|
||||||
|
* As phantomjs doesn't support WebGL (see e.g.
|
||||||
|
* https://github.com/ariya/phantomjs/wiki/Supported-Web-Standards and
|
||||||
|
* http://code.google.com/p/phantomjs/issues/detail?id=273) This won't render
|
||||||
|
* OpenLayers maps rendered through the webglrenderer.
|
||||||
|
*
|
||||||
|
* In parts based upon this gist: https://gist.github.com/crazy4groovy/3160121
|
||||||
|
*/
|
||||||
|
(function() { // global closure
|
||||||
|
|
||||||
|
var page = require('webpage').create(), // imports
|
||||||
|
fs = require('fs'),
|
||||||
|
system = require('system'),
|
||||||
|
// arguments
|
||||||
|
baseExamplesUrl = system.args[1],
|
||||||
|
exampleDir = system.args[2],
|
||||||
|
// various settings
|
||||||
|
ignoreFiles = [
|
||||||
|
'index.html'
|
||||||
|
],
|
||||||
|
intervalMillisecs = 25,
|
||||||
|
renderMillisecs = 2000,
|
||||||
|
// basic variables
|
||||||
|
curDir = fs.workingDirectory,
|
||||||
|
exampleDirList = fs.list(exampleDir),
|
||||||
|
pageindex = 0,
|
||||||
|
fileName = '',
|
||||||
|
htmlFiles = [],
|
||||||
|
lenHtmlFiles = 0,
|
||||||
|
loadInProgress = false;
|
||||||
|
|
||||||
|
// simple object with helper functions
|
||||||
|
var util = {
|
||||||
|
/**
|
||||||
|
* Returns the basename of a file given a path.
|
||||||
|
*/
|
||||||
|
baseName: function(path) {
|
||||||
|
var parts = path.split(fs.separator);
|
||||||
|
return parts[parts.length - 1];
|
||||||
|
},
|
||||||
|
/**
|
||||||
|
* Super basic test whether a file can be considered a HTML-file.
|
||||||
|
*/
|
||||||
|
isHtmlFile: function(filename) {
|
||||||
|
return (/\.html?$/).test(filename);
|
||||||
|
},
|
||||||
|
/**
|
||||||
|
* Appends a slash to given string if it isn't there already.
|
||||||
|
*/
|
||||||
|
appendSlash: function(str) {
|
||||||
|
return ((/\/$/).test(str)) ? str : str + '/';
|
||||||
|
},
|
||||||
|
/**
|
||||||
|
* Generates an URL out of given baseurl and path.
|
||||||
|
*/
|
||||||
|
buildUrl: function(baseurl, path) {
|
||||||
|
var name = util.baseName(path),
|
||||||
|
mode = 'raw';
|
||||||
|
return util.appendSlash(baseurl) + name + '?mode=' + mode;
|
||||||
|
},
|
||||||
|
/**
|
||||||
|
* Simple progressbar logger that uses our globals pageindex & lenHtmlFiles.
|
||||||
|
*/
|
||||||
|
logProgress: function() {
|
||||||
|
var doneSymbol = '-',
|
||||||
|
todoSymbol = ' ',
|
||||||
|
currentSymbol = '>',
|
||||||
|
barStrLeft = '[',
|
||||||
|
barStrRight = ']',
|
||||||
|
progresStep = 5, // one doneSymbol equals this percentage
|
||||||
|
totalSteps = Math.round(100 / progresStep),
|
||||||
|
ratio = (lenHtmlFiles === 0) ? 0 : (pageindex / lenHtmlFiles),
|
||||||
|
percent = (ratio === 0) ? 0 : ratio * 100,
|
||||||
|
normalizedNumDone = Math.floor(ratio * totalSteps),
|
||||||
|
normalizedNumTodo = totalSteps - normalizedNumDone,
|
||||||
|
progressLine = '',
|
||||||
|
i = 0;
|
||||||
|
// the progress bar
|
||||||
|
progressLine += barStrLeft;
|
||||||
|
for (; i < normalizedNumDone; i++) {
|
||||||
|
progressLine += doneSymbol;
|
||||||
|
}
|
||||||
|
for (i = 0; i < normalizedNumTodo; i++) {
|
||||||
|
progressLine += (i === 0) ? currentSymbol : todoSymbol;
|
||||||
|
}
|
||||||
|
progressLine += barStrRight;
|
||||||
|
// the percentage information
|
||||||
|
// pad if necessary
|
||||||
|
if (percent < 10) {
|
||||||
|
progressLine += ' ';
|
||||||
|
} else if (percent < 100) {
|
||||||
|
progressLine += ' ';
|
||||||
|
}
|
||||||
|
progressLine += ' ' + percent.toFixed(1) + ' % done';
|
||||||
|
// additional information
|
||||||
|
if (fileName !== '') {
|
||||||
|
progressLine += ', ' + util.baseName(fileName) + '';
|
||||||
|
}
|
||||||
|
console.log(progressLine);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
// iterate over all files in examples directory
|
||||||
|
// and find the HTML files.
|
||||||
|
for (var i = 0; i < exampleDirList.length; i++) {
|
||||||
|
var fullpath = exampleDir + fs.separator + exampleDirList[i];
|
||||||
|
if (fs.isFile(fullpath) && util.isHtmlFile(fullpath) &&
|
||||||
|
ignoreFiles.indexOf(util.baseName(fullpath)) === -1) {
|
||||||
|
//TODO: make this more async (i.e. pop on/off stack WHILE rending pages)
|
||||||
|
htmlFiles.push(fullpath);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
lenHtmlFiles = htmlFiles.length;
|
||||||
|
|
||||||
|
console.log('Capturing ' + lenHtmlFiles + ' example screenshots.');
|
||||||
|
|
||||||
|
// The main interval function that is executed regularly and renders a
|
||||||
|
// page to a file
|
||||||
|
var interval = setInterval(function() {
|
||||||
|
if (!loadInProgress && pageindex < lenHtmlFiles) {
|
||||||
|
util.logProgress();
|
||||||
|
fileName = htmlFiles[pageindex];
|
||||||
|
page.viewportSize = { width: 800, height: 600 };
|
||||||
|
page.clipRect = {
|
||||||
|
top: 0,
|
||||||
|
left: 0,
|
||||||
|
width: page.viewportSize.width,
|
||||||
|
height: page.viewportSize.height
|
||||||
|
};
|
||||||
|
page.open(util.buildUrl(baseExamplesUrl, htmlFiles[pageindex]));
|
||||||
|
}
|
||||||
|
if (pageindex == lenHtmlFiles) {
|
||||||
|
util.logProgress();
|
||||||
|
console.log(lenHtmlFiles + ' screenshots captured.');
|
||||||
|
phantom.exit();
|
||||||
|
}
|
||||||
|
}, intervalMillisecs);
|
||||||
|
|
||||||
|
// set loadInProgress flag so we only process one image at time.
|
||||||
|
page.onLoadStarted = function() {
|
||||||
|
loadInProgress = true;
|
||||||
|
};
|
||||||
|
|
||||||
|
// When the page is loaded, render it to an image
|
||||||
|
page.onLoadFinished = function() {
|
||||||
|
var dest = exampleDir + fs.separator + util.baseName(fileName) + '.png';
|
||||||
|
window.setTimeout(function() {
|
||||||
|
loadInProgress = false;
|
||||||
|
page.render(dest); // actually render the page.
|
||||||
|
pageindex++;
|
||||||
|
}, renderMillisecs);
|
||||||
|
};
|
||||||
|
|
||||||
|
})(); // eof global closure
|
||||||
69
bin/loader_hosted_examples.js
Normal file
69
bin/loader_hosted_examples.js
Normal file
@@ -0,0 +1,69 @@
|
|||||||
|
/**
|
||||||
|
* This loader is used for the hosted examples. It is used in place of the
|
||||||
|
* development loader (examples/loader.js).
|
||||||
|
*
|
||||||
|
* The loader loads ol.js and the example's script in "production" mode; it
|
||||||
|
* loads Closure Library's base.js, ol-deps.js, the example's "goog.require"
|
||||||
|
* script, and the example's script in "development" mode.
|
||||||
|
*
|
||||||
|
* The ol.js and ol-deps.js scripts are built using OpenLayers's Makefile. They are
|
||||||
|
* located in the ../build/ directory, relative to this script.
|
||||||
|
*
|
||||||
|
* The script must be named loader.js.
|
||||||
|
*
|
||||||
|
* Usage:
|
||||||
|
*
|
||||||
|
* <script src="../loader.js?id=my-demo"></script>
|
||||||
|
*/
|
||||||
|
|
||||||
|
(function() {
|
||||||
|
|
||||||
|
var i, pair;
|
||||||
|
|
||||||
|
var href = window.location.href, start, end, paramsString, pairs,
|
||||||
|
pageParams = {};
|
||||||
|
if (href.indexOf('?') > 0) {
|
||||||
|
start = href.indexOf('?') + 1;
|
||||||
|
end = href.indexOf('#') > 0 ? href.indexOf('#') : href.length;
|
||||||
|
paramsString = href.substring(start, end);
|
||||||
|
pairs = paramsString.split(/[&;]/);
|
||||||
|
for (i = 0; i < pairs.length; ++i) {
|
||||||
|
pair = pairs[i].split('=');
|
||||||
|
if (pair[0]) {
|
||||||
|
pageParams[decodeURIComponent(pair[0])] =
|
||||||
|
decodeURIComponent(pair[1]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var scripts = document.getElementsByTagName('script');
|
||||||
|
var src, index, search, chunks, scriptParams = {};
|
||||||
|
for (i = scripts.length - 1; i >= 0; --i) {
|
||||||
|
src = scripts[i].getAttribute('src');
|
||||||
|
if (~(index = src.indexOf('loader.js?'))) {
|
||||||
|
search = src.substr(index + 10);
|
||||||
|
chunks = search ? search.split('&') : [];
|
||||||
|
for (i = chunks.length - 1; i >= 0; --i) {
|
||||||
|
pair = chunks[i].split('=');
|
||||||
|
if (pair[0]) {
|
||||||
|
scriptParams[decodeURIComponent(pair[0])] =
|
||||||
|
decodeURIComponent(pair[1]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var raw = pageParams.mode && pageParams.mode.toLowerCase() === 'raw';
|
||||||
|
|
||||||
|
var scriptId = encodeURIComponent(scriptParams.id);
|
||||||
|
if (!raw) {
|
||||||
|
document.write('<scr' + 'ipt type="text/javascript" src="../build/ol.js"></scr' + 'ipt>');
|
||||||
|
} else {
|
||||||
|
window.CLOSURE_NO_DEPS = true; // we've got our own deps file
|
||||||
|
document.write('<scr' + 'ipt type="text/javascript" src="../closure-library/closure/goog/base.js"></scr' + 'ipt>');
|
||||||
|
document.write('<scr' + 'ipt type="text/javascript" src="../build/ol-deps.js"></scr' + 'ipt>');
|
||||||
|
document.write('<scr' + 'ipt type="text/javascript" src="' + scriptId + '-require.js"></scr' + 'ipt>');
|
||||||
|
}
|
||||||
|
document.write('<scr' + 'ipt type="text/javascript" src="' + scriptId + '.js"></scr' + 'ipt>');
|
||||||
|
}());
|
||||||
39
bin/split-example.py
Normal file
39
bin/split-example.py
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
import os
|
||||||
|
import re
|
||||||
|
import sys
|
||||||
|
|
||||||
|
|
||||||
|
def split_example_file(example, dst_dir):
|
||||||
|
lines = open(example, 'rU').readlines()
|
||||||
|
|
||||||
|
target_lines = []
|
||||||
|
target_require_lines = []
|
||||||
|
|
||||||
|
found_requires = False
|
||||||
|
found_code = False
|
||||||
|
for line in lines:
|
||||||
|
m = re.match(r'goog.require\(\'(.*)\'\);', line)
|
||||||
|
if m:
|
||||||
|
found_requires = True
|
||||||
|
target_require_lines.append(line)
|
||||||
|
elif found_requires:
|
||||||
|
if found_code or line not in ('\n', '\r\n'):
|
||||||
|
found_code = True
|
||||||
|
target_lines.append(line)
|
||||||
|
|
||||||
|
target = open(
|
||||||
|
os.path.join(dst_dir, os.path.basename(example)), 'wb')
|
||||||
|
target_require = open(
|
||||||
|
os.path.join(dst_dir, os.path.basename(example)
|
||||||
|
.replace('.js', '-require.js')),
|
||||||
|
'wb')
|
||||||
|
|
||||||
|
target.writelines(target_lines)
|
||||||
|
target.close()
|
||||||
|
|
||||||
|
target_require.writelines(target_require_lines)
|
||||||
|
target_require.close()
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
split_example_file(*sys.argv[1:])
|
||||||
@@ -1,479 +1,6 @@
|
|||||||
## Upgrade notes
|
## Upgrade notes
|
||||||
|
|
||||||
### Next version
|
### Next release
|
||||||
|
|
||||||
#### Backwards incompatible changes
|
|
||||||
|
|
||||||
#### Removal of `GEOLOCATION` constant from `ol/has`
|
|
||||||
|
|
||||||
If you were previously using this constant, you can check if `'geolocation'` is define in `navigator` instead.
|
|
||||||
|
|
||||||
```js
|
|
||||||
if ('geolocation' in navigator) {
|
|
||||||
// ...
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Removal of CSS print rules
|
|
||||||
|
|
||||||
The CSS media print rules were removed from the `ol.css` file. To get the previous behavior, use the following CSS:
|
|
||||||
|
|
||||||
```css
|
|
||||||
@media print {
|
|
||||||
.ol-control {
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Removal of optional this arguments
|
|
||||||
|
|
||||||
The optional this (i.e. opt_this) arguments were removed from the following methods.
|
|
||||||
Please use closures, the es6 arrow function or the bind method to achieve this effect (Bind is explained here:
|
|
||||||
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/bind).
|
|
||||||
|
|
||||||
* `forEachCorner` in `ol/extent`
|
|
||||||
* `LRUCache#forEach`
|
|
||||||
* `RBush#forEach` and `RBush#forEachInExtent`
|
|
||||||
|
|
||||||
##### The `setCenter`, `setZoom`, `setResolution` and `setRotation` methods on `ol/View` do not bypass constraints anymore
|
|
||||||
|
|
||||||
Previously, these methods allowed setting values that were inconsistent with the given view constraints.
|
|
||||||
This is no longer the case and all changes to the view state now follow the same logic:
|
|
||||||
target values are provided and constraints are applied on these to determine the actual values to be used.
|
|
||||||
|
|
||||||
##### Removal of the `constrainResolution` option on `View.fit`, `PinchZoom`, `MouseWheelZoom` and `ol/interaction.js`
|
|
||||||
|
|
||||||
The `constrainResolution` option is now only supported by the `View` class. A `View.setConstrainResolution` method was added as well.
|
|
||||||
|
|
||||||
Generally, the responsibility of applying center/rotation/resolutions constraints was moved from interactions and controls to the `View` class.
|
|
||||||
|
|
||||||
##### The view `extent` option now applies to the whole viewport
|
|
||||||
|
|
||||||
Previously, this options only constrained the view *center*. This behaviour can still be obtained by specifying `constrainCenterOnly` in the view options.
|
|
||||||
|
|
||||||
As a side effect, the view `rotate` method is gone and has been replaced with `adjustRotation` which takes a delta as input.
|
|
||||||
|
|
||||||
##### The view is constrained so only one world is visible
|
|
||||||
|
|
||||||
Previously, maps showed multiple worlds at low zoom levels. In addition, it used to be possible to pan off the north or south edge of the world. Now, the view is restricted to show only one world, and you cannot pan off the edge. To get the previous behavior, configure the `ol/View` with `multiWorld: true`.
|
|
||||||
|
|
||||||
##### Removal of deprecated methods
|
|
||||||
|
|
||||||
The `inherits` function that was used to inherit the prototype methods from one constructor into another has been removed.
|
|
||||||
The standard ECMAScript classes should be used instead.
|
|
||||||
|
|
||||||
The deprecated `getSnapToPixel` and `setSnapToPixel` functions from the `ImageStyle` class have been removed.
|
|
||||||
|
|
||||||
##### New internal tile coordinates
|
|
||||||
|
|
||||||
Previously, the internal tile coordinates used in the library had an unusual row order – the origin of the tile coordinate system was at the top left as expected, but the rows increased upwards. This meant that all tile coordinates within a tile grid's extent had negative `y` values.
|
|
||||||
|
|
||||||
Now, the internal tile coordinates used in the library have the same row order as standard (e.g. XYZ) tile coordinates. The origin is at the top left (as before), and rows or `y` values increase downward. So the top left tile of a tile grid is now `0, 0`, whereas it was `0, -1` before.
|
|
||||||
|
|
||||||
```
|
|
||||||
x, y values for tile coordinates
|
|
||||||
|
|
||||||
origin
|
|
||||||
*__________________________
|
|
||||||
| | | |
|
|
||||||
| 0, 0 | 1, 0 | 2, 0 |
|
|
||||||
|________|________|________|
|
|
||||||
| | | |
|
|
||||||
| 0, 1 | 1, 1 | 2, 1 |
|
|
||||||
|________|________|________|
|
|
||||||
| | | |
|
|
||||||
| 0, 2 | 1, 2 | 2, 2 |
|
|
||||||
|________|________|________|
|
|
||||||
```
|
|
||||||
|
|
||||||
This change should only affect you if you were using a custom `tileLoadFunction` or `tileUrlFunction`. For example, if you used to have a `tileUrlFunction` that looked like this:
|
|
||||||
|
|
||||||
```js
|
|
||||||
// before
|
|
||||||
function tileUrlFunction(tileCoord) {
|
|
||||||
const z = tileCoord[0];
|
|
||||||
const x = tileCoord[1];
|
|
||||||
const y = -tileCoord[2] - 1;
|
|
||||||
// do something with z, x, y
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
You would now do something like this:
|
|
||||||
```js
|
|
||||||
// after
|
|
||||||
function tileUrlFunction(tileCoord) {
|
|
||||||
const z = tileCoord[0];
|
|
||||||
const x = tileCoord[1];
|
|
||||||
const y = tileCoord[2];
|
|
||||||
// do something with z, x, y
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
In addition (this should be exceedingly rare), if you previously created a `ol/tilegrid/WMTS` by hand and you were providing an array of `sizes`, you no longer have to provide a negative height if your tile origin is the top-left corner (the common case). On the other hand, if you are providing a custom array of `sizes` and your origin is the bottom of the grid (this is uncommon), your height values must now be negative.
|
|
||||||
|
|
||||||
##### Removal of the "vector" render mode for vector tile layers
|
|
||||||
|
|
||||||
If you were previously using `VectorTile` layers with `renderMode: 'vector'`, you have to remove this configuration option. That mode was removed. `'hybrid'` (default) and `'image'` are still available.
|
|
||||||
|
|
||||||
##### Removal of the "renderMode" option for vector layers
|
|
||||||
|
|
||||||
If you were previously using `Vector` layers with `renderMode: 'image'`, you have to remove this configuration option. Instead, use the new `ol/layer/VectorImage` layer with your `ol/source/Vector`.
|
|
||||||
|
|
||||||
##### New declutter behavior
|
|
||||||
|
|
||||||
If a map has more than one layer with `declutter` set to true, decluttering now considers all `Vector` and `VectorTile` layers, instead of decluttering each layer separately. Only `VectorImage` layers continue to be decluttered separately. The higher the z-index of a layer, the higher the priority of its decluttered items.
|
|
||||||
|
|
||||||
Within a layer, the declutter order has changed. Previously, styles with a lower `zIndex` were prioritized over those with a higher `zIndex`. Now the opposite order is used.
|
|
||||||
|
|
||||||
On vector layers, even if decluttered images or texts have a lower z-Index than polygons or lines, they will now be rendered on top of the polygons or lines. For vector tile layers, this was the case already in previous releases.
|
|
||||||
|
|
||||||
##### New `prerender` and `postrender` layer events replace old `precompose`, `render` and `postcompose` events
|
|
||||||
|
|
||||||
If you were previously registering for `precompose` and `postcompose` events, you should now register for `prerender` and `postrender` events on layers. Instead of the previous `render` event, you should now listen for `postrender`. Layers are no longer composed to a single Canvas element. Instead, they are added to the map viewport as individual elements.
|
|
||||||
|
|
||||||
##### New `getVectorContext` function provides access to the immediate vector rendering API
|
|
||||||
|
|
||||||
Previously, render events included a `vectorContext` property that allowed you to render features or geometries directly to the map. This is still possible, but you now have to explicitly create a vector context with the `getVectorContext` function. This change makes the immediate rendering API an explicit dependency if your application uses it. If you don't use this API, your application bundle will not include the vector rendering modules (as it did before).
|
|
||||||
|
|
||||||
Here is an abbreviated example of how to use the `getVectorContext` function:
|
|
||||||
|
|
||||||
```js
|
|
||||||
import {getVectorContext} from 'ol/render';
|
|
||||||
|
|
||||||
// construct your map and layers as usual
|
|
||||||
|
|
||||||
layer.on('postrender', function(event) {
|
|
||||||
const vectorContext = getVectorContext(event);
|
|
||||||
// use any of the drawing methods on the vector context
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
##### Layers can only be added to a single map
|
|
||||||
|
|
||||||
Previously, it was possible to render a single layer in two maps. Now, each layer can only belong to a single map (in the same way that a single DOM element can only have one parent).
|
|
||||||
|
|
||||||
##### The `OverviewMap` requires a list of layers.
|
|
||||||
|
|
||||||
Due to the constraint above (layers can only be added to a single map), the overview map needs to be constructed with a list of layers.
|
|
||||||
|
|
||||||
##### The `ol/Graticule` has been replaced by `ol/layer/Graticule`
|
|
||||||
|
|
||||||
Previously, a graticule was not a layer. Now it is. See the graticule example for details on how to add a graticule layer to your map.
|
|
||||||
|
|
||||||
##### `ol/format/Feature` API change
|
|
||||||
|
|
||||||
The `getLastExtent()` method, which was required for custom `tileLoadFunction`s in `ol/source/Vector`, has been removed because it is no longer needed (see below).
|
|
||||||
|
|
||||||
##### `ol/VectorTile` API changes
|
|
||||||
|
|
||||||
* Removal of the `getProjection()` and `setProjection()` methods. These were used in custom `tileLoadFunction`s on `ol/source/VectorTile`, which work differently now (see below).
|
|
||||||
* Removal of the `getExtent()` and `setExtent()` methods. These were used in custom `tileLoadFunction`s on `ol/source/VectorTile`, which work differently now (see below).
|
|
||||||
|
|
||||||
##### Custom tileLoadFunction on a VectorTile source needs changes
|
|
||||||
|
|
||||||
Previously, applications needed to call `setProjection()` and `setExtent()` on the tile in a custom `tileLoadFunction` on `ol/source/VectorTile`. The format's `getLastExtent()` method was used to get the extent. All this is no longer needed. Instead, the `extent` (first argument to the loader function) and `projection` (third argument to the loader function) are simply passed as `extent` and `featureProjection` options to the format's `readFeatures()` method.
|
|
||||||
|
|
||||||
Example for an old `tileLoadFunction`:
|
|
||||||
|
|
||||||
```js
|
|
||||||
function(tile, url) {
|
|
||||||
tile.setLoader(function() {
|
|
||||||
fetch(url).then(function(response) {
|
|
||||||
response.arrayBuffer().then(function(data) {
|
|
||||||
var format = tile.getFormat();
|
|
||||||
tile.setProjection(format.readProjection(data));
|
|
||||||
tile.setFeatures(format.readFeatures(data, {
|
|
||||||
// featureProjection is not required for ol/format/MVT
|
|
||||||
featureProjection: map.getView().getProjection()
|
|
||||||
}));
|
|
||||||
tile.setExtent(format.getLastExtent());
|
|
||||||
})
|
|
||||||
})
|
|
||||||
}
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
This function needs to be changed to:
|
|
||||||
|
|
||||||
```js
|
|
||||||
function(tile, url) {
|
|
||||||
tile.setLoader(function(extent, resolution, projection) {
|
|
||||||
fetch(url).then(function(response) {
|
|
||||||
response.arrayBuffer().then(function(data) {
|
|
||||||
var format = tile.getFormat();
|
|
||||||
tile.setFeatures(format.readFeatures(data, {
|
|
||||||
// extent is only required for ol/format/MVT
|
|
||||||
extent: extent,
|
|
||||||
featureProjection: projection
|
|
||||||
}));
|
|
||||||
})
|
|
||||||
})
|
|
||||||
}
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
##### Drop of support for the experimental WebGL renderer
|
|
||||||
|
|
||||||
The WebGL map and layers renderers are gone, replaced by a `WebGLHelper` function that provides a lightweight,
|
|
||||||
low-level access to the WebGL API. This is implemented in a new `WebGLPointsLayer` which does simple rendering of large number
|
|
||||||
of points with custom shaders.
|
|
||||||
|
|
||||||
This is now used in the `Heatmap` layer.
|
|
||||||
|
|
||||||
The removed classes and components are:
|
|
||||||
* `WebGLMap` and `WebGLMapRenderer`
|
|
||||||
* `WebGLLayerRenderer`
|
|
||||||
* `WebGLImageLayer` and `WebGLImageLayerRenderer`
|
|
||||||
* `WebGLTileLayer` and `WebGLTileLayerRenderer`
|
|
||||||
* `WebGLVectorLayer` and `WebGLVectorLayerRenderer`
|
|
||||||
* `WebGLReplay` and derived classes, along with associated shaders
|
|
||||||
* `WebGLReplayGroup`
|
|
||||||
* `WebGLImmediateRenderer`
|
|
||||||
* `WebGLMap`
|
|
||||||
* The shader build process using `mustache` and the `Makefile` at the root
|
|
||||||
|
|
||||||
##### Removal of the AtlasManager
|
|
||||||
|
|
||||||
Following the removal of the experimental WebGL renderer, the AtlasManager has been removed as well. The atlas was only used by this renderer.
|
|
||||||
The non API `getChecksum` functions of the style is also removed.
|
|
||||||
|
|
||||||
##### Change of the behavior of the vector source's clear() and refresh() methods
|
|
||||||
|
|
||||||
The `ol/source/Vector#clear()` method no longer triggers a reload of the data from the server. If you were previously using `clear()` to refetch from the server, you now have to use `refresh()`.
|
|
||||||
|
|
||||||
The `ol/source/Vector#refresh()` method now removes all features from the source and triggers a reload of the data from the server. If you were previously using the `refresh()` method to re-render a vector layer, you should instead call `ol/layer/Vector#changed()`.
|
|
||||||
|
|
||||||
#### Other changes
|
|
||||||
|
|
||||||
##### Allow declutter in image render mode
|
|
||||||
|
|
||||||
It is now possible to configure vector tile layers with `declutter: true` and `renderMode: 'image'`. However, note that decluttering will be done per tile, resulting in labels and point symbols getting cut off at tile boundaries.
|
|
||||||
Until now, using both options forced the render mode to be `hybrid`.
|
|
||||||
|
|
||||||
##### Always load tiles while animating or interacting
|
|
||||||
|
|
||||||
`ol/PluggableMap` and subclasses no longer support the `loadTilesWhileAnimating` and `loadTilesWhileInteracting` options. These options were used to enable tile loading during animations and interactions. With the new DOM composition render strategy, it is no longer necessary to postpone tile loading until after animations or interactions.
|
|
||||||
|
|
||||||
### v5.3.0
|
|
||||||
|
|
||||||
#### The `getUid` function returns string
|
|
||||||
|
|
||||||
The `getUid` function from the `ol/util` module now returns a string instead of a number.
|
|
||||||
|
|
||||||
#### Attributions are not collapsible for `ol/source/OSM`
|
|
||||||
|
|
||||||
When a map contains a layer from a `ol/source/OSM` source, the `ol/control/Attribution` control will be shown with the `collapsible: false` behavior.
|
|
||||||
|
|
||||||
To get the previous behavior, configure the `ol/control/Attribution` control with `collapsible: true`.
|
|
||||||
|
|
||||||
### v5.2.0
|
|
||||||
|
|
||||||
#### Removal of the `snapToPixel` option for `ol/style/Image` subclasses
|
|
||||||
|
|
||||||
The `snapToPixel` option has been removed, and the `getSnapToPixel` and `setSnapToPixel` methods are deprecated.
|
|
||||||
|
|
||||||
The renderer now snaps to integer pixels when no interaction or animation is running to get crisp rendering. During interaction or animation, it does not snap to integer pixels to avoid jitter.
|
|
||||||
|
|
||||||
When rendering with the Immediate API, symbols will no longer be snapped to integer pixels. To get crisp images, set `context.imageSmoothingEnabled = false` before rendering with the Immediate API, and `context.imageSmoothingEnabled = true` afterwards.
|
|
||||||
|
|
||||||
### v5.1.0
|
|
||||||
|
|
||||||
#### Geometry constructor and `setCoordinates` no longer accept `null` coordinates
|
|
||||||
|
|
||||||
Geometries (`ol/geom/*`) now need to be constructed with valid coordinates (center for `ol/geom/Circle`) as first constructor argument. The same applies to the `setCoordinates()` (`setCenter()` for `ol/geom/Circle`) method.
|
|
||||||
|
|
||||||
### v5.0.0
|
|
||||||
|
|
||||||
#### Renamed `ol/source/TileUTFGrid` to `ol/source/UTFGrid`
|
|
||||||
|
|
||||||
The module name is now `ol/source/UTFGrid` (`ol.source.UTFGrid` in the full build).
|
|
||||||
|
|
||||||
#### Renaming of the `defaultDataProjection` in the options and property of the `ol/format/Feature` class and its subclasses
|
|
||||||
|
|
||||||
The `defaultDataProjection` option is now named `dataProjection`. The protected property available on the class is also renamed.
|
|
||||||
|
|
||||||
#### `transition` option of `ol/source/VectorTile` is ignored
|
|
||||||
|
|
||||||
The `transition` option to get an opacity transition to fade in tiles has been disabled for `ol/source/VectorTile`. Vector tiles are now always rendered without an opacity transition.
|
|
||||||
|
|
||||||
#### `ol/style/Fill` with `CanvasGradient` or `CanvasPattern`
|
|
||||||
|
|
||||||
The origin for gradients and patterns has changed from the top-left corner of the extent of the geometry being filled to 512 css pixel increments from map coordinate `[0, 0]`. This allows repeat patterns to be aligned properly with vector tiles. For seamless repeat patterns, width and height of the pattern image must be a factor of two (2, 4, 8, ..., 512).
|
|
||||||
|
|
||||||
#### Removal of the renderer option for maps
|
|
||||||
|
|
||||||
The `renderer` option has been removed from the `Map` constructor. The purpose of this change is to avoid bundling code in your application that you do not need. Previously, code for both the Canvas and WebGL renderers was included in all applications - even though most people only use one renderer. The `Map` constructor now gives you a Canvas (2D) based renderer. If you want to try the WebGL renderer, you can import the constructor from `ol/WebGLMap`.
|
|
||||||
|
|
||||||
Old code:
|
|
||||||
```js
|
|
||||||
import Map from 'ol/Map';
|
|
||||||
|
|
||||||
const canvasMap = new Map({
|
|
||||||
renderer: ['canvas']
|
|
||||||
// other options...
|
|
||||||
});
|
|
||||||
|
|
||||||
const webglMap = new Map({
|
|
||||||
renderer: ['webgl']
|
|
||||||
// other options...
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
New code:
|
|
||||||
```js
|
|
||||||
import Map from 'ol/Map';
|
|
||||||
import WebGLMap from 'ol/WebGLMap';
|
|
||||||
|
|
||||||
const canvasMap = new Map({
|
|
||||||
// options...
|
|
||||||
});
|
|
||||||
|
|
||||||
const webglMap = new WebGLMap({
|
|
||||||
// options...
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Removal of ol.FeatureStyleFunction
|
|
||||||
|
|
||||||
The signature of the vector style function passed to the feature has changed. The function now always takes the `feature` and the `resolution` as arguments, the `feature` is no longer bound to `this`.
|
|
||||||
|
|
||||||
Old code:
|
|
||||||
```js
|
|
||||||
feature.setStyle(function(resolution) {
|
|
||||||
var text = this.get('name');
|
|
||||||
...
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
New code:
|
|
||||||
```js
|
|
||||||
feature.setStyle(function(feature, resolution) {
|
|
||||||
var text = feature.get('name');
|
|
||||||
...
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Changed behavior of the `Draw` interaction
|
|
||||||
|
|
||||||
For better drawing experience, two changes were made to the behavior of the Draw interaction:
|
|
||||||
|
|
||||||
1. On long press, the current vertex can be dragged to its desired position.
|
|
||||||
2. On touch move (e.g. when panning the map on a mobile device), no draw cursor is shown, and the geometry being drawn is not updated. But because of 1., the draw cursor will appear on long press. Mouse moves are not affected by this change.
|
|
||||||
|
|
||||||
#### Changes in proj4 integration
|
|
||||||
|
|
||||||
Because relying on a globally available proj4 is not practical with ES modules, we have made a change to the way we integrate proj4:
|
|
||||||
|
|
||||||
* The `setProj4()` function from the `ol/proj` module was removed.
|
|
||||||
* A new `ol/proj/proj4` module with a `register()` function was added. Regardless of whether the application imports `proj4` or uses a global `proj4`, this function needs to be called with the proj4 instance as argument whenever projection definitions were added to proj4's registry with (`proj4.defs`).
|
|
||||||
|
|
||||||
It is also recommended to no longer use a global `proj4`. Instead,
|
|
||||||
|
|
||||||
npm install proj4
|
|
||||||
|
|
||||||
and import it:
|
|
||||||
|
|
||||||
```js
|
|
||||||
import proj4 from 'proj4';
|
|
||||||
```
|
|
||||||
|
|
||||||
Applications can be updated by importing the `register` function from the `ol/proj/proj4` module
|
|
||||||
|
|
||||||
```js
|
|
||||||
import {register} from 'ol/proj/proj4'
|
|
||||||
```
|
|
||||||
|
|
||||||
and calling it before using projections, and any time the proj4 registry was changed by `proj4.defs()` calls:
|
|
||||||
|
|
||||||
```js
|
|
||||||
register(proj4);
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Removal of logos
|
|
||||||
|
|
||||||
The map and sources no longer accept a `logo` option. Instead, if you wish to append a logo to your map, add the desired markup directly in your HTML. In addition, you can use the `attributions` property of a source to display arbitrary markup per-source with the attribution control.
|
|
||||||
|
|
||||||
#### Replacement of `ol/Sphere` constructor with `ol/sphere` functions
|
|
||||||
|
|
||||||
The `ol/Sphere` constructor has been removed. If you were using the `getGeodesicArea` method, use the `getArea` function instead. If you were using the `haversineDistance` method, use the `getDistance` function instead.
|
|
||||||
|
|
||||||
Examples before:
|
|
||||||
```js
|
|
||||||
// using ol@4
|
|
||||||
import Sphere from 'ol/sphere';
|
|
||||||
|
|
||||||
var sphere = new Sphere(Sphere.DEFAULT_RADIUS);
|
|
||||||
var area = sphere.getGeodesicArea(polygon);
|
|
||||||
var distance = sphere.haversineDistance(g1, g2);
|
|
||||||
```
|
|
||||||
|
|
||||||
Examples after:
|
|
||||||
```js
|
|
||||||
// using ol@5
|
|
||||||
import {circular as circularPolygon} from 'ol/geom/Polygon';
|
|
||||||
import {getArea, getDistance} from 'ol/sphere';
|
|
||||||
|
|
||||||
var area = getArea(polygon);
|
|
||||||
var distance = getDistance(g1, g2);
|
|
||||||
var circle = circularPolygon(center, radius);
|
|
||||||
```
|
|
||||||
|
|
||||||
#### New signature for the `circular` function for creating polygons
|
|
||||||
|
|
||||||
The `circular` function exported from `ol/geom/Polygon` no longer requires a `Sphere` as the first argument.
|
|
||||||
|
|
||||||
Example before:
|
|
||||||
```js
|
|
||||||
// using ol@4
|
|
||||||
import Polygon from 'ol/geom/polygon';
|
|
||||||
import Sphere from 'ol/sphere';
|
|
||||||
|
|
||||||
var poly = Polygon.circular(new Sphere(Sphere.DEFAULT_RADIUS), center, radius);
|
|
||||||
```
|
|
||||||
|
|
||||||
Example after:
|
|
||||||
```js
|
|
||||||
// using ol@5
|
|
||||||
import {circular as circularPolygon} from 'ol/geom/Polygon';
|
|
||||||
|
|
||||||
var poly = circularPolygon(center, radius);
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Removal of optional this arguments.
|
|
||||||
|
|
||||||
The optional this (i.e. opt_this) arguments were removed from the following methods. Please use closures, the es6 arrow function or the bind method to achieve this effect (Bind is explained here: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/bind).
|
|
||||||
|
|
||||||
* Collection#forEach
|
|
||||||
* geom/LineString#forEachSegment
|
|
||||||
* Observable#on, #once, #un
|
|
||||||
* Map#forEachLayerAtPixel
|
|
||||||
* source/TileUTFGrid#forDataAtCoordinateAndResolution
|
|
||||||
* source/Vector#forEachFeature, #forEachFeatureInExtent, #forEachFeatureIntersectingExtent
|
|
||||||
|
|
||||||
|
|
||||||
#### `Map#forEachLayerAtPixel` parameters have changed
|
|
||||||
|
|
||||||
If you are using the layer filter, please note that you now have to pass in the layer filter via an `AtPixelOptions` object. If you are not using the layer filter the usage has not changed.
|
|
||||||
|
|
||||||
Old syntax:
|
|
||||||
```
|
|
||||||
map.forEachLayerAtPixel(pixel, callback, callbackThis, layerFilterFn, layerFilterThis);
|
|
||||||
```
|
|
||||||
|
|
||||||
New syntax:
|
|
||||||
|
|
||||||
```
|
|
||||||
map.forEachLayerAtPixel(pixel, callback, {
|
|
||||||
layerFilter: layerFilterFn
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
To bind a function to a this, please use the bind method of the function (See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/bind).
|
|
||||||
|
|
||||||
This change is due to the introduction of the `hitTolerance` parameter which can be passed in via this `AtPixelOptions` object, too.
|
|
||||||
|
|
||||||
### v4.6.0
|
|
||||||
|
|
||||||
#### Renamed `exceedLength` option of `ol.style.Text` to `overflow`
|
#### Renamed `exceedLength` option of `ol.style.Text` to `overflow`
|
||||||
|
|
||||||
|
|||||||
@@ -1,91 +0,0 @@
|
|||||||
# v4.6.0
|
|
||||||
|
|
||||||
### Summary
|
|
||||||
|
|
||||||
The 4.6 release includes enhancements and fixes from 30 or so pull requests. Headlining this release, vector layers got new `textBackgroundFill`, `textBackgroundStroke` and `padding` options that can be used to render background boxes for text. `ol.source.ImageVector` is now deprecated and replaced by a more convenient way to render vectors as images: by simply setting `renderMode: 'image'` on the vector layer.
|
|
||||||
|
|
||||||
Please note that if you are using `closure-util` to build your OpenLayers based application, it is time to migrate to using the [`ol` package](https://www.npmjs.com/package/ol) and a module bundler like webpack. OpenLayers has not had a dependency on the Closure Library since the [3.19 release](https://github.com/openlayers/openlayers/releases/tag/v3.19.0); and with the 5.0 release we will be moving completely away from `goog.require` and `goog.provide`, dropping support for `closure-util`, and going with ES modules for our sources.
|
|
||||||
|
|
||||||
See the [wiki](https://github.com/openlayers/openlayers/wiki/OpenLayers-v5.x) about upcoming changes in 5.0 and tips on how to upgrade. We likely won't have another 4.x release before the 5.0 release. If you're interested in continuing to get feature enhancements in future releases, migrating to the `ol` package now will make the transition easier.
|
|
||||||
|
|
||||||
|
|
||||||
### Upgrade notes
|
|
||||||
|
|
||||||
#### Renamed `exceedLength` option of `ol.style.Text` to `overflow`
|
|
||||||
|
|
||||||
To update your applications, simply replace `exceedLength` with `overflow`.
|
|
||||||
|
|
||||||
#### Deprecation of `ol.source.ImageVector`
|
|
||||||
|
|
||||||
Rendering vector sources as image is now directly supported by `ol.layer.Vector` with the new `renderMode: 'image'` configuration option. Change code like this:
|
|
||||||
|
|
||||||
```js
|
|
||||||
new ol.layer.Image({
|
|
||||||
source: new ol.source.ImageVector({
|
|
||||||
style: myStyle,
|
|
||||||
source: new ol.source.Vector({
|
|
||||||
url: 'my/data.json',
|
|
||||||
format: new ol.format.GeoJSON()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
});
|
|
||||||
```
|
|
||||||
to:
|
|
||||||
|
|
||||||
```js
|
|
||||||
new ol.layer.Vector({
|
|
||||||
renderMode: 'image',
|
|
||||||
style: myStyle,
|
|
||||||
source: new ol.source.Vector({
|
|
||||||
url: 'my/data.json',
|
|
||||||
format: new ol.format.GeoJSON()
|
|
||||||
})
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Detailed changes
|
|
||||||
|
|
||||||
See below for the full list of changes.
|
|
||||||
|
|
||||||
* [#7538](https://github.com/openlayers/openlayers/pull/7538) - removeFromLoadedExtents to remove extents that failed to load ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7537](https://github.com/openlayers/openlayers/pull/7537) - Fix Draw.removeLastPoint exception when no points to remove ([@walkermatt](https://github.com/walkermatt))
|
|
||||||
* [#7461](https://github.com/openlayers/openlayers/pull/7461) - Use the matrixSet projection by default ([@oterral](https://github.com/oterral))
|
|
||||||
* [#5883](https://github.com/openlayers/openlayers/pull/5883) - Fixes setUrl() for WMTS sources (ol.source.WMTS) ([@bylexus](https://github.com/bylexus))
|
|
||||||
* [#7531](https://github.com/openlayers/openlayers/pull/7531) - Update the ol package readme ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7372](https://github.com/openlayers/openlayers/pull/7372) - Add method to set max cache size in ol.style.IconImageCache ([@notnotse](https://github.com/notnotse))
|
|
||||||
* [#7530](https://github.com/openlayers/openlayers/pull/7530) - Check forward/back 1 world if wrapping ([@raiyni](https://github.com/raiyni))
|
|
||||||
* [#7526](https://github.com/openlayers/openlayers/pull/7526) - Allow clicks to be stopped while drawing ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7524](https://github.com/openlayers/openlayers/pull/7524) - Snap view center to pixel ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7521](https://github.com/openlayers/openlayers/pull/7521) - fix setMinZoom/setMaxZoom ([@cs09g](https://github.com/cs09g))
|
|
||||||
* [#7519](https://github.com/openlayers/openlayers/pull/7519) - Reuse declutter tree for hit detection ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7499](https://github.com/openlayers/openlayers/pull/7499) - Remove attributions from olx.FrameState instances ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7501](https://github.com/openlayers/openlayers/pull/7501) - Option to render vector layers as images ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7516](https://github.com/openlayers/openlayers/pull/7516) - Deprecate exceedLength and replace with overflow ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7510](https://github.com/openlayers/openlayers/pull/7510) - Do not fade the states layer ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7513](https://github.com/openlayers/openlayers/pull/7513) - Make strokeKey safer ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7514](https://github.com/openlayers/openlayers/pull/7514) - Prune the label cache less aggressively ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7505](https://github.com/openlayers/openlayers/pull/7505) - Remove ol.DeviceOrientation link from API index ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7497](https://github.com/openlayers/openlayers/pull/7497) - Use getGeometry ([@nicholas-l](https://github.com/nicholas-l))
|
|
||||||
* [#7495](https://github.com/openlayers/openlayers/pull/7495) - Remove layer renderers when viewport is removed ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7492](https://github.com/openlayers/openlayers/pull/7492) - Remove unneeded type cast from examples ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7489](https://github.com/openlayers/openlayers/pull/7489) - Allow string to be passed as ol.interaction.Draw type ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7445](https://github.com/openlayers/openlayers/pull/7445) - Load css rules from full-screen.css in examples ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7481](https://github.com/openlayers/openlayers/pull/7481) - Make zoom to extent control extensible ([@gberaudo](https://github.com/gberaudo))
|
|
||||||
* [#7477](https://github.com/openlayers/openlayers/pull/7477) - Make text states available for replay time ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7482](https://github.com/openlayers/openlayers/pull/7482) - Reset rotation after rendering ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7480](https://github.com/openlayers/openlayers/pull/7480) - Create a new image when loading tile after an error ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7476](https://github.com/openlayers/openlayers/pull/7476) - Reset text measurements when available fonts change ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7454](https://github.com/openlayers/openlayers/pull/7454) - Add text background rendering and text padding ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7468](https://github.com/openlayers/openlayers/pull/7468) - Add new API-key for HERE example ([@chrismayer](https://github.com/chrismayer))
|
|
||||||
* [#7465](https://github.com/openlayers/openlayers/pull/7465) - Export ol.proj.Projection#getAxisOrientation function ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7462](https://github.com/openlayers/openlayers/pull/7462) - Respect metersPerUnit in ScaleLine control ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
|
|
||||||
|
|
||||||
Additionally a number of updates where made to our dependencies:
|
|
||||||
* [#7536](https://github.com/openlayers/openlayers/pull/7536) - Update fs-extra to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7533](https://github.com/openlayers/openlayers/pull/7533) - Update marked to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7527](https://github.com/openlayers/openlayers/pull/7527) - Update eslint to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7511](https://github.com/openlayers/openlayers/pull/7511) - Update rollup to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7512](https://github.com/openlayers/openlayers/pull/7512) - Update eslint to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7484](https://github.com/openlayers/openlayers/pull/7484) - Update closure-util to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# 4.6.1
|
|
||||||
|
|
||||||
The v4.6.1 release fixes a number of issues in the 4.6 releases.
|
|
||||||
|
|
||||||
## Fixes
|
|
||||||
|
|
||||||
* [#7543](https://github.com/openlayers/openlayers/pull/7543) - Donut polygon labels do not get a chance to get rendered ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7542](https://github.com/openlayers/openlayers/pull/7542) - Still respect deprecated exceedLength option ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7541](https://github.com/openlayers/openlayers/pull/7541) - Fix case of vectorrendertype.js ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
# 4.6.2
|
|
||||||
|
|
||||||
The v4.6.2 release fixes a regression that could cause tremendous amounts of unneeded vector data to be fetched from the source.
|
|
||||||
|
|
||||||
## Fixes
|
|
||||||
|
|
||||||
* [#7546](https://github.com/openlayers/openlayers/pull/7546) - Do not request features for wrapped extent ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
# 4.6.3
|
|
||||||
|
|
||||||
The v4.6.3 release fixes a performance issue when `renderMode: 'image'` is set on an `ol.layer.Vector`.
|
|
||||||
|
|
||||||
## Fixes
|
|
||||||
|
|
||||||
* [#7554](https://github.com/openlayers/openlayers/pull/7554) - Only compose image vector frame when the replay group has changed ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
# 4.6.4
|
|
||||||
|
|
||||||
The v4.6.4 release fixes a feature selection issue when `renderMode: 'image'` is set on an `ol.layer.Vector`.
|
|
||||||
|
|
||||||
## Fixes
|
|
||||||
|
|
||||||
* [#7559](https://github.com/openlayers/openlayers/pull/7559) - Handle skipping and unskipping features with renderMode: 'image' ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
# 4.6.5
|
|
||||||
|
|
||||||
The v4.6.5 release fixes a hit detection issue when `declutter: true` is set on an `ol.layer.VectorTile`.
|
|
||||||
|
|
||||||
## Fixes
|
|
||||||
|
|
||||||
* [#7669](https://github.com/openlayers/openlayers/pull/7559) - Use declutter tree only for text and image replays ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
@@ -1,667 +0,0 @@
|
|||||||
# v5.0.0
|
|
||||||
|
|
||||||
The main theme of the v5.0.0 release is an improved developer/user experience with OpenLayers. Toward this end, we have reworked the library as a set of ES Modules, completely removing any dependency on the Closure Compiler, and improving compatibility with mainstream module bundlers.
|
|
||||||
|
|
||||||
See the [hosted examples](https://openlayers.org/en/latest/examples/), [API docs](https://openlayers.org/en/latest/apidoc/), and [bundle tutorial](https://openlayers.org/en/latest/doc/tutorials/bundle.html) for the new syntax, but basic usage looks like this:
|
|
||||||
|
|
||||||
```js
|
|
||||||
import 'ol/ol.css';
|
|
||||||
import {Map, View} from 'ol';
|
|
||||||
import TileLayer from 'ol/layer/Tile';
|
|
||||||
import OSM from 'ol/source/OSM';
|
|
||||||
|
|
||||||
const map = new Map({
|
|
||||||
target: 'map',
|
|
||||||
layers: [
|
|
||||||
new TileLayer({
|
|
||||||
source: new OSM()
|
|
||||||
})
|
|
||||||
],
|
|
||||||
view: new View({
|
|
||||||
center: [0, 0],
|
|
||||||
zoom: 0
|
|
||||||
})
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
See below for specific notes on upgrading from 4.x releases. We'll be working on updating the website with improved documentation and examples. Take a look at the issue tracker if you're interested in contributing.
|
|
||||||
|
|
||||||
### Upgrade Notes
|
|
||||||
|
|
||||||
#### Renamed `ol/source/TileUTFGrid` to `ol/source/UTFGrid`
|
|
||||||
|
|
||||||
The module name is now `ol/source/UTFGrid` (`ol.source.UTFGrid` in the full build).
|
|
||||||
|
|
||||||
#### Renaming of the `defaultDataProjection` in the options and property of the `ol/format/Feature` class and its subclasses
|
|
||||||
|
|
||||||
The `defaultDataProjection` option is now named `dataProjection`. The protected property available on the class is also renamed.
|
|
||||||
|
|
||||||
#### `transition` option of `ol/source/VectorTile` is ignored
|
|
||||||
|
|
||||||
The `transition` option to get an opacity transition to fade in tiles has been disabled for `ol/source/VectorTile`. Vector tiles are now always rendered without an opacity transition.
|
|
||||||
|
|
||||||
#### `ol/style/Fill` with `CanvasGradient` or `CanvasPattern`
|
|
||||||
|
|
||||||
The origin for gradients and patterns has changed from the top-left corner of the extent of the geometry being filled to 512 css pixel increments from map coordinate `[0, 0]`. This allows repeat patterns to be aligned properly with vector tiles. For seamless repeat patterns, width and height of the pattern image must be a factor of two (2, 4, 8, ..., 512).
|
|
||||||
|
|
||||||
#### Removal of the renderer option for maps
|
|
||||||
|
|
||||||
The `renderer` option has been removed from the `Map` constructor. The purpose of this change is to avoid bundling code in your application that you do not need. Previously, code for both the Canvas and WebGL renderers was included in all applications - even though most people only use one renderer. The `Map` constructor now gives you a Canvas (2D) based renderer. If you want to try the WebGL renderer, you can import the constructor from `ol/WebGLMap`.
|
|
||||||
|
|
||||||
Old code:
|
|
||||||
```js
|
|
||||||
import Map from 'ol/Map';
|
|
||||||
|
|
||||||
const canvasMap = new Map({
|
|
||||||
renderer: ['canvas']
|
|
||||||
// other options...
|
|
||||||
});
|
|
||||||
|
|
||||||
const webglMap = new Map({
|
|
||||||
renderer: ['webgl']
|
|
||||||
// other options...
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
New code:
|
|
||||||
```js
|
|
||||||
import Map from 'ol/Map';
|
|
||||||
import WebGLMap from 'ol/WebGLMap';
|
|
||||||
|
|
||||||
const canvasMap = new Map({
|
|
||||||
// options...
|
|
||||||
});
|
|
||||||
|
|
||||||
const webglMap = new WebGLMap({
|
|
||||||
// options...
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Removal of ol.FeatureStyleFunction
|
|
||||||
|
|
||||||
The signature of the vector style function passed to the feature has changed. The function now always takes the `feature` and the `resolution` as arguments, the `feature` is no longer bound to `this`.
|
|
||||||
|
|
||||||
Old code:
|
|
||||||
```js
|
|
||||||
feature.setStyle(function(resolution) {
|
|
||||||
var text = this.get('name');
|
|
||||||
...
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
New code:
|
|
||||||
```js
|
|
||||||
feature.setStyle(function(feature, resolution) {
|
|
||||||
var text = feature.get('name');
|
|
||||||
...
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Changed behavior of the `Draw` interaction
|
|
||||||
|
|
||||||
For better drawing experience, two changes were made to the behavior of the Draw interaction:
|
|
||||||
|
|
||||||
1. On long press, the current vertex can be dragged to its desired position.
|
|
||||||
2. On touch move (e.g. when panning the map on a mobile device), no draw cursor is shown, and the geometry being drawn is not updated. But because of 1., the draw cursor will appear on long press. Mouse moves are not affected by this change.
|
|
||||||
|
|
||||||
#### Changes in proj4 integration
|
|
||||||
|
|
||||||
Because relying on a globally available proj4 is not practical with ES modules, we have made a change to the way we integrate proj4:
|
|
||||||
|
|
||||||
* The `setProj4()` function from the `ol/proj` module was removed.
|
|
||||||
* A new `ol/proj/proj4` module with a `register()` function was added. Regardless of whether the application imports `proj4` or uses a global `proj4`, this function needs to be called with the proj4 instance as argument whenever projection definitions were added to proj4's registry with (`proj4.defs`).
|
|
||||||
|
|
||||||
It is also recommended to no longer use a global `proj4`. Instead,
|
|
||||||
|
|
||||||
npm install proj4
|
|
||||||
|
|
||||||
and import it:
|
|
||||||
|
|
||||||
```js
|
|
||||||
import proj4 from 'proj4';
|
|
||||||
```
|
|
||||||
|
|
||||||
Applications can be updated by importing the `register` function from the `ol/proj/proj4` module
|
|
||||||
|
|
||||||
```js
|
|
||||||
import {register} from 'ol/proj/proj4'
|
|
||||||
```
|
|
||||||
|
|
||||||
and calling it before using projections, and any time the proj4 registry was changed by `proj4.defs()` calls:
|
|
||||||
|
|
||||||
```js
|
|
||||||
register(proj4);
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Removal of logos
|
|
||||||
|
|
||||||
The map and sources no longer accept a `logo` option. Instead, if you wish to append a logo to your map, add the desired markup directly in your HTML. In addition, you can use the `attributions` property of a source to display arbitrary markup per-source with the attribution control.
|
|
||||||
|
|
||||||
#### Replacement of `ol/Sphere` constructor with `ol/sphere` functions
|
|
||||||
|
|
||||||
The `ol/Sphere` constructor has been removed. If you were using the `getGeodesicArea` method, use the `getArea` function instead. If you were using the `haversineDistance` method, use the `getDistance` function instead.
|
|
||||||
|
|
||||||
Examples before:
|
|
||||||
```js
|
|
||||||
// using ol@4
|
|
||||||
import Sphere from 'ol/sphere';
|
|
||||||
|
|
||||||
var sphere = new Sphere(Sphere.DEFAULT_RADIUS);
|
|
||||||
var area = sphere.getGeodesicArea(polygon);
|
|
||||||
var distance = sphere.haversineDistance(g1, g2);
|
|
||||||
```
|
|
||||||
|
|
||||||
Examples after:
|
|
||||||
```js
|
|
||||||
// using ol@5
|
|
||||||
import {circular as circularPolygon} from 'ol/geom/Polygon';
|
|
||||||
import {getArea, getDistance} from 'ol/sphere';
|
|
||||||
|
|
||||||
var area = getArea(polygon);
|
|
||||||
var distance = getDistance(g1, g2);
|
|
||||||
var circle = circularPolygon(center, radius);
|
|
||||||
```
|
|
||||||
|
|
||||||
#### New signature for the `circular` function for creating polygons
|
|
||||||
|
|
||||||
The `circular` function exported from `ol/geom/Polygon` no longer requires a `Sphere` as the first argument.
|
|
||||||
|
|
||||||
Example before:
|
|
||||||
```js
|
|
||||||
// using ol@4
|
|
||||||
import Polygon from 'ol/geom/polygon';
|
|
||||||
import Sphere from 'ol/sphere';
|
|
||||||
|
|
||||||
var poly = Polygon.circular(new Sphere(Sphere.DEFAULT_RADIUS), center, radius);
|
|
||||||
```
|
|
||||||
|
|
||||||
Example after:
|
|
||||||
```js
|
|
||||||
// using ol@5
|
|
||||||
import {circular as circularPolygon} from 'ol/geom/Polygon';
|
|
||||||
|
|
||||||
var poly = circularPolygon(center, radius);
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Removal of optional this arguments.
|
|
||||||
|
|
||||||
The optional this (i.e. opt_this) arguments were removed from the following methods. Please use closures, the es6 arrow function or the bind method to achieve this effect (Bind is explained here: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/bind).
|
|
||||||
|
|
||||||
* Collection#forEach
|
|
||||||
* geom/LineString#forEachSegment
|
|
||||||
* Observable#on, #once, #un
|
|
||||||
* Map#forEachLayerAtPixel
|
|
||||||
* source/TileUTFGrid#forDataAtCoordinateAndResolution
|
|
||||||
* source/Vector#forEachFeature, #forEachFeatureInExtent, #forEachFeatureIntersectingExtent
|
|
||||||
|
|
||||||
|
|
||||||
#### `Map#forEachLayerAtPixel` parameters have changed
|
|
||||||
|
|
||||||
If you are using the layer filter, please note that you now have to pass in the layer filter via an `AtPixelOptions` object. If you are not using the layer filter the usage has not changed.
|
|
||||||
|
|
||||||
Old syntax:
|
|
||||||
```
|
|
||||||
map.forEachLayerAtPixel(pixel, callback, callbackThis, layerFilterFn, layerFilterThis);
|
|
||||||
```
|
|
||||||
|
|
||||||
New syntax:
|
|
||||||
|
|
||||||
```
|
|
||||||
map.forEachLayerAtPixel(pixel, callback, {
|
|
||||||
layerFilter: layerFilterFn
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
To bind a function to a this, please use the bind method of the function (See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/bind).
|
|
||||||
|
|
||||||
This change is due to the introduction of the `hitTolerance` parameter which can be passed in via this `AtPixelOptions` object, too.
|
|
||||||
|
|
||||||
### New Features and Fixes
|
|
||||||
|
|
||||||
* [#8314](https://github.com/openlayers/openlayers/pull/8314) - Accept hitTolerance in map.forEachLayerAtPixel() ([@simonseyock](https://github.com/simonseyock))
|
|
||||||
* [#7750](https://github.com/openlayers/openlayers/pull/7750) - Don't assume fill for canvas polygon hit detection. ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8305](https://github.com/openlayers/openlayers/pull/8305) - Update quickstart and tutorials for v5 ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8301](https://github.com/openlayers/openlayers/pull/8301) - Do not render vectors in image mode ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8302](https://github.com/openlayers/openlayers/pull/8302) - Ignore node_modules everywhere ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8299](https://github.com/openlayers/openlayers/pull/8299) - Make classes in ol/ available as named exports from ol ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8298](https://github.com/openlayers/openlayers/pull/8298) - Add README for ol package ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8295](https://github.com/openlayers/openlayers/pull/8295) - Prepare for building/publishing v5 ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8296](https://github.com/openlayers/openlayers/pull/8296) - Fix style documentation ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8294](https://github.com/openlayers/openlayers/pull/8294) - Remove non-functional type checks from testing ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8292](https://github.com/openlayers/openlayers/pull/8292) - Remove now unneeded single quotes in examples ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8291](https://github.com/openlayers/openlayers/pull/8291) - Graticule code cleanup ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8287](https://github.com/openlayers/openlayers/pull/8287) - Rename ol/source/TileUTFGrid to ol/source/UTFGrid ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8286](https://github.com/openlayers/openlayers/pull/8286) - Fix class name property in Overlay documentation ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8281](https://github.com/openlayers/openlayers/pull/8281) - Rename default data projection ([@gberaudo](https://github.com/gberaudo))
|
|
||||||
* [#8283](https://github.com/openlayers/openlayers/pull/8283) - Remove references to tutorials/custom-builds.html ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8280](https://github.com/openlayers/openlayers/pull/8280) - Add missing property in VectorTile options, remove params from createRenderer ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8277](https://github.com/openlayers/openlayers/pull/8277) - Fix code block in comment ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8273](https://github.com/openlayers/openlayers/pull/8273) - Remove the externs/ directory ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8246](https://github.com/openlayers/openlayers/pull/8246) - Don't go back to not moving when dragging ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8258](https://github.com/openlayers/openlayers/pull/8258) - Use Webpack 4 for tests (and examples) ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8250](https://github.com/openlayers/openlayers/pull/8250) - Fix various jsdoc types ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8245](https://github.com/openlayers/openlayers/pull/8245) - Fix vector tile docs and types ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8233](https://github.com/openlayers/openlayers/pull/8233) - Use rollup instead of webpack for the full build ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8231](https://github.com/openlayers/openlayers/pull/8231) - Fix JSTS usage with OL classes injected ([@bjornharrtell](https://github.com/bjornharrtell))
|
|
||||||
* [#8229](https://github.com/openlayers/openlayers/pull/8229) - Support layers instead of renderers for ol/source/Raster ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8227](https://github.com/openlayers/openlayers/pull/8227) - Better vectortile experience ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8225](https://github.com/openlayers/openlayers/pull/8225) - renderMode: 'image' fixes for ol/layer/Vector ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8226](https://github.com/openlayers/openlayers/pull/8226) - Accept renderers as sources for the Raster source ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8210](https://github.com/openlayers/openlayers/pull/8210) - Align patterns and gradients to a grid ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8201](https://github.com/openlayers/openlayers/pull/8201) - Remove babelrc, transform using babel-core ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8203](https://github.com/openlayers/openlayers/pull/8203) - Type checking complete ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8204](https://github.com/openlayers/openlayers/pull/8204) - Document ol/control~defaults in the right place ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8200](https://github.com/openlayers/openlayers/pull/8200) - Set textAlign to the canvas context ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8194](https://github.com/openlayers/openlayers/pull/8194) - miscellaneous code cleanup ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8189](https://github.com/openlayers/openlayers/pull/8189) - More apidoc fixes ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8191](https://github.com/openlayers/openlayers/pull/8191) - Do not scale text outline width ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8187](https://github.com/openlayers/openlayers/pull/8187) - Hide attribution control if there are no attributions ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8186](https://github.com/openlayers/openlayers/pull/8186) - Updates to get the examples building ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8180](https://github.com/openlayers/openlayers/pull/8180) - Fix some JSDoc issues ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8175](https://github.com/openlayers/openlayers/pull/8175) - More typing fixes ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8177](https://github.com/openlayers/openlayers/pull/8177) - Remove documentation related to the closure compiler ([@gberaudo](https://github.com/gberaudo))
|
|
||||||
* [#8174](https://github.com/openlayers/openlayers/pull/8174) - Fix typo in ol/style/Image~Options typedef ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8172](https://github.com/openlayers/openlayers/pull/8172) - Ignore 'this' type in function typedef ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8173](https://github.com/openlayers/openlayers/pull/8173) - Fix typing in ol/xml module ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8169](https://github.com/openlayers/openlayers/pull/8169) - Shorter module paths for default exports ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8171](https://github.com/openlayers/openlayers/pull/8171) - Remove wrong override tags ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8170](https://github.com/openlayers/openlayers/pull/8170) - Basic apidocs ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8167](https://github.com/openlayers/openlayers/pull/8167) - Remove externs/oli.js ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8166](https://github.com/openlayers/openlayers/pull/8166) - Updated type annotations ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8165](https://github.com/openlayers/openlayers/pull/8165) - Update linter config ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8163](https://github.com/openlayers/openlayers/pull/8163) - Fix type syntax ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8161](https://github.com/openlayers/openlayers/pull/8161) - Fix skipping of texts with background ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8156](https://github.com/openlayers/openlayers/pull/8156) - fix assert 36 on error documentation #8147 ([@mainakae](https://github.com/mainakae))
|
|
||||||
* [#8143](https://github.com/openlayers/openlayers/pull/8143) - Shorter module paths for default exports ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8137](https://github.com/openlayers/openlayers/pull/8137) - Avoid `this` at top level of modules ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8138](https://github.com/openlayers/openlayers/pull/8138) - Update tasks to use native async/await ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8139](https://github.com/openlayers/openlayers/pull/8139) - Add @module annotation for ol/control/util ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8135](https://github.com/openlayers/openlayers/pull/8135) - Break the circular dependency: overview map, map, controls, overview map ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8132](https://github.com/openlayers/openlayers/pull/8132) - Add minZoom to the createResolutionConstraint function return type ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8129](https://github.com/openlayers/openlayers/pull/8129) - Fix some types ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8127](https://github.com/openlayers/openlayers/pull/8127) - Move RasterOperationType into ol/source/Raster ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8123](https://github.com/openlayers/openlayers/pull/8123) - More Jsdoc module fixes ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8125](https://github.com/openlayers/openlayers/pull/8125) - Shorter module paths for default exports ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8122](https://github.com/openlayers/openlayers/pull/8122) - Remove unused 'format' options from Cluster source constructor ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8121](https://github.com/openlayers/openlayers/pull/8121) - More Jsdoc module fixes ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8117](https://github.com/openlayers/openlayers/pull/8117) - Re-export style constructors from ol/style ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8115](https://github.com/openlayers/openlayers/pull/8115) - Re-export layer constructors from ol/layer ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8114](https://github.com/openlayers/openlayers/pull/8114) - Re-export interaction constructors from ol/interaction ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8116](https://github.com/openlayers/openlayers/pull/8116) - Re-export source constructors from ol/source ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8113](https://github.com/openlayers/openlayers/pull/8113) - Re-export geometry constructors from ol/geom ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8112](https://github.com/openlayers/openlayers/pull/8112) - Re-export format constructors from ol/format ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8111](https://github.com/openlayers/openlayers/pull/8111) - Re-export control constructors ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8118](https://github.com/openlayers/openlayers/pull/8118) - Use list for cloak entries ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8109](https://github.com/openlayers/openlayers/pull/8109) - Make any falsey undefinedHTML retain the mouse position ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8103](https://github.com/openlayers/openlayers/pull/8103) - Fix some jsdoc path types ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7784](https://github.com/openlayers/openlayers/pull/7784) - Adds option to retain MousePosition when pointer leaves viewport ([@pedros007](https://github.com/pedros007))
|
|
||||||
* [#8101](https://github.com/openlayers/openlayers/pull/8101) - More Jsdoc module fixes ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7908](https://github.com/openlayers/openlayers/pull/7908) - ScaleLine fix for non-degree based units ([@hyperknot](https://github.com/hyperknot))
|
|
||||||
* [#8099](https://github.com/openlayers/openlayers/pull/8099) - More Jsdoc module fixes ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8098](https://github.com/openlayers/openlayers/pull/8098) - Remove externs/olx.js and src/ol/typedefs.js ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8096](https://github.com/openlayers/openlayers/pull/8096) - Fix rotation default ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8081](https://github.com/openlayers/openlayers/pull/8081) - Move olx.render.* and related typedefs to ol/render/* ([@pfirpfel](https://github.com/pfirpfel))
|
|
||||||
* [#8087](https://github.com/openlayers/openlayers/pull/8087) - Move various typedefs out of typdefs.js ([@pfirpfel](https://github.com/pfirpfel))
|
|
||||||
* [#8052](https://github.com/openlayers/openlayers/pull/8052) - More Jsdoc module fixes ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8048](https://github.com/openlayers/openlayers/pull/8048) - Remove all comments from shaders ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8089](https://github.com/openlayers/openlayers/pull/8089) - Allow unprefixed WMTS tileMatrix identifiers ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8088](https://github.com/openlayers/openlayers/pull/8088) - Correct type for TextPlacement (jsdoc) ([@camptocamp](https://github.com/camptocamp))
|
|
||||||
* [#8083](https://github.com/openlayers/openlayers/pull/8083) - Move structs typedefs to ol/structs/* ([@pfirpfel](https://github.com/pfirpfel))
|
|
||||||
* [#8077](https://github.com/openlayers/openlayers/pull/8077) - Add hasFeature method to ol.source.Vector ([@icholy](https://github.com/icholy))
|
|
||||||
* [#8080](https://github.com/openlayers/openlayers/pull/8080) - #8079 Mark functions setRotateWithView and setSnapToPixel of ol/style/Image with @api ([@iagafonov](https://github.com/iagafonov))
|
|
||||||
* [#8084](https://github.com/openlayers/openlayers/pull/8084) - Move ol.Reproj* typedefs to ol/reproj ([@pfirpfel](https://github.com/pfirpfel))
|
|
||||||
* [#8082](https://github.com/openlayers/openlayers/pull/8082) - Remove unused typedefs ([@pfirpfel](https://github.com/pfirpfel))
|
|
||||||
* [#8076](https://github.com/openlayers/openlayers/pull/8076) - Move olx.style.* and ol.Style* to ol/style/* ([@pfirpfel](https://github.com/pfirpfel))
|
|
||||||
* [#8075](https://github.com/openlayers/openlayers/pull/8075) - Move olx.tilegrid.* to ol/tilegrid/* ([@pfirpfel](https://github.com/pfirpfel))
|
|
||||||
* [#8073](https://github.com/openlayers/openlayers/pull/8073) - Remove dependency on deprecated sinon@5 ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7994](https://github.com/openlayers/openlayers/pull/7994) - Explicit renderer dependencies ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7863](https://github.com/openlayers/openlayers/pull/7863) - Add note about null geom in VectorSource.forEachFeature ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8055](https://github.com/openlayers/openlayers/pull/8055) - Mark optional property with square brackets ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8054](https://github.com/openlayers/openlayers/pull/8054) - Generate correct includes list for `build-index` script on windows hosts. ([@lilliputten](https://github.com/lilliputten))
|
|
||||||
* [#8053](https://github.com/openlayers/openlayers/pull/8053) - Don't import from 'functions' multiple times ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8041](https://github.com/openlayers/openlayers/pull/8041) - Remove olx typedefs ol/source ([@fgravin](https://github.com/fgravin))
|
|
||||||
* [#8026](https://github.com/openlayers/openlayers/pull/8026) - [doc] dispatchChangeEvent -> changed ([@nyurik](https://github.com/nyurik))
|
|
||||||
* [#8003](https://github.com/openlayers/openlayers/pull/8003) - Add an example showing Chaikins smoothing algorithm ([@marcjansen](https://github.com/marcjansen))
|
|
||||||
* [#8044](https://github.com/openlayers/openlayers/pull/8044) - Rename constructor options typedef to 'Options' ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8042](https://github.com/openlayers/openlayers/pull/8042) - Only process loaded tiles ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8036](https://github.com/openlayers/openlayers/pull/8036) - Move the temporary arrays to the module level ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8032](https://github.com/openlayers/openlayers/pull/8032) - Start removing externs for `ol/source` ([@romanzoller](https://github.com/romanzoller))
|
|
||||||
* [#8038](https://github.com/openlayers/openlayers/pull/8038) - Fix ZoomToExtent default tipLabel value ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8034](https://github.com/openlayers/openlayers/pull/8034) - More Jsdoc module fixes ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8029](https://github.com/openlayers/openlayers/pull/8029) - More Jsdoc module fixes ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8030](https://github.com/openlayers/openlayers/pull/8030) - Set `user-select: text` for .ol-selectable ([@walkermatt](https://github.com/walkermatt))
|
|
||||||
* [#8025](https://github.com/openlayers/openlayers/pull/8025) - Move olx.layer.* to ol/layer/* ([@romanzoller](https://github.com/romanzoller))
|
|
||||||
* [#8023](https://github.com/openlayers/openlayers/pull/8023) - Module type changes for ol.webgl ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8021](https://github.com/openlayers/openlayers/pull/8021) - Move olx.ViewState to ol/View ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8012](https://github.com/openlayers/openlayers/pull/8012) - More Jsdoc module fixes ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8015](https://github.com/openlayers/openlayers/pull/8015) - Remove some typedefs from src/ol/typedefs.js ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8016](https://github.com/openlayers/openlayers/pull/8016) - Move olx.layer.BaseOptions to ol/layer/Base ([@romanzoller](https://github.com/romanzoller))
|
|
||||||
* [#8005](https://github.com/openlayers/openlayers/pull/8005) - Add vector tile selection example ([@chrismayer](https://github.com/chrismayer))
|
|
||||||
* [#7999](https://github.com/openlayers/openlayers/pull/7999) - More Jsdoc module fixes ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7998](https://github.com/openlayers/openlayers/pull/7998) - More Jsdoc module fixes ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7992](https://github.com/openlayers/openlayers/pull/7992) - Fix freeze on export PDF example ([@trenneman](https://github.com/trenneman))
|
|
||||||
* [#7997](https://github.com/openlayers/openlayers/pull/7997) - Jsdoc module ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7986](https://github.com/openlayers/openlayers/pull/7986) - Use module syntax for type annotations ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7996](https://github.com/openlayers/openlayers/pull/7996) - 4.6.5 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7993](https://github.com/openlayers/openlayers/pull/7993) - Module types ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7989](https://github.com/openlayers/openlayers/pull/7989) - Redistribute olx types for ol/interaction ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7991](https://github.com/openlayers/openlayers/pull/7991) - Fix some type paths ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7985](https://github.com/openlayers/openlayers/pull/7985) - Use path type instead of ol.tilegrid ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7983](https://github.com/openlayers/openlayers/pull/7983) - Use path type instead of ol.Extent ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7980](https://github.com/openlayers/openlayers/pull/7980) - Use module syntax for type annotations ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7979](https://github.com/openlayers/openlayers/pull/7979) - Mark optional property with square brackets ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7975](https://github.com/openlayers/openlayers/pull/7975) - Mark optional property with square brackets ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7960](https://github.com/openlayers/openlayers/pull/7960) - Fix memory leak in CanvasImageRenderer ([@PetroDE](https://github.com/PetroDE))
|
|
||||||
* [#7974](https://github.com/openlayers/openlayers/pull/7974) - Fix spelling ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7973](https://github.com/openlayers/openlayers/pull/7973) - Remove setAttributeNS function from ol/xml ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7971](https://github.com/openlayers/openlayers/pull/7971) - Use module syntax for type annotations ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7968](https://github.com/openlayers/openlayers/pull/7968) - More types in the right places ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7966](https://github.com/openlayers/openlayers/pull/7966) - Remove namespaces from olx.js ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7965](https://github.com/openlayers/openlayers/pull/7965) - Redistribute types from externs/olx.js ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7608](https://github.com/openlayers/openlayers/pull/7608) - Facilitate the removal of externs/olx.js ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7964](https://github.com/openlayers/openlayers/pull/7964) - Coordinate type typo ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7961](https://github.com/openlayers/openlayers/pull/7961) - Correct type for style ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7958](https://github.com/openlayers/openlayers/pull/7958) - miscellaneous fixes to the types annotation ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7953](https://github.com/openlayers/openlayers/pull/7953) - Get rid of externs/olx.js and src/ol/typedefs.js typedefs for ol/ and ol/events/ ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7956](https://github.com/openlayers/openlayers/pull/7956) - Make sure namespaces are populated after they were created ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7952](https://github.com/openlayers/openlayers/pull/7952) - Fix typo in jsdoc type ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7948](https://github.com/openlayers/openlayers/pull/7948) - Better type definition ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7946](https://github.com/openlayers/openlayers/pull/7946) - New typedef syntax and module path types for some modules ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7944](https://github.com/openlayers/openlayers/pull/7944) - Make wrap work with points in the vector-labels example ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7933](https://github.com/openlayers/openlayers/pull/7933) - Better code indentation ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7930](https://github.com/openlayers/openlayers/pull/7930) - Use listen function instead of on ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7929](https://github.com/openlayers/openlayers/pull/7929) - Remove unused devDependencies ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7927](https://github.com/openlayers/openlayers/pull/7927) - Remove unused deps, unused tasks, and outdated info ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7923](https://github.com/openlayers/openlayers/pull/7923) - Fix exports and use of constants ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7914](https://github.com/openlayers/openlayers/pull/7914) - Some easy window cleanups ([@gberaudo](https://github.com/gberaudo))
|
|
||||||
* [#7915](https://github.com/openlayers/openlayers/pull/7915) - Untie feature loader and XML code ([@gberaudo](https://github.com/gberaudo))
|
|
||||||
* [#7918](https://github.com/openlayers/openlayers/pull/7918) - Move the nullFunction to ol/functions ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7910](https://github.com/openlayers/openlayers/pull/7910) - Better code indentation ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7904](https://github.com/openlayers/openlayers/pull/7904) - Add focus condition, e.g. for wheel zoom ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7902](https://github.com/openlayers/openlayers/pull/7902) - Add a unicode symbol for symbol font detection ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7899](https://github.com/openlayers/openlayers/pull/7899) - Use nomnom@1.8.1 ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7897](https://github.com/openlayers/openlayers/pull/7897) - Better variables scoping ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7894](https://github.com/openlayers/openlayers/pull/7894) - More named exports, fewer static members ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7881](https://github.com/openlayers/openlayers/pull/7881) - Better variables scoping ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7888](https://github.com/openlayers/openlayers/pull/7888) - Rework away static members from pointer related classes ([@bjornharrtell](https://github.com/bjornharrtell))
|
|
||||||
* [#7880](https://github.com/openlayers/openlayers/pull/7880) - Named exports from ol/style/Style ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7872](https://github.com/openlayers/openlayers/pull/7872) - More named export ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7874](https://github.com/openlayers/openlayers/pull/7874) - Cleaning up exports ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7871](https://github.com/openlayers/openlayers/pull/7871) - Memory optimization ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7870](https://github.com/openlayers/openlayers/pull/7870) - Use exported function from ol/webgl ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7868](https://github.com/openlayers/openlayers/pull/7868) - Named export ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7861](https://github.com/openlayers/openlayers/pull/7861) - Named exports from ol/structs/PriorityQueue ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7860](https://github.com/openlayers/openlayers/pull/7860) - Don't export private constant from ol/webgl ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7855](https://github.com/openlayers/openlayers/pull/7855) - More named exports ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7851](https://github.com/openlayers/openlayers/pull/7851) - Replacing static functions with named exports ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7852](https://github.com/openlayers/openlayers/pull/7852) - Rename extent ([@nicholas-l](https://github.com/nicholas-l))
|
|
||||||
* [#7840](https://github.com/openlayers/openlayers/pull/7840) - More export renaming ([@raiyni](https://github.com/raiyni))
|
|
||||||
* [#7843](https://github.com/openlayers/openlayers/pull/7843) - Better code indentation ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7842](https://github.com/openlayers/openlayers/pull/7842) - Allow setting the label cache size ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7791](https://github.com/openlayers/openlayers/pull/7791) - Named exports from ol/tilecoord ([@marcjansen](https://github.com/marcjansen))
|
|
||||||
* [#7835](https://github.com/openlayers/openlayers/pull/7835) - Add and use a constant for the collapsed CSS class ([@marcjansen](https://github.com/marcjansen))
|
|
||||||
* [#7834](https://github.com/openlayers/openlayers/pull/7834) - Named exports from ol/transform ([@marcjansen](https://github.com/marcjansen))
|
|
||||||
* [#7831](https://github.com/openlayers/openlayers/pull/7831) - Add new maxTilesLoading option to ol/PluggableMap ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7833](https://github.com/openlayers/openlayers/pull/7833) - Fix createEmptyTexture function call in ol/webgl/Context ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7832](https://github.com/openlayers/openlayers/pull/7832) - Webgl Layer and Context named exports ([@fgravin](https://github.com/fgravin))
|
|
||||||
* [#7826](https://github.com/openlayers/openlayers/pull/7826) - Better code indentation and modules renaming ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7828](https://github.com/openlayers/openlayers/pull/7828) - Refactor constraints static methods to module functions ([@bjornharrtell](https://github.com/bjornharrtell))
|
|
||||||
* [#7827](https://github.com/openlayers/openlayers/pull/7827) - Named exports from ol/render/canvas ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7823](https://github.com/openlayers/openlayers/pull/7823) - Replace static members with named exports ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7820](https://github.com/openlayers/openlayers/pull/7820) - ol/geom/flat/* exports ([@raiyni](https://github.com/raiyni))
|
|
||||||
* [#7824](https://github.com/openlayers/openlayers/pull/7824) - Fix code indentation ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7821](https://github.com/openlayers/openlayers/pull/7821) - Add new canvas instruction array in ol/render/canvas/Instruction ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7817](https://github.com/openlayers/openlayers/pull/7817) - Remove more private static members ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7814](https://github.com/openlayers/openlayers/pull/7814) - Remove more private static members ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7816](https://github.com/openlayers/openlayers/pull/7816) - Use toString instead of asString in asColorLike ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7811](https://github.com/openlayers/openlayers/pull/7811) - Remove ol.FeatureStyleFunction support ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7815](https://github.com/openlayers/openlayers/pull/7815) - Remove private statics from webgl related modules ([@bjornharrtell](https://github.com/bjornharrtell))
|
|
||||||
* [#7803](https://github.com/openlayers/openlayers/pull/7803) - Remove private static members from constructors ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7808](https://github.com/openlayers/openlayers/pull/7808) - Make sure the requested image size matches the desired ratio ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7807](https://github.com/openlayers/openlayers/pull/7807) - Run typecheck after tests, because of its current verbosity ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7805](https://github.com/openlayers/openlayers/pull/7805) - Remove private static members from constructors ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7806](https://github.com/openlayers/openlayers/pull/7806) - Fix rotate import ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7800](https://github.com/openlayers/openlayers/pull/7800) - More named exports ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7741](https://github.com/openlayers/openlayers/pull/7741) - Type checking and full build creation ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7797](https://github.com/openlayers/openlayers/pull/7797) - Better default export names for WebGL modules ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7794](https://github.com/openlayers/openlayers/pull/7794) - Call animation callback in a timeout ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7793](https://github.com/openlayers/openlayers/pull/7793) - More renaming of default exports ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7799](https://github.com/openlayers/openlayers/pull/7799) - Use tmpSize to reduce garbage generation ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7788](https://github.com/openlayers/openlayers/pull/7788) - Fix shaders generation ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7789](https://github.com/openlayers/openlayers/pull/7789) - Use STATIC_DRAW as default WebGL buffer usage ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7787](https://github.com/openlayers/openlayers/pull/7787) - More renaming ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7782](https://github.com/openlayers/openlayers/pull/7782) - Named exports from specific proj modules ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7780](https://github.com/openlayers/openlayers/pull/7780) - More named exports ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7783](https://github.com/openlayers/openlayers/pull/7783) - Named exports from ol/xml ([@raiyni](https://github.com/raiyni))
|
|
||||||
* [#7774](https://github.com/openlayers/openlayers/pull/7774) - Pass destination extent to avoid garbage generation ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7771](https://github.com/openlayers/openlayers/pull/7771) - Named exports from loadingstrategy ([@marcjansen](https://github.com/marcjansen))
|
|
||||||
* [#7772](https://github.com/openlayers/openlayers/pull/7772) - Named exports from filter module ([@marcjansen](https://github.com/marcjansen))
|
|
||||||
* [#7770](https://github.com/openlayers/openlayers/pull/7770) - Rename _ol_render_Box_ to RenderBox ([@marcjansen](https://github.com/marcjansen))
|
|
||||||
* [#7763](https://github.com/openlayers/openlayers/pull/7763) - Use the temporary extent in VectorTileLayer ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7765](https://github.com/openlayers/openlayers/pull/7765) - Named exports from events condition ([@marcjansen](https://github.com/marcjansen))
|
|
||||||
* [#7767](https://github.com/openlayers/openlayers/pull/7767) - Transformation functions: Fix spelling and use the symbol × ([@marcjansen](https://github.com/marcjansen))
|
|
||||||
* [#7764](https://github.com/openlayers/openlayers/pull/7764) - Named exports from ol/has ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7761](https://github.com/openlayers/openlayers/pull/7761) - Rename _ol_render_canvas_Instruction_ to CanvasInstruction ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7749](https://github.com/openlayers/openlayers/pull/7749) - Check if the sketch feature is defined in finishDrawing ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7745](https://github.com/openlayers/openlayers/pull/7745) - More named exports ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7743](https://github.com/openlayers/openlayers/pull/7743) - Set enableHighAccuracy in geolocation example ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7738](https://github.com/openlayers/openlayers/pull/7738) - Named exports from ol/events ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7724](https://github.com/openlayers/openlayers/pull/7724) - Update prism library ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7727](https://github.com/openlayers/openlayers/pull/7727) - Deactivate transition effect for semi transparent layer example ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7726](https://github.com/openlayers/openlayers/pull/7726) - Named exports from ol/string ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7725](https://github.com/openlayers/openlayers/pull/7725) - Remove extra comment ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7721](https://github.com/openlayers/openlayers/pull/7721) - More renaming ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7716](https://github.com/openlayers/openlayers/pull/7716) - Better variables scoping ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7698](https://github.com/openlayers/openlayers/pull/7698) - Fix for loop in color test ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7703](https://github.com/openlayers/openlayers/pull/7703) - Improved drawing experience on touch devices ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7713](https://github.com/openlayers/openlayers/pull/7713) - Better variables scoping ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7711](https://github.com/openlayers/openlayers/pull/7711) - Do not use (I)CLA anymore ([@bartvde](https://github.com/bartvde))
|
|
||||||
* [#7709](https://github.com/openlayers/openlayers/pull/7709) - More named export ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7705](https://github.com/openlayers/openlayers/pull/7705) - More renaming ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7700](https://github.com/openlayers/openlayers/pull/7700) - Fix ScaleLine control for Projections in degrees ([@pedros007](https://github.com/pedros007))
|
|
||||||
* [#7697](https://github.com/openlayers/openlayers/pull/7697) - Use const and let ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7695](https://github.com/openlayers/openlayers/pull/7695) - More renaming ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7693](https://github.com/openlayers/openlayers/pull/7693) - More import renaming ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7678](https://github.com/openlayers/openlayers/pull/7678) - Add jsDelivr hits badge ([@LukasDrgon](https://github.com/LukasDrgon))
|
|
||||||
* [#7686](https://github.com/openlayers/openlayers/pull/7686) - More import renaming ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7669](https://github.com/openlayers/openlayers/pull/7669) - Use declutter tree only for text and image replays ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7683](https://github.com/openlayers/openlayers/pull/7683) - Move IGCZ enum to src/ol/format/IGC.js ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7682](https://github.com/openlayers/openlayers/pull/7682) - Add new condition to MouseWheelZoom interaction ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7676](https://github.com/openlayers/openlayers/pull/7676) - Check fonts against two reference fonts ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7668](https://github.com/openlayers/openlayers/pull/7668) - Hit detect text background ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7661](https://github.com/openlayers/openlayers/pull/7661) - Background fill stroke ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7654](https://github.com/openlayers/openlayers/pull/7654) - Add named export for transformWithOptions function ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7652](https://github.com/openlayers/openlayers/pull/7652) - More renaming ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7649](https://github.com/openlayers/openlayers/pull/7649) - Named Map export for ol/Map ([@raiyni](https://github.com/raiyni))
|
|
||||||
* [#7646](https://github.com/openlayers/openlayers/pull/7646) - Named export for Polyline format and SimpleGeometry ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7650](https://github.com/openlayers/openlayers/pull/7650) - Rename _ol_PluggableMap_ to PluggableMap ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7642](https://github.com/openlayers/openlayers/pull/7642) - Don't store private function into GPX ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7643](https://github.com/openlayers/openlayers/pull/7643) - Replace ol/Sphere with ol/sphere ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7644](https://github.com/openlayers/openlayers/pull/7644) - Named exports from ol/math module ([@raiyni](https://github.com/raiyni))
|
|
||||||
* [#7636](https://github.com/openlayers/openlayers/pull/7636) - Named exports from the ol/array module ([@marcjansen](https://github.com/marcjansen))
|
|
||||||
* [#7614](https://github.com/openlayers/openlayers/pull/7614) - Remove opt_this from the API ([@KlausBenndorf](https://github.com/KlausBenndorf))
|
|
||||||
* [#7640](https://github.com/openlayers/openlayers/pull/7640) - Remove unneeded and already skipped test ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7637](https://github.com/openlayers/openlayers/pull/7637) - Named exports from the ol/color module ([@marcjansen](https://github.com/marcjansen))
|
|
||||||
* [#7639](https://github.com/openlayers/openlayers/pull/7639) - Don't store private function into GeoJSON ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7635](https://github.com/openlayers/openlayers/pull/7635) - More module renaming ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7632](https://github.com/openlayers/openlayers/pull/7632) - Named exports from ol/css module ([@marcjansen](https://github.com/marcjansen))
|
|
||||||
* [#7634](https://github.com/openlayers/openlayers/pull/7634) - Rename _ol_layer_Tile_ to TileLayer ([@marcjansen](https://github.com/marcjansen))
|
|
||||||
* [#7633](https://github.com/openlayers/openlayers/pull/7633) - Import assert function directly ([@marcjansen](https://github.com/marcjansen))
|
|
||||||
* [#7631](https://github.com/openlayers/openlayers/pull/7631) - More named export and rename ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7627](https://github.com/openlayers/openlayers/pull/7627) - Nicer import name ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7622](https://github.com/openlayers/openlayers/pull/7622) - Named export ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7624](https://github.com/openlayers/openlayers/pull/7624) - Remove eslint-plugin-openlayers-internal rules ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7625](https://github.com/openlayers/openlayers/pull/7625) - Named export for ol/control and ol/interaction ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7623](https://github.com/openlayers/openlayers/pull/7623) - Named export for ol/tileurlfunction ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7621](https://github.com/openlayers/openlayers/pull/7621) - Replace ZeroClipboard with Clipboard.js ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7620](https://github.com/openlayers/openlayers/pull/7620) - Rename variables in format modules ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7619](https://github.com/openlayers/openlayers/pull/7619) - More variable renaming ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7612](https://github.com/openlayers/openlayers/pull/7612) - Better import name for _ol_ext_* import ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7611](https://github.com/openlayers/openlayers/pull/7611) - Change olx.SphereMetricOptions to SphereMetricOptions ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7615](https://github.com/openlayers/openlayers/pull/7615) - Remove logos ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7610](https://github.com/openlayers/openlayers/pull/7610) - More variable renaming ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7609](https://github.com/openlayers/openlayers/pull/7609) - Redistribute a few types and docs ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7598](https://github.com/openlayers/openlayers/pull/7598) - Modular proj4 integration ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7607](https://github.com/openlayers/openlayers/pull/7607) - Rename interaction variables ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7599](https://github.com/openlayers/openlayers/pull/7599) - Rename event variables ([@marcjansen](https://github.com/marcjansen))
|
|
||||||
* [#7605](https://github.com/openlayers/openlayers/pull/7605) - Better import and class name in ol/format/filter/ ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7604](https://github.com/openlayers/openlayers/pull/7604) - Named exports from ol/functions ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7603](https://github.com/openlayers/openlayers/pull/7603) - Simplify default export ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7602](https://github.com/openlayers/openlayers/pull/7602) - Remove now unused DEVICE_ORIENTATION ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7597](https://github.com/openlayers/openlayers/pull/7597) - More es6 named export ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7600](https://github.com/openlayers/openlayers/pull/7600) - Simplify default export of ol/events/KeyCode ([@marcjansen](https://github.com/marcjansen))
|
|
||||||
* [#7594](https://github.com/openlayers/openlayers/pull/7594) - Rename control variables ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7593](https://github.com/openlayers/openlayers/pull/7593) - Simplify default export ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7591](https://github.com/openlayers/openlayers/pull/7591) - Rename geometry variables ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7586](https://github.com/openlayers/openlayers/pull/7586) - Named exports from ol/dom ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7581](https://github.com/openlayers/openlayers/pull/7581) - Named exports from ol/proj ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7585](https://github.com/openlayers/openlayers/pull/7585) - Remove leftovers olx.animation typedefs ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7584](https://github.com/openlayers/openlayers/pull/7584) - Named exports from ol/easing ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7582](https://github.com/openlayers/openlayers/pull/7582) - Remove default export from ol/extent ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7580](https://github.com/openlayers/openlayers/pull/7580) - No default export from lowercase modules ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7575](https://github.com/openlayers/openlayers/pull/7575) - Add named exports for extent ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7579](https://github.com/openlayers/openlayers/pull/7579) - VectorImageTile: call changed() before removing listeners on dispose ([@mbleichner](https://github.com/mbleichner))
|
|
||||||
* [#7578](https://github.com/openlayers/openlayers/pull/7578) - Remove deprecated functionality from 4.x ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7577](https://github.com/openlayers/openlayers/pull/7577) - Redistribute things in ol/index.js ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7576](https://github.com/openlayers/openlayers/pull/7576) - Named exports from ol/index.js ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7570](https://github.com/openlayers/openlayers/pull/7570) - Transform sources to ES modules ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7569](https://github.com/openlayers/openlayers/pull/7569) - Remove unnecessary require ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7568](https://github.com/openlayers/openlayers/pull/7568) - Remove unneeded configs from test ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7566](https://github.com/openlayers/openlayers/pull/7566) - Proper projection construction ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#7565](https://github.com/openlayers/openlayers/pull/7565) - Release v4.6.4 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7563](https://github.com/openlayers/openlayers/pull/7563) - Use full precision for the declutter box ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7559](https://github.com/openlayers/openlayers/pull/7559) - Handle skipping and unskipping features with renderMode: 'image' ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7562](https://github.com/openlayers/openlayers/pull/7562) - Remove unused, confusing projection code ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7555](https://github.com/openlayers/openlayers/pull/7555) - Release v4.6.3 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7554](https://github.com/openlayers/openlayers/pull/7554) - Only compose image vector frame when the replay group has changed ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7550](https://github.com/openlayers/openlayers/pull/7550) - Update examples to d3.js v4 ([@fredj](https://github.com/fredj))
|
|
||||||
* [#7548](https://github.com/openlayers/openlayers/pull/7548) - Fix pull request link ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7547](https://github.com/openlayers/openlayers/pull/7547) - Release v4.6.2 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7546](https://github.com/openlayers/openlayers/pull/7546) - Do not request features for wrapped extent ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7545](https://github.com/openlayers/openlayers/pull/7545) - Release v4.6.1 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7543](https://github.com/openlayers/openlayers/pull/7543) - Donut polygon labels do not get a chance to get rendered ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7542](https://github.com/openlayers/openlayers/pull/7542) - Still respect deprecated exceedLength option ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#7541](https://github.com/openlayers/openlayers/pull/7541) - Fix case of vectorrendertype.js ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Dependency Updates</summary>
|
|
||||||
|
|
||||||
* [#8315](https://github.com/openlayers/openlayers/pull/8315) - Update eslint to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8309](https://github.com/openlayers/openlayers/pull/8309) - Update eslint to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8311](https://github.com/openlayers/openlayers/pull/8311) - Update webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8310](https://github.com/openlayers/openlayers/pull/8310) - Update rollup to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8297](https://github.com/openlayers/openlayers/pull/8297) - Update rollup to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8293](https://github.com/openlayers/openlayers/pull/8293) - Update rollup to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8285](https://github.com/openlayers/openlayers/pull/8285) - Update google-closure-compiler to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8275](https://github.com/openlayers/openlayers/pull/8275) - Update serve to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8271](https://github.com/openlayers/openlayers/pull/8271) - chore(package): update google-closure-compiler to version 20180610.0.1 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8270](https://github.com/openlayers/openlayers/pull/8270) - chore(package): update rollup to version 0.60.7 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8266](https://github.com/openlayers/openlayers/pull/8266) - chore(package): update rollup to version 0.60.4 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8261](https://github.com/openlayers/openlayers/pull/8261) - Update rollup to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8260](https://github.com/openlayers/openlayers/pull/8260) - Update sinon to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8252](https://github.com/openlayers/openlayers/pull/8252) - Update rollup to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8248](https://github.com/openlayers/openlayers/pull/8248) - Update serve to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8247](https://github.com/openlayers/openlayers/pull/8247) - Update rollup to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8241](https://github.com/openlayers/openlayers/pull/8241) - Update recast to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8230](https://github.com/openlayers/openlayers/pull/8230) - Update serve to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8208](https://github.com/openlayers/openlayers/pull/8208) - Update marked to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8205](https://github.com/openlayers/openlayers/pull/8205) - Update mocha to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8179](https://github.com/openlayers/openlayers/pull/8179) - Update google-closure-compiler to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8146](https://github.com/openlayers/openlayers/pull/8146) - Update coveralls to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8145](https://github.com/openlayers/openlayers/pull/8145) - Update fs-extra to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8140](https://github.com/openlayers/openlayers/pull/8140) - Update sinon to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8131](https://github.com/openlayers/openlayers/pull/8131) - Update babel-plugin-jsdoc-closure to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8130](https://github.com/openlayers/openlayers/pull/8130) - Update babel-plugin-jsdoc-closure to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8128](https://github.com/openlayers/openlayers/pull/8128) - Update babel-plugin-jsdoc-closure to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8124](https://github.com/openlayers/openlayers/pull/8124) - Update babel-plugin-jsdoc-closure to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8102](https://github.com/openlayers/openlayers/pull/8102) - Update babel-plugin-jsdoc-closure to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8095](https://github.com/openlayers/openlayers/pull/8095) - Update babel-plugin-jsdoc-closure to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8094](https://github.com/openlayers/openlayers/pull/8094) - Update babel-plugin-jsdoc-closure to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8093](https://github.com/openlayers/openlayers/pull/8093) - chore(package): update serve to version 6.5.5 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8090](https://github.com/openlayers/openlayers/pull/8090) - chore(package): update url-polyfill to version 1.0.13 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8091](https://github.com/openlayers/openlayers/pull/8091) - chore(package): update karma-firefox-launcher to version 1.1.0 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8085](https://github.com/openlayers/openlayers/pull/8085) - Update mocha to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8071](https://github.com/openlayers/openlayers/pull/8071) - Update mocha to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8060](https://github.com/openlayers/openlayers/pull/8060) - Update google-closure-compiler to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8039](https://github.com/openlayers/openlayers/pull/8039) - Update google-closure-compiler to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8028](https://github.com/openlayers/openlayers/pull/8028) - Update marked to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8019](https://github.com/openlayers/openlayers/pull/8019) - Update mocha to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8017](https://github.com/openlayers/openlayers/pull/8017) - Update marked to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8018](https://github.com/openlayers/openlayers/pull/8018) - Update recast to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8014](https://github.com/openlayers/openlayers/pull/8014) - Update recast to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8009](https://github.com/openlayers/openlayers/pull/8009) - chore(package): update sinon to version 5.0.0 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8008](https://github.com/openlayers/openlayers/pull/8008) - Update eslint to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8000](https://github.com/openlayers/openlayers/pull/8000) - Update karma-webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7990](https://github.com/openlayers/openlayers/pull/7990) - Update eslint to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7984](https://github.com/openlayers/openlayers/pull/7984) - Update sinon to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7981](https://github.com/openlayers/openlayers/pull/7981) - Update sinon to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7977](https://github.com/openlayers/openlayers/pull/7977) - Update sinon to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7972](https://github.com/openlayers/openlayers/pull/7972) - Update sinon to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7963](https://github.com/openlayers/openlayers/pull/7963) - chore(package): update url-polyfill to version 1.0.11 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7962](https://github.com/openlayers/openlayers/pull/7962) - chore(package): update serve to version 6.5.2 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7959](https://github.com/openlayers/openlayers/pull/7959) - Update babel-plugin-jsdoc-closure to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7957](https://github.com/openlayers/openlayers/pull/7957) - Update recast to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7950](https://github.com/openlayers/openlayers/pull/7950) - Update mocha to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7945](https://github.com/openlayers/openlayers/pull/7945) - Update babel-plugin-jsdoc-closure to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7943](https://github.com/openlayers/openlayers/pull/7943) - Update mocha to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7940](https://github.com/openlayers/openlayers/pull/7940) - Update babel-plugin-jsdoc-closure to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7938](https://github.com/openlayers/openlayers/pull/7938) - Update mocha to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7925](https://github.com/openlayers/openlayers/pull/7925) - Update eslint to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7921](https://github.com/openlayers/openlayers/pull/7921) - Update clean-css-cli to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7916](https://github.com/openlayers/openlayers/pull/7916) - chore(package): update html-webpack-plugin to version 3.0.1 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7905](https://github.com/openlayers/openlayers/pull/7905) - Update karma-webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7903](https://github.com/openlayers/openlayers/pull/7903) - Update marked to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7901](https://github.com/openlayers/openlayers/pull/7901) - Update karma-webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7898](https://github.com/openlayers/openlayers/pull/7898) - chore(package): update karma-webpack to version 2.0.11 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7893](https://github.com/openlayers/openlayers/pull/7893) - Update sinon to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7891](https://github.com/openlayers/openlayers/pull/7891) - chore(package): update recast to version 0.14.4 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7886](https://github.com/openlayers/openlayers/pull/7886) - Update sinon to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7882](https://github.com/openlayers/openlayers/pull/7882) - Update sinon to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7876](https://github.com/openlayers/openlayers/pull/7876) - Update recast to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7877](https://github.com/openlayers/openlayers/pull/7877) - Update webpack-merge to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7865](https://github.com/openlayers/openlayers/pull/7865) - Update marked to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7866](https://github.com/openlayers/openlayers/pull/7866) - Update eslint to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7867](https://github.com/openlayers/openlayers/pull/7867) - Update recast to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7858](https://github.com/openlayers/openlayers/pull/7858) - Update recast to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7850](https://github.com/openlayers/openlayers/pull/7850) - Update marked to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7849](https://github.com/openlayers/openlayers/pull/7849) - Update recast to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7848](https://github.com/openlayers/openlayers/pull/7848) - Update nomnom to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7847](https://github.com/openlayers/openlayers/pull/7847) - Update eslint to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7845](https://github.com/openlayers/openlayers/pull/7845) - chore(package): update marked to version 0.3.14 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7841](https://github.com/openlayers/openlayers/pull/7841) - Greenkeeper/babel plugin jsdoc closure 1.2.0 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7822](https://github.com/openlayers/openlayers/pull/7822) - Update mocha to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7813](https://github.com/openlayers/openlayers/pull/7813) - Update recast to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7809](https://github.com/openlayers/openlayers/pull/7809) - Update webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7812](https://github.com/openlayers/openlayers/pull/7812) - chore(package): update sinon to version 4.3.0 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7777](https://github.com/openlayers/openlayers/pull/7777) - Update babel-minify-webpack-plugin to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7759](https://github.com/openlayers/openlayers/pull/7759) - Update eslint to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7746](https://github.com/openlayers/openlayers/pull/7746) - Update sinon to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7735](https://github.com/openlayers/openlayers/pull/7735) - Update sinon to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7729](https://github.com/openlayers/openlayers/pull/7729) - Update jquery to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7732](https://github.com/openlayers/openlayers/pull/7732) - Update sinon to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7731](https://github.com/openlayers/openlayers/pull/7731) - Update webpack-dev-server to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7728](https://github.com/openlayers/openlayers/pull/7728) - Update eslint to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7720](https://github.com/openlayers/openlayers/pull/7720) - Update mocha to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7712](https://github.com/openlayers/openlayers/pull/7712) - Update sinon to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7702](https://github.com/openlayers/openlayers/pull/7702) - Update webpack-dev-server to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7701](https://github.com/openlayers/openlayers/pull/7701) - Update sinon to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7691](https://github.com/openlayers/openlayers/pull/7691) - Update webpack-dev-server to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7688](https://github.com/openlayers/openlayers/pull/7688) - Update marked to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7685](https://github.com/openlayers/openlayers/pull/7685) - Update sinon to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7681](https://github.com/openlayers/openlayers/pull/7681) - Update eslint to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7680](https://github.com/openlayers/openlayers/pull/7680) - Update webpack-dev-server to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7667](https://github.com/openlayers/openlayers/pull/7667) - Update mocha to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7656](https://github.com/openlayers/openlayers/pull/7656) - Update eslint to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7655](https://github.com/openlayers/openlayers/pull/7655) - Update marked to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7651](https://github.com/openlayers/openlayers/pull/7651) - Update karma to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7647](https://github.com/openlayers/openlayers/pull/7647) - Update rbush to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7596](https://github.com/openlayers/openlayers/pull/7596) - Update karma-webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7589](https://github.com/openlayers/openlayers/pull/7589) - chore(package): update karma-webpack to version 2.0.8 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7571](https://github.com/openlayers/openlayers/pull/7571) - Update eslint to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7567](https://github.com/openlayers/openlayers/pull/7567) - Update fs-extra to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7558](https://github.com/openlayers/openlayers/pull/7558) - Update eslint to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7552](https://github.com/openlayers/openlayers/pull/7552) - Update jscodeshift to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#7551](https://github.com/openlayers/openlayers/pull/7551) - Update sinon to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
|
|
||||||
</details>
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# 5.0.1
|
|
||||||
|
|
||||||
The v5.0.1 release helps reduce bundle sizes for bundlers that support the `"sideEffects": "false"`option in `package.json`, and fixes website documentation regarding cdn locations and debug build which has been replaced by source maps.
|
|
||||||
|
|
||||||
## Fixes
|
|
||||||
|
|
||||||
* [#8341](https://github.com/openlayers/openlayers/pull/8341) - Set sideEffects: false flag ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8342](https://github.com/openlayers/openlayers/pull/8342) - Fix links and description in quickstart tutorial ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
# 5.0.2
|
|
||||||
|
|
||||||
The v5.0.2 release updates the package readme with new example projects.
|
|
||||||
|
|
||||||
## Fixes
|
|
||||||
|
|
||||||
* [#8332](https://github.com/openlayers/openlayers/pull/8343) - Starter projects ([@tschaub](https://github.com/tschaub))
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# 5.0.3
|
|
||||||
|
|
||||||
The v5.0.3 fixes a regression in the vector tile renderer and improves the built examples and release package.
|
|
||||||
|
|
||||||
## Fixes
|
|
||||||
|
|
||||||
* [#8364](https://github.com/openlayers/openlayers/pull/8364) - Make examples work in IE11 ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8363](https://github.com/openlayers/openlayers/pull/8363) - Autogenerate src/ol/package.json ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8371](https://github.com/openlayers/openlayers/pull/8371) - Skip rendering when there is no replay group ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
@@ -1,64 +0,0 @@
|
|||||||
# v5.1.0
|
|
||||||
|
|
||||||
The 5.1 release adds a few new features a handful of fixes. You should be able to upgrade without any additional work. See the one note below regarding `null` geometry coordinates.
|
|
||||||
|
|
||||||
We're working toward type checking with TypeScript. This will complete our move away from using the Closure Compiler for type checking and compilation. We're excited about the improved experience for application developers and will highlight some of the benefit in upcoming releases.
|
|
||||||
|
|
||||||
### Upgrade Notes
|
|
||||||
|
|
||||||
#### Geometry constructor and `setCoordinates` no longer accept `null` coordinates
|
|
||||||
|
|
||||||
Geometries (`ol/geom/*`) now need to be constructed with valid coordinates (center for `ol/geom/Circle`) as first constructor argument. The same applies to the `setCoordinates()` (`setCenter() for `ol/geom/Circle`) method.
|
|
||||||
|
|
||||||
### New Features and Fixes
|
|
||||||
|
|
||||||
* [#8409](https://github.com/openlayers/openlayers/pull/8409) - Add abstract translate to ol/geom/Geometry ([@pjeweb](https://github.com/pjeweb))
|
|
||||||
* [#8405](https://github.com/openlayers/openlayers/pull/8405) - Minor type fixes ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8401](https://github.com/openlayers/openlayers/pull/8401) - Make webpack's css loader work ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8403](https://github.com/openlayers/openlayers/pull/8403) - Markdown links ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8402](https://github.com/openlayers/openlayers/pull/8402) - Type fixes from the typescript checks ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8400](https://github.com/openlayers/openlayers/pull/8400) - ESLint config update ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8399](https://github.com/openlayers/openlayers/pull/8399) - Copy ol.css to build dir when building package ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8397](https://github.com/openlayers/openlayers/pull/8397) - Update rollup ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8385](https://github.com/openlayers/openlayers/pull/8385) - Use class syntax ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8383](https://github.com/openlayers/openlayers/pull/8383) - style/Icon: Add `setAnchor()` method ([@Turbo87](https://github.com/Turbo87))
|
|
||||||
* [#8368](https://github.com/openlayers/openlayers/pull/8368) - Make render listeners work with image render mode ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8376](https://github.com/openlayers/openlayers/pull/8376) - copy ZM values to polygon in makeRegular ([@virtualcitySYSTEMS](https://github.com/virtualcitySYSTEMS))
|
|
||||||
* [#8372](https://github.com/openlayers/openlayers/pull/8372) - Release v5.0.3 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8364](https://github.com/openlayers/openlayers/pull/8364) - Make examples work in IE11 ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8363](https://github.com/openlayers/openlayers/pull/8363) - Autogenerate src/ol/package.json ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8371](https://github.com/openlayers/openlayers/pull/8371) - Skip rendering when there is no replay group ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8362](https://github.com/openlayers/openlayers/pull/8362) - Smart flat coordinates ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8352](https://github.com/openlayers/openlayers/pull/8352) - Set `sideEffects` to `false` instead of `"false"` ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8351](https://github.com/openlayers/openlayers/pull/8351) - Fix typo in release notes ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8350](https://github.com/openlayers/openlayers/pull/8350) - Updates for v5.0.2 ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8349](https://github.com/openlayers/openlayers/pull/8349) - Release v5.0.1 ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8343](https://github.com/openlayers/openlayers/pull/8343) - Starter projects ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8347](https://github.com/openlayers/openlayers/pull/8347) - Fix typos in release notes ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8346](https://github.com/openlayers/openlayers/pull/8346) - Release v5.0.1 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8342](https://github.com/openlayers/openlayers/pull/8342) - Fix links and description in quickstart tutorial ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8344](https://github.com/openlayers/openlayers/pull/8344) - Updated issue and pr templates ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8341](https://github.com/openlayers/openlayers/pull/8341) - Set sideEffects: false flag ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8333](https://github.com/openlayers/openlayers/pull/8333) - Fix wrong return type for readHref function ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8329](https://github.com/openlayers/openlayers/pull/8329) - Better jsdoc typing ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8319](https://github.com/openlayers/openlayers/pull/8319) - Remove reference to setProj4 function in documentation ([@fredj](https://github.com/fredj))
|
|
||||||
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Dependency Updates</summary>
|
|
||||||
|
|
||||||
* [#8410](https://github.com/openlayers/openlayers/pull/8410) - Update rollup to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8408](https://github.com/openlayers/openlayers/pull/8408) - Update rollup to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8386](https://github.com/openlayers/openlayers/pull/8386) - Update fs-extra to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8382](https://github.com/openlayers/openlayers/pull/8382) - Update webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8373](https://github.com/openlayers/openlayers/pull/8373) - Update webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8355](https://github.com/openlayers/openlayers/pull/8355) - Update recast to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8354](https://github.com/openlayers/openlayers/pull/8354) - Update webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8348](https://github.com/openlayers/openlayers/pull/8348) - Update webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8338](https://github.com/openlayers/openlayers/pull/8338) - Update recast to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8332](https://github.com/openlayers/openlayers/pull/8332) - Update webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8326](https://github.com/openlayers/openlayers/pull/8326) - Update webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8321](https://github.com/openlayers/openlayers/pull/8321) - Update rollup to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8318](https://github.com/openlayers/openlayers/pull/8318) - Update webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
|
|
||||||
</details>
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
# 5.1.1
|
|
||||||
|
|
||||||
The 5.1.1 release is a patch to include the readme in the package. See the [5.1.0 notes](https://github.com/openlayers/openlayers/releases/tag/v5.1.0) for detail on the 5.1 release.
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
# 5.1.2
|
|
||||||
|
|
||||||
The 5.1.2 release is a patch to fix the API docs. See the [5.1.0 notes](https://github.com/openlayers/openlayers/releases/tag/v5.1.0) for detail on the 5.1 release.
|
|
||||||
|
|
||||||
* [#8413](https://github.com/openlayers/openlayers/pull/8413) - Remove extra curly in type ([@tschaub](https://github.com/tschaub))
|
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
# 5.1.3
|
|
||||||
|
|
||||||
The 5.1.3 release is a patch to fix the API docs and the legacy full build. See the [5.1.0 notes](https://github.com/openlayers/openlayers/releases/tag/v5.1.0) for detail on the 5.1 release.
|
|
||||||
|
|
||||||
* [#8417](https://github.com/openlayers/openlayers/pull/8417) - Minor doc updates ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8418](https://github.com/openlayers/openlayers/pull/8418) - Set api annotation on classdesc, not constructor ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
@@ -1,86 +0,0 @@
|
|||||||
# v5.2.0
|
|
||||||
|
|
||||||
The 5.2 release adds a few new features a handful of fixes, including regressions that were reported after the 5.1 release. You should be able to upgrade without any additional work. See the one note below regarding `snapToPixel` on `ol/style/Image` and subclasses.
|
|
||||||
|
|
||||||
We're still working toward type checking with TypeScript. Until that is complete, we apologize for some flwas in the online API documentation. We're excited about the improved experience for application developers when the effort is finished, and will highlight some of the benefit in upcoming releases.
|
|
||||||
|
|
||||||
### Upgrade Notes
|
|
||||||
|
|
||||||
#### Removal of the `snapToPixel` option for `ol/style/Image` subclasses
|
|
||||||
|
|
||||||
The `snapToPixel` option has been removed, and the `getSnapToPixel` and `setSnapToPixel` methods are deprecated.
|
|
||||||
|
|
||||||
The renderer now snaps to integer pixels when no interaction or animation is running to get crisp rendering. During interaction or animation, it does not snap to integer pixels to avoid jitter.
|
|
||||||
|
|
||||||
When rendering with the Immediate API, symbols will no longer be snapped to integer pixels. To get crisp images, set `context.imageSmoothingEnabled = false` before rendering with the Immediate API, and `context.imageSmoothingEnabled = true` afterwards.
|
|
||||||
|
|
||||||
### New Features and Fixes
|
|
||||||
|
|
||||||
* [#8511](https://github.com/openlayers/openlayers/pull/8511) - Update IGN API key ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8547](https://github.com/openlayers/openlayers/pull/8547) - Fix port number in developing doc ([@pgiraud](https://github.com/pgiraud))
|
|
||||||
* [#8546](https://github.com/openlayers/openlayers/pull/8546) - Update projection FAQ for v5 ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8481](https://github.com/openlayers/openlayers/pull/8481) - Expose some internal functions ([@gberaudo](https://github.com/gberaudo))
|
|
||||||
* [#8510](https://github.com/openlayers/openlayers/pull/8510) - Fix WMTS URLs with dimensions ([@gberaudo](https://github.com/gberaudo))
|
|
||||||
* [#8524](https://github.com/openlayers/openlayers/pull/8524) - Fix compatiblity with XHTML content type ([@NeoRaider](https://github.com/NeoRaider))
|
|
||||||
* [#8532](https://github.com/openlayers/openlayers/pull/8532) - Add 'rendercomplete' event ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8529](https://github.com/openlayers/openlayers/pull/8529) - Update link to base class in docs ([@TDesjardins](https://github.com/TDesjardins))
|
|
||||||
* [#8528](https://github.com/openlayers/openlayers/pull/8528) - Update link to base class in docs ([@TDesjardins](https://github.com/TDesjardins))
|
|
||||||
* [#8525](https://github.com/openlayers/openlayers/pull/8525) - Re-export Projection from ol/proj for convenience ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8499](https://github.com/openlayers/openlayers/pull/8499) - Round center in viewState to pixels ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8520](https://github.com/openlayers/openlayers/pull/8520) - Remove redundant if block ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8515](https://github.com/openlayers/openlayers/pull/8515) - More convenient select and sketch layer management ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8503](https://github.com/openlayers/openlayers/pull/8503) - Avoid block scope issues in transpiled code ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8490](https://github.com/openlayers/openlayers/pull/8490) - WMTS getCapabilities readCoodinates more than one whitespace delimiter ([@MarquesDeAzevedo](https://github.com/MarquesDeAzevedo))
|
|
||||||
* [#8489](https://github.com/openlayers/openlayers/pull/8489) - Use .prototype. only where necessary ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8478](https://github.com/openlayers/openlayers/pull/8478) - Check font availability with multiple font weights ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8483](https://github.com/openlayers/openlayers/pull/8483) - Don't create Polygon with null coordinates ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8471](https://github.com/openlayers/openlayers/pull/8471) - Add getUrl and getImageExtent to ImageStatic API ([@samuel-girard](https://github.com/samuel-girard))
|
|
||||||
* [#8470](https://github.com/openlayers/openlayers/pull/8470) - Update Tile loading API docs ([@scroach](https://github.com/scroach))
|
|
||||||
* [#8477](https://github.com/openlayers/openlayers/pull/8477) - Expose original getGutter ([@gberaudo](https://github.com/gberaudo))
|
|
||||||
* [#8466](https://github.com/openlayers/openlayers/pull/8466) - Add onFocusOnly option to interaction defaults ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8465](https://github.com/openlayers/openlayers/pull/8465) - Do not prevent default on pointermove ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8461](https://github.com/openlayers/openlayers/pull/8461) - Fix double backtick typo ([@lionralfs](https://github.com/lionralfs))
|
|
||||||
* [#8452](https://github.com/openlayers/openlayers/pull/8452) - Remove extra translate function in Geometry, add missing api tag ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8451](https://github.com/openlayers/openlayers/pull/8451) - Remove unimplemented functions ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8450](https://github.com/openlayers/openlayers/pull/8450) - Mark properties of ReadOptions and WriteOptions as optional ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8443](https://github.com/openlayers/openlayers/pull/8443) - Explicit void ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8437](https://github.com/openlayers/openlayers/pull/8437) - Avoid shadowing EventTarget ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8439](https://github.com/openlayers/openlayers/pull/8439) - Fewer dots in types ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8441](https://github.com/openlayers/openlayers/pull/8441) - Fix loaded script for the example-verbatim examples ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8435](https://github.com/openlayers/openlayers/pull/8435) - Call setCoordinates on the point instance ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8428](https://github.com/openlayers/openlayers/pull/8428) - Type name on same line as type ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8422](https://github.com/openlayers/openlayers/pull/8422) - Improve JSDoc such that `ng build --prod` with angular/cli 6.0.8 succeeds again ([@jkoelewijn](https://github.com/jkoelewijn))
|
|
||||||
* [#8396](https://github.com/openlayers/openlayers/pull/8396) - Fix ol.interaction.Draw~createRegularPolygon ([@iamplex](https://github.com/iamplex))
|
|
||||||
* [#8420](https://github.com/openlayers/openlayers/pull/8420) - Keep function names when building examples ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8419](https://github.com/openlayers/openlayers/pull/8419) - Release v5.1.3 ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8417](https://github.com/openlayers/openlayers/pull/8417) - Minor doc updates ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8418](https://github.com/openlayers/openlayers/pull/8418) - Set api annotation on classdesc, not constructor ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8414](https://github.com/openlayers/openlayers/pull/8414) - Updates for 5.1.2 ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8413](https://github.com/openlayers/openlayers/pull/8413) - Remove extra curly in type ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8412](https://github.com/openlayers/openlayers/pull/8412) - Changes for 5.1.1. ([@tschaub](https://github.com/tschaub))
|
|
||||||
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Dependency Updates</summary>
|
|
||||||
|
|
||||||
* [#8543](https://github.com/openlayers/openlayers/pull/8543) - Update rollup to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8541](https://github.com/openlayers/openlayers/pull/8541) - Update proj4 to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8542](https://github.com/openlayers/openlayers/pull/8542) - Update rollup-plugin-commonjs to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8533](https://github.com/openlayers/openlayers/pull/8533) - Update webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8530](https://github.com/openlayers/openlayers/pull/8530) - Update webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8522](https://github.com/openlayers/openlayers/pull/8522) - Update marked to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8505](https://github.com/openlayers/openlayers/pull/8505) - Update karma to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8501](https://github.com/openlayers/openlayers/pull/8501) - Update rollup-plugin-commonjs to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8495](https://github.com/openlayers/openlayers/pull/8495) - Update rollup to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8493](https://github.com/openlayers/openlayers/pull/8493) - Update clean-css-cli to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8491](https://github.com/openlayers/openlayers/pull/8491) - Update rollup to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8486](https://github.com/openlayers/openlayers/pull/8486) - Update webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8476](https://github.com/openlayers/openlayers/pull/8476) - Update webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8475](https://github.com/openlayers/openlayers/pull/8475) - Update clean-css-cli to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8469](https://github.com/openlayers/openlayers/pull/8469) - Update rollup to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8453](https://github.com/openlayers/openlayers/pull/8453) - Update webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8447](https://github.com/openlayers/openlayers/pull/8447) - Update rollup-plugin-commonjs to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8426](https://github.com/openlayers/openlayers/pull/8426) - Update webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
|
|
||||||
|
|
||||||
</details>
|
|
||||||
@@ -1,217 +0,0 @@
|
|||||||
# v5.3.0
|
|
||||||
|
|
||||||
We're continuing to work toward more complete type checking with TypeScript – based on JSDoc annotations in the source. The 5.3 release includes a number of bug fixes related to the type checking effort. In addition the release comes with a handful of new features and improved API reference docs.
|
|
||||||
|
|
||||||
### Upgrade Notes
|
|
||||||
|
|
||||||
#### The `getUid` function returns string
|
|
||||||
|
|
||||||
The `getUid` function from the `ol/util` module now returns a string instead of a number.
|
|
||||||
|
|
||||||
#### Attributions are not collapsible for `ol/source/OSM`
|
|
||||||
|
|
||||||
When a map contains a layer from a `ol/source/OSM` source, the `ol/control/Attribution` control will be shown with the `collapsible: false` behavior.
|
|
||||||
|
|
||||||
To get the previous behavior, configure the `ol/control/Attribution` control with `collapsible: true`.
|
|
||||||
|
|
||||||
### New Features and Fixes
|
|
||||||
|
|
||||||
* [#8642](https://github.com/openlayers/openlayers/pull/8642) - Fixes for optional key passing, issue #8067 for tile sources ([@dimin](https://github.com/dimin))
|
|
||||||
* [#8885](https://github.com/openlayers/openlayers/pull/8885) - Move GeolocationProperty into Geolocation ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8881](https://github.com/openlayers/openlayers/pull/8881) - Remove custom styles in drag-and-drop examples ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8877](https://github.com/openlayers/openlayers/pull/8877) - Create context in vector tile layer constructor ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8883](https://github.com/openlayers/openlayers/pull/8883) - New test runner ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8882](https://github.com/openlayers/openlayers/pull/8882) - Import simplification ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8858](https://github.com/openlayers/openlayers/pull/8858) - Add condition for viewParams and TypeScript related option ([@webgeodatavore](https://github.com/webgeodatavore))
|
|
||||||
* [#8879](https://github.com/openlayers/openlayers/pull/8879) - Build with CircleCI ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8878](https://github.com/openlayers/openlayers/pull/8878) - Avoid logging 404 warnings ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8876](https://github.com/openlayers/openlayers/pull/8876) - Remove RenderType enum from vector tile layer ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8874](https://github.com/openlayers/openlayers/pull/8874) - Remove unnecessary type casts in canvas layer renderer ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8869](https://github.com/openlayers/openlayers/pull/8869) - Fix more types for TypeScript ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8868](https://github.com/openlayers/openlayers/pull/8868) - Throw when calling abstract methods; fix abstract return types ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8862](https://github.com/openlayers/openlayers/pull/8862) - Legacy build and apidoc improvements ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8867](https://github.com/openlayers/openlayers/pull/8867) - Fix example builder ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8852](https://github.com/openlayers/openlayers/pull/8852) - Improve link handling in API docs ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8853](https://github.com/openlayers/openlayers/pull/8853) - Make rendercomplete work with vector sources without loader ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8851](https://github.com/openlayers/openlayers/pull/8851) - Use typescript types for RBush ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8850](https://github.com/openlayers/openlayers/pull/8850) - Remove old TODO in ol/Graticule ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8847](https://github.com/openlayers/openlayers/pull/8847) - Fix API docs ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8845](https://github.com/openlayers/openlayers/pull/8845) - Remove RenderType enum from vector layer ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8843](https://github.com/openlayers/openlayers/pull/8843) - Fix ts typing for fullscreen button ([@tonio](https://github.com/tonio))
|
|
||||||
* [#8841](https://github.com/openlayers/openlayers/pull/8841) - Use super.method instead of prototype.method.call ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8842](https://github.com/openlayers/openlayers/pull/8842) - Change target type from Element to HTMLElement ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8840](https://github.com/openlayers/openlayers/pull/8840) - Remove unneeded code in VectorTile renderer ([@elemoine](https://github.com/elemoine))
|
|
||||||
* [#8844](https://github.com/openlayers/openlayers/pull/8844) - Set crossOrigin to anonymous in mapbox-streets-v6-style ([@elemoine](https://github.com/elemoine))
|
|
||||||
* [#8776](https://github.com/openlayers/openlayers/pull/8776) - Use setTimeout without the window namespace ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8837](https://github.com/openlayers/openlayers/pull/8837) - Re-export MousePosition from ol/control ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8832](https://github.com/openlayers/openlayers/pull/8832) - Remove source foreachfeatureatcoordinate from ol/renderer/webgl/ImageLayer ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8833](https://github.com/openlayers/openlayers/pull/8833) - Fix wrong filename in type annotation ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8827](https://github.com/openlayers/openlayers/pull/8827) - Removed unused forEachFeatureAtCoordinate from ol/source/Source ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8830](https://github.com/openlayers/openlayers/pull/8830) - Type annotation fixes in ol/control/ ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8829](https://github.com/openlayers/openlayers/pull/8829) - Change getUid return type from number to string ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8825](https://github.com/openlayers/openlayers/pull/8825) - Fix TypeScript errors ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8828](https://github.com/openlayers/openlayers/pull/8828) - Re-export VectorTile from ol/source ([@elemoine](https://github.com/elemoine))
|
|
||||||
* [#8806](https://github.com/openlayers/openlayers/pull/8806) - Preserve button class name list in full screen control on toggle ([@notnotse](https://github.com/notnotse))
|
|
||||||
* [#8817](https://github.com/openlayers/openlayers/pull/8817) - Clarify format option for ol/source/WMTS ([@romanzoller](https://github.com/romanzoller))
|
|
||||||
* [#8824](https://github.com/openlayers/openlayers/pull/8824) - Fix TypeScript errors in ol/format/GML ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8820](https://github.com/openlayers/openlayers/pull/8820) - Polygon intersectsExtent failure - Issue #8795 ([@hmdavidjunior](https://github.com/hmdavidjunior))
|
|
||||||
* [#8519](https://github.com/openlayers/openlayers/pull/8519) - GML Format Improvements #8516 #8517 #8518 ([@NielsCharlier](https://github.com/NielsCharlier))
|
|
||||||
* [#8711](https://github.com/openlayers/openlayers/pull/8711) - Fix TypeScript errors in ol/format/GML ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8818](https://github.com/openlayers/openlayers/pull/8818) - Fix the way zoom comes from ([@cs09g](https://github.com/cs09g))
|
|
||||||
* [#8804](https://github.com/openlayers/openlayers/pull/8804) - Add possibility to disable collapsible attributions from Source ([@notnotse](https://github.com/notnotse))
|
|
||||||
* [#8787](https://github.com/openlayers/openlayers/pull/8787) - Replace instanceof checks with other logic ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8808](https://github.com/openlayers/openlayers/pull/8808) - Fix format and version properties in ol/source/WMTS Options typedef ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8812](https://github.com/openlayers/openlayers/pull/8812) - Update snap.js ([@rosedo](https://github.com/rosedo))
|
|
||||||
* [#8809](https://github.com/openlayers/openlayers/pull/8809) - Configurable interval options ([@notnotse](https://github.com/notnotse))
|
|
||||||
* [#8798](https://github.com/openlayers/openlayers/pull/8798) - Use unpkg.com instead of rawgit.com ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8805](https://github.com/openlayers/openlayers/pull/8805) - Do not draw image with width or height < 0.5 ([@notnotse](https://github.com/notnotse))
|
|
||||||
* [#8803](https://github.com/openlayers/openlayers/pull/8803) - Handle zoom slider position with floating point numbers ([@notnotse](https://github.com/notnotse))
|
|
||||||
* [#8789](https://github.com/openlayers/openlayers/pull/8789) - Spelling and indentation fixes ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8782](https://github.com/openlayers/openlayers/pull/8782) - Fix getSimplifiedGeometry definition ([@wallw-bits](https://github.com/wallw-bits))
|
|
||||||
* [#8783](https://github.com/openlayers/openlayers/pull/8783) - Fix missing method declaration ([@wallw-bits](https://github.com/wallw-bits))
|
|
||||||
* [#8781](https://github.com/openlayers/openlayers/pull/8781) - Fix type check errors ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8779](https://github.com/openlayers/openlayers/pull/8779) - Fix additional type check errors ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8753](https://github.com/openlayers/openlayers/pull/8753) - Fix type check in ol/PluggableMap.js ([@wallw-bits](https://github.com/wallw-bits))
|
|
||||||
* [#8762](https://github.com/openlayers/openlayers/pull/8762) - Fix type errors from interaction event handlers ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8763](https://github.com/openlayers/openlayers/pull/8763) - Fix type check for ol/events ([@wallw-bits](https://github.com/wallw-bits))
|
|
||||||
* [#8774](https://github.com/openlayers/openlayers/pull/8774) - Fix type check errors in ol/renderer/webgl ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8768](https://github.com/openlayers/openlayers/pull/8768) - Fix type check errors in ol/interaction/Select ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8764](https://github.com/openlayers/openlayers/pull/8764) - Fix TypeScript errors in ol/interaction/Draw ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8767](https://github.com/openlayers/openlayers/pull/8767) - Fix type check errors in ol/interaction/Modify ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8773](https://github.com/openlayers/openlayers/pull/8773) - Fix type check errors in ol/renderer/canvas ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8769](https://github.com/openlayers/openlayers/pull/8769) - Fix type check errors in ol/render/canvas ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8770](https://github.com/openlayers/openlayers/pull/8770) - Fix type check errors in ol/render/webgl ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8765](https://github.com/openlayers/openlayers/pull/8765) - Simplify logic for fixed tile url functions ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8766](https://github.com/openlayers/openlayers/pull/8766) - Use FeatureLike typedef ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8739](https://github.com/openlayers/openlayers/pull/8739) - Fix TypeScript errors in ol/format/WMSGetFeatureInfo ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8666](https://github.com/openlayers/openlayers/pull/8666) - Fix condition TypeScript errors ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8757](https://github.com/openlayers/openlayers/pull/8757) - Use typeof to simplify JSDoc class types ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8759](https://github.com/openlayers/openlayers/pull/8759) - Use es6 class inheritance in examples ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8761](https://github.com/openlayers/openlayers/pull/8761) - Allow returning RenderFeature in ol/format/Feature ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8758](https://github.com/openlayers/openlayers/pull/8758) - Fix TS error and prevent extra string conversion ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8736](https://github.com/openlayers/openlayers/pull/8736) - Typescript misc fixes ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8741](https://github.com/openlayers/openlayers/pull/8741) - Fix TypeScript errors in ol/geom/* ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8707](https://github.com/openlayers/openlayers/pull/8707) - Fix TypeScript errors in ol/format/Feature ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8754](https://github.com/openlayers/openlayers/pull/8754) - Fix type check in ol/math ([@wallw-bits](https://github.com/wallw-bits))
|
|
||||||
* [#8747](https://github.com/openlayers/openlayers/pull/8747) - Update doc/faq.md ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8744](https://github.com/openlayers/openlayers/pull/8744) - Fix type checks in VectorTileSource ([@wallw-bits](https://github.com/wallw-bits))
|
|
||||||
* [#8740](https://github.com/openlayers/openlayers/pull/8740) - Increase linestring textalign test tolerance to be Firefox compliant. ([@benVigie](https://github.com/benVigie))
|
|
||||||
* [#8738](https://github.com/openlayers/openlayers/pull/8738) - Cast to parent type to fix TS errors ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8737](https://github.com/openlayers/openlayers/pull/8737) - Flag optional param to fix TS error ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8742](https://github.com/openlayers/openlayers/pull/8742) - Fix type checks in Vector source ([@wallw-bits](https://github.com/wallw-bits))
|
|
||||||
* [#8743](https://github.com/openlayers/openlayers/pull/8743) - Fix type check in Raster source ([@wallw-bits](https://github.com/wallw-bits))
|
|
||||||
* [#8733](https://github.com/openlayers/openlayers/pull/8733) - Fix TypeScript errors in ol/format/WFS ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8735](https://github.com/openlayers/openlayers/pull/8735) - Fix TypeScript errors in ol/format/WKT ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8730](https://github.com/openlayers/openlayers/pull/8730) - Fix TypeScript errors in ol/format/KML ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8732](https://github.com/openlayers/openlayers/pull/8732) - Fix type check in ol/source/Tile ([@wallw-bits](https://github.com/wallw-bits))
|
|
||||||
* [#8731](https://github.com/openlayers/openlayers/pull/8731) - Dispatch a GeolocationError in Geolocation ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8729](https://github.com/openlayers/openlayers/pull/8729) - Move functions out of the PointerEvent class ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8724](https://github.com/openlayers/openlayers/pull/8724) - Typescript misc fixes ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8717](https://github.com/openlayers/openlayers/pull/8717) - Fix type checks in TileArcGISRest ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8718](https://github.com/openlayers/openlayers/pull/8718) - Fix TypeScript errors in ol/format/GPX ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8706](https://github.com/openlayers/openlayers/pull/8706) - Use EsriJSON types from @types/arcgis-rest-api ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8709](https://github.com/openlayers/openlayers/pull/8709) - Fix TypeScript errors in ol/format/GeoJSON ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8708](https://github.com/openlayers/openlayers/pull/8708) - Fix type checks in ImageCanvas source ([@wallw-bits](https://github.com/wallw-bits))
|
|
||||||
* [#8710](https://github.com/openlayers/openlayers/pull/8710) - Fix type checks in ImageArcGISRest ([@wallw-bits](https://github.com/wallw-bits))
|
|
||||||
* [#8698](https://github.com/openlayers/openlayers/pull/8698) - Fix zoom slider events ([@intouch-smartwater](https://github.com/intouch-smartwater))
|
|
||||||
* [#8697](https://github.com/openlayers/openlayers/pull/8697) - Remove unused properties from Cluster and Image options ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8688](https://github.com/openlayers/openlayers/pull/8688) - Fix PointerEventHandler event type ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8686](https://github.com/openlayers/openlayers/pull/8686) - Remove extra imports in jsdoc ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8681](https://github.com/openlayers/openlayers/pull/8681) - Check the type of the source before using it ([@wallw-bits](https://github.com/wallw-bits))
|
|
||||||
* [#8691](https://github.com/openlayers/openlayers/pull/8691) - Fix assertion error documentation URL ([@romanzoller](https://github.com/romanzoller))
|
|
||||||
* [#8692](https://github.com/openlayers/openlayers/pull/8692) - Type check fixes for Cluster source ([@wallw-bits](https://github.com/wallw-bits))
|
|
||||||
* [#8677](https://github.com/openlayers/openlayers/pull/8677) - Type check fixes for VectorSource ([@wallw-bits](https://github.com/wallw-bits))
|
|
||||||
* [#8684](https://github.com/openlayers/openlayers/pull/8684) - Define BingMapsImageryMetadataResponse type ([@wallw-bits](https://github.com/wallw-bits))
|
|
||||||
* [#8690](https://github.com/openlayers/openlayers/pull/8690) - Fix type checks in CartoDB ([@wallw-bits](https://github.com/wallw-bits))
|
|
||||||
* [#8693](https://github.com/openlayers/openlayers/pull/8693) - Fix type check errors for Image source ([@wallw-bits](https://github.com/wallw-bits))
|
|
||||||
* [#8672](https://github.com/openlayers/openlayers/pull/8672) - Fix source type in Raster source ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8665](https://github.com/openlayers/openlayers/pull/8665) - Fix type check errors in RBush ([@wallw-bits](https://github.com/wallw-bits))
|
|
||||||
* [#8680](https://github.com/openlayers/openlayers/pull/8680) - TypeScript fixes for ol/events ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8678](https://github.com/openlayers/openlayers/pull/8678) - Ensure image is Image or Video before settings src ([@wallw-bits](https://github.com/wallw-bits))
|
|
||||||
* [#8676](https://github.com/openlayers/openlayers/pull/8676) - Cast tileGrid to WMTSTileGrid for type check ([@wallw-bits](https://github.com/wallw-bits))
|
|
||||||
* [#8679](https://github.com/openlayers/openlayers/pull/8679) - Type check fixes in Triangulation ([@wallw-bits](https://github.com/wallw-bits))
|
|
||||||
* [#8657](https://github.com/openlayers/openlayers/pull/8657) - Typescript fixes ([@fgravin](https://github.com/fgravin))
|
|
||||||
* [#8671](https://github.com/openlayers/openlayers/pull/8671) - Fix typescript in FeatureLoader ([@fgravin](https://github.com/fgravin))
|
|
||||||
* [#8675](https://github.com/openlayers/openlayers/pull/8675) - Get width as number from number|Size ([@wallw-bits](https://github.com/wallw-bits))
|
|
||||||
* [#8654](https://github.com/openlayers/openlayers/pull/8654) - Remove extra imports in jsdoc ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8655](https://github.com/openlayers/openlayers/pull/8655) - Remove webkit specific properties from Touch ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8663](https://github.com/openlayers/openlayers/pull/8663) - Add vendor-specific TS declarations for the Fullscreen API. ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8658](https://github.com/openlayers/openlayers/pull/8658) - Don't define functions in the prototype ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8662](https://github.com/openlayers/openlayers/pull/8662) - Explicitly define type of 'this' ([@wallw-bits](https://github.com/wallw-bits))
|
|
||||||
* [#8664](https://github.com/openlayers/openlayers/pull/8664) - Add native Event to ListenerFunction signature. ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8668](https://github.com/openlayers/openlayers/pull/8668) - Add missing 'module' annotation ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8643](https://github.com/openlayers/openlayers/pull/8643) - Fix style TypeScript errors ([@schmidtk](https://github.com/schmidtk))
|
|
||||||
* [#8638](https://github.com/openlayers/openlayers/pull/8638) - Fix event type in hasListener check ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8618](https://github.com/openlayers/openlayers/pull/8618) - Use TopoJSON types from @types/topojson ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8619](https://github.com/openlayers/openlayers/pull/8619) - Remove wrong Geometry type in KML format ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8627](https://github.com/openlayers/openlayers/pull/8627) - Fix several type imports ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8629](https://github.com/openlayers/openlayers/pull/8629) - Enable circle primitive in draw-shapes example ([@megawac](https://github.com/megawac))
|
|
||||||
* [#8626](https://github.com/openlayers/openlayers/pull/8626) - Better type annotations / type casts ([@marcjansen](https://github.com/marcjansen))
|
|
||||||
* [#8622](https://github.com/openlayers/openlayers/pull/8622) - Remove unused method ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8615](https://github.com/openlayers/openlayers/pull/8615) - Use GeoJSON types from @types/geojson ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8609](https://github.com/openlayers/openlayers/pull/8609) - Remove extra imports in jsdoc ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8613](https://github.com/openlayers/openlayers/pull/8613) - Lazily detect tainted canvas ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8610](https://github.com/openlayers/openlayers/pull/8610) - Sensible touch behavior of the MousePosition control ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8602](https://github.com/openlayers/openlayers/pull/8602) - Add missing map property in ol/layer/Layer constructor options ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8607](https://github.com/openlayers/openlayers/pull/8607) - Listener return is boolean or void ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8595](https://github.com/openlayers/openlayers/pull/8595) - Optional arguments and typedef properties ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8594](https://github.com/openlayers/openlayers/pull/8594) - Remove extra imports in jsdoc ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8596](https://github.com/openlayers/openlayers/pull/8596) - Add types for the UTFGrid and TileJSON JSON responses ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8591](https://github.com/openlayers/openlayers/pull/8591) - Add missing properties in TextState typedef ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8590](https://github.com/openlayers/openlayers/pull/8590) - Don't import ourselves ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8586](https://github.com/openlayers/openlayers/pull/8586) - Cast 'originalEvent' in interactions ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8588](https://github.com/openlayers/openlayers/pull/8588) - Rework createXYZ ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8587](https://github.com/openlayers/openlayers/pull/8587) - Add a statement to trigger TypeScript checking ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8345](https://github.com/openlayers/openlayers/pull/8345) - TypeScript (1/n) ([@tschaub](https://github.com/tschaub))
|
|
||||||
* [#8579](https://github.com/openlayers/openlayers/pull/8579) - Better type annotation ([@marcjansen](https://github.com/marcjansen))
|
|
||||||
* [#8580](https://github.com/openlayers/openlayers/pull/8580) - Cast POINTER_ID before comparison ([@marcjansen](https://github.com/marcjansen))
|
|
||||||
* [#8574](https://github.com/openlayers/openlayers/pull/8574) - Rename Extent to ExtentInteraction ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8577](https://github.com/openlayers/openlayers/pull/8577) - Remove geojson.js extern inclusion in tasks/generate-info ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8573](https://github.com/openlayers/openlayers/pull/8573) - Fix freehand polygon drawing ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8572](https://github.com/openlayers/openlayers/pull/8572) - typescript misc fixes ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8569](https://github.com/openlayers/openlayers/pull/8569) - Make proj~get simpler and faster ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8567](https://github.com/openlayers/openlayers/pull/8567) - Use 'Element' type instead of 'Node' ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8558](https://github.com/openlayers/openlayers/pull/8558) - Fix default zIndex value and documentation for layer options ([@fredj](https://github.com/fredj))
|
|
||||||
* [#8555](https://github.com/openlayers/openlayers/pull/8555) - Do not minify examples that inject code into workers ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
* [#8557](https://github.com/openlayers/openlayers/pull/8557) - Fix typo in release notes ([@ahocevar](https://github.com/ahocevar))
|
|
||||||
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Dependency Updates</summary>
|
|
||||||
|
|
||||||
* [#8884](https://github.com/openlayers/openlayers/pull/8884) - Update webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8880](https://github.com/openlayers/openlayers/pull/8880) - Update webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8872](https://github.com/openlayers/openlayers/pull/8872) - Update webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8860](https://github.com/openlayers/openlayers/pull/8860) - Update webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8855](https://github.com/openlayers/openlayers/pull/8855) - Update webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8838](https://github.com/openlayers/openlayers/pull/8838) - Update webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8834](https://github.com/openlayers/openlayers/pull/8834) - Update webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8799](https://github.com/openlayers/openlayers/pull/8799) - Update rollup to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8796](https://github.com/openlayers/openlayers/pull/8796) - Update rollup-plugin-commonjs to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8793](https://github.com/openlayers/openlayers/pull/8793) - Update rollup-plugin-buble to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8794](https://github.com/openlayers/openlayers/pull/8794) - Update rollup to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8788](https://github.com/openlayers/openlayers/pull/8788) - Update front-matter to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8785](https://github.com/openlayers/openlayers/pull/8785) - chore(package): update rollup to version 0.66.4 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8719](https://github.com/openlayers/openlayers/pull/8719) - Update marked to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8714](https://github.com/openlayers/openlayers/pull/8714) - chore(package): update webpack to version 4.20.2 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8703](https://github.com/openlayers/openlayers/pull/8703) - Update webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8646](https://github.com/openlayers/openlayers/pull/8646) - Update mustache to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8645](https://github.com/openlayers/openlayers/pull/8645) - Update rollup-plugin-uglify to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8685](https://github.com/openlayers/openlayers/pull/8685) - Update rollup to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8683](https://github.com/openlayers/openlayers/pull/8683) - Update rollup to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8656](https://github.com/openlayers/openlayers/pull/8656) - chore(package): update rollup-plugin-commonjs to version 9.1.8 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8667](https://github.com/openlayers/openlayers/pull/8667) - chore(package): update uglifyjs-webpack-plugin to version 2.0.1 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8661](https://github.com/openlayers/openlayers/pull/8661) - Update webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8644](https://github.com/openlayers/openlayers/pull/8644) - Update rollup to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8631](https://github.com/openlayers/openlayers/pull/8631) - Update webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8630](https://github.com/openlayers/openlayers/pull/8630) - Update webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8617](https://github.com/openlayers/openlayers/pull/8617) - chore(package): update webpack to version 4.18.0 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8589](https://github.com/openlayers/openlayers/pull/8589) - Update rollup to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8581](https://github.com/openlayers/openlayers/pull/8581) - Update rollup-plugin-node-resolve to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8585](https://github.com/openlayers/openlayers/pull/8585) - Update rollup to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8578](https://github.com/openlayers/openlayers/pull/8578) - Update webpack to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8563](https://github.com/openlayers/openlayers/pull/8563) - Update rollup-plugin-uglify to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
* [#8561](https://github.com/openlayers/openlayers/pull/8561) - Update rollup-plugin-uglify to the latest version 🚀 ([@openlayers](https://github.com/openlayers))
|
|
||||||
|
|
||||||
|
|
||||||
</details>
|
|
||||||
45
config/example.json
Normal file
45
config/example.json
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
{
|
||||||
|
"exports": [],
|
||||||
|
"src": [
|
||||||
|
"src/**/*.js",
|
||||||
|
"build/ol.ext/*.js",
|
||||||
|
"build/examples/{{id}}.js"
|
||||||
|
],
|
||||||
|
"compile": {
|
||||||
|
"js": [
|
||||||
|
"externs/olx.js",
|
||||||
|
"externs/oli.js"
|
||||||
|
],
|
||||||
|
"externs": [
|
||||||
|
"externs/bingmaps.js",
|
||||||
|
"externs/cartodb.js",
|
||||||
|
"externs/bootstrap.js",
|
||||||
|
"externs/closure-compiler.js",
|
||||||
|
"externs/esrijson.js",
|
||||||
|
"externs/example.js",
|
||||||
|
"externs/geojson.js",
|
||||||
|
"externs/jquery-1.9.js",
|
||||||
|
"externs/proj4js.js",
|
||||||
|
"externs/tilejson.js",
|
||||||
|
"externs/topojson.js"
|
||||||
|
],
|
||||||
|
"jscomp_error": [
|
||||||
|
"*"
|
||||||
|
],
|
||||||
|
"jscomp_off": [
|
||||||
|
"lintChecks",
|
||||||
|
"analyzerChecks",
|
||||||
|
"missingProvide",
|
||||||
|
"unknownDefines"
|
||||||
|
],
|
||||||
|
"extra_annotation_name": [
|
||||||
|
"api", "observable"
|
||||||
|
],
|
||||||
|
"rewrite_polyfills": "false",
|
||||||
|
"compilation_level": "ADVANCED",
|
||||||
|
"warning_level": "VERBOSE",
|
||||||
|
"output_wrapper": "(function(){%output%})();",
|
||||||
|
"use_types_for_optimization": true,
|
||||||
|
"manage_closure_dependencies": true
|
||||||
|
}
|
||||||
|
}
|
||||||
45
config/examples-all.json
Normal file
45
config/examples-all.json
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
{
|
||||||
|
"exports": [],
|
||||||
|
"src": [
|
||||||
|
"src/**/*.js",
|
||||||
|
"build/ol.ext/*.js",
|
||||||
|
"build/compiled-examples/all.js"
|
||||||
|
],
|
||||||
|
"compile": {
|
||||||
|
"js": [
|
||||||
|
"externs/olx.js",
|
||||||
|
"externs/oli.js"
|
||||||
|
],
|
||||||
|
"externs": [
|
||||||
|
"externs/bingmaps.js",
|
||||||
|
"externs/bootstrap.js",
|
||||||
|
"externs/cartodb.js",
|
||||||
|
"externs/closure-compiler.js",
|
||||||
|
"externs/esrijson.js",
|
||||||
|
"externs/example.js",
|
||||||
|
"externs/geojson.js",
|
||||||
|
"externs/jquery-1.9.js",
|
||||||
|
"externs/proj4js.js",
|
||||||
|
"externs/tilejson.js",
|
||||||
|
"externs/topojson.js"
|
||||||
|
],
|
||||||
|
"jscomp_error": [
|
||||||
|
"*"
|
||||||
|
],
|
||||||
|
"jscomp_off": [
|
||||||
|
"lintChecks",
|
||||||
|
"analyzerChecks",
|
||||||
|
"unusedLocalVariables"
|
||||||
|
],
|
||||||
|
"extra_annotation_name": [
|
||||||
|
"api", "observable"
|
||||||
|
],
|
||||||
|
"rewrite_polyfills": "false",
|
||||||
|
"compilation_level": "ADVANCED",
|
||||||
|
"warning_level": "VERBOSE",
|
||||||
|
"output_wrapper": "(function(){%output%})();",
|
||||||
|
"use_types_for_optimization": true,
|
||||||
|
"manage_closure_dependencies": true
|
||||||
|
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,76 +1,18 @@
|
|||||||
<!DOCTYPE html>
|
<!DOCTYPE html>
|
||||||
<html lang="en-US">
|
<html lang="en-US">
|
||||||
<head>
|
<head>
|
||||||
<script>
|
|
||||||
var gaProperty = 'UA-2577926-1';
|
|
||||||
// Disable tracking if the opt-out cookie exists.
|
|
||||||
var disableStr = 'ga-disable-' + gaProperty;
|
|
||||||
if (document.cookie.indexOf(disableStr + '=true') > -1) {
|
|
||||||
window[disableStr] = true;
|
|
||||||
}
|
|
||||||
function gaOptout() {
|
|
||||||
document.cookie = disableStr + '=true; expires=Thu, 31 Dec 2099 23:59:59 UTC; path=/';
|
|
||||||
window[disableStr] = true;
|
|
||||||
}
|
|
||||||
function gaOptoutRevoke() {
|
|
||||||
document.cookie = disableStr + '=false; expires=Thu, 31 Dec 2099 23:59:59 UTC; path=/';
|
|
||||||
window[disableStr] = false;
|
|
||||||
}
|
|
||||||
</script>
|
|
||||||
<!-- Global site tag (gtag.js) - Google Analytics -->
|
|
||||||
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-2577926-1"></script>
|
|
||||||
<script>
|
|
||||||
window.dataLayer = window.dataLayer || [];
|
|
||||||
function gtag(){dataLayer.push(arguments);}
|
|
||||||
gtag('js', new Date());
|
|
||||||
gtag('config', 'UA-2577926-1', { 'anonymize_ip': true });
|
|
||||||
</script>
|
|
||||||
<link rel="stylesheet" type="text/css" href="//cdnjs.cloudflare.com/ajax/libs/cookieconsent2/3.1.0/cookieconsent.min.css" />
|
|
||||||
<script src="//cdnjs.cloudflare.com/ajax/libs/cookieconsent2/3.1.0/cookieconsent.min.js"></script>
|
|
||||||
<script src="https://unpkg.com/lz-string@1.4.4/libs/lz-string.min.js"></script>
|
|
||||||
<script>
|
|
||||||
window.addEventListener("load", function() {
|
|
||||||
window.cookieconsent.initialise({
|
|
||||||
'palette': {
|
|
||||||
'popup': {
|
|
||||||
'background': '#eaf7f7',
|
|
||||||
'text': '#5c7291'
|
|
||||||
},
|
|
||||||
'button': {
|
|
||||||
'background': '#56cbdb',
|
|
||||||
'text': '#ffffff'
|
|
||||||
}
|
|
||||||
},
|
|
||||||
'theme': 'edgeless',
|
|
||||||
'type': 'opt-out',
|
|
||||||
'onInitialise': function (status) {
|
|
||||||
if (!this.hasConsented()) {
|
|
||||||
gaOptout()
|
|
||||||
}
|
|
||||||
},
|
|
||||||
'onStatusChange': function(status, chosenBefore) {
|
|
||||||
if (!this.hasConsented()) {
|
|
||||||
gaOptout()
|
|
||||||
}
|
|
||||||
},
|
|
||||||
'onRevokeChoice': function() {
|
|
||||||
gaOptoutRevoke()
|
|
||||||
}
|
|
||||||
})
|
|
||||||
});
|
|
||||||
</script>
|
|
||||||
<meta charset="UTF-8">
|
<meta charset="UTF-8">
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=Edge">
|
<meta http-equiv="X-UA-Compatible" content="IE=Edge">
|
||||||
<meta name="viewport" content="initial-scale=1.0, user-scalable=no, width=device-width">
|
<meta name="viewport" content="initial-scale=1.0, user-scalable=no, width=device-width">
|
||||||
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.4.0/css/font-awesome.min.css" type="text/css">
|
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.4.0/css/font-awesome.min.css" type="text/css">
|
||||||
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css" type="text/css">
|
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css" type="text/css">
|
||||||
<link rel="stylesheet" href="./resources/prism/prism.css" type="text/css">
|
<link rel="stylesheet" href="./resources/prism/prism.css" type="text/css">
|
||||||
<link rel="stylesheet" href="./css/ol.css" type="text/css">
|
<link rel="stylesheet" href="../css/ol.css" type="text/css">
|
||||||
<link rel="stylesheet" href="./resources/layout.css" type="text/css">
|
<link rel="stylesheet" href="./resources/layout.css" type="text/css">
|
||||||
{{{ extraHead.local }}}
|
{{{ extraHead.local }}}
|
||||||
{{{ css.tag }}}
|
{{{ css.tag }}}
|
||||||
<script src="https://cdn.polyfill.io/v2/polyfill.min.js?features=fetch,requestAnimationFrame,Element.prototype.classList,URL"></script>
|
<script src="https://cdn.polyfill.io/v2/polyfill.min.js?features=fetch,requestAnimationFrame,Element.prototype.classList,URL"></script>
|
||||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js"></script>
|
<script src="./resources/zeroclipboard/ZeroClipboard.min.js"></script>
|
||||||
<title>{{ title }}</title>
|
<title>{{ title }}</title>
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
@@ -78,7 +20,7 @@
|
|||||||
<header class="navbar" role="navigation">
|
<header class="navbar" role="navigation">
|
||||||
<div class="container">
|
<div class="container">
|
||||||
<div class="display-table pull-left" id="navbar-logo-container">
|
<div class="display-table pull-left" id="navbar-logo-container">
|
||||||
<a class="navbar-brand" href="./"><img src="./resources/logo-70x70.png"> OpenLayers</a>
|
<a class="navbar-brand" href="./"><img src="./resources/logo-70x70.png"> OpenLayers Examples</a>
|
||||||
</div>
|
</div>
|
||||||
<!-- menu items that get hidden below 768px width -->
|
<!-- menu items that get hidden below 768px width -->
|
||||||
<nav class='collapse navbar-collapse navbar-responsive-collapse'>
|
<nav class='collapse navbar-collapse navbar-responsive-collapse'>
|
||||||
@@ -100,59 +42,52 @@
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="row-fluid">
|
<div class="row-fluid">
|
||||||
<a class="codepen-button pull-right"><i class="fa fa-codepen"></i> Edit</a>
|
|
||||||
<div class="span12">
|
<div class="span12">
|
||||||
<h4 id="title">{{ title }}</h4>
|
<h4 id="title">{{ title }}</h4>
|
||||||
{{{ contents }}}
|
{{{ contents }}}
|
||||||
</div>
|
</div>
|
||||||
<form method="POST" id="codepen-form" target="_blank" action="https://codesandbox.io/api/v1/sandboxes/define">
|
|
||||||
<input id="codesandbox-params" type="hidden" name="parameters">
|
|
||||||
</form>
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="row-fluid">
|
<div class="row-fluid">
|
||||||
<div class="span12">
|
<div class="span12">
|
||||||
<p id="shortdesc">{{ shortdesc }}</p>
|
<p id="shortdesc">{{ shortdesc }}</p>
|
||||||
<div id="docs">{{ md docs }}</div>
|
<div id="docs">{{ md docs }}</div>
|
||||||
|
<div id="api-links">Related API documentation: {{{ js.apiHtml }}}</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="row-fluid">
|
<div class="row-fluid">
|
||||||
<div class="source-controls">
|
<div id="source-controls">
|
||||||
<a class="copy-button" id="copy-html-button" data-clipboard-target="#example-html-source"><i class="fa fa-clipboard"></i> Copy</a>
|
<a id="copy-button"><i class="fa fa-clipboard"></i> Copy</a>
|
||||||
|
<a id="codepen-button"><i class="fa fa-codepen"></i> Edit</a>
|
||||||
</div>
|
</div>
|
||||||
<pre><legend>index.html</legend><code id="example-html-source" class="language-markup"><!DOCTYPE html>
|
<form method="POST" id="codepen-form" target="_blank" action="https://codepen.io/pen/define/">
|
||||||
<html lang="en">
|
<textarea class="hidden" name="title">{{ title }}</textarea>
|
||||||
|
<textarea class="hidden" name="description">{{ shortdesc }}</textarea>
|
||||||
|
<textarea class="hidden" name="js">{{ js.source }}</textarea>
|
||||||
|
<textarea class="hidden" name="css">{{ css.source }}</textarea>
|
||||||
|
<textarea class="hidden" name="html">{{ contents }}</textarea>
|
||||||
|
<input type="hidden" name="resources" value="https://openlayers.org/en/v{{ olVersion }}/css/ol.css,https://openlayers.org/en/v{{ olVersion }}/build/ol.js{{ extraResources }}">
|
||||||
|
<input type="hidden" name="data">
|
||||||
|
</form>
|
||||||
|
<pre><code id="example-source" class="language-markup"><!DOCTYPE html>
|
||||||
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<title>{{ title }}</title>
|
<title>{{ title }}</title>
|
||||||
|
<link rel="stylesheet" href="https://openlayers.org/en/v{{ olVersion }}/css/ol.css" type="text/css">
|
||||||
<!-- The line below is only needed for old environments like Internet Explorer and Android 4.x -->
|
<!-- The line below is only needed for old environments like Internet Explorer and Android 4.x -->
|
||||||
<script src="https://cdn.polyfill.io/v2/polyfill.min.js?features=requestAnimationFrame,Element.prototype.classList,URL"></script>{{#if extraHead.remote}}
|
<script src="https://cdn.polyfill.io/v2/polyfill.min.js?features=requestAnimationFrame,Element.prototype.classList,URL"></script>
|
||||||
{{ indent extraHead.remote spaces=4 }}{{/if}}
|
<script src="https://openlayers.org/en/v{{ olVersion }}/build/ol.js"></script>{{#if extraHead.remote}}
|
||||||
|
{{ indent extraHead.remote spaces=4 }}{{/if}}{{#if css.source}}
|
||||||
<style>
|
<style>
|
||||||
.map {
|
{{ indent css.source spaces=6 }} </style>{{/if}}
|
||||||
width: 100%;
|
|
||||||
height:400px;
|
|
||||||
}
|
|
||||||
{{#if css.source}}{{ indent css.source spaces=6 }}{{/if}} </style>
|
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
{{ indent contents spaces=4 }} <script src="index.js"></script>
|
{{ indent contents spaces=4 }} <script>
|
||||||
|
{{ indent js.source spaces=6 }} </script>
|
||||||
</body>
|
</body>
|
||||||
</html></code></pre>
|
</html></code></pre>
|
||||||
</div>
|
</div>
|
||||||
<div class="row-fluid">
|
|
||||||
<div class="source-controls">
|
|
||||||
<a class="copy-button" id="copy-js-button" data-clipboard-target="#example-js-source"><i class="fa fa-clipboard"></i> Copy</a>
|
|
||||||
</div>
|
|
||||||
<pre><legend>index.js</legend><code id="example-js-source" class="language-js">import 'ol/ol.css';
|
|
||||||
{{ js.source }}</code></pre>
|
|
||||||
</div>
|
|
||||||
<div class="row-fluid">
|
|
||||||
<div class="source-controls">
|
|
||||||
<a class="copy-button" id="copy-pkg-button" data-clipboard-target="#example-pkg-source"><i class="fa fa-clipboard"></i> Copy</a>
|
|
||||||
</div>
|
|
||||||
<pre><legend>package.json</legend><code id="example-pkg-source" class="language-js">{{ pkgJson }}</code></pre>
|
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<script src="./resources/common.js"></script>
|
<script src="./resources/common.js"></script>
|
||||||
@@ -170,7 +105,7 @@
|
|||||||
var branchSearch = url.match(/\/([^\/]*)\/examples\//);
|
var branchSearch = url.match(/\/([^\/]*)\/examples\//);
|
||||||
var cookieText = 'dismissed=-' + latestVersion + '-';
|
var cookieText = 'dismissed=-' + latestVersion + '-';
|
||||||
var dismissed = document.cookie.indexOf(cookieText) != -1;
|
var dismissed = document.cookie.indexOf(cookieText) != -1;
|
||||||
if (branchSearch && !dismissed && /^v[0-9\.]*$/.test(branchSearch[1]) && '{{ olVersion }}' != latestVersion) {
|
if (!dismissed && /^v[0-9\.]*$/.test(branchSearch[1]) && '{{ olVersion }}' != latestVersion) {
|
||||||
var link = url.replace(branchSearch[0], '/latest/examples/');
|
var link = url.replace(branchSearch[0], '/latest/examples/');
|
||||||
fetch(link, {method: 'head'}).then(function(response) {
|
fetch(link, {method: 'head'}).then(function(response) {
|
||||||
var a = document.getElementById('latest-link');
|
var a = document.getElementById('latest-link');
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
{
|
|
||||||
"opts": {
|
|
||||||
"recurse": true,
|
|
||||||
"template": "node_modules/jsdoc-json"
|
|
||||||
},
|
|
||||||
"tags": {
|
|
||||||
"allowUnknownTags": true
|
|
||||||
},
|
|
||||||
"source": {
|
|
||||||
"includePattern": "\\.js$",
|
|
||||||
"include": [
|
|
||||||
"src/ol"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"plugins": [
|
|
||||||
"jsdoc-plugin-typescript",
|
|
||||||
"config/jsdoc/api-info/plugins/api",
|
|
||||||
"config/jsdoc/api-info/plugins/module"
|
|
||||||
],
|
|
||||||
"typescript": {
|
|
||||||
"moduleRoot": "src"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
|
|
||||||
/**
|
|
||||||
* Handle the api annotation.
|
|
||||||
* @param {Object} dictionary The tag dictionary.
|
|
||||||
*/
|
|
||||||
exports.defineTags = dictionary => {
|
|
||||||
|
|
||||||
dictionary.defineTag('api', {
|
|
||||||
onTagged: (doclet, tag) => {
|
|
||||||
doclet.api = true;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
};
|
|
||||||
|
|
||||||
@@ -1,170 +0,0 @@
|
|||||||
/**
|
|
||||||
* This plugin adds an `exportMap` property to @module doclets. Each export map
|
|
||||||
* is an object with properties named like the local identifier and values named
|
|
||||||
* like the exported identifier.
|
|
||||||
*
|
|
||||||
* For example, the code below
|
|
||||||
*
|
|
||||||
* export {foo as bar};
|
|
||||||
*
|
|
||||||
* would be a map like `{foo: 'bar'}`.
|
|
||||||
*
|
|
||||||
* In the case of an export declaration with a source, the export identifier is
|
|
||||||
* prefixed by the source. For example, this code
|
|
||||||
*
|
|
||||||
* export {foo as bar} from 'ol/bam';
|
|
||||||
*
|
|
||||||
* would be a map like `{'ol/bam foo': 'bar'}`.
|
|
||||||
*
|
|
||||||
* If a default export is a literal or object expression, the local name will be
|
|
||||||
* an empty string. For example
|
|
||||||
*
|
|
||||||
* export default {foo: 'bar'};
|
|
||||||
*
|
|
||||||
* would be a map like `{'': 'default'}`.
|
|
||||||
*/
|
|
||||||
const assert = require('assert');
|
|
||||||
const path = require('path');
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* A lookup of export maps per source filepath.
|
|
||||||
*/
|
|
||||||
const exportMapLookup = {};
|
|
||||||
|
|
||||||
function loc(filepath, node) {
|
|
||||||
return `${filepath}:${node.loc.start.line}`;
|
|
||||||
}
|
|
||||||
|
|
||||||
function nameFromChildIdentifier(filepath, node) {
|
|
||||||
assert.ok(node.id, `expected identifer in ${loc(filepath, node)}`);
|
|
||||||
assert.strictEqual(node.id.type, 'Identifier', `expected identifer in ${loc(filepath, node)}`);
|
|
||||||
return node.id.name;
|
|
||||||
}
|
|
||||||
|
|
||||||
function handleExportNamedDeclaration(filepath, node) {
|
|
||||||
if (!(filepath in exportMapLookup)) {
|
|
||||||
exportMapLookup[filepath] = {};
|
|
||||||
}
|
|
||||||
const exportMap = exportMapLookup[filepath];
|
|
||||||
|
|
||||||
const declaration = node.declaration;
|
|
||||||
if (declaration) {
|
|
||||||
// `export class Foo{}` or `export function foo() {}`
|
|
||||||
if (declaration.type === 'ClassDeclaration' || declaration.type === 'FunctionDeclaration') {
|
|
||||||
const name = nameFromChildIdentifier(filepath, declaration);
|
|
||||||
exportMap[name] = name;
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// `export const foo = 'bar', bam = 42`
|
|
||||||
if (declaration.type === 'VariableDeclaration') {
|
|
||||||
const declarations = declaration.declarations;
|
|
||||||
assert.ok(declarations.length > 0, `expected variable declarations in ${loc(filepath, declaration)}`);
|
|
||||||
for (const declarator of declarations) {
|
|
||||||
assert.strictEqual(declarator.type, 'VariableDeclarator', `unexpected "${declarator.type}" in ${loc(filepath, declarator)}`);
|
|
||||||
const name = nameFromChildIdentifier(filepath, declarator);
|
|
||||||
exportMap[name] = name;
|
|
||||||
}
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
throw new Error(`Unexpected named export "${declaration.type}" in ${loc(filepath, declaration)}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
let prefix = '';
|
|
||||||
const source = node.source;
|
|
||||||
if (source) {
|
|
||||||
// `export foo from 'bar'`
|
|
||||||
assert.strictEqual(source.type, 'Literal', `unexpected export source "${source.type}" in ${loc(filepath, source)}`);
|
|
||||||
prefix = `${source.value} `;
|
|
||||||
}
|
|
||||||
|
|
||||||
const specifiers = node.specifiers;
|
|
||||||
assert.ok(specifiers.length > 0, `expected export specifiers in ${loc(filepath, node)}`);
|
|
||||||
// `export {foo, bar}` or `export {default as Foo} from 'bar'`
|
|
||||||
for (const specifier of specifiers) {
|
|
||||||
assert.strictEqual(specifier.type, 'ExportSpecifier', `unexpected export specifier in ${loc(filepath, specifier)}`);
|
|
||||||
|
|
||||||
const local = specifier.local;
|
|
||||||
assert.strictEqual(local.type, 'Identifier', `unexpected local specifier "${local.type} in ${loc(filepath, local)}`);
|
|
||||||
|
|
||||||
const exported = specifier.exported;
|
|
||||||
assert.strictEqual(local.type, 'Identifier', `unexpected exported specifier "${exported.type} in ${loc(filepath, exported)}`);
|
|
||||||
|
|
||||||
exportMap[prefix + local.name] = exported.name;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function handleDefaultDeclaration(filepath, node) {
|
|
||||||
if (!(filepath in exportMapLookup)) {
|
|
||||||
exportMapLookup[filepath] = {};
|
|
||||||
}
|
|
||||||
const exportMap = exportMapLookup[filepath];
|
|
||||||
|
|
||||||
const declaration = node.declaration;
|
|
||||||
if (declaration) {
|
|
||||||
// `export default class Foo{}` or `export default function foo () {}`
|
|
||||||
if (declaration.type === 'ClassDeclaration' || declaration.type === 'FunctionDeclaration') {
|
|
||||||
const name = nameFromChildIdentifier(filepath, declaration);
|
|
||||||
exportMap[name] = 'default';
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// `export default foo`
|
|
||||||
if (declaration.type === 'Identifier') {
|
|
||||||
exportMap[declaration.name] = 'default';
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// `export default {foo: 'bar'}` or `export default 42`
|
|
||||||
if (declaration.type === 'ObjectExpression' || declaration.type === 'Literal') {
|
|
||||||
exportMap[''] = 'default';
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
throw new Error(`Unexpected default export "${declaration.type}" in ${loc(filepath, declaration)}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
exports.astNodeVisitor = {
|
|
||||||
visitNode: (node, event, parser, filepath) => {
|
|
||||||
if (node.type === 'ExportNamedDeclaration') {
|
|
||||||
return handleExportNamedDeclaration(filepath, node);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (node.type === 'ExportDefaultDeclaration') {
|
|
||||||
return handleDefaultDeclaration(filepath, node);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
const moduleLookup = {};
|
|
||||||
|
|
||||||
exports.handlers = {
|
|
||||||
|
|
||||||
// create a lookup of @module doclets
|
|
||||||
newDoclet: event => {
|
|
||||||
const doclet = event.doclet;
|
|
||||||
if (doclet.kind === 'module') {
|
|
||||||
const filepath = path.join(doclet.meta.path, doclet.meta.filename);
|
|
||||||
|
|
||||||
assert.ok(!(filepath in moduleLookup), `duplicate @module doc in ${filepath}`);
|
|
||||||
moduleLookup[filepath] = doclet;
|
|
||||||
}
|
|
||||||
},
|
|
||||||
|
|
||||||
// assign the `exportMap` property to @module doclets
|
|
||||||
parseComplete: event => {
|
|
||||||
for (const filepath in moduleLookup) {
|
|
||||||
assert.ok(filepath in exportMapLookup, `missing ${filepath} in export map lookup`);
|
|
||||||
moduleLookup[filepath].exportMap = exportMapLookup[filepath];
|
|
||||||
}
|
|
||||||
|
|
||||||
// make sure there was a @module doclet for each export map
|
|
||||||
for (const filepath in exportMapLookup) {
|
|
||||||
assert.ok(filepath in moduleLookup, `missing @module doclet in ${filepath}`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
};
|
|
||||||
@@ -1,37 +1,38 @@
|
|||||||
{
|
{
|
||||||
"opts": {
|
"opts": {
|
||||||
"recurse": true,
|
"recurse": true,
|
||||||
"template": "config/jsdoc/api/template"
|
"template": "config/jsdoc/api/template"
|
||||||
},
|
|
||||||
"tags": {
|
|
||||||
"allowUnknownTags": true
|
|
||||||
},
|
|
||||||
"source": {
|
|
||||||
"includePattern": ".+\\.js$",
|
|
||||||
"excludePattern": "(^|\\/|\\\\)_",
|
|
||||||
"include": [
|
|
||||||
"src/ol"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"plugins": [
|
|
||||||
"config/jsdoc/api/plugins/markdown",
|
|
||||||
"jsdoc-plugin-typescript",
|
|
||||||
"config/jsdoc/api/plugins/inline-options",
|
|
||||||
"config/jsdoc/api/plugins/inheritdoc",
|
|
||||||
"config/jsdoc/api/plugins/events",
|
|
||||||
"config/jsdoc/api/plugins/observable",
|
|
||||||
"config/jsdoc/api/plugins/api"
|
|
||||||
],
|
|
||||||
"typescript": {
|
|
||||||
"moduleRoot": "src"
|
|
||||||
},
|
|
||||||
"templates": {
|
|
||||||
"cleverLinks": true,
|
|
||||||
"monospaceLinks": true,
|
|
||||||
"default": {
|
|
||||||
"outputSourceFiles": false
|
|
||||||
},
|
},
|
||||||
"applicationName": "OpenLayers"
|
"tags": {
|
||||||
},
|
"allowUnknownTags": true
|
||||||
"jsVersion": 180
|
},
|
||||||
|
"source": {
|
||||||
|
"includePattern": ".+\\.js(doc)?$",
|
||||||
|
"excludePattern": "(^|\\/|\\\\)_",
|
||||||
|
"include": [
|
||||||
|
"src",
|
||||||
|
"externs/oli.js",
|
||||||
|
"externs/olx.js"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"plugins": [
|
||||||
|
"plugins/markdown",
|
||||||
|
"config/jsdoc/api/plugins/inheritdoc",
|
||||||
|
"config/jsdoc/api/plugins/typedefs",
|
||||||
|
"config/jsdoc/api/plugins/events",
|
||||||
|
"config/jsdoc/api/plugins/observable",
|
||||||
|
"config/jsdoc/api/plugins/api"
|
||||||
|
],
|
||||||
|
"markdown": {
|
||||||
|
"parser": "gfm"
|
||||||
|
},
|
||||||
|
"templates": {
|
||||||
|
"cleverLinks": true,
|
||||||
|
"monospaceLinks": true,
|
||||||
|
"default": {
|
||||||
|
"outputSourceFiles": false
|
||||||
|
},
|
||||||
|
"applicationName": "OpenLayers"
|
||||||
|
},
|
||||||
|
"jsVersion": 180
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,43 +1,43 @@
|
|||||||
<table><tr>
|
<table><tr>
|
||||||
<th width="33.3%">Map</th><th width="33.3%">View</th><th width="33.3%">Layers</th>
|
<th width="33.3%">Map</th><th width="33.3%">View</th><th width="33.3%">Layers</th>
|
||||||
</tr><tr>
|
</tr><tr>
|
||||||
<td><p>A <a href="module-ol_Map-Map.html">map</a> is made of <a href="module-ol_layer_Base-BaseLayer.html">layers</a>, a <a href="module-ol_View-View.html">view</a> to visualize them, <a href="module-ol_interaction_Interaction-Interaction.html">interactions</a> to modify map content and <a href="module-ol_control_Control-Control.html">controls</a> with UI components.</p>
|
<td><p>A [map](ol.Map.html) is made of [layers](ol.layer.html), a [view](ol.View.html) to visualize them, [interactions](ol.interaction.html) to modify map content and [controls](ol.control.html) with UI components.</p>
|
||||||
<a href="module-ol_Map-Map.html">Overview</a><br>
|
[Overview](ol.Map.html)<br>
|
||||||
<a href="module-ol_Map-Map.html#Map">Creation</a><br>
|
[Creation](ol.Map.html#Map)<br>
|
||||||
<a href="module-ol_MapBrowserEvent-MapBrowserEvent.html">Events</a></td>
|
[Events](ol.MapBrowserEvent.html)</td>
|
||||||
<td><p>The view manages the visual parameters of the map view, like resolution or rotation.</p>
|
<td><p>The view manages the visual parameters of the map view, like resolution or rotation.</p>
|
||||||
<a href="module-ol_View-View.html">View</a> with center, projection, resolution and rotation</td>
|
[ol.View](ol.View.html) with center, projection, resolution and rotation</td>
|
||||||
<td><p>Layers are lightweight containers that get their data from <a href="module-ol_source_Source-Source.html">sources</a>.</p>
|
<td><p>Layers are lightweight containers that get their data from [sources](ol.source.html).</p>
|
||||||
<a href="module-ol_layer_Tile-TileLayer.html">ol/layer/Tile</a><br>
|
[ol.layer.Tile](ol.layer.Tile.html)<br>
|
||||||
<a href="module-ol_layer_Image-ImageLayer.html">ol/layer/Image</a><br>
|
[ol.layer.Image](ol.layer.Image.html)<br>
|
||||||
<a href="module-ol_layer_Vector-VectorLayer.html">ol/layer/Vector</a><br>
|
[ol.layer.Vector](ol.layer.Vector.html)<br>
|
||||||
<a href="module-ol_layer_VectorTile-VectorTileLayer.html">ol/layer/VectorTile</a></td>
|
[ol.layer.VectorTile](ol.layer.VectorTile.html)</td>
|
||||||
</tr><tr>
|
</tr><tr>
|
||||||
<th>Controls</th><th>Interactions</th><th>Sources and formats</th>
|
<th>Controls</th><th>Interactions</th><th>Sources and formats</th>
|
||||||
</tr><tr>
|
</tr><tr>
|
||||||
<td><a href="module-ol_control_util.html#.defaults">Map default controls</a><br>
|
<td>[Map default controls](ol.control.html#.defaults)<br>
|
||||||
<a href="module-ol_control_Control-Control.html">All controls</a>
|
[All controls](ol.control.html)
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<a href="module-ol_interaction.html#~defaults">Map default interactions</a><br>
|
[Map default interactions](ol.interaction.html#.defaults)<br>
|
||||||
Interactions for <a href="module-ol_Feature-Feature.html">vector features</a>
|
Interactions for [vector features](ol.Feature.html)
|
||||||
<ul><li><a href="module-ol_interaction_Select-Select.html">ol/interaction/Select</a></li>
|
<ul><li>[ol.interaction.Select](ol.interaction.Select.html)</li>
|
||||||
<li><a href="module-ol_interaction_Draw-Draw.html">ol/interaction/Draw</a></li>
|
<li>[ol.interaction.Draw](ol.interaction.Draw.html)</li>
|
||||||
<li><a href="module-ol_interaction_Modify-Modify.html">ol/interaction/Modify</a></li></ul>
|
<li>[ol.interaction.Modify](ol.interaction.Modify.html)</li></ul>
|
||||||
<a href="module-ol_interaction_Interaction-Interaction.html">All interactions</a></td>
|
[All interactions](ol.interaction.html)</td>
|
||||||
<td><a href="module-ol_source_Tile-TileSource.html">Tile sources</a> for <a href="module-ol_layer_Tile-TileLayer.html">ol/layer/Tile</a>
|
<td>[Tile sources](ol.source.Tile.html) for [ol.layer.Tile](ol.layer.Tile.html)
|
||||||
<br><a href="module-ol_source_Image-ImageSource.html">Image sources</a> for <a href="module-ol_layer_Image-ImageLayer.html">ol/layer/Image</a>
|
<br>[Image sources](ol.source.Image.html) for [ol.layer.Image](ol.layer.Image.html)
|
||||||
<br><a href="module-ol_source_Vector-VectorSource.html">Vector sources</a> for <a href="module-ol_layer_Vector-VectorLayer.html">ol/layer/Vector</a>
|
<br>[Vector sources](ol.source.Vector.html) for [ol.layer.Vector](ol.layer.Vector.html)
|
||||||
<br><a href="module-ol_source_VectorTile-VectorTile.html">Vector tile sources</a> for <a href="module-ol_layer_VectorTile-VectorTileLayer.html">ol/layer/VectorTile</a>
|
<br>[Vector tile sources](ol.source.VectorTile.html) for [ol.layer.VectorTile](ol.layer.VectorTile.html)
|
||||||
<br><a href="module-ol_format_Feature-FeatureFormat.html">Formats</a> for reading/writing vector data
|
<br>[Formats](ol.format.Feature.html) for reading/writing vector data
|
||||||
<br><a href="module-ol_format_WMSCapabilities-WMSCapabilities.html">ol/format/WMSCapabilities</a></td></tr>
|
<br>[ol.format.WMSCapabilities](ol.format.WMSCapabilities.html)</td></tr>
|
||||||
<tr><th>Projections</th><th>Observable objects</th><th>Other components</th></tr>
|
<tr><th>Projections</th><th>Observable objects</th><th>Other components</th></tr>
|
||||||
<tr><td><p>All coordinates and extents need to be provided in view projection (default: EPSG:3857). To transform, use <a href="module-ol_proj.html#.transform">ol/proj#transform()</a> and <a href="module-ol_proj.html#.transformExtent">ol/proj#transformExtent()</a>.</p>
|
<tr><td><p>All coordinates and extents need to be provided in view projection (default: EPSG:3857). To transform, use [ol.proj.transform()](ol.proj.html#.transform) and [ol.proj.transformExtent()](ol.proj.html#.transformExtent).</p>
|
||||||
<a href="module-ol_proj.html">ol/proj</a></td>
|
[ol.proj](ol.proj.html)</td>
|
||||||
<td><p>Changes to all <a href="module-ol_Object-BaseObject.html">ol/Object</a>s can be observed by calling the <a href="module-ol_Object-BaseObject.html#on">object.on('propertychange')</a> method. Listeners receive an <a href="module-ol_Object-ObjectEvent.html">ol/Object.ObjectEvent</a> with information on the changed property and old value.</p>
|
<td><p>Changes to all [ol.Objects](ol.Object.html) can be observed by calling the [object.on('propertychange')](ol.Object.html#on) method. Listeners receive an [ol.Object.Event](ol.Object.Event.html) with information on the changed property and old value.</p>
|
||||||
<td>
|
<td>
|
||||||
<a href="module-ol_Geolocation.html">ol/Geolocation</a><br>
|
[ol.Geolocation](ol.Geolocation.html)<br>
|
||||||
<a href="module-ol_Overlay-Overlay.html">ol/Overlay</a><br></td>
|
[ol.Overlay](ol.Overlay.html)<br></td>
|
||||||
</tr></table>
|
</tr></table>
|
||||||
|
|
||||||
|
|
||||||
@@ -52,4 +52,11 @@ The OpenLayers API consists of
|
|||||||
|
|
||||||
Within a major release series, the API will not be changed. Any changes to the API will be accompanied by a new major release.
|
Within a major release series, the API will not be changed. Any changes to the API will be accompanied by a new major release.
|
||||||
|
|
||||||
*Note*: The API change policy does not cover CSS class names that are used to style the OpenLayers UI. It also does not cover any typedefs and enums.
|
*Note*: The API change policy does not cover CSS class names that are used to style the
|
||||||
|
OpenLayers UI.
|
||||||
|
|
||||||
|
*Note for Closure Compiler users compiling their application code together with OpenLayers*:
|
||||||
|
The names of types other than those in the list above (e.g. `ol.Coordinate`) are subject to change. It
|
||||||
|
is therefore recommended to either use the resolved type as listed in the API docs (e.g.
|
||||||
|
`Array.<number>` instead of `ol.Coordinate`), or pay attention to the upgrade notes, which will list
|
||||||
|
the changes for those types.
|
||||||
|
|||||||
@@ -1,6 +1,5 @@
|
|||||||
/**
|
/**
|
||||||
* Define an @api tag
|
* Define an @api tag
|
||||||
* @param {Object} dictionary The tag dictionary.
|
|
||||||
*/
|
*/
|
||||||
exports.defineTags = function(dictionary) {
|
exports.defineTags = function(dictionary) {
|
||||||
dictionary.defineTag('api', {
|
dictionary.defineTag('api', {
|
||||||
@@ -9,32 +8,32 @@ exports.defineTags = function(dictionary) {
|
|||||||
canHaveName: false,
|
canHaveName: false,
|
||||||
onTagged: function(doclet, tag) {
|
onTagged: function(doclet, tag) {
|
||||||
includeTypes(doclet);
|
includeTypes(doclet);
|
||||||
doclet.stability = 'stable';
|
doclet.stability = "stable";
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Based on @api annotations, and assuming that items with no @api annotation
|
* Based on @api annotations, and assuming that items with no @api annotation
|
||||||
* should not be documented, this plugin removes undocumented symbols
|
* should not be documented, this plugin removes undocumented symbols
|
||||||
* from the documentation.
|
* from the documentation.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
const api = [];
|
var api = [];
|
||||||
const classes = {};
|
var classes = {};
|
||||||
const types = {};
|
var types = {};
|
||||||
const modules = {};
|
|
||||||
|
|
||||||
function hasApiMembers(doclet) {
|
function hasApiMembers(doclet) {
|
||||||
return doclet.longname.split('#')[0] == this.longname;
|
return doclet.longname.split('#')[0] == this.longname;
|
||||||
}
|
}
|
||||||
|
|
||||||
function includeAugments(doclet) {
|
function includeAugments(doclet) {
|
||||||
const augments = doclet.augments;
|
var augments = doclet.augments;
|
||||||
if (augments) {
|
if (augments) {
|
||||||
let cls;
|
var cls;
|
||||||
for (let i = augments.length - 1; i >= 0; --i) {
|
for (var i = augments.length - 1; i >= 0; --i) {
|
||||||
cls = classes[augments[i]];
|
cls = classes[augments[i]];
|
||||||
if (cls) {
|
if (cls) {
|
||||||
includeAugments(cls);
|
includeAugments(cls);
|
||||||
@@ -58,8 +57,10 @@ function includeAugments(doclet) {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
cls._hideConstructor = true;
|
if (cls.longname.indexOf('oli.') !== 0) {
|
||||||
delete cls.undocumented;
|
cls._hideConstructor = true;
|
||||||
|
delete cls.undocumented;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -67,25 +68,25 @@ function includeAugments(doclet) {
|
|||||||
|
|
||||||
function extractTypes(item) {
|
function extractTypes(item) {
|
||||||
item.type.names.forEach(function(type) {
|
item.type.names.forEach(function(type) {
|
||||||
const match = type.match(/^(.*<)?([^>]*)>?$/);
|
var match = type.match(/^(.*<)?([^>]*)>?$/);
|
||||||
if (match) {
|
if (match) {
|
||||||
modules[match[2]] = true;
|
|
||||||
types[match[2]] = true;
|
types[match[2]] = true;
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
function includeTypes(doclet) {
|
function includeTypes(doclet) {
|
||||||
if (doclet.params) {
|
if (doclet.params && doclet.kind != 'class') {
|
||||||
doclet.params.forEach(extractTypes);
|
doclet.params.forEach(extractTypes);
|
||||||
}
|
}
|
||||||
if (doclet.returns) {
|
if (doclet.returns) {
|
||||||
doclet.returns.forEach(extractTypes);
|
doclet.returns.forEach(extractTypes);
|
||||||
}
|
}
|
||||||
if (doclet.properties) {
|
if (doclet.isEnum) {
|
||||||
doclet.properties.forEach(extractTypes);
|
types[doclet.meta.code.name] = true;
|
||||||
}
|
}
|
||||||
if (doclet.type && doclet.meta.code.type == 'MemberExpression') {
|
if (doclet.type && doclet.meta.code.type == 'MemberExpression') {
|
||||||
|
// types in olx.js
|
||||||
extractTypes(doclet);
|
extractTypes(doclet);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -93,30 +94,30 @@ function includeTypes(doclet) {
|
|||||||
exports.handlers = {
|
exports.handlers = {
|
||||||
|
|
||||||
newDoclet: function(e) {
|
newDoclet: function(e) {
|
||||||
const doclet = e.doclet;
|
var doclet = e.doclet;
|
||||||
|
// Keep track of api items - needed in parseComplete to determine classes
|
||||||
|
// with api members.
|
||||||
|
if (doclet.meta.filename == 'olx.js' && doclet.kind == 'typedef') {
|
||||||
|
doclet.undocumented = false;
|
||||||
|
}
|
||||||
if (doclet.stability) {
|
if (doclet.stability) {
|
||||||
modules[doclet.longname.split(/[~\.]/).shift()] = true;
|
|
||||||
api.push(doclet);
|
api.push(doclet);
|
||||||
}
|
}
|
||||||
if (doclet.kind == 'class') {
|
// Mark explicity defined namespaces - needed in parseComplete to keep
|
||||||
modules[doclet.longname.split(/[~\.]/).shift()] = true;
|
// namespaces that we need as containers for api items.
|
||||||
if (!(doclet.longname in classes)) {
|
if (/.*\.jsdoc$/.test(doclet.meta.filename) && doclet.kind == 'namespace') {
|
||||||
classes[doclet.longname] = doclet;
|
doclet.namespace_ = true;
|
||||||
} else if ('augments' in doclet) {
|
|
||||||
classes[doclet.longname].augments = doclet.augments;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
if (doclet.name === doclet.longname && !doclet.memberof) {
|
if (doclet.kind == 'class') {
|
||||||
// Make sure anonymous default exports are documented
|
classes[doclet.longname] = doclet;
|
||||||
doclet.setMemberof(doclet.longname);
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
parseComplete: function(e) {
|
parseComplete: function(e) {
|
||||||
const doclets = e.doclets;
|
var doclets = e.doclets;
|
||||||
for (let i = doclets.length - 1; i >= 0; --i) {
|
for (var i = doclets.length - 1; i >= 0; --i) {
|
||||||
const doclet = doclets[i];
|
var doclet = doclets[i];
|
||||||
if (doclet.stability) {
|
if (doclet.stability || doclet.namespace_) {
|
||||||
if (doclet.kind == 'class') {
|
if (doclet.kind == 'class') {
|
||||||
includeAugments(doclet);
|
includeAugments(doclet);
|
||||||
}
|
}
|
||||||
@@ -133,13 +134,6 @@ exports.handlers = {
|
|||||||
// Always document namespaces and items with stability annotation
|
// Always document namespaces and items with stability annotation
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
if (doclet.kind == 'module' && doclet.longname in modules) {
|
|
||||||
// Document all modules that are referenced by the API
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
if (doclet.isEnum || doclet.kind == 'typedef') {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
if (doclet.kind == 'class' && api.some(hasApiMembers, doclet)) {
|
if (doclet.kind == 'class' && api.some(hasApiMembers, doclet)) {
|
||||||
// Mark undocumented classes with documented members as unexported.
|
// Mark undocumented classes with documented members as unexported.
|
||||||
// This is used in ../template/tmpl/container.tmpl to hide the
|
// This is used in ../template/tmpl/container.tmpl to hide the
|
||||||
|
|||||||
@@ -1,32 +1,35 @@
|
|||||||
const events = {};
|
var events = {};
|
||||||
|
var classes = {};
|
||||||
|
|
||||||
exports.handlers = {
|
exports.handlers = {
|
||||||
|
|
||||||
newDoclet: function(e) {
|
newDoclet: function(e) {
|
||||||
const doclet = e.doclet;
|
var doclet = e.doclet;
|
||||||
if (doclet.kind !== 'event') {
|
var cls;
|
||||||
return;
|
if (doclet.kind == 'event') {
|
||||||
|
cls = doclet.longname.split('#')[0];
|
||||||
|
if (!(cls in events)) {
|
||||||
|
events[cls] = [];
|
||||||
|
}
|
||||||
|
events[cls].push(doclet.longname);
|
||||||
|
} else if (doclet.kind == 'class') {
|
||||||
|
classes[doclet.longname] = doclet;
|
||||||
}
|
}
|
||||||
|
|
||||||
const cls = doclet.longname.split('#')[0];
|
|
||||||
if (!(cls in events)) {
|
|
||||||
events[cls] = [];
|
|
||||||
}
|
|
||||||
events[cls].push(doclet.longname);
|
|
||||||
},
|
},
|
||||||
|
|
||||||
parseComplete: function(e) {
|
parseComplete: function(e) {
|
||||||
const doclets = e.doclets;
|
var doclets = e.doclets;
|
||||||
for (let i = 0, ii = doclets.length - 1; i < ii; ++i) {
|
var doclet, i, ii, j, jj, event, fires;
|
||||||
const doclet = doclets[i];
|
for (i = 0, ii = doclets.length - 1; i < ii; ++i) {
|
||||||
|
doclet = doclets[i];
|
||||||
if (doclet.fires) {
|
if (doclet.fires) {
|
||||||
if (doclet.kind == 'class') {
|
if (doclet.kind == 'class') {
|
||||||
const fires = [];
|
fires = [];
|
||||||
for (let j = 0, jj = doclet.fires.length; j < jj; ++j) {
|
for (j = 0, jj = doclet.fires.length; j < jj; ++j) {
|
||||||
const event = doclet.fires[j].replace('event:', '');
|
event = doclet.fires[j].replace('event:', '');
|
||||||
if (events[event]) {
|
if (events[event]) {
|
||||||
fires.push.apply(fires, events[event]);
|
fires.push.apply(fires, events[event]);
|
||||||
} else if (doclet.fires[j] !== 'event:ObjectEvent') {
|
} else {
|
||||||
fires.push(doclet.fires[j]);
|
fires.push(doclet.fires[j]);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -37,3 +40,4 @@ exports.handlers = {
|
|||||||
}
|
}
|
||||||
|
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
29
config/jsdoc/api/plugins/inheritdoc.js
Executable file → Normal file
29
config/jsdoc/api/plugins/inheritdoc.js
Executable file → Normal file
@@ -1,8 +1,12 @@
|
|||||||
/*
|
/*
|
||||||
* This is a hack to prevent inheritDoc tags from entirely removing
|
* This is a hack to prevent inheritDoc tags from entirely removing
|
||||||
* documentation of the method that inherits the documentation.
|
* documentation of the method that inherits the documentation.
|
||||||
|
*
|
||||||
|
* TODO: Remove this hack when https://github.com/jsdoc3/jsdoc/issues/53
|
||||||
|
* is addressed.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
exports.defineTags = function(dictionary) {
|
exports.defineTags = function(dictionary) {
|
||||||
dictionary.defineTag('inheritDoc', {
|
dictionary.defineTag('inheritDoc', {
|
||||||
mustHaveValue: false,
|
mustHaveValue: false,
|
||||||
@@ -15,16 +19,16 @@ exports.defineTags = function(dictionary) {
|
|||||||
};
|
};
|
||||||
|
|
||||||
|
|
||||||
const lookup = {};
|
var lookup = {};
|
||||||
const incompleteByClass = {};
|
var incompleteByClass = {};
|
||||||
const keepKeys = ['comment', 'meta', 'name', 'memberof', 'longname', 'augment',
|
var keepKeys = ['comment', 'meta', 'name', 'memberof', 'longname', 'augment',
|
||||||
'stability'];
|
'stability'];
|
||||||
|
|
||||||
exports.handlers = {
|
exports.handlers = {
|
||||||
|
|
||||||
newDoclet: function(e) {
|
newDoclet: function(e) {
|
||||||
const doclet = e.doclet;
|
var doclet = e.doclet;
|
||||||
let incompletes;
|
var incompletes;
|
||||||
if (!(doclet.longname in lookup)) {
|
if (!(doclet.longname in lookup)) {
|
||||||
lookup[doclet.longname] = [];
|
lookup[doclet.longname] = [];
|
||||||
}
|
}
|
||||||
@@ -41,9 +45,9 @@ exports.handlers = {
|
|||||||
},
|
},
|
||||||
|
|
||||||
parseComplete: function(e) {
|
parseComplete: function(e) {
|
||||||
let ancestors, candidate, candidates, doclet, i, j, k, l, key;
|
var ancestors, candidate, candidates, doclet, i, j, k, l, key;
|
||||||
let incompleteDoclet, stability, incomplete, incompletes;
|
var incompleteDoclet, stability, incomplete, incompletes;
|
||||||
const doclets = e.doclets;
|
var doclets = e.doclets;
|
||||||
for (i = doclets.length - 1; i >= 0; --i) {
|
for (i = doclets.length - 1; i >= 0; --i) {
|
||||||
doclet = doclets[i];
|
doclet = doclets[i];
|
||||||
if (doclet.augments) {
|
if (doclet.augments) {
|
||||||
@@ -88,15 +92,10 @@ exports.handlers = {
|
|||||||
incompleteDoclet.stability = stability;
|
incompleteDoclet.stability = stability;
|
||||||
for (key in candidate) {
|
for (key in candidate) {
|
||||||
if (candidate.hasOwnProperty(key) &&
|
if (candidate.hasOwnProperty(key) &&
|
||||||
keepKeys.indexOf(key) == -1) {
|
keepKeys.indexOf(key) == -1) {
|
||||||
incompleteDoclet[key] = candidate[key];
|
incompleteDoclet[key] = candidate[key];
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
// We have found a matching parent doc and applied it so we
|
|
||||||
// don't want to ignore this doclet anymore.
|
|
||||||
incompleteDoclet.ignore = false;
|
|
||||||
// We found a match so we can stop break
|
|
||||||
break;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,49 +0,0 @@
|
|||||||
/**
|
|
||||||
* @filedesc
|
|
||||||
* Inlines option params from typedefs
|
|
||||||
*/
|
|
||||||
|
|
||||||
const properties = {};
|
|
||||||
|
|
||||||
exports.handlers = {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Collects all typedefs, keyed by longname
|
|
||||||
* @param {Object} e Event object.
|
|
||||||
*/
|
|
||||||
newDoclet: function(e) {
|
|
||||||
if (e.doclet.kind == 'typedef' && e.doclet.properties) {
|
|
||||||
properties[e.doclet.longname] = e.doclet.properties;
|
|
||||||
}
|
|
||||||
},
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Adds `options.*` params for options that match the longname of one of the
|
|
||||||
* collected typedefs.
|
|
||||||
* @param {Object} e Event object.
|
|
||||||
*/
|
|
||||||
parseComplete: function(e) {
|
|
||||||
const doclets = e.doclets;
|
|
||||||
for (let i = 0, ii = doclets.length; i < ii; ++i) {
|
|
||||||
const doclet = doclets[i];
|
|
||||||
if (doclet.params) {
|
|
||||||
const params = doclet.params;
|
|
||||||
for (let j = 0, jj = params.length; j < jj; ++j) {
|
|
||||||
const param = params[j];
|
|
||||||
if (param.type && param.type.names) {
|
|
||||||
const type = param.type.names[0];
|
|
||||||
if (type in properties) {
|
|
||||||
param.type.names[0] = type;
|
|
||||||
params.push.apply(params, properties[type].map(p => {
|
|
||||||
const property = Object.assign({}, p);
|
|
||||||
property.name = `${param.name}.${property.name}`;
|
|
||||||
return property;
|
|
||||||
}));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
};
|
|
||||||
@@ -1,111 +0,0 @@
|
|||||||
/**
|
|
||||||
* Modified from JSDoc's plugins/markdown and lib/jsdoc/util/markdown modules
|
|
||||||
* (see https://github.com/jsdoc3/jsdoc/), which are licensed under the Apache 2
|
|
||||||
* license (see http://www.apache.org/licenses/LICENSE-2.0).
|
|
||||||
*
|
|
||||||
* This version does not protect http(s) urls from being turned into links, and
|
|
||||||
* works around an issue with `~` characters in module paths by escaping them.
|
|
||||||
*/
|
|
||||||
|
|
||||||
const marked = require('marked');
|
|
||||||
const format = require('util').format;
|
|
||||||
|
|
||||||
const tags = [
|
|
||||||
'author',
|
|
||||||
'classdesc',
|
|
||||||
'description',
|
|
||||||
'exceptions',
|
|
||||||
'params',
|
|
||||||
'properties',
|
|
||||||
'returns',
|
|
||||||
'see',
|
|
||||||
'summary'
|
|
||||||
];
|
|
||||||
|
|
||||||
const hasOwnProp = Object.prototype.hasOwnProperty;
|
|
||||||
|
|
||||||
const markedRenderer = new marked.Renderer();
|
|
||||||
|
|
||||||
// Allow prettyprint to work on inline code samples
|
|
||||||
markedRenderer.code = function(code, language) {
|
|
||||||
const langClass = language ? ' lang-' + language : '';
|
|
||||||
|
|
||||||
return format('<pre class="prettyprint source%s"><code>%s</code></pre>',
|
|
||||||
langClass, escapeCode(code));
|
|
||||||
};
|
|
||||||
|
|
||||||
function escapeCode(source) {
|
|
||||||
return source.replace(/</g, '<')
|
|
||||||
.replace(/"/g, '"')
|
|
||||||
.replace(/'/g, ''');
|
|
||||||
}
|
|
||||||
|
|
||||||
function escapeUnderscoresAndTildes(source) {
|
|
||||||
return source.replace(/\{@[^}\r\n]+\}/g, function(wholeMatch) {
|
|
||||||
return wholeMatch
|
|
||||||
.replace(/(^|[^\\])_/g, '$1\\_')
|
|
||||||
.replace('~', '˜');
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
function unencodeQuotesAndTildes(source) {
|
|
||||||
return source.replace(/\{@[^}\r\n]+\}/g, function(wholeMatch) {
|
|
||||||
return wholeMatch
|
|
||||||
.replace(/"/g, '"')
|
|
||||||
.replace(/˜/g, '~');
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
function parse(source) {
|
|
||||||
let result;
|
|
||||||
|
|
||||||
source = escapeUnderscoresAndTildes(source);
|
|
||||||
|
|
||||||
result = marked(source, {renderer: markedRenderer})
|
|
||||||
.replace(/\s+$/, '')
|
|
||||||
.replace(/'/g, '\'');
|
|
||||||
|
|
||||||
result = unencodeQuotesAndTildes(result);
|
|
||||||
|
|
||||||
return result;
|
|
||||||
}
|
|
||||||
|
|
||||||
function shouldProcessString(tagName, text) {
|
|
||||||
let shouldProcess = true;
|
|
||||||
|
|
||||||
// we only want to process `@author` and `@see` tags that contain Markdown links
|
|
||||||
if ((tagName === 'author' || tagName === 'see') && text.indexOf('[') === -1) {
|
|
||||||
shouldProcess = false;
|
|
||||||
}
|
|
||||||
|
|
||||||
return shouldProcess;
|
|
||||||
}
|
|
||||||
|
|
||||||
function process(doclet) {
|
|
||||||
tags.forEach(function(tag) {
|
|
||||||
if (!hasOwnProp.call(doclet, tag)) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (typeof doclet[tag] === 'string' && shouldProcessString(tag, doclet[tag])) {
|
|
||||||
doclet[tag] = parse(doclet[tag]);
|
|
||||||
} else if (Array.isArray(doclet[tag])) {
|
|
||||||
doclet[tag].forEach(function(value, index, original) {
|
|
||||||
const inner = {};
|
|
||||||
|
|
||||||
inner[tag] = value;
|
|
||||||
process(inner);
|
|
||||||
original[index] = inner[tag];
|
|
||||||
});
|
|
||||||
} else if (doclet[tag]) {
|
|
||||||
process(doclet[tag]);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
exports.handlers = {
|
|
||||||
newDoclet: function(e) {
|
|
||||||
process(e.doclet);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
@@ -1,25 +1,25 @@
|
|||||||
const classes = {};
|
var classes = {};
|
||||||
const observables = {};
|
var observables = {};
|
||||||
|
|
||||||
exports.handlers = {
|
exports.handlers = {
|
||||||
|
|
||||||
newDoclet: function(e) {
|
newDoclet: function(e) {
|
||||||
const doclet = e.doclet;
|
var doclet = e.doclet;
|
||||||
if (doclet.kind == 'class' && !(doclet.longname in classes)) {
|
if (doclet.kind == 'class') {
|
||||||
classes[doclet.longname] = doclet;
|
classes[doclet.longname] = doclet;
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
parseComplete: function(e) {
|
parseComplete: function(e) {
|
||||||
const doclets = e.doclets;
|
var doclets = e.doclets;
|
||||||
let cls, doclet, event, i, ii, observable;
|
var cls, doclet, event, i, ii, observable;
|
||||||
for (i = 0, ii = doclets.length - 1; i < ii; ++i) {
|
for (i = 0, ii = doclets.length - 1; i < ii; ++i) {
|
||||||
doclet = doclets[i];
|
doclet = doclets[i];
|
||||||
cls = classes[doclet.longname.split('#')[0]];
|
cls = classes[doclet.longname.split('#')[0]];
|
||||||
if (typeof doclet.observable == 'string' && cls) {
|
if (typeof doclet.observable == 'string' && cls) {
|
||||||
let name = doclet.name.replace(/^[sg]et/, '');
|
var name = doclet.name.replace(/^[sg]et/, '');
|
||||||
name = name.substr(0, 1).toLowerCase() + name.substr(1);
|
name = name.substr(0, 1).toLowerCase() + name.substr(1);
|
||||||
const key = doclet.longname.split('#')[0] + '#' + name;
|
var key = doclet.longname.split('#')[0] + '#' + name;
|
||||||
doclet.observable = key;
|
doclet.observable = key;
|
||||||
if (!observables[key]) {
|
if (!observables[key]) {
|
||||||
observables[key] = {};
|
observables[key] = {};
|
||||||
@@ -27,7 +27,7 @@ exports.handlers = {
|
|||||||
observable = observables[key];
|
observable = observables[key];
|
||||||
observable.name = name;
|
observable.name = name;
|
||||||
observable.readonly = typeof observable.readonly == 'boolean' ?
|
observable.readonly = typeof observable.readonly == 'boolean' ?
|
||||||
observable.readonly : true;
|
observable.readonly : true;
|
||||||
if (doclet.name.indexOf('get') === 0) {
|
if (doclet.name.indexOf('get') === 0) {
|
||||||
observable.type = doclet.returns[0].type;
|
observable.type = doclet.returns[0].type;
|
||||||
observable.description = doclet.returns[0].description;
|
observable.description = doclet.returns[0].description;
|
||||||
@@ -47,7 +47,7 @@ exports.handlers = {
|
|||||||
if (!cls.fires) {
|
if (!cls.fires) {
|
||||||
cls.fires = [];
|
cls.fires = [];
|
||||||
}
|
}
|
||||||
event = 'module:ol/Object.ObjectEvent#event:change:' + name;
|
event = 'ol.Object.Event#event:change:' + name;
|
||||||
if (cls.fires.indexOf(event) == -1) {
|
if (cls.fires.indexOf(event) == -1) {
|
||||||
cls.fires.push(event);
|
cls.fires.push(event);
|
||||||
}
|
}
|
||||||
|
|||||||
123
config/jsdoc/api/plugins/typedefs.js
Normal file
123
config/jsdoc/api/plugins/typedefs.js
Normal file
@@ -0,0 +1,123 @@
|
|||||||
|
/*
|
||||||
|
* Converts olx.js @type annotations into properties of the previous @typedef.
|
||||||
|
* Changes @enum annotations into @typedef.
|
||||||
|
*/
|
||||||
|
|
||||||
|
var lastOlxTypedef = null;
|
||||||
|
var olxTypes = {};
|
||||||
|
// names of the olx typenames
|
||||||
|
var olxTypeNames = [];
|
||||||
|
// types that are undefined or typedefs containing undefined
|
||||||
|
var undefinedLikes = null;
|
||||||
|
|
||||||
|
function addSubparams(params) {
|
||||||
|
for (var j = 0, jj = params.length; j < jj; ++j) {
|
||||||
|
var param = params[j];
|
||||||
|
var types = param.type.names;
|
||||||
|
for (var k = 0, kk = types.length; k < kk; ++k) {
|
||||||
|
var name = types[k];
|
||||||
|
if (name in olxTypes) {
|
||||||
|
param.subparams = olxTypes[name];
|
||||||
|
// TODO addSubparams(param.subparams);
|
||||||
|
// TODO Do we need to support multiple object literal types per
|
||||||
|
// param?
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Changes the description of the param, if it is found to be a required
|
||||||
|
* option of an olxTypeName.
|
||||||
|
*/
|
||||||
|
function markRequiredIfNeeded(doclet){
|
||||||
|
var memberof = doclet.memberof;
|
||||||
|
// only check doclets that belong to an olxTypeName
|
||||||
|
if (!memberof || olxTypeNames.indexOf(memberof) == -1) {
|
||||||
|
return doclet;
|
||||||
|
}
|
||||||
|
|
||||||
|
var types = doclet.type.names;
|
||||||
|
var isRequiredParam = true;
|
||||||
|
|
||||||
|
// iterate over all types that are like-undefined (see above for explanation)
|
||||||
|
for (var idx = undefinedLikes.length - 1; idx >= 0; idx--) {
|
||||||
|
var undefinedLike = undefinedLikes[idx];
|
||||||
|
// … if the current types contains a type that is undefined-like,
|
||||||
|
// it is not required.
|
||||||
|
if (types.indexOf(undefinedLike) != -1) {
|
||||||
|
isRequiredParam = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (isRequiredParam) {
|
||||||
|
var reqSnippet = '<span class="required-option">Required.</span></p>';
|
||||||
|
var endsWithP = /<\/p>$/i;
|
||||||
|
var description = doclet.description;
|
||||||
|
if (description && endsWithP.test(description)) {
|
||||||
|
description = description.replace(endsWithP, ' ' + reqSnippet);
|
||||||
|
} else if (doclet.description === undefined) {
|
||||||
|
description = '<p>' + reqSnippet;
|
||||||
|
}
|
||||||
|
doclet.description = description;
|
||||||
|
}
|
||||||
|
return doclet;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Iterates over all doclets and finds the names of types that contain
|
||||||
|
* undefined. Stores the names in the global variable undefinedLikes, so
|
||||||
|
* that e.g. markRequiredIfNeeded can use these.
|
||||||
|
*/
|
||||||
|
function findTypesLikeUndefined(doclets) {
|
||||||
|
undefinedLikes = ['undefined']; // include type 'undefined' explicitly
|
||||||
|
for (var i = doclets.length - 1; i >= 0; --i) {
|
||||||
|
var doclet = doclets[i];
|
||||||
|
if(doclet.kind === 'typedef') {
|
||||||
|
var types = doclet.type.names;
|
||||||
|
if (types.indexOf('undefined') !== -1) {
|
||||||
|
// the typedef contains 'undefined', so it self is undefinedLike.
|
||||||
|
undefinedLikes.push(doclet.longname);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
exports.handlers = {
|
||||||
|
|
||||||
|
newDoclet: function(e) {
|
||||||
|
var doclet = e.doclet;
|
||||||
|
if (doclet.meta.filename == 'olx.js') {
|
||||||
|
if (doclet.kind == 'typedef') {
|
||||||
|
lastOlxTypedef = doclet;
|
||||||
|
olxTypeNames.push(doclet.longname);
|
||||||
|
olxTypes[doclet.longname] = [];
|
||||||
|
doclet.properties = [];
|
||||||
|
} else if (lastOlxTypedef && doclet.memberof == lastOlxTypedef.longname) {
|
||||||
|
lastOlxTypedef.properties.push(doclet);
|
||||||
|
olxTypes[lastOlxTypedef.longname].push(doclet);
|
||||||
|
} else {
|
||||||
|
lastOlxTypedef = null;
|
||||||
|
}
|
||||||
|
} else if (doclet.isEnum) {
|
||||||
|
// We never export enums, so we document them like typedefs
|
||||||
|
doclet.kind = 'typedef';
|
||||||
|
delete doclet.isEnum;
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
parseComplete: function(e) {
|
||||||
|
var doclets = e.doclets;
|
||||||
|
findTypesLikeUndefined(doclets);
|
||||||
|
for (var i = doclets.length - 1; i >= 0; --i) {
|
||||||
|
var doclet = doclets[i];
|
||||||
|
var params = doclet.params;
|
||||||
|
if (params) {
|
||||||
|
addSubparams(params);
|
||||||
|
}
|
||||||
|
markRequiredIfNeeded(doclet);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
};
|
||||||
@@ -47,6 +47,21 @@ ol.MapBrowserEventType = {
|
|||||||
```
|
```
|
||||||
Note the value of the `@event` annotation. The text before the hash refers to the event class that the event belongs to, and the text after the hash is the type of the event.
|
Note the value of the `@event` annotation. The text before the hash refers to the event class that the event belongs to, and the text after the hash is the type of the event.
|
||||||
|
|
||||||
|
To export event properties, they need to be defined in `externs/oli.js` (also see `readme.md` in `externs/`) and marked with an @api annotation:
|
||||||
|
```js
|
||||||
|
/** @interface */
|
||||||
|
oli.MapBrowserEvent;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @type {ol.Coordinate}
|
||||||
|
* @api
|
||||||
|
*/
|
||||||
|
oli.MapBrowserEvent.prototype.coordinate;
|
||||||
|
|
||||||
|
// ...
|
||||||
|
|
||||||
|
};
|
||||||
|
```
|
||||||
To document which events are fired by a class or method, the `@fires` annotation is used:
|
To document which events are fired by a class or method, the `@fires` annotation is used:
|
||||||
```js
|
```js
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -1,164 +1,152 @@
|
|||||||
/*global env: true */
|
/*global env: true */
|
||||||
|
var template = require('jsdoc/lib/jsdoc/template'),
|
||||||
const hasOwnProp = Object.prototype.hasOwnProperty;
|
fs = require('jsdoc/lib/jsdoc/fs'),
|
||||||
|
path = require('jsdoc/lib/jsdoc/path'),
|
||||||
// Work around an issue with hasOwnProperty in JSDoc's templateHelper.js.
|
taffy = require('taffydb').taffy,
|
||||||
//TODO Fix in JSDoc.
|
handle = require('jsdoc/lib/jsdoc/util/error').handle,
|
||||||
Object.prototype.hasOwnProperty = function(property) {
|
helper = require('jsdoc/lib/jsdoc/util/templateHelper'),
|
||||||
return property in this;
|
_ = require('underscore'),
|
||||||
};
|
htmlsafe = helper.htmlsafe,
|
||||||
|
linkto = helper.linkto,
|
||||||
const template = require('jsdoc/lib/jsdoc/template');
|
resolveAuthorLinks = helper.resolveAuthorLinks,
|
||||||
const fs = require('jsdoc/lib/jsdoc/fs');
|
scopeToPunc = helper.scopeToPunc,
|
||||||
const path = require('jsdoc/lib/jsdoc/path');
|
hasOwnProp = Object.prototype.hasOwnProperty,
|
||||||
const taffy = require('taffydb').taffy;
|
data,
|
||||||
const handle = require('jsdoc/lib/jsdoc/util/error').handle;
|
view,
|
||||||
const helper = require('jsdoc/lib/jsdoc/util/templateHelper');
|
outdir = env.opts.destination;
|
||||||
const _ = require('underscore');
|
|
||||||
const htmlsafe = helper.htmlsafe;
|
|
||||||
const linkto = helper.linkto;
|
|
||||||
const resolveAuthorLinks = helper.resolveAuthorLinks;
|
|
||||||
const outdir = env.opts.destination;
|
|
||||||
|
|
||||||
// Work around an issue with hasOwnProperty in JSDoc's templateHelper.js.
|
|
||||||
//TODO Fix in JSDoc.
|
|
||||||
Object.prototype.hasOwnProperty = hasOwnProp;
|
|
||||||
|
|
||||||
let view;
|
|
||||||
let data;
|
|
||||||
|
|
||||||
function find(spec) {
|
function find(spec) {
|
||||||
return helper.find(data, spec);
|
return helper.find(data, spec);
|
||||||
}
|
}
|
||||||
|
|
||||||
function tutoriallink(tutorial) {
|
function tutoriallink(tutorial) {
|
||||||
return helper.toTutorial(tutorial, null, {tag: 'em', classname: 'disabled', prefix: 'Tutorial: '});
|
return helper.toTutorial(tutorial, null, { tag: 'em', classname: 'disabled', prefix: 'Tutorial: ' });
|
||||||
}
|
}
|
||||||
|
|
||||||
function getAncestorLinks(doclet) {
|
function getAncestorLinks(doclet) {
|
||||||
return helper.getAncestorLinks(data, doclet);
|
return helper.getAncestorLinks(data, doclet);
|
||||||
}
|
}
|
||||||
|
|
||||||
function hashToLink(doclet, hash) {
|
function hashToLink(doclet, hash) {
|
||||||
if (!/^(#.+)/.test(hash)) {
|
if ( !/^(#.+)/.test(hash) ) { return hash; }
|
||||||
return hash;
|
|
||||||
}
|
|
||||||
|
|
||||||
let url = helper.createLink(doclet);
|
var url = helper.createLink(doclet);
|
||||||
|
|
||||||
url = url.replace(/(#.+|$)/, hash);
|
url = url.replace(/(#.+|$)/, hash);
|
||||||
return '<a href="' + url + '">' + hash + '</a>';
|
return '<a href="' + url + '">' + hash + '</a>';
|
||||||
}
|
}
|
||||||
|
|
||||||
function needsSignature(doclet) {
|
function needsSignature(doclet) {
|
||||||
let needsSig = false;
|
var needsSig = false;
|
||||||
|
|
||||||
// function and class definitions always get a signature
|
// function and class definitions always get a signature
|
||||||
if (doclet.kind === 'function' || doclet.kind === 'class') {
|
if (doclet.kind === 'function' || doclet.kind === 'class') {
|
||||||
needsSig = true;
|
|
||||||
} else if (doclet.kind === 'typedef' && doclet.type && doclet.type.names &&
|
|
||||||
doclet.type.names.length) {
|
|
||||||
// typedefs that contain functions get a signature, too
|
|
||||||
for (let i = 0, l = doclet.type.names.length; i < l; i++) {
|
|
||||||
if (doclet.type.names[i].toLowerCase() === 'function') {
|
|
||||||
needsSig = true;
|
needsSig = true;
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
// typedefs that contain functions get a signature, too
|
||||||
|
else if (doclet.kind === 'typedef' && doclet.type && doclet.type.names &&
|
||||||
|
doclet.type.names.length) {
|
||||||
|
for (var i = 0, l = doclet.type.names.length; i < l; i++) {
|
||||||
|
if (doclet.type.names[i].toLowerCase() === 'function') {
|
||||||
|
needsSig = true;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
return needsSig;
|
return needsSig;
|
||||||
}
|
}
|
||||||
|
|
||||||
function addSignatureParams(f) {
|
function addSignatureParams(f) {
|
||||||
const params = helper.getSignatureParams(f, 'optional');
|
var params = helper.getSignatureParams(f, 'optional');
|
||||||
|
|
||||||
f.signature = (f.signature || '') + '(' + params.join(', ') + ')';
|
f.signature = (f.signature || '') + '('+params.join(', ')+')';
|
||||||
}
|
}
|
||||||
|
|
||||||
function addSignatureReturns(f) {
|
function addSignatureReturns(f) {
|
||||||
const returnTypes = helper.getSignatureReturns(f);
|
var returnTypes = helper.getSignatureReturns(f);
|
||||||
|
|
||||||
f.signature = '<span class="signature">' + (f.signature || '') + '</span>';
|
f.signature = '<span class="signature">'+(f.signature || '') + '</span>';
|
||||||
|
|
||||||
if (returnTypes.length) {
|
if (returnTypes.length) {
|
||||||
f.signature += '<span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">' + (returnTypes.length ? '{' + returnTypes.join('|') + '}' : '') + '</span>';
|
f.signature += '<span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">'+(returnTypes.length ? '{'+returnTypes.join('|')+'}' : '')+'</span>';
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function addSignatureTypes(f) {
|
function addSignatureTypes(f) {
|
||||||
const types = helper.getSignatureTypes(f);
|
var types = helper.getSignatureTypes(f);
|
||||||
|
|
||||||
f.signature = (f.signature || '') + '<span class="type-signature">' + (types.length ? ' :' + types.join('|') : '') + ' </span>';
|
f.signature = (f.signature || '') + '<span class="type-signature">'+(types.length? ' :'+types.join('|') : '')+' </span>';
|
||||||
}
|
}
|
||||||
|
|
||||||
function shortenPaths(files, commonPrefix) {
|
function shortenPaths(files, commonPrefix) {
|
||||||
// always use forward slashes
|
// always use forward slashes
|
||||||
const regexp = new RegExp('\\\\', 'g');
|
var regexp = new RegExp('\\\\', 'g');
|
||||||
|
|
||||||
Object.keys(files).forEach(function(file) {
|
Object.keys(files).forEach(function(file) {
|
||||||
files[file].shortened = files[file].resolved.replace(commonPrefix, '')
|
files[file].shortened = files[file].resolved.replace(commonPrefix, '')
|
||||||
.replace(regexp, '/');
|
.replace(regexp, '/');
|
||||||
});
|
});
|
||||||
|
|
||||||
return files;
|
return files;
|
||||||
}
|
}
|
||||||
|
|
||||||
function resolveSourcePath(filepath) {
|
function resolveSourcePath(filepath) {
|
||||||
return path.resolve(process.cwd(), filepath);
|
return path.resolve(process.cwd(), filepath);
|
||||||
}
|
}
|
||||||
|
|
||||||
function getPathFromDoclet(doclet) {
|
function getPathFromDoclet(doclet) {
|
||||||
if (!doclet.meta) {
|
if (!doclet.meta) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
const filepath = doclet.meta.path && doclet.meta.path !== 'null' ?
|
var filepath = doclet.meta.path && doclet.meta.path !== 'null' ?
|
||||||
doclet.meta.path + '/' + doclet.meta.filename.split(/[\/\\]/).pop() :
|
doclet.meta.path + '/' + doclet.meta.filename.split(/[\/\\]/).pop() :
|
||||||
doclet.meta.filename;
|
doclet.meta.filename;
|
||||||
|
|
||||||
return filepath;
|
return filepath;
|
||||||
}
|
}
|
||||||
|
|
||||||
function generate(title, docs, filename, resolveLinks) {
|
function generate(title, docs, filename, resolveLinks) {
|
||||||
resolveLinks = resolveLinks === false ? false : true;
|
resolveLinks = resolveLinks === false ? false : true;
|
||||||
|
|
||||||
const docData = {
|
var docData = {
|
||||||
filename: filename,
|
filename: filename,
|
||||||
title: title,
|
title: title,
|
||||||
docs: docs,
|
docs: docs,
|
||||||
packageInfo: (find({kind: 'package'}) || []) [0]
|
packageInfo: ( find({kind: 'package'}) || [] ) [0]
|
||||||
};
|
};
|
||||||
|
|
||||||
const outpath = path.join(outdir, filename);
|
var outpath = path.join(outdir, filename),
|
||||||
let html = view.render('container.tmpl', docData);
|
html = view.render('container.tmpl', docData);
|
||||||
|
|
||||||
if (resolveLinks) {
|
if (resolveLinks) {
|
||||||
html = helper.resolveLinks(html); // turn {@link foo} into <a href="foodoc.html">foo</a>
|
html = helper.resolveLinks(html); // turn {@link foo} into <a href="foodoc.html">foo</a>
|
||||||
}
|
}
|
||||||
|
|
||||||
fs.writeFileSync(outpath, html, 'utf8');
|
fs.writeFileSync(outpath, html, 'utf8');
|
||||||
}
|
}
|
||||||
|
|
||||||
function generateSourceFiles(sourceFiles) {
|
function generateSourceFiles(sourceFiles) {
|
||||||
Object.keys(sourceFiles).forEach(function(file) {
|
Object.keys(sourceFiles).forEach(function(file) {
|
||||||
let source;
|
var source;
|
||||||
// links are keyed to the shortened path in each doclet's `meta.filename` property
|
// links are keyed to the shortened path in each doclet's `meta.filename` property
|
||||||
const sourceOutfile = helper.getUniqueFilename(sourceFiles[file].shortened);
|
var sourceOutfile = helper.getUniqueFilename(sourceFiles[file].shortened);
|
||||||
helper.registerLink(sourceFiles[file].shortened, sourceOutfile);
|
helper.registerLink(sourceFiles[file].shortened, sourceOutfile);
|
||||||
|
|
||||||
try {
|
try {
|
||||||
source = {
|
source = {
|
||||||
kind: 'source',
|
kind: 'source',
|
||||||
code: helper.htmlsafe(fs.readFileSync(sourceFiles[file].resolved, 'utf8'))
|
code: helper.htmlsafe( fs.readFileSync(sourceFiles[file].resolved, 'utf8') )
|
||||||
};
|
};
|
||||||
} catch (e) {
|
}
|
||||||
handle(e);
|
catch(e) {
|
||||||
}
|
handle(e);
|
||||||
|
}
|
||||||
|
|
||||||
generate('Source: ' + sourceFiles[file].shortened, [source], sourceOutfile,
|
generate('Source: ' + sourceFiles[file].shortened, [source], sourceOutfile,
|
||||||
false);
|
false);
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -168,353 +156,351 @@ function generateSourceFiles(sourceFiles) {
|
|||||||
* for display purposes. This function mutates the original arrays.
|
* for display purposes. This function mutates the original arrays.
|
||||||
*
|
*
|
||||||
* @private
|
* @private
|
||||||
* @param {Array<module:jsdoc/doclet.Doclet>} doclets - The array of classes and functions to
|
* @param {Array.<module:jsdoc/doclet.Doclet>} doclets - The array of classes and functions to
|
||||||
* check.
|
* check.
|
||||||
* @param {Array<module:jsdoc/doclet.Doclet>} modules - The array of module doclets to search.
|
* @param {Array.<module:jsdoc/doclet.Doclet>} modules - The array of module doclets to search.
|
||||||
*/
|
*/
|
||||||
function attachModuleSymbols(doclets, modules) {
|
function attachModuleSymbols(doclets, modules) {
|
||||||
const symbols = {};
|
var symbols = {};
|
||||||
|
|
||||||
// build a lookup table
|
// build a lookup table
|
||||||
doclets.forEach(function(symbol) {
|
doclets.forEach(function(symbol) {
|
||||||
symbols[symbol.longname] = symbol;
|
symbols[symbol.longname] = symbol;
|
||||||
});
|
});
|
||||||
|
|
||||||
modules.forEach(function(module) {
|
return modules.map(function(module) {
|
||||||
if (symbols[module.longname]) {
|
if (symbols[module.longname]) {
|
||||||
module.module = symbols[module.longname];
|
module.module = symbols[module.longname];
|
||||||
module.module.name = module.module.name.replace('module:', 'require("') + '")';
|
module.module.name = module.module.name.replace('module:', 'require("') + '")';
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Create the navigation sidebar.
|
* Create the navigation sidebar.
|
||||||
* @param {object} members The members that will be used to create the sidebar.
|
* @param {object} members The members that will be used to create the sidebar.
|
||||||
* @param {Array<Object>} members.classes Classes.
|
* @param {array<object>} members.classes
|
||||||
* @param {Array<Object>} members.externals Externals.
|
* @param {array<object>} members.externals
|
||||||
* @param {Array<Object>} members.globals Globals.
|
* @param {array<object>} members.globals
|
||||||
* @param {Array<Object>} members.mixins Mixins.
|
* @param {array<object>} members.mixins
|
||||||
* @param {Array<Object>} members.modules Modules.
|
* @param {array<object>} members.modules
|
||||||
* @param {Array<Object>} members.namespaces Namespaces.
|
* @param {array<object>} members.namespaces
|
||||||
* @param {Array<Object>} members.tutorials Tutorials.
|
* @param {array<object>} members.tutorials
|
||||||
* @param {Array<Object>} members.events Events.
|
* @param {array<object>} members.events
|
||||||
* @return {string} The HTML for the navigation sidebar.
|
* @return {string} The HTML for the navigation sidebar.
|
||||||
*/
|
*/
|
||||||
function buildNav(members) {
|
function buildNav(members) {
|
||||||
const nav = [];
|
var nav = [];
|
||||||
// merge namespaces and classes, then sort
|
// merge namespaces and classes, then sort
|
||||||
const merged = members.modules.concat(members.classes);
|
var merged = members.namespaces.concat(members.classes);
|
||||||
merged.sort(function(a, b) {
|
merged.sort(function (a, b) {
|
||||||
if (a.longname > b.longname) {
|
if (a.longname > b.longname)
|
||||||
return 1;
|
return 1;
|
||||||
}
|
if (a.longname < b.longname)
|
||||||
if (a.longname < b.longname) {
|
return -1;
|
||||||
return -1;
|
return 0;
|
||||||
}
|
});
|
||||||
return 0;
|
_.each(merged, function (v) {
|
||||||
});
|
// exclude 'olx' and interfaces from sidebar
|
||||||
_.each(merged, function(v) {
|
if (v.longname.indexOf('olx') !== 0 && v.interface !== true) {
|
||||||
// exclude interfaces from sidebar
|
if (v.kind == 'namespace') {
|
||||||
if (v.interface !== true) {
|
nav.push({
|
||||||
if (v.kind == 'module') {
|
type: 'namespace',
|
||||||
nav.push({
|
longname: v.longname,
|
||||||
type: 'module',
|
name: v.name,
|
||||||
longname: v.longname,
|
members: find({
|
||||||
name: v.name,
|
kind: 'member',
|
||||||
members: find({
|
memberof: v.longname
|
||||||
kind: 'member',
|
}),
|
||||||
memberof: v.longname
|
methods: find({
|
||||||
}),
|
kind: 'function',
|
||||||
methods: find({
|
memberof: v.longname
|
||||||
kind: 'function',
|
}),
|
||||||
memberof: v.longname
|
typedefs: find({
|
||||||
}),
|
kind: 'typedef',
|
||||||
typedefs: find({
|
memberof: v.longname
|
||||||
kind: 'typedef',
|
}),
|
||||||
memberof: v.longname
|
events: find({
|
||||||
}),
|
kind: 'event',
|
||||||
events: find({
|
memberof: v.longname
|
||||||
kind: 'event',
|
})
|
||||||
memberof: v.longname
|
});
|
||||||
})
|
}
|
||||||
});
|
if (v.kind == 'class') {
|
||||||
|
nav.push({
|
||||||
|
type: 'class',
|
||||||
|
longname: v.longname,
|
||||||
|
name: v.name,
|
||||||
|
members: find({
|
||||||
|
kind: 'member',
|
||||||
|
memberof: v.longname
|
||||||
|
}),
|
||||||
|
methods: find({
|
||||||
|
kind: 'function',
|
||||||
|
memberof: v.longname
|
||||||
|
}),
|
||||||
|
typedefs: find({
|
||||||
|
kind: 'typedef',
|
||||||
|
memberof: v.longname
|
||||||
|
}),
|
||||||
|
fires: v.fires,
|
||||||
|
events: find({
|
||||||
|
kind: 'event',
|
||||||
|
memberof: v.longname
|
||||||
|
})
|
||||||
|
});
|
||||||
|
}
|
||||||
}
|
}
|
||||||
if (v.kind == 'class') {
|
});
|
||||||
nav.push({
|
return nav;
|
||||||
type: 'class',
|
|
||||||
longname: v.longname,
|
|
||||||
name: v.name,
|
|
||||||
members: find({
|
|
||||||
kind: 'member',
|
|
||||||
memberof: v.longname
|
|
||||||
}),
|
|
||||||
methods: find({
|
|
||||||
kind: 'function',
|
|
||||||
memberof: v.longname
|
|
||||||
}),
|
|
||||||
typedefs: find({
|
|
||||||
kind: 'typedef',
|
|
||||||
memberof: v.longname
|
|
||||||
}),
|
|
||||||
fires: v.fires,
|
|
||||||
events: find({
|
|
||||||
kind: 'event',
|
|
||||||
memberof: v.longname
|
|
||||||
})
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
return nav;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {Object} taffyData See <http://taffydb.com/>.
|
@param {TAFFY} taffyData See <http://taffydb.com/>.
|
||||||
* @param {Object} opts Options.
|
@param {object} opts
|
||||||
* @param {Object} tutorials Tutorials.
|
@param {Tutorial} tutorials
|
||||||
*/
|
*/
|
||||||
exports.publish = function(taffyData, opts, tutorials) {
|
exports.publish = function(taffyData, opts, tutorials) {
|
||||||
data = taffyData;
|
data = taffyData;
|
||||||
|
|
||||||
const conf = env.conf.templates || {};
|
var conf = env.conf.templates || {};
|
||||||
conf['default'] = conf['default'] || {};
|
conf['default'] = conf['default'] || {};
|
||||||
|
|
||||||
const templatePath = opts.template;
|
var templatePath = opts.template;
|
||||||
view = new template.Template(templatePath + '/tmpl');
|
view = new template.Template(templatePath + '/tmpl');
|
||||||
|
|
||||||
// claim some special filenames in advance, so the All-Powerful Overseer of Filename Uniqueness
|
// claim some special filenames in advance, so the All-Powerful Overseer of Filename Uniqueness
|
||||||
// doesn't try to hand them out later
|
// doesn't try to hand them out later
|
||||||
const indexUrl = helper.getUniqueFilename('index');
|
var indexUrl = helper.getUniqueFilename('index');
|
||||||
// don't call registerLink() on this one! 'index' is also a valid longname
|
// don't call registerLink() on this one! 'index' is also a valid longname
|
||||||
|
|
||||||
const globalUrl = helper.getUniqueFilename('global');
|
var globalUrl = helper.getUniqueFilename('global');
|
||||||
helper.registerLink('global', globalUrl);
|
helper.registerLink('global', globalUrl);
|
||||||
|
|
||||||
// set up templating
|
// set up templating
|
||||||
view.layout = 'layout.tmpl';
|
view.layout = 'layout.tmpl';
|
||||||
|
|
||||||
// set up tutorials for helper
|
// set up tutorials for helper
|
||||||
helper.setTutorials(tutorials);
|
helper.setTutorials(tutorials);
|
||||||
|
|
||||||
data = helper.prune(data);
|
data = helper.prune(data);
|
||||||
data.sort('longname, version, since');
|
data.sort('longname, version, since');
|
||||||
helper.addEventListeners(data);
|
helper.addEventListeners(data);
|
||||||
|
|
||||||
let sourceFiles = {};
|
var sourceFiles = {};
|
||||||
const sourceFilePaths = [];
|
var sourceFilePaths = [];
|
||||||
data().each(function(doclet) {
|
data().each(function(doclet) {
|
||||||
doclet.attribs = '';
|
doclet.attribs = '';
|
||||||
|
|
||||||
if (doclet.examples) {
|
if (doclet.examples) {
|
||||||
doclet.examples = doclet.examples.map(function(example) {
|
doclet.examples = doclet.examples.map(function(example) {
|
||||||
let caption, code;
|
var caption, code;
|
||||||
|
|
||||||
if (example.match(/^\s*<caption>([\s\S]+?)<\/caption>(\s*[\n\r])([\s\S]+)$/i)) {
|
if (example.match(/^\s*<caption>([\s\S]+?)<\/caption>(\s*[\n\r])([\s\S]+)$/i)) {
|
||||||
caption = RegExp.$1;
|
caption = RegExp.$1;
|
||||||
code = RegExp.$3;
|
code = RegExp.$3;
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
caption: caption || '',
|
||||||
|
code: code || example
|
||||||
|
};
|
||||||
|
});
|
||||||
|
}
|
||||||
|
if (doclet.see) {
|
||||||
|
doclet.see.forEach(function(seeItem, i) {
|
||||||
|
doclet.see[i] = hashToLink(doclet, seeItem);
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
return {
|
// build a list of source files
|
||||||
caption: caption || '',
|
var sourcePath;
|
||||||
code: code || example
|
var resolvedSourcePath;
|
||||||
};
|
if (doclet.meta) {
|
||||||
});
|
sourcePath = getPathFromDoclet(doclet);
|
||||||
}
|
resolvedSourcePath = resolveSourcePath(sourcePath);
|
||||||
if (doclet.see) {
|
sourceFiles[sourcePath] = {
|
||||||
doclet.see.forEach(function(seeItem, i) {
|
resolved: resolvedSourcePath,
|
||||||
doclet.see[i] = hashToLink(doclet, seeItem);
|
shortened: null
|
||||||
});
|
};
|
||||||
}
|
sourceFilePaths.push(resolvedSourcePath);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
// build a list of source files
|
fs.mkPath(outdir);
|
||||||
let sourcePath;
|
|
||||||
let resolvedSourcePath;
|
|
||||||
if (doclet.meta) {
|
|
||||||
sourcePath = getPathFromDoclet(doclet);
|
|
||||||
resolvedSourcePath = resolveSourcePath(sourcePath);
|
|
||||||
sourceFiles[sourcePath] = {
|
|
||||||
resolved: resolvedSourcePath,
|
|
||||||
shortened: null
|
|
||||||
};
|
|
||||||
sourceFilePaths.push(resolvedSourcePath);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
fs.mkPath(outdir);
|
// copy the template's static files to outdir
|
||||||
|
var fromDir = path.join(templatePath, 'static');
|
||||||
|
var staticFiles = fs.ls(fromDir, 3);
|
||||||
|
|
||||||
// copy the template's static files to outdir
|
staticFiles.forEach(function(fileName) {
|
||||||
const fromDir = path.join(templatePath, 'static');
|
var toDir = fs.toDir( fileName.replace(fromDir, outdir) );
|
||||||
const staticFiles = fs.ls(fromDir, 3);
|
|
||||||
|
|
||||||
staticFiles.forEach(function(fileName) {
|
|
||||||
const toDir = fs.toDir(fileName.replace(fromDir, outdir));
|
|
||||||
fs.mkPath(toDir);
|
|
||||||
fs.copyFileSync(fileName, toDir);
|
|
||||||
});
|
|
||||||
|
|
||||||
// copy user-specified static files to outdir
|
|
||||||
let staticFilePaths;
|
|
||||||
let staticFileFilter;
|
|
||||||
let staticFileScanner;
|
|
||||||
if (conf['default'].staticFiles) {
|
|
||||||
staticFilePaths = conf['default'].staticFiles.paths || [];
|
|
||||||
staticFileFilter = new (require('jsdoc/lib/jsdoc/src/filter')).Filter(conf['default'].staticFiles);
|
|
||||||
staticFileScanner = new (require('jsdoc/lib/jsdoc/src/scanner')).Scanner();
|
|
||||||
|
|
||||||
staticFilePaths.forEach(function(filePath) {
|
|
||||||
const extraStaticFiles = staticFileScanner.scan([filePath], 10, staticFileFilter);
|
|
||||||
|
|
||||||
extraStaticFiles.forEach(function(fileName) {
|
|
||||||
const sourcePath = fs.statSync(filePath).isDirectory() ? filePath :
|
|
||||||
path.dirname(filePath);
|
|
||||||
const toDir = fs.toDir(fileName.replace(sourcePath, outdir));
|
|
||||||
fs.mkPath(toDir);
|
fs.mkPath(toDir);
|
||||||
fs.copyFileSync(fileName, toDir);
|
fs.copyFileSync(fileName, toDir);
|
||||||
});
|
|
||||||
});
|
});
|
||||||
}
|
|
||||||
|
|
||||||
if (sourceFilePaths.length) {
|
// copy user-specified static files to outdir
|
||||||
sourceFiles = shortenPaths(sourceFiles, path.commonPrefix(sourceFilePaths));
|
var staticFilePaths;
|
||||||
}
|
var staticFileFilter;
|
||||||
data().each(function(doclet) {
|
var staticFileScanner;
|
||||||
const url = helper.createLink(doclet);
|
if (conf['default'].staticFiles) {
|
||||||
helper.registerLink(doclet.longname, url);
|
staticFilePaths = conf['default'].staticFiles.paths || [];
|
||||||
|
staticFileFilter = new (require('jsdoc/lib/jsdoc/src/filter')).Filter(conf['default'].staticFiles);
|
||||||
|
staticFileScanner = new (require('jsdoc/lib/jsdoc/src/scanner')).Scanner();
|
||||||
|
|
||||||
// replace the filename with a shortened version of the full path
|
staticFilePaths.forEach(function(filePath) {
|
||||||
let docletPath;
|
var extraStaticFiles = staticFileScanner.scan([filePath], 10, staticFileFilter);
|
||||||
if (doclet.meta) {
|
|
||||||
docletPath = getPathFromDoclet(doclet);
|
|
||||||
docletPath = sourceFiles[docletPath].shortened;
|
|
||||||
if (docletPath) {
|
|
||||||
doclet.meta.filename = docletPath;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
data().each(function(doclet) {
|
extraStaticFiles.forEach(function(fileName) {
|
||||||
const url = helper.longnameToUrl[doclet.longname];
|
var sourcePath = fs.statSync(filePath).isDirectory() ? filePath :
|
||||||
|
path.dirname(filePath);
|
||||||
if (url.indexOf('#') > -1) {
|
var toDir = fs.toDir( fileName.replace(sourcePath, outdir) );
|
||||||
doclet.id = helper.longnameToUrl[doclet.longname].split(/#/).pop();
|
fs.mkPath(toDir);
|
||||||
} else {
|
fs.copyFileSync(fileName, toDir);
|
||||||
doclet.id = doclet.name;
|
});
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
if (needsSignature(doclet)) {
|
if (sourceFilePaths.length) {
|
||||||
addSignatureParams(doclet);
|
sourceFiles = shortenPaths( sourceFiles, path.commonPrefix(sourceFilePaths) );
|
||||||
addSignatureReturns(doclet);
|
|
||||||
}
|
}
|
||||||
});
|
data().each(function(doclet) {
|
||||||
|
var url = helper.createLink(doclet);
|
||||||
|
helper.registerLink(doclet.longname, url);
|
||||||
|
|
||||||
// do this after the urls have all been generated
|
// replace the filename with a shortened version of the full path
|
||||||
data().each(function(doclet) {
|
var docletPath;
|
||||||
doclet.ancestors = getAncestorLinks(doclet);
|
if (doclet.meta) {
|
||||||
|
docletPath = getPathFromDoclet(doclet);
|
||||||
|
docletPath = sourceFiles[docletPath].shortened;
|
||||||
|
if (docletPath) {
|
||||||
|
doclet.meta.filename = docletPath;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
if (doclet.kind === 'member') {
|
data().each(function(doclet) {
|
||||||
addSignatureTypes(doclet);
|
var url = helper.longnameToUrl[doclet.longname];
|
||||||
|
|
||||||
|
if (url.indexOf('#') > -1) {
|
||||||
|
doclet.id = helper.longnameToUrl[doclet.longname].split(/#/).pop();
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
doclet.id = doclet.name;
|
||||||
|
}
|
||||||
|
|
||||||
|
if ( needsSignature(doclet) ) {
|
||||||
|
addSignatureParams(doclet);
|
||||||
|
addSignatureReturns(doclet);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// do this after the urls have all been generated
|
||||||
|
data().each(function(doclet) {
|
||||||
|
doclet.ancestors = getAncestorLinks(doclet);
|
||||||
|
|
||||||
|
if (doclet.kind === 'member') {
|
||||||
|
addSignatureTypes(doclet);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (doclet.kind === 'constant') {
|
||||||
|
addSignatureTypes(doclet);
|
||||||
|
doclet.kind = 'member';
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
var members = helper.getMembers(data);
|
||||||
|
members.tutorials = tutorials.children;
|
||||||
|
|
||||||
|
// add template helpers
|
||||||
|
view.find = find;
|
||||||
|
view.linkto = linkto;
|
||||||
|
view.resolveAuthorLinks = resolveAuthorLinks;
|
||||||
|
view.tutoriallink = tutoriallink;
|
||||||
|
view.htmlsafe = htmlsafe;
|
||||||
|
view.members = members; //@davidshimjs: To make navigation for customizing
|
||||||
|
|
||||||
|
// once for all
|
||||||
|
view.nav = buildNav(members);
|
||||||
|
attachModuleSymbols( find({ kind: ['class', 'function'], longname: {left: 'module:'} }),
|
||||||
|
members.modules );
|
||||||
|
|
||||||
|
// only output pretty-printed source files if requested; do this before generating any other
|
||||||
|
// pages, so the other pages can link to the source files
|
||||||
|
if (conf['default'].outputSourceFiles) {
|
||||||
|
generateSourceFiles(sourceFiles);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (doclet.kind === 'constant') {
|
if (members.globals.length) { generate('Global', [{kind: 'globalobj'}], globalUrl); }
|
||||||
addSignatureTypes(doclet);
|
|
||||||
doclet.kind = 'member';
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
const members = helper.getMembers(data);
|
// index page displays information from package.json and lists files
|
||||||
members.tutorials = tutorials.children;
|
var files = find({kind: 'file'});
|
||||||
|
|
||||||
// add template helpers
|
generate('Index',
|
||||||
view.find = find;
|
[{kind: 'mainpage', readme: opts.readme, longname: (opts.mainpagetitle) ? opts.mainpagetitle : 'Main Page'}].concat(files),
|
||||||
view.linkto = linkto;
|
|
||||||
view.resolveAuthorLinks = resolveAuthorLinks;
|
|
||||||
view.tutoriallink = tutoriallink;
|
|
||||||
view.htmlsafe = htmlsafe;
|
|
||||||
view.members = members; //@davidshimjs: To make navigation for customizing
|
|
||||||
|
|
||||||
// once for all
|
|
||||||
view.nav = buildNav(members);
|
|
||||||
attachModuleSymbols(find({kind: ['class', 'function'], longname: {left: 'module:'}}),
|
|
||||||
members.modules);
|
|
||||||
|
|
||||||
// only output pretty-printed source files if requested; do this before generating any other
|
|
||||||
// pages, so the other pages can link to the source files
|
|
||||||
if (conf['default'].outputSourceFiles) {
|
|
||||||
generateSourceFiles(sourceFiles);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (members.globals.length) {
|
|
||||||
generate('Global', [{kind: 'globalobj'}], globalUrl);
|
|
||||||
}
|
|
||||||
|
|
||||||
// index page displays information from package.json and lists files
|
|
||||||
const files = find({kind: 'file'});
|
|
||||||
|
|
||||||
generate('Index',
|
|
||||||
[{kind: 'mainpage', readme: opts.readme, longname: (opts.mainpagetitle) ? opts.mainpagetitle : 'Main Page'}].concat(files),
|
|
||||||
indexUrl);
|
indexUrl);
|
||||||
|
|
||||||
// set up the lists that we'll use to generate pages
|
// set up the lists that we'll use to generate pages
|
||||||
const classes = taffy(members.classes);
|
var classes = taffy(members.classes);
|
||||||
const modules = taffy(members.modules);
|
var modules = taffy(members.modules);
|
||||||
const namespaces = taffy(members.namespaces);
|
var namespaces = taffy(members.namespaces);
|
||||||
const mixins = taffy(members.mixins);
|
var mixins = taffy(members.mixins);
|
||||||
const externals = taffy(members.externals);
|
var externals = taffy(members.externals);
|
||||||
|
|
||||||
for (const longname in helper.longnameToUrl) {
|
for (var longname in helper.longnameToUrl) {
|
||||||
if (hasOwnProp.call(helper.longnameToUrl, longname)) {
|
if ( hasOwnProp.call(helper.longnameToUrl, longname) ) {
|
||||||
const myClasses = helper.find(classes, {longname: longname});
|
var myClasses = helper.find(classes, {longname: longname});
|
||||||
if (myClasses.length) {
|
if (myClasses.length) {
|
||||||
generate('Class: ' + myClasses[0].name, myClasses, helper.longnameToUrl[longname]);
|
generate('Class: ' + myClasses[0].name, myClasses, helper.longnameToUrl[longname]);
|
||||||
}
|
}
|
||||||
|
|
||||||
const myModules = helper.find(modules, {longname: longname});
|
var myModules = helper.find(modules, {longname: longname});
|
||||||
if (myModules.length) {
|
if (myModules.length) {
|
||||||
generate('Module: ' + myModules[0].name, myModules, helper.longnameToUrl[longname]);
|
generate('Module: ' + myModules[0].name, myModules, helper.longnameToUrl[longname]);
|
||||||
}
|
}
|
||||||
|
|
||||||
const myNamespaces = helper.find(namespaces, {longname: longname});
|
var myNamespaces = helper.find(namespaces, {longname: longname});
|
||||||
if (myNamespaces.length) {
|
if (myNamespaces.length) {
|
||||||
generate('Namespace: ' + myNamespaces[0].name, myNamespaces, helper.longnameToUrl[longname]);
|
generate('Namespace: ' + myNamespaces[0].name, myNamespaces, helper.longnameToUrl[longname]);
|
||||||
}
|
}
|
||||||
|
|
||||||
const myMixins = helper.find(mixins, {longname: longname});
|
var myMixins = helper.find(mixins, {longname: longname});
|
||||||
if (myMixins.length) {
|
if (myMixins.length) {
|
||||||
generate('Mixin: ' + myMixins[0].name, myMixins, helper.longnameToUrl[longname]);
|
generate('Mixin: ' + myMixins[0].name, myMixins, helper.longnameToUrl[longname]);
|
||||||
}
|
}
|
||||||
|
|
||||||
const myExternals = helper.find(externals, {longname: longname});
|
var myExternals = helper.find(externals, {longname: longname});
|
||||||
if (myExternals.length) {
|
if (myExternals.length) {
|
||||||
generate('External: ' + myExternals[0].name, myExternals, helper.longnameToUrl[longname]);
|
generate('External: ' + myExternals[0].name, myExternals, helper.longnameToUrl[longname]);
|
||||||
}
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
// TODO: move the tutorial functions to templateHelper.js
|
// TODO: move the tutorial functions to templateHelper.js
|
||||||
function generateTutorial(title, tutorial, filename) {
|
function generateTutorial(title, tutorial, filename) {
|
||||||
const tutorialData = {
|
var tutorialData = {
|
||||||
title: title,
|
title: title,
|
||||||
header: tutorial.title,
|
header: tutorial.title,
|
||||||
content: tutorial.parse(),
|
content: tutorial.parse(),
|
||||||
children: tutorial.children
|
children: tutorial.children
|
||||||
};
|
};
|
||||||
|
|
||||||
let html = view.render('tutorial.tmpl', tutorialData);
|
var tutorialPath = path.join(outdir, filename),
|
||||||
// yes, you can use {@link} in tutorials too!
|
html = view.render('tutorial.tmpl', tutorialData);
|
||||||
html = helper.resolveLinks(html); // turn {@link foo} into <a href="foodoc.html">foo</a>
|
|
||||||
|
|
||||||
const tutorialPath = path.join(outdir, filename);
|
// yes, you can use {@link} in tutorials too!
|
||||||
fs.writeFileSync(tutorialPath, html, 'utf8');
|
html = helper.resolveLinks(html); // turn {@link foo} into <a href="foodoc.html">foo</a>
|
||||||
}
|
|
||||||
|
|
||||||
// tutorials can have only one parent so there is no risk for loops
|
fs.writeFileSync(tutorialPath, html, 'utf8');
|
||||||
function saveChildren(node) {
|
}
|
||||||
node.children.forEach(function(child) {
|
|
||||||
generateTutorial('Tutorial: ' + child.title, child, helper.tutorialToUrl(child.name));
|
// tutorials can have only one parent so there is no risk for loops
|
||||||
saveChildren(child);
|
function saveChildren(node) {
|
||||||
});
|
node.children.forEach(function(child) {
|
||||||
}
|
generateTutorial('Tutorial: ' + child.title, child, helper.tutorialToUrl(child.name));
|
||||||
saveChildren(tutorials);
|
saveChildren(child);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
saveChildren(tutorials);
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -30,11 +30,7 @@ $(function () {
|
|||||||
});
|
});
|
||||||
|
|
||||||
// Show an item related a current documentation automatically
|
// Show an item related a current documentation automatically
|
||||||
var filename = $('.page-title').data('filename')
|
var filename = $('.page-title').data('filename').replace(/\.[a-z]+$/, '');
|
||||||
.replace(/\.[a-z]+$/, '')
|
|
||||||
.replace('module-', 'module:')
|
|
||||||
.replace(/_/g, '/')
|
|
||||||
.replace(/-/g, '~');
|
|
||||||
var $currentItem = $('.navigation .item[data-name*="' + filename + '"]:eq(0)');
|
var $currentItem = $('.navigation .item[data-name*="' + filename + '"]:eq(0)');
|
||||||
|
|
||||||
if ($currentItem.length) {
|
if ($currentItem.length) {
|
||||||
@@ -89,7 +85,7 @@ $(function () {
|
|||||||
var srcLinks = $('div.tag-source');
|
var srcLinks = $('div.tag-source');
|
||||||
srcLinks.each(function(i, el) {
|
srcLinks.each(function(i, el) {
|
||||||
var textParts = el.innerHTML.trim().split(', ');
|
var textParts = el.innerHTML.trim().split(', ');
|
||||||
var link = 'https://github.com/openlayers/openlayers/blob/v' + currentVersion + '/src/ol/' +
|
var link = 'https://github.com/openlayers/openlayers/blob/v' + currentVersion + '/' +
|
||||||
textParts[0];
|
textParts[0];
|
||||||
el.innerHTML = '<a href="' + link + '">' + textParts[0] + '</a>, ' +
|
el.innerHTML = '<a href="' + link + '">' + textParts[0] + '</a>, ' +
|
||||||
'<a href="' + link + textParts[1].replace('line ', '#L') + '">' +
|
'<a href="' + link + textParts[1].replace('line ', '#L') + '">' +
|
||||||
@@ -101,8 +97,7 @@ $(function () {
|
|||||||
var anchors = $('.anchor');
|
var anchors = $('.anchor');
|
||||||
var _onHashChange = function () {
|
var _onHashChange = function () {
|
||||||
var activeHash = window.document.location.hash
|
var activeHash = window.document.location.hash
|
||||||
.replace(/\./g, '\\.') // Escape dot in element id
|
.replace(/\./g, '\\.'); // Escape dot in element id
|
||||||
.replace(/\~/g, '\\~'); // Escape tilde in element id
|
|
||||||
|
|
||||||
anchors.removeClass('highlighted');
|
anchors.removeClass('highlighted');
|
||||||
|
|
||||||
|
|||||||
@@ -20,10 +20,12 @@
|
|||||||
<br>
|
<br>
|
||||||
<?js if (doc.stability || doc.kind == 'namespace') {
|
<?js if (doc.stability || doc.kind == 'namespace') {
|
||||||
var ancestors = doc.ancestors.map(a => a.replace(/>\./g, '>').replace(/\.</g, '<')).join('/');
|
var ancestors = doc.ancestors.map(a => a.replace(/>\./g, '>').replace(/\.</g, '<')).join('/');
|
||||||
|
var name = doc.name.toLowerCase();
|
||||||
var parts = [];
|
var parts = [];
|
||||||
if (ancestors) {
|
if (ancestors) {
|
||||||
parts.push(ancestors.split('~').shift());
|
parts.push(ancestors);
|
||||||
}
|
}
|
||||||
|
parts.push(name);
|
||||||
var importPath = parts.join('/');
|
var importPath = parts.join('/');
|
||||||
?>
|
?>
|
||||||
<pre class="prettyprint source"><code>import <?js= doc.name ?> from '<?js= importPath ?>';</code></pre>
|
<pre class="prettyprint source"><code>import <?js= doc.name ?> from '<?js= importPath ?>';</code></pre>
|
||||||
|
|||||||
@@ -4,63 +4,6 @@ var version = obj.packageInfo.version;
|
|||||||
<!DOCTYPE html>
|
<!DOCTYPE html>
|
||||||
<html lang="en">
|
<html lang="en">
|
||||||
<head>
|
<head>
|
||||||
<script>
|
|
||||||
var gaProperty = 'UA-2577926-1';
|
|
||||||
// Disable tracking if the opt-out cookie exists.
|
|
||||||
var disableStr = 'ga-disable-' + gaProperty;
|
|
||||||
if (document.cookie.indexOf(disableStr + '=true') > -1) {
|
|
||||||
window[disableStr] = true;
|
|
||||||
}
|
|
||||||
function gaOptout() {
|
|
||||||
document.cookie = disableStr + '=true; expires=Thu, 31 Dec 2099 23:59:59 UTC; path=/';
|
|
||||||
window[disableStr] = true;
|
|
||||||
}
|
|
||||||
function gaOptoutRevoke() {
|
|
||||||
document.cookie = disableStr + '=false; expires=Thu, 31 Dec 2099 23:59:59 UTC; path=/';
|
|
||||||
window[disableStr] = false;
|
|
||||||
}
|
|
||||||
</script>
|
|
||||||
<!-- Global site tag (gtag.js) - Google Analytics -->
|
|
||||||
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-2577926-1"></script>
|
|
||||||
<script>
|
|
||||||
window.dataLayer = window.dataLayer || [];
|
|
||||||
function gtag(){dataLayer.push(arguments);}
|
|
||||||
gtag('js', new Date());
|
|
||||||
gtag('config', 'UA-2577926-1', { 'anonymize_ip': true });
|
|
||||||
</script>
|
|
||||||
<link rel="stylesheet" type="text/css" href="//cdnjs.cloudflare.com/ajax/libs/cookieconsent2/3.1.0/cookieconsent.min.css" />
|
|
||||||
<script src="//cdnjs.cloudflare.com/ajax/libs/cookieconsent2/3.1.0/cookieconsent.min.js"></script>
|
|
||||||
<script>
|
|
||||||
window.addEventListener("load", function() {
|
|
||||||
window.cookieconsent.initialise({
|
|
||||||
'palette': {
|
|
||||||
'popup': {
|
|
||||||
'background': '#eaf7f7',
|
|
||||||
'text': '#5c7291'
|
|
||||||
},
|
|
||||||
'button': {
|
|
||||||
'background': '#56cbdb',
|
|
||||||
'text': '#ffffff'
|
|
||||||
}
|
|
||||||
},
|
|
||||||
'theme': 'edgeless',
|
|
||||||
'type': 'opt-out',
|
|
||||||
'onInitialise': function (status) {
|
|
||||||
if (!this.hasConsented()) {
|
|
||||||
gaOptout()
|
|
||||||
}
|
|
||||||
},
|
|
||||||
'onStatusChange': function(status, chosenBefore) {
|
|
||||||
if (!this.hasConsented()) {
|
|
||||||
gaOptout()
|
|
||||||
}
|
|
||||||
},
|
|
||||||
'onRevokeChoice': function() {
|
|
||||||
gaOptoutRevoke()
|
|
||||||
}
|
|
||||||
})
|
|
||||||
});
|
|
||||||
</script>
|
|
||||||
<meta charset="utf-8">
|
<meta charset="utf-8">
|
||||||
<title>OpenLayers v<?js= version ?> API - <?js= title ?></title>
|
<title>OpenLayers v<?js= version ?> API - <?js= title ?></title>
|
||||||
<script src="https://cdn.polyfill.io/v2/polyfill.min.js?features=fetch"></script>
|
<script src="https://cdn.polyfill.io/v2/polyfill.min.js?features=fetch"></script>
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ if (data.type && data.type.names) {
|
|||||||
<div class="anchor" id="<?js= id ?>">
|
<div class="anchor" id="<?js= id ?>">
|
||||||
</div>
|
</div>
|
||||||
<h4 class="name">
|
<h4 class="name">
|
||||||
<?js= data.attribs + (data.scope === 'static' ? longname : name.indexOf('module:') === 0 ? name.split('/').pop() : name) + typeSignature ?>
|
<?js= data.attribs + (data.scope === 'static' ? longname : name) + typeSignature ?>
|
||||||
<?js= this.partial('stability.tmpl', data) ?>
|
<?js= this.partial('stability.tmpl', data) ?>
|
||||||
</h4>
|
</h4>
|
||||||
</div>
|
</div>
|
||||||
@@ -28,9 +28,9 @@ if (data.type && data.type.names) {
|
|||||||
<?js= data.description ?>
|
<?js= data.description ?>
|
||||||
</div>
|
</div>
|
||||||
<?js } ?>
|
<?js } ?>
|
||||||
|
|
||||||
<?js= this.partial('details.tmpl', data) ?>
|
<?js= this.partial('details.tmpl', data) ?>
|
||||||
|
|
||||||
<?js if (data.examples && examples.length) { ?>
|
<?js if (data.examples && examples.length) { ?>
|
||||||
<h5>Example<?js= examples.length > 1? 's':'' ?></h5>
|
<h5>Example<?js= examples.length > 1? 's':'' ?></h5>
|
||||||
<?js= this.partial('examples.tmpl', examples) ?>
|
<?js= this.partial('examples.tmpl', examples) ?>
|
||||||
|
|||||||
@@ -77,7 +77,7 @@ var self = this;
|
|||||||
(<?js= self.linkto(eventClass.longname) ?>)
|
(<?js= self.linkto(eventClass.longname) ?>)
|
||||||
<?js } ?>
|
<?js } ?>
|
||||||
<?js } ?>
|
<?js } ?>
|
||||||
<?js= self.partial('stability.tmpl', eventDoclet || (data.stability ? data : {})) ?>
|
<?js= self.partial('stability.tmpl', eventDoclet || (data.stability ? data : {stability: 'experimental'})) ?>
|
||||||
<?js if (description) { ?> -
|
<?js if (description) { ?> -
|
||||||
<?js= description ?>
|
<?js= description ?>
|
||||||
<?js } ?>
|
<?js } ?>
|
||||||
|
|||||||
@@ -1,8 +1,5 @@
|
|||||||
<?js
|
<?js
|
||||||
var self = this;
|
var self = this;
|
||||||
function toShortName(name) {
|
|
||||||
return name.indexOf('module:') === 0 ? name.split('/').pop() : name;
|
|
||||||
}
|
|
||||||
?>
|
?>
|
||||||
<div class="navigation">
|
<div class="navigation">
|
||||||
<div class="search">
|
<div class="search">
|
||||||
@@ -14,7 +11,7 @@ function toShortName(name) {
|
|||||||
?>
|
?>
|
||||||
<li class="item" data-name="<?js= item.longname ?>">
|
<li class="item" data-name="<?js= item.longname ?>">
|
||||||
<span class="title">
|
<span class="title">
|
||||||
<?js= self.linkto(item.longname, item.longname.replace('module:', '')) ?>
|
<?js= self.linkto(item.longname, item.longname) ?>
|
||||||
<?js if (item.type === 'namespace' &&
|
<?js if (item.type === 'namespace' &&
|
||||||
(item.members.length + item.typedefs.length + item.methods.length +
|
(item.members.length + item.typedefs.length + item.methods.length +
|
||||||
item.events.length > 0)) { ?>
|
item.events.length > 0)) { ?>
|
||||||
@@ -28,7 +25,7 @@ function toShortName(name) {
|
|||||||
<?js
|
<?js
|
||||||
item.members.forEach(function (v) {
|
item.members.forEach(function (v) {
|
||||||
?>
|
?>
|
||||||
<li data-name="<?js= v.longname ?>"><?js= self.linkto(v.longname, toShortName(v.name)) ?></li>
|
<li data-name="<?js= v.longname ?>"><?js= self.linkto(v.longname, v.name) ?></li>
|
||||||
<?js
|
<?js
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
@@ -43,7 +40,7 @@ function toShortName(name) {
|
|||||||
item.typedefs.forEach(function (v) {
|
item.typedefs.forEach(function (v) {
|
||||||
?>
|
?>
|
||||||
<li data-name="<?js= v.longname ?>" class="<?js= (v.stability && v.stability !== 'stable') ? 'unstable' : ''?>">
|
<li data-name="<?js= v.longname ?>" class="<?js= (v.stability && v.stability !== 'stable') ? 'unstable' : ''?>">
|
||||||
<?js= self.linkto(v.longname, toShortName(v.name)) ?>
|
<?js= self.linkto(v.longname, v.name) ?>
|
||||||
</li>
|
</li>
|
||||||
<?js
|
<?js
|
||||||
});
|
});
|
||||||
@@ -60,7 +57,7 @@ function toShortName(name) {
|
|||||||
item.methods.forEach(function (v) {
|
item.methods.forEach(function (v) {
|
||||||
?>
|
?>
|
||||||
<li data-name="<?js= v.longname ?>" class="<?js= (v.stability && v.stability !== 'stable') ? 'unstable' : ''?>">
|
<li data-name="<?js= v.longname ?>" class="<?js= (v.stability && v.stability !== 'stable') ? 'unstable' : ''?>">
|
||||||
<?js= self.linkto(v.longname, toShortName(v.name)) ?>
|
<?js= self.linkto(v.longname, v.name) ?>
|
||||||
</li>
|
</li>
|
||||||
<?js
|
<?js
|
||||||
});
|
});
|
||||||
@@ -77,7 +74,7 @@ function toShortName(name) {
|
|||||||
v = self.find({longname: v})[0] || {longname: v, name: v.split(/#?event:/)[1]};
|
v = self.find({longname: v})[0] || {longname: v, name: v.split(/#?event:/)[1]};
|
||||||
?>
|
?>
|
||||||
<li data-name="<?js= v.longname ?>" class="<?js= (v.stability && v.stability != 'stable') ? 'unstable' : '' ?>">
|
<li data-name="<?js= v.longname ?>" class="<?js= (v.stability && v.stability != 'stable') ? 'unstable' : '' ?>">
|
||||||
<?js= self.linkto(v.longname, toShortName(v.name)) ?>
|
<?js= self.linkto(v.longname, v.name) ?>
|
||||||
</li>
|
</li>
|
||||||
<?js
|
<?js
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -8,7 +8,7 @@
|
|||||||
<th>Name</th>
|
<th>Name</th>
|
||||||
<th>Type</th>
|
<th>Type</th>
|
||||||
<th>Settable</th>
|
<th>Settable</th>
|
||||||
<th><a href="module-ol_Object-ObjectEvent.html">ol/Object.ObjectEvent</a> type</th>
|
<th><a href="ol.Object.Event.html">ol.Object.Event</a> type</th>
|
||||||
<th class="last">Description</th>
|
<th class="last">Description</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ exports.defineTags = function(dictionary) {
|
|||||||
|
|
||||||
dictionary.defineTag('api', {
|
dictionary.defineTag('api', {
|
||||||
onTagged: function(doclet, tag) {
|
onTagged: function(doclet, tag) {
|
||||||
doclet.api = true;
|
doclet.api = tag.text || 'experimental';
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
@@ -10,12 +10,8 @@
|
|||||||
"includePattern": "\\.js$"
|
"includePattern": "\\.js$"
|
||||||
},
|
},
|
||||||
"plugins": [
|
"plugins": [
|
||||||
"jsdoc-plugin-typescript",
|
|
||||||
"config/jsdoc/info/api-plugin",
|
"config/jsdoc/info/api-plugin",
|
||||||
"config/jsdoc/info/define-plugin",
|
"config/jsdoc/info/define-plugin",
|
||||||
"config/jsdoc/info/virtual-plugin"
|
"config/jsdoc/info/virtual-plugin"
|
||||||
],
|
]
|
||||||
"typescript": {
|
|
||||||
"moduleRoot": "src"
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
const DEFAULT_VALUE = /default\s+is\s+`?(true|false)`?/i;
|
var DEFAULT_VALUE = /default\s+is\s+`?(true|false)`?/i;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -19,9 +19,9 @@ exports.defineTags = function(dictionary) {
|
|||||||
canHaveType: true,
|
canHaveType: true,
|
||||||
mustHaveValue: true,
|
mustHaveValue: true,
|
||||||
onTagged: function(doclet, tag) {
|
onTagged: function(doclet, tag) {
|
||||||
const types = tag.value.type.names;
|
var types = tag.value.type.names;
|
||||||
if (types.length === 1 && types[0] === 'boolean') {
|
if (types.length === 1 && types[0] === 'boolean') {
|
||||||
const match = tag.value.description.match(DEFAULT_VALUE);
|
var match = tag.value.description.match(DEFAULT_VALUE);
|
||||||
if (match) {
|
if (match) {
|
||||||
doclet.define = {
|
doclet.define = {
|
||||||
default: match[1] === 'true'
|
default: match[1] === 'true'
|
||||||
|
|||||||
@@ -2,8 +2,8 @@
|
|||||||
* @fileoverview Generates JSON output based on exportable symbols (those with
|
* @fileoverview Generates JSON output based on exportable symbols (those with
|
||||||
* an api tag) and boolean defines (with a define tag and a default value).
|
* an api tag) and boolean defines (with a define tag and a default value).
|
||||||
*/
|
*/
|
||||||
const assert = require('assert');
|
var assert = require('assert');
|
||||||
const path = require('path');
|
var path = require('path');
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -15,52 +15,67 @@ const path = require('path');
|
|||||||
exports.publish = function(data, opts) {
|
exports.publish = function(data, opts) {
|
||||||
|
|
||||||
function getTypes(data) {
|
function getTypes(data) {
|
||||||
const types = [];
|
var types = [];
|
||||||
data.forEach(function(name) {
|
data.forEach(function(name) {
|
||||||
types.push(name.replace(/^function$/, 'Function'));
|
types.push(name.replace(/^function$/, 'Function'));
|
||||||
});
|
});
|
||||||
return types;
|
return types;
|
||||||
}
|
}
|
||||||
|
|
||||||
// get all doclets with the "api" property or define (excluding events)
|
// get all doclets with the "api" property or define (excluding events) or
|
||||||
const classes = {};
|
// with olx namespace
|
||||||
const docs = data(
|
var classes = {};
|
||||||
[
|
var docs = data(
|
||||||
{define: {isObject: true}},
|
[
|
||||||
function() {
|
{define: {isObject: true}},
|
||||||
if (this.kind == 'class') {
|
function() {
|
||||||
if (!('extends' in this) || typeof this.api == 'boolean') {
|
if (this.kind == 'class') {
|
||||||
classes[this.longname] = this;
|
if (!('extends' in this) || typeof this.api == 'string') {
|
||||||
return true;
|
classes[this.longname] = this;
|
||||||
|
return true;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
return (typeof this.api == 'string' ||
|
||||||
return (typeof this.api == 'boolean' ||
|
|
||||||
this.meta && (/[\\\/]externs$/).test(this.meta.path));
|
this.meta && (/[\\\/]externs$/).test(this.meta.path));
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
{kind: {'!is': 'file'}},
|
{kind: {'!is': 'file'}},
|
||||||
{kind: {'!is': 'event'}}).get();
|
{kind: {'!is': 'event'}}).get();
|
||||||
|
|
||||||
// get symbols data, filter out those that are members of private classes
|
// get symbols data, filter out those that are members of private classes
|
||||||
const symbols = [];
|
var symbols = [];
|
||||||
const defines = [];
|
var defines = [];
|
||||||
const typedefs = [];
|
var typedefs = [];
|
||||||
const externs = [];
|
var externs = [];
|
||||||
let base = [];
|
var base = [];
|
||||||
const augments = {};
|
var augments = {};
|
||||||
const symbolsByName = {};
|
var symbolsByName = {};
|
||||||
docs.filter(function(doc) {
|
docs.filter(function(doc) {
|
||||||
let include = true;
|
var include = true;
|
||||||
const constructor = doc.memberof;
|
var constructor = doc.memberof;
|
||||||
if (constructor && constructor.substr(-1) === '_' && constructor.indexOf('module:') === -1) {
|
if (constructor && constructor.substr(-1) === '_') {
|
||||||
assert.strictEqual(doc.inherited, true,
|
assert.strictEqual(doc.inherited, true,
|
||||||
'Unexpected export on private class: ' + doc.longname);
|
'Unexpected export on private class: ' + doc.longname);
|
||||||
include = false;
|
include = false;
|
||||||
}
|
}
|
||||||
return include;
|
return include;
|
||||||
}).forEach(function(doc) {
|
}).forEach(function(doc) {
|
||||||
const isExterns = (/[\\\/]externs$/).test(doc.meta.path);
|
var isExterns = (/[\\\/]externs$/).test(doc.meta.path);
|
||||||
if (doc.define) {
|
if (isExterns && doc.longname.indexOf('olx.') === 0) {
|
||||||
|
if (doc.kind == 'typedef') {
|
||||||
|
typedefs.push({
|
||||||
|
name: doc.longname,
|
||||||
|
types: ['{}']
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
var typedef = typedefs[typedefs.length - 1];
|
||||||
|
var type = typedef.types[0];
|
||||||
|
typedef.types[0] = type
|
||||||
|
.replace(/\}$/, ', ' + doc.longname.split('#')[1] +
|
||||||
|
': (' + getTypes(doc.type.names).join('|') + ')}')
|
||||||
|
.replace('{, ', '{');
|
||||||
|
}
|
||||||
|
} else if (doc.define) {
|
||||||
defines.push({
|
defines.push({
|
||||||
name: doc.longname,
|
name: doc.longname,
|
||||||
description: doc.description,
|
description: doc.description,
|
||||||
@@ -73,10 +88,11 @@ exports.publish = function(data, opts) {
|
|||||||
types: getTypes(doc.type.names)
|
types: getTypes(doc.type.names)
|
||||||
});
|
});
|
||||||
} else {
|
} else {
|
||||||
const symbol = {
|
var symbol = {
|
||||||
name: doc.longname,
|
name: doc.longname,
|
||||||
kind: doc.kind,
|
kind: doc.kind,
|
||||||
description: doc.classdesc || doc.description,
|
description: doc.classdesc || doc.description,
|
||||||
|
stability: doc.api,
|
||||||
path: path.join(doc.meta.path, doc.meta.filename)
|
path: path.join(doc.meta.path, doc.meta.filename)
|
||||||
};
|
};
|
||||||
if (doc.augments) {
|
if (doc.augments) {
|
||||||
@@ -89,9 +105,9 @@ exports.publish = function(data, opts) {
|
|||||||
symbol.types = getTypes(doc.type.names);
|
symbol.types = getTypes(doc.type.names);
|
||||||
}
|
}
|
||||||
if (doc.params) {
|
if (doc.params) {
|
||||||
const params = [];
|
var params = [];
|
||||||
doc.params.forEach(function(param) {
|
doc.params.forEach(function(param) {
|
||||||
const paramInfo = {
|
var paramInfo = {
|
||||||
name: param.name
|
name: param.name
|
||||||
};
|
};
|
||||||
params.push(paramInfo);
|
params.push(paramInfo);
|
||||||
@@ -126,10 +142,10 @@ exports.publish = function(data, opts) {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
const target = isExterns ? externs : (doc.api ? symbols : base);
|
var target = isExterns ? externs : (doc.api ? symbols : base);
|
||||||
const existingSymbol = symbolsByName[symbol.name];
|
var existingSymbol = symbolsByName[symbol.name];
|
||||||
if (existingSymbol) {
|
if (existingSymbol) {
|
||||||
const idx = target.indexOf(existingSymbol);
|
var idx = target.indexOf(existingSymbol);
|
||||||
target.splice(idx, 1);
|
target.splice(idx, 1);
|
||||||
}
|
}
|
||||||
target.push(symbol);
|
target.push(symbol);
|
||||||
@@ -153,13 +169,13 @@ exports.publish = function(data, opts) {
|
|||||||
|
|
||||||
return new Promise(function(resolve, reject) {
|
return new Promise(function(resolve, reject) {
|
||||||
process.stdout.write(
|
process.stdout.write(
|
||||||
JSON.stringify({
|
JSON.stringify({
|
||||||
symbols: symbols,
|
symbols: symbols,
|
||||||
defines: defines,
|
defines: defines,
|
||||||
typedefs: typedefs,
|
typedefs: typedefs,
|
||||||
externs: externs,
|
externs: externs,
|
||||||
base: base
|
base: base
|
||||||
}, null, 2));
|
}, null, 2));
|
||||||
});
|
});
|
||||||
|
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -4,7 +4,7 @@
|
|||||||
*/
|
*/
|
||||||
exports.defineTags = function(dictionary) {
|
exports.defineTags = function(dictionary) {
|
||||||
|
|
||||||
const classTag = dictionary.lookUp('class');
|
var classTag = dictionary.lookUp('class');
|
||||||
dictionary.defineTag('interface', {
|
dictionary.defineTag('interface', {
|
||||||
mustHaveValue: false,
|
mustHaveValue: false,
|
||||||
onTagged: function(doclet, tag) {
|
onTagged: function(doclet, tag) {
|
||||||
|
|||||||
4
config/ol-debug.json
Normal file
4
config/ol-debug.json
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
{
|
||||||
|
"exports": ["*"],
|
||||||
|
"umd": true
|
||||||
|
}
|
||||||
38
config/ol.json
Normal file
38
config/ol.json
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
{
|
||||||
|
"exports": ["*"],
|
||||||
|
"umd": true,
|
||||||
|
"compile": {
|
||||||
|
"externs": [
|
||||||
|
"externs/bingmaps.js",
|
||||||
|
"externs/cartodb.js",
|
||||||
|
"externs/closure-compiler.js",
|
||||||
|
"externs/esrijson.js",
|
||||||
|
"externs/geojson.js",
|
||||||
|
"externs/oli.js",
|
||||||
|
"externs/olx.js",
|
||||||
|
"externs/proj4js.js",
|
||||||
|
"externs/tilejson.js",
|
||||||
|
"externs/topojson.js"
|
||||||
|
],
|
||||||
|
"define": [
|
||||||
|
"ol.DEBUG_WEBGL=false"
|
||||||
|
],
|
||||||
|
"jscomp_error": [
|
||||||
|
"*"
|
||||||
|
],
|
||||||
|
"jscomp_off": [
|
||||||
|
"lintChecks",
|
||||||
|
"analyzerChecks"
|
||||||
|
],
|
||||||
|
"extra_annotation_name": [
|
||||||
|
"api", "observable"
|
||||||
|
],
|
||||||
|
"rewrite_polyfills": "false",
|
||||||
|
"compilation_level": "ADVANCED",
|
||||||
|
"warning_level": "VERBOSE",
|
||||||
|
"use_types_for_optimization": true,
|
||||||
|
"manage_closure_dependencies": true,
|
||||||
|
"create_source_map": "build/ol.js.map",
|
||||||
|
"source_map_format": "V3"
|
||||||
|
}
|
||||||
|
}
|
||||||
3
config/readme.md
Normal file
3
config/readme.md
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# Configuration Files
|
||||||
|
|
||||||
|
This directory includes configuration files for the build scripts in and documentation templates.
|
||||||
@@ -1,64 +0,0 @@
|
|||||||
{
|
|
||||||
"compilerOptions": {
|
|
||||||
/* Basic Options */
|
|
||||||
"target": "ES5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
|
|
||||||
"module": "es2015", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
|
|
||||||
// "lib": [], /* Specify library files to be included in the compilation. */
|
|
||||||
"allowJs": true, /* Allow javascript files to be compiled. */
|
|
||||||
// "checkJs": true, /* Report errors in .js files. */
|
|
||||||
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
|
|
||||||
// "declaration": true, /* Generates corresponding '.d.ts' file. */
|
|
||||||
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
|
|
||||||
"sourceMap": true, /* Generates corresponding '.map' file. */
|
|
||||||
// "outFile": "./", /* Concatenate and emit output to single file. */
|
|
||||||
"outDir": "../build/ol", /* Redirect output structure to the directory. */
|
|
||||||
// "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
|
|
||||||
// "composite": true, /* Enable project compilation */
|
|
||||||
// "removeComments": true, /* Do not emit comments to output. */
|
|
||||||
// "noEmit": true, /* Do not emit outputs. */
|
|
||||||
"importHelpers": false, /* Import emit helpers from 'tslib'. */
|
|
||||||
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
|
|
||||||
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
|
|
||||||
|
|
||||||
/* Strict Type-Checking Options */
|
|
||||||
"strict": false, /* Enable all strict type-checking options. */
|
|
||||||
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
|
|
||||||
// "strictNullChecks": true, /* Enable strict null checks. */
|
|
||||||
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
|
|
||||||
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
|
|
||||||
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
|
|
||||||
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
|
|
||||||
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
|
|
||||||
|
|
||||||
/* Additional Checks */
|
|
||||||
// "noUnusedLocals": true, /* Report errors on unused locals. */
|
|
||||||
// "noUnusedParameters": true, /* Report errors on unused parameters. */
|
|
||||||
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
|
|
||||||
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
|
|
||||||
|
|
||||||
/* Module Resolution Options */
|
|
||||||
"moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
|
|
||||||
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
|
|
||||||
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
|
|
||||||
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
|
|
||||||
// "typeRoots": [], /* List of folders to include type definitions from. */
|
|
||||||
// "types": [], /* Type declaration files to be included in compilation. */
|
|
||||||
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
|
|
||||||
"esModuleInterop": false, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
|
|
||||||
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
|
|
||||||
|
|
||||||
/* Source Map Options */
|
|
||||||
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
|
|
||||||
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
|
|
||||||
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
|
|
||||||
"inlineSources": false /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
|
|
||||||
|
|
||||||
/* Experimental Options */
|
|
||||||
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
|
|
||||||
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
|
|
||||||
},
|
|
||||||
"include": [
|
|
||||||
"../build/ol/src/**/*.js"
|
|
||||||
],
|
|
||||||
"exclude": []
|
|
||||||
}
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
const path = require('path');
|
|
||||||
module.exports = {
|
|
||||||
entry: './build/index.js',
|
|
||||||
devtool: 'source-map',
|
|
||||||
mode: 'production',
|
|
||||||
output: {
|
|
||||||
path: path.resolve('./build/legacy'),
|
|
||||||
filename: 'ol.js',
|
|
||||||
library: 'ol',
|
|
||||||
libraryTarget: 'umd',
|
|
||||||
libraryExport: 'default'
|
|
||||||
}
|
|
||||||
};
|
|
||||||
@@ -26,43 +26,7 @@
|
|||||||
text-align: center;
|
text-align: center;
|
||||||
margin: 1px;
|
margin: 1px;
|
||||||
will-change: contents, width;
|
will-change: contents, width;
|
||||||
transition: all 0.25s;
|
|
||||||
}
|
}
|
||||||
.ol-scale-bar {
|
|
||||||
position: absolute;
|
|
||||||
bottom: 8px;
|
|
||||||
left: 8px;
|
|
||||||
}
|
|
||||||
.ol-scale-step-marker {
|
|
||||||
width: 1px;
|
|
||||||
height: 15px;
|
|
||||||
background-color: #000000;
|
|
||||||
float: right;
|
|
||||||
z-Index: 10;
|
|
||||||
}
|
|
||||||
.ol-scale-step-text {
|
|
||||||
position: absolute;
|
|
||||||
bottom: -5px;
|
|
||||||
font-size: 12px;
|
|
||||||
z-Index: 11;
|
|
||||||
color: #000000;
|
|
||||||
text-shadow: -2px 0 #FFFFFF, 0 2px #FFFFFF, 2px 0 #FFFFFF, 0 -2px #FFFFFF;
|
|
||||||
}
|
|
||||||
.ol-scale-text {
|
|
||||||
position: absolute;
|
|
||||||
font-size: 14px;
|
|
||||||
text-align: center;
|
|
||||||
bottom: 25px;
|
|
||||||
color: #000000;
|
|
||||||
text-shadow: -2px 0 #FFFFFF, 0 2px #FFFFFF, 2px 0 #FFFFFF, 0 -2px #FFFFFF;
|
|
||||||
}
|
|
||||||
.ol-scale-singlebar {
|
|
||||||
position: relative;
|
|
||||||
height: 10px;
|
|
||||||
z-Index: 9;
|
|
||||||
border: 1px solid black;
|
|
||||||
}
|
|
||||||
|
|
||||||
.ol-overlay-container {
|
.ol-overlay-container {
|
||||||
will-change: left,right,top,bottom;
|
will-change: left,right,top,bottom;
|
||||||
}
|
}
|
||||||
@@ -80,10 +44,10 @@
|
|||||||
}
|
}
|
||||||
.ol-selectable {
|
.ol-selectable {
|
||||||
-webkit-touch-callout: default;
|
-webkit-touch-callout: default;
|
||||||
-webkit-user-select: text;
|
-webkit-user-select: auto;
|
||||||
-moz-user-select: text;
|
-moz-user-select: auto;
|
||||||
-ms-user-select: text;
|
-ms-user-select: auto;
|
||||||
user-select: text;
|
user-select: auto;
|
||||||
}
|
}
|
||||||
.ol-grabbing {
|
.ol-grabbing {
|
||||||
cursor: -webkit-grabbing;
|
cursor: -webkit-grabbing;
|
||||||
@@ -127,6 +91,11 @@
|
|||||||
right: .5em;
|
right: .5em;
|
||||||
top: .5em;
|
top: .5em;
|
||||||
}
|
}
|
||||||
|
@media print {
|
||||||
|
.ol-control {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
.ol-control button {
|
.ol-control button {
|
||||||
display: block;
|
display: block;
|
||||||
@@ -210,6 +179,9 @@
|
|||||||
.ol-attribution.ol-collapsed ul {
|
.ol-attribution.ol-collapsed ul {
|
||||||
display: none;
|
display: none;
|
||||||
}
|
}
|
||||||
|
.ol-attribution.ol-logo-only ul {
|
||||||
|
display: block;
|
||||||
|
}
|
||||||
.ol-attribution:not(.ol-collapsed) {
|
.ol-attribution:not(.ol-collapsed) {
|
||||||
background: rgba(255,255,255,0.8);
|
background: rgba(255,255,255,0.8);
|
||||||
}
|
}
|
||||||
@@ -220,10 +192,17 @@
|
|||||||
height: 1.1em;
|
height: 1.1em;
|
||||||
line-height: 1em;
|
line-height: 1em;
|
||||||
}
|
}
|
||||||
|
.ol-attribution.ol-logo-only {
|
||||||
|
background: transparent;
|
||||||
|
bottom: .4em;
|
||||||
|
height: 1.1em;
|
||||||
|
line-height: 1em;
|
||||||
|
}
|
||||||
.ol-attribution.ol-uncollapsible img {
|
.ol-attribution.ol-uncollapsible img {
|
||||||
margin-top: -.2em;
|
margin-top: -.2em;
|
||||||
max-height: 1.6em;
|
max-height: 1.6em;
|
||||||
}
|
}
|
||||||
|
.ol-attribution.ol-logo-only button,
|
||||||
.ol-attribution.ol-uncollapsible button {
|
.ol-attribution.ol-uncollapsible button {
|
||||||
display: none;
|
display: none;
|
||||||
}
|
}
|
||||||
@@ -43,7 +43,7 @@ Unknown `serverType` configured.
|
|||||||
|
|
||||||
### 10
|
### 10
|
||||||
|
|
||||||
The default `geometryFunction` can only handle `ol/geom/Point` geometries.
|
The default `geometryFunction` can only handle `ol.geom.Point` geometries.
|
||||||
|
|
||||||
### 11
|
### 11
|
||||||
|
|
||||||
@@ -111,7 +111,7 @@ Features for `updates` must have an id set by the feature reader or `ol.Feature#
|
|||||||
|
|
||||||
### 28
|
### 28
|
||||||
|
|
||||||
`renderMode` must be `'image'` or `'hybrid'`.
|
`renderMode` must be `'image'`, `'hybrid'` or `'vector'`.
|
||||||
|
|
||||||
### 29
|
### 29
|
||||||
|
|
||||||
@@ -139,7 +139,7 @@ Invalid geometry layout. Must be `XY`, `XYZ`, `XYM` or `XYZM`.
|
|||||||
|
|
||||||
### 36
|
### 36
|
||||||
|
|
||||||
Unknown SRS type. Expected `"name"`.
|
Unknown SRS type. Expected `"name"` or `"EPSG"`.
|
||||||
|
|
||||||
### 37
|
### 37
|
||||||
|
|
||||||
@@ -165,6 +165,14 @@ Expected an `ol.style.Style` or an array of `ol.style.Style`.
|
|||||||
|
|
||||||
Expected `layers` to be an array or an `ol.Collection`.
|
Expected `layers` to be an array or an `ol.Collection`.
|
||||||
|
|
||||||
|
### 44
|
||||||
|
|
||||||
|
`logo.href` should be a string.
|
||||||
|
|
||||||
|
### 45
|
||||||
|
|
||||||
|
`logo.src` should be a string.
|
||||||
|
|
||||||
### 46
|
### 46
|
||||||
|
|
||||||
Incorrect format for `renderer` option.
|
Incorrect format for `renderer` option.
|
||||||
@@ -220,11 +228,3 @@ Duplicate item added to a unique collection. For example, it may be that you tr
|
|||||||
### 59
|
### 59
|
||||||
|
|
||||||
Invalid command found in the PBF. This indicates that the loaded vector tile may be corrupt.
|
Invalid command found in the PBF. This indicates that the loaded vector tile may be corrupt.
|
||||||
|
|
||||||
### 60
|
|
||||||
|
|
||||||
Missing or invalid `size`.
|
|
||||||
|
|
||||||
### 61
|
|
||||||
|
|
||||||
Cannot determine IIIF Image API version from provided image information JSON.
|
|
||||||
|
|||||||
193
doc/faq.md
193
doc/faq.md
@@ -5,7 +5,7 @@ layout: doc.hbs
|
|||||||
|
|
||||||
# Frequently Asked Questions (FAQ)
|
# Frequently Asked Questions (FAQ)
|
||||||
|
|
||||||
Certain questions arise more often than others when users ask for help. This
|
Certain questions arise more often than others when users ask for help. This
|
||||||
document tries to list some of the common questions that frequently get asked,
|
document tries to list some of the common questions that frequently get asked,
|
||||||
e.g. on [Stack Overflow](http://stackoverflow.com/questions/tagged/openlayers).
|
e.g. on [Stack Overflow](http://stackoverflow.com/questions/tagged/openlayers).
|
||||||
|
|
||||||
@@ -21,7 +21,10 @@ Table of contents:
|
|||||||
* [Why aren't there any features in my source?](#why-aren-t-there-any-features-in-my-source-)
|
* [Why aren't there any features in my source?](#why-aren-t-there-any-features-in-my-source-)
|
||||||
* [How do I force a re-render of the map?](#how-do-i-force-a-re-render-of-the-map-)
|
* [How do I force a re-render of the map?](#how-do-i-force-a-re-render-of-the-map-)
|
||||||
* [Why are my features not found?](#why-are-my-features-not-found-)
|
* [Why are my features not found?](#why-are-my-features-not-found-)
|
||||||
* [Why is zooming or clicking off, inaccurate?](#user-content-why-is-zooming-or-clicking-off-inaccurate)
|
* [How do I create a custom build of OpenLayers?](#how-do-i-create-a-custom-build-of-openlayers-)
|
||||||
|
* [Do I need to write my own code using Closure library?](#do-i-need-to-write-my-own-code-using-closure-library-)
|
||||||
|
* [Do I need to compress my code with Closure compiler?](#do-i-need-to-compress-my-code-with-closure-compiler-)
|
||||||
|
|
||||||
|
|
||||||
## What projection is OpenLayers using?
|
## What projection is OpenLayers using?
|
||||||
|
|
||||||
@@ -54,12 +57,9 @@ The projection of your map can be set through the `view`-property. Here are some
|
|||||||
examples:
|
examples:
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
import Map from 'ol/Map';
|
|
||||||
import View from 'ol/View';
|
|
||||||
|
|
||||||
// OpenLayers comes with support for the World Geodetic System 1984, EPSG:4326:
|
// OpenLayers comes with support for the World Geodetic System 1984, EPSG:4326:
|
||||||
const map = new Map({
|
var map = new ol.Map({
|
||||||
view: new View({
|
view: new ol.View({
|
||||||
projection: 'EPSG:4326'
|
projection: 'EPSG:4326'
|
||||||
// other view properties like map center etc.
|
// other view properties like map center etc.
|
||||||
})
|
})
|
||||||
@@ -68,29 +68,24 @@ const map = new Map({
|
|||||||
```
|
```
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
import Map from 'ol/Map';
|
// To use other projections, you have to register the projection in OpenLayers:
|
||||||
import View from 'ol/View';
|
|
||||||
import proj4 from 'proj4';
|
|
||||||
import {register} from 'ol/proj/proj4';
|
|
||||||
import {get as getProjection} from 'ol/proj';
|
|
||||||
|
|
||||||
// To use other projections, you have to register the projection in OpenLayers.
|
|
||||||
// This can easily be done with [https://proj4js.org](proj4)
|
|
||||||
//
|
//
|
||||||
// By default OpenLayers does not know about the EPSG:21781 (Swiss) projection.
|
// By default OpenLayers does not know about the EPSG:21781 (Swiss) projection.
|
||||||
// So we create a projection instance for EPSG:21781 and pass it to
|
// So we create a projection instance for EPSG:21781 and pass it to
|
||||||
// register to make it available to the library for lookup by its
|
// ol.proj.addProjection to make it available to the library for lookup by its
|
||||||
// code.
|
// code.
|
||||||
proj4.defs('EPSG:21781',
|
var swissProjection = new ol.proj.Projection({
|
||||||
'+proj=somerc +lat_0=46.95240555555556 +lon_0=7.439583333333333 +k_0=1 ' +
|
code: 'EPSG:21781',
|
||||||
'+x_0=600000 +y_0=200000 +ellps=bessel ' +
|
// The extent is used to determine zoom level 0. Recommended values for a
|
||||||
'+towgs84=660.077,13.551,369.344,2.484,1.783,2.939,5.66 +units=m +no_defs');
|
// projection's validity extent can be found at https://epsg.io/.
|
||||||
register(proj4);
|
extent: [485869.5728, 76443.1884, 837076.5648, 299941.7864],
|
||||||
const swissProjection = getProjection('EPSG:21781');
|
units: 'm'
|
||||||
|
});
|
||||||
|
ol.proj.addProjection(swissProjection);
|
||||||
|
|
||||||
// we can now use the projection:
|
// we can now use the projection:
|
||||||
const map = new Map({
|
var map = new ol.Map({
|
||||||
view: new View({
|
view: new ol.View({
|
||||||
projection: swissProjection
|
projection: swissProjection
|
||||||
// other view properties like map center etc.
|
// other view properties like map center etc.
|
||||||
})
|
})
|
||||||
@@ -113,20 +108,15 @@ coordinates for the center have to be provided in that projection. Chances are
|
|||||||
that your map looks like this:
|
that your map looks like this:
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
import Map from 'ol/Map';
|
var washingtonLonLat = [-77.036667, 38.895];
|
||||||
import View from 'ol/View';
|
var map = new ol.Map({
|
||||||
import TileLayer from 'ol/layer/Tile';
|
|
||||||
import OSM from 'ol/source/OSM';
|
|
||||||
|
|
||||||
const washingtonLonLat = [-77.036667, 38.895];
|
|
||||||
const map = new Map({
|
|
||||||
layers: [
|
layers: [
|
||||||
new TileLayer({
|
new ol.layer.Tile({
|
||||||
source: new OSM()
|
source: new ol.source.OSM()
|
||||||
})
|
})
|
||||||
],
|
],
|
||||||
target: 'map',
|
target: 'map',
|
||||||
view: new View({
|
view: new ol.View({
|
||||||
center: washingtonLonLat,
|
center: washingtonLonLat,
|
||||||
zoom: 12
|
zoom: 12
|
||||||
})
|
})
|
||||||
@@ -142,38 +132,31 @@ The solution is easy: Provide the coordinates projected into Web Mercator.
|
|||||||
OpenLayers has some helpful utility methods to assist you:
|
OpenLayers has some helpful utility methods to assist you:
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
import Map from 'ol/Map';
|
var washingtonLonLat = [-77.036667, 38.895];
|
||||||
import View from 'ol/View';
|
var washingtonWebMercator = ol.proj.fromLonLat(washingtonLonLat);
|
||||||
import TileLayer from 'ol/layer/Tile';
|
|
||||||
import OSM from 'ol/source/OSM';
|
|
||||||
import {fromLonLat} from 'ol/proj';
|
|
||||||
|
|
||||||
const washingtonLonLat = [-77.036667, 38.895];
|
var map = new ol.Map({
|
||||||
const washingtonWebMercator = fromLonLat(washingtonLonLat);
|
|
||||||
|
|
||||||
const map = new Map({
|
|
||||||
layers: [
|
layers: [
|
||||||
new TileLayer({
|
new ol.layer.Tile({
|
||||||
source: new OSM()
|
source: new ol.source.OSM()
|
||||||
})
|
})
|
||||||
],
|
],
|
||||||
target: 'map',
|
target: 'map',
|
||||||
view: new View({
|
view: new ol.View({
|
||||||
center: washingtonWebMercator,
|
center: washingtonWebMercator,
|
||||||
zoom: 8
|
zoom: 8
|
||||||
})
|
})
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
The method `fromLonLat()` is available from version 3.5 onwards.
|
The method `ol.proj.fromLonLat()` is available from version 3.5 onwards.
|
||||||
|
|
||||||
If you told OpenLayers about a custom projection (see above), you can use the
|
If you told OpenLayers about a custom projection (see above), you can use the
|
||||||
following method to transform a coordinate from WGS84 to your projection:
|
following method to transform a coordinate from WGS84 to your projection:
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
import {transform} from 'ol/proj';
|
|
||||||
// assuming that OpenLayers knows about EPSG:21781, see above
|
// assuming that OpenLayers knows about EPSG:21781, see above
|
||||||
const swissCoord = transform([8.23, 46.86], 'EPSG:4326', 'EPSG:21781');
|
var swissCoord = ol.proj.transform([8.23, 46.86], 'EPSG:4326', 'EPSG:21781');
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
@@ -210,24 +193,18 @@ So the next step would be to put the decimal coordinates into an array and use
|
|||||||
it as center:
|
it as center:
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
import Map from 'ol/Map';
|
var schladming = [47.394167, 13.689167]; // caution partner, read on...
|
||||||
import View from 'ol/View';
|
|
||||||
import TileLayer from 'ol/layer/Tile';
|
|
||||||
import OSM from 'ol/source/OSM';
|
|
||||||
import {fromLonLat} from 'ol/proj';
|
|
||||||
|
|
||||||
const schladming = [47.394167, 13.689167]; // caution partner, read on...
|
|
||||||
// since we are using OSM, we have to transform the coordinates...
|
// since we are using OSM, we have to transform the coordinates...
|
||||||
const schladmingWebMercator = fromLonLat(schladming);
|
var schladmingWebMercator = ol.proj.fromLonLat(schladming);
|
||||||
|
|
||||||
const map = new Map({
|
var map = new ol.Map({
|
||||||
layers: [
|
layers: [
|
||||||
new TileLayer({
|
new ol.layer.Tile({
|
||||||
source: new OSM()
|
source: new ol.source.OSM()
|
||||||
})
|
})
|
||||||
],
|
],
|
||||||
target: 'map',
|
target: 'map',
|
||||||
view: new View({
|
view: new ol.View({
|
||||||
center: schladmingWebMercator,
|
center: schladmingWebMercator,
|
||||||
zoom: 9
|
zoom: 9
|
||||||
})
|
})
|
||||||
@@ -246,24 +223,18 @@ e.g. try to change the map center.
|
|||||||
Ok, then let's flip the coordinates:
|
Ok, then let's flip the coordinates:
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
import Map from 'ol/Map';
|
var schladming = [13.689167, 47.394167]; // longitude first, then latitude
|
||||||
import View from 'ol/View';
|
|
||||||
import TileLayer from 'ol/layer/Tile';
|
|
||||||
import OSM from 'ol/source/OSM';
|
|
||||||
import {fromLonLat} from 'ol/proj';
|
|
||||||
|
|
||||||
const schladming = [13.689167, 47.394167]; // longitude first, then latitude
|
|
||||||
// since we are using OSM, we have to transform the coordinates...
|
// since we are using OSM, we have to transform the coordinates...
|
||||||
const schladmingWebMercator = fromLonLat(schladming);
|
var schladmingWebMercator = ol.proj.fromLonLat(schladming);
|
||||||
|
|
||||||
const map = new Map({
|
var map = new ol.Map({
|
||||||
layers: [
|
layers: [
|
||||||
new TileLayer({
|
new ol.layer.Tile({
|
||||||
source: new OSM()
|
source: new ol.source.OSM()
|
||||||
})
|
})
|
||||||
],
|
],
|
||||||
target: 'map',
|
target: 'map',
|
||||||
view: new View({
|
view: new ol.View({
|
||||||
center: schladmingWebMercator,
|
center: schladmingWebMercator,
|
||||||
zoom: 9
|
zoom: 9
|
||||||
})
|
})
|
||||||
@@ -277,7 +248,7 @@ first, and then the latitude. This behaviour is the same as we had in OpenLayers
|
|||||||
2, and it actually makes sense because of the natural axis order in WGS84.
|
2, and it actually makes sense because of the natural axis order in WGS84.
|
||||||
|
|
||||||
If you cannot remember the correct order, just have a look at the method name
|
If you cannot remember the correct order, just have a look at the method name
|
||||||
we used: `fromLonLat`; even there we hint that we expect longitude
|
we used: `ol.proj.fromLonLat`; even there we hint that we expect longitude
|
||||||
first, and then latitude.
|
first, and then latitude.
|
||||||
|
|
||||||
|
|
||||||
@@ -287,11 +258,8 @@ Suppose you want to load a KML file and display the contained features on the
|
|||||||
map. Code like the following could be used:
|
map. Code like the following could be used:
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
import VectorLayer from 'ol/layer/Vector';
|
var vector = new ol.layer.Vector({
|
||||||
import KMLSource from 'ol/source/KML';
|
source: new ol.source.KML({
|
||||||
|
|
||||||
const vector = new VectorLayer({
|
|
||||||
source: new KMLSource({
|
|
||||||
projection: 'EPSG:3857',
|
projection: 'EPSG:3857',
|
||||||
url: 'data/kml/2012-02-10.kml'
|
url: 'data/kml/2012-02-10.kml'
|
||||||
})
|
})
|
||||||
@@ -302,16 +270,13 @@ You may ask yourself how many features are in that KML, and try something like
|
|||||||
the following:
|
the following:
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
import VectorLayer from 'ol/layer/Vector';
|
var vector = new ol.layer.Vector({
|
||||||
import KMLSource from 'ol/source/KML';
|
source: new ol.source.KML({
|
||||||
|
|
||||||
const vector = new VectorLayer({
|
|
||||||
source: new KMLSource({
|
|
||||||
projection: 'EPSG:3857',
|
projection: 'EPSG:3857',
|
||||||
url: 'data/kml/2012-02-10.kml'
|
url: 'data/kml/2012-02-10.kml'
|
||||||
})
|
})
|
||||||
});
|
});
|
||||||
const numFeatures = vector.getSource().getFeatures().length;
|
var numFeatures = vector.getSource().getFeatures().length;
|
||||||
console.log("Count right after construction: " + numFeatures);
|
console.log("Count right after construction: " + numFeatures);
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -323,9 +288,9 @@ been populated with features), you should use an event listener function on the
|
|||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
vector.getSource().on('change', function(evt){
|
vector.getSource().on('change', function(evt){
|
||||||
const source = evt.target;
|
var source = evt.target;
|
||||||
if (source.getState() === 'ready') {
|
if (source.getState() === 'ready') {
|
||||||
const numFeatures = source.getFeatures().length;
|
var numFeatures = source.getFeatures().length;
|
||||||
console.log("Count after change: " + numFeatures);
|
console.log("Count after change: " + numFeatures);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -354,17 +319,16 @@ map.renderSync();
|
|||||||
|
|
||||||
## Why are my features not found?
|
## Why are my features not found?
|
||||||
|
|
||||||
You are using `Map#forEachFeatureAtPixel` or `Map#hasFeatureAtPixel`, but
|
You are using `ol.Map#forEachFeatureAtPixel` or `ol.Map#hasFeatureAtPixel`, but
|
||||||
it sometimes does not work for large icons or labels? The *hit detection* only
|
it sometimes does not work for large icons or labels? The *hit detection* only
|
||||||
checks features that are within a certain distance of the given position. For large
|
checks features that are within a certain distance of the given position. For large
|
||||||
icons, the actual geometry of a feature might be too far away and is not considered.
|
icons, the actual geometry of a feature might be too far away and is not considered.
|
||||||
|
|
||||||
In this case, set the `renderBuffer` property of `VectorLayer` (the default value is 100px):
|
In this case, set the `renderBuffer` property of `ol.layer.Vector` (the default
|
||||||
|
value is 100px):
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
import VectorLayer from 'ol/layer/Vector';
|
var vectorLayer = new ol.layer.Vector({
|
||||||
|
|
||||||
const vectorLayer = new VectorLayer({
|
|
||||||
...
|
...
|
||||||
renderBuffer: 200
|
renderBuffer: 200
|
||||||
});
|
});
|
||||||
@@ -372,29 +336,36 @@ const vectorLayer = new VectorLayer({
|
|||||||
|
|
||||||
The recommended value is the size of the largest symbol, line width or label.
|
The recommended value is the size of the largest symbol, line width or label.
|
||||||
|
|
||||||
## Why is zooming or clicking in the map off/inaccurate?
|
## How do I create a custom build of OpenLayers?
|
||||||
|
|
||||||
OpenLayers does not update the map when the container element is resized. This can be caused by progressive updates
|
Please refer to the [official create custom builds tutorial](tutorials/custom-builds.html)
|
||||||
to CSS styles or manually resizing the map. When that happens, any interaction will become inaccurate: the map would zoom in and out, and end up not being centered on the pointer. This makes it hard to do certain interactions, e.g. selecting the desired feature.
|
which explains how to create a custom build of OpenLayers with just those parts
|
||||||
|
included that you want.
|
||||||
|
|
||||||
There is currently no built-in way to react to element's size changes, as [Resize Observer API](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver) is only implemented in Chrome.
|
|
||||||
|
|
||||||
There is however an easy to use [polyfill](https://github.com/que-etc/resize-observer-polyfill):
|
## Do I need to write my own code using Closure library?
|
||||||
|
|
||||||
```javascript
|
OpenLayers is built on top of the [Google Closure JavaScript
|
||||||
import Map from 'ol/Map';
|
library](https://developers.google.com/closure/library/), but this
|
||||||
import ResizeObserver from 'resize-observer-polyfill';
|
does not mean that you must use that library in your application code.
|
||||||
|
|
||||||
const mapElement = document.querySelector('#map')
|
OpenLayers should play well with all sorts of JavaScript libraries out there,
|
||||||
const map = new Map({
|
and you are in no way forced to use a specific one. Choose one that looks
|
||||||
target: mapElement
|
right for you.
|
||||||
})
|
|
||||||
|
|
||||||
|
## Do I need to compress my code with Closure compiler?
|
||||||
|
|
||||||
|
No, you don't need to do compress your code with the [Google Closure
|
||||||
|
compiler](https://developers.google.com/closure/compiler/).
|
||||||
|
|
||||||
|
It may be a good choice though, because when your application code and the
|
||||||
|
OpenLayers source code is compiled together using closure compiler, the
|
||||||
|
resulting build will most probably be the smallest in terms of byte-size. For
|
||||||
|
more details refer to the
|
||||||
|
[compile application and OpenLayers together tutorial](tutorials/closure.html).
|
||||||
|
|
||||||
|
If you don't want to use the closure compiler, or you can't, you are not at all
|
||||||
|
forced to use it.
|
||||||
|
|
||||||
const sizeObserver = new ResizeObserver(() => {
|
|
||||||
map.updateSize()
|
|
||||||
})
|
|
||||||
sizeObserver.observe(mapElement)
|
|
||||||
|
|
||||||
// called when the map is destroyed
|
|
||||||
// sizeObserver.disconnect()
|
|
||||||
```
|
|
||||||
|
|||||||
@@ -5,11 +5,6 @@ layout: doc.hbs
|
|||||||
|
|
||||||
# Quick Start
|
# Quick Start
|
||||||
|
|
||||||
This primer shows you how to put a simple map on a web page.
|
|
||||||
|
|
||||||
**For production, we strongly recommend bundling the application together with its dependencies, as explained in the [Building an OpenLayers Application](./tutorials/bundle.html) tutorial.**
|
|
||||||
|
|
||||||
|
|
||||||
## Put a map on a page
|
## Put a map on a page
|
||||||
|
|
||||||
Below you'll find a complete working example. Create a new file, copy in the contents below, and open in a browser:
|
Below you'll find a complete working example. Create a new file, copy in the contents below, and open in a browser:
|
||||||
@@ -18,14 +13,14 @@ Below you'll find a complete working example. Create a new file, copy in the co
|
|||||||
<!doctype html>
|
<!doctype html>
|
||||||
<html lang="en">
|
<html lang="en">
|
||||||
<head>
|
<head>
|
||||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/openlayers/openlayers.github.io@master/en/{{ latest }}/css/ol.css" type="text/css">
|
<link rel="stylesheet" href="https://openlayers.org/en/{{ latest }}/css/ol.css" type="text/css">
|
||||||
<style>
|
<style>
|
||||||
.map {
|
.map {
|
||||||
height: 400px;
|
height: 400px;
|
||||||
width: 100%;
|
width: 100%;
|
||||||
}
|
}
|
||||||
</style>
|
</style>
|
||||||
<script src="https://cdn.jsdelivr.net/gh/openlayers/openlayers.github.io@master/en/{{ latest }}/build/ol.js"></script>
|
<script src="https://openlayers.org/en/{{ latest }}/build/ol.js" type="text/javascript"></script>
|
||||||
<title>OpenLayers example</title>
|
<title>OpenLayers example</title>
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
@@ -60,7 +55,7 @@ To include a map a web page you will need 3 things:
|
|||||||
### Include OpenLayers
|
### Include OpenLayers
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<script src="https://cdn.jsdelivr.net/gh/openlayers/openlayers.github.io@master/en/{{ latest }}/build/ol.js"></script>
|
<script src="https://openlayers.org/en/{{ latest }}/build/ol.js" type="text/javascript"></script>
|
||||||
```
|
```
|
||||||
|
|
||||||
The first part is to include the JavaScript library. For the purpose of this tutorial, here we simply point to the openlayers.org website to get the whole library. In a production environment, we would build a custom version of the library including only the module needed for our application.
|
The first part is to include the JavaScript library. For the purpose of this tutorial, here we simply point to the openlayers.org website to get the whole library. In a production environment, we would build a custom version of the library including only the module needed for our application.
|
||||||
@@ -130,7 +125,7 @@ The `layers: [ ... ]` array is used to define the list of layers available in th
|
|||||||
]
|
]
|
||||||
```
|
```
|
||||||
|
|
||||||
Layers in OpenLayers are defined with a type (Image, Tile or Vector) which contains a source. The source is the protocol used to get the map tiles.
|
Layers in OpenLayers are defined with a type (Image, Tile or Vector) which contains a source. The source is the protocol used to get the map tiles. You can consult the list of [available layer sources here](/en/{{ latest }}/apidoc/ol.source.html)
|
||||||
|
|
||||||
The next part of the `Map` object is the `View`. The view allows to specify the center, resolution, and rotation of the map. The simplest way to define a view is to define a center point and a zoom level. Note that zoom level 0 is zoomed out.
|
The next part of the `Map` object is the `View`. The view allows to specify the center, resolution, and rotation of the map. The simplest way to define a view is to define a center point and a zoom level. Note that zoom level 0 is zoomed out.
|
||||||
|
|
||||||
|
|||||||
@@ -1,49 +0,0 @@
|
|||||||
---
|
|
||||||
title: Introduction
|
|
||||||
layout: doc.hbs
|
|
||||||
---
|
|
||||||
|
|
||||||
# Introduction
|
|
||||||
|
|
||||||
## Objectives
|
|
||||||
|
|
||||||
OpenLayers is a modular, high-performance, feature-packed library for displaying and interacting with maps and geospatial data.
|
|
||||||
|
|
||||||
The library comes with built-in support for a wide range of commercial and free image and vector tile sources, and the most popular open and proprietary vector data formats. With OpenLayers's map projection support, data can be in any projection.
|
|
||||||
|
|
||||||
## Public API
|
|
||||||
|
|
||||||
OpenLayers is available as [`ol` npm package](https://npmjs.com/package/ol), which provides all modules of the officially supported [API](../../apidoc).
|
|
||||||
|
|
||||||
## Renderers and Browser Support
|
|
||||||
|
|
||||||
By default, OpenLayers uses a performance optimized Canvas renderer.
|
|
||||||
|
|
||||||
OpenLayers runs on all modern browsers that support [HTML5](https://html.spec.whatwg.org/multipage/) and [ECMAScript 5](http://www.ecma-international.org/ecma-262/5.1/). This includes Chrome, Firefox, Safari and Edge. For older browsers and platforms like Internet Explorer (down to version 9) and Android 4.x, [polyfills](http://polyfill.io), the application bundle needs to be transpiled (e.g. using [Babel](https://babeljs.io)) and bundled with polyfills for `requestAnimationFrame`, `Element.prototype.classList` and `URL`.
|
|
||||||
|
|
||||||
The library is intended for use on both desktop/laptop and mobile devices, and supports pointer and touch interactions.
|
|
||||||
|
|
||||||
## Module and Naming Conventions
|
|
||||||
|
|
||||||
OpenLayers modules with CamelCase names provide classes as default exports, and may contain additional constants or functions as named exports:
|
|
||||||
|
|
||||||
```js
|
|
||||||
import Map from 'ol/Map';
|
|
||||||
import View from 'ol/View';
|
|
||||||
```
|
|
||||||
|
|
||||||
Class hierarchies grouped by their parent are provided in a subfolder of the package, e.g. `layer/`.
|
|
||||||
|
|
||||||
For convenience, these are also available as named exports, e.g.
|
|
||||||
|
|
||||||
```js
|
|
||||||
import {Map, View} from 'ol';
|
|
||||||
import {Tile, Vector} from 'ol/layer';
|
|
||||||
```
|
|
||||||
|
|
||||||
In addition to these re-exported classes, modules with lowercase names also provide constants or functions as named exports:
|
|
||||||
|
|
||||||
```js
|
|
||||||
import {getUid} from 'ol';
|
|
||||||
import {fromLonLat} from 'ol/proj';
|
|
||||||
```
|
|
||||||
87
doc/tutorials/browserify.md
Normal file
87
doc/tutorials/browserify.md
Normal file
@@ -0,0 +1,87 @@
|
|||||||
|
---
|
||||||
|
title: Basic project setup using NPM and Browserify
|
||||||
|
layout: doc.hbs
|
||||||
|
---
|
||||||
|
|
||||||
|
# Introduction
|
||||||
|
|
||||||
|
When going beyond modifying existing examples you might be looking for a way to setup your own code with dependency management together with external dependencies like OpenLayers.
|
||||||
|
|
||||||
|
This tutorial serves as a suggested project setup using NPM and Browserify for the most basic needs. There are several other options, and in particular you might be interested in a more modern one (ES2015) [using Webpack with OpenLayers](https://gist.github.com/tschaub/79025aef325cd2837364400a105405b8).
|
||||||
|
|
||||||
|
## Initial steps
|
||||||
|
|
||||||
|
Create a new empty directory for your project and navigate to it by running `mkdir new-project && cd new-project`. Initialize your project using `npm init` and answer the questions asked.
|
||||||
|
|
||||||
|
Add OpenLayers as dependency to your application with `npm install --save ol`.
|
||||||
|
|
||||||
|
At this point you can ask NPM to add required development dependencies by running
|
||||||
|
```
|
||||||
|
npm install --save-dev cssify browserify cssify http-server uglify-js watchify
|
||||||
|
npm install --save-dev babelify babel-plugin-transform-es2015-modules-commonjs
|
||||||
|
```
|
||||||
|
We will be using `cssify` to include the css definitions required by OpenLayers in our bundle. `watchify`, `http-server` and `uglify-js` are used to monitor for changes and to build into a minified bundle. `babelify` and `babel-plugin-transform-es2015-modules-commonjs` are used to make the `ol` package, which was created using ES2015 modules, work with CommonJS.
|
||||||
|
|
||||||
|
## Application code and index.html
|
||||||
|
|
||||||
|
Place your application code in `index.js`. Here is a simple starting point:
|
||||||
|
|
||||||
|
```js
|
||||||
|
require('ol/ol.css');
|
||||||
|
var ol_Map = require('ol/map').default;
|
||||||
|
var ol_layer_Tile = require('ol/layer/tile').default;
|
||||||
|
var ol_source_OSM = require('ol/source/osm').default;
|
||||||
|
var ol_View = require('ol/view').default;
|
||||||
|
|
||||||
|
var map = new ol_Map({
|
||||||
|
target: 'map',
|
||||||
|
layers: [
|
||||||
|
new ol_layer_Tile({
|
||||||
|
source: new ol_source_OSM()
|
||||||
|
})
|
||||||
|
],
|
||||||
|
view: new ol_View({
|
||||||
|
center: [0, 0],
|
||||||
|
zoom: 0
|
||||||
|
})
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
You will also need an `ìndex.html` file that will use your bundle. Here is a simple example:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<title>Using Browserify with OpenLayers</title>
|
||||||
|
<style>
|
||||||
|
#map {
|
||||||
|
width: 400px;
|
||||||
|
height: 250px;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="map"></div>
|
||||||
|
<script src="bundle.js"></script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Creating a bundle
|
||||||
|
|
||||||
|
With simple scripts you can introduce the commands `npm run build` and `npm start` to manually build your bundle and watch for changes, respectively. Add the following to the script section in `package.json`:
|
||||||
|
|
||||||
|
```json
|
||||||
|
"scripts": {
|
||||||
|
"start": "watchify index.js -g cssify --outfile bundle.js & http-server",
|
||||||
|
"build": "browserify -g cssify index.js | uglifyjs --compress --output bundle.js"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
Now to test your application open http://localhost:8080/ in your browser. `watchify` will update `bundle.js` whenever you change something. You simply need to reload the page in your browser to see the changes.
|
||||||
|
```
|
||||||
|
$ npm start
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that `bundle.js` will contain your application code and all dependencies used in your application. From OpenLayers, it only contains the required components.
|
||||||
@@ -1,103 +0,0 @@
|
|||||||
---
|
|
||||||
title: Basic project setup using NPM and Parcel
|
|
||||||
layout: doc.hbs
|
|
||||||
---
|
|
||||||
|
|
||||||
# Introduction
|
|
||||||
|
|
||||||
Modern JavaScript works best when using and authoring modules. The recommended way of using OpenLayers is installing the [`ol`](https://npmjs.com/package/ol) package. This tutorial walks you through setting up a simple dev environment, which requires [node](https://nodejs.org) for everything to work.
|
|
||||||
|
|
||||||
In this tutorial, we will be using [Parcel](https://parceljs.org) to bundle our application. There are several other options, some of which are linked from the [README](https://npmjs.com/package/ol).
|
|
||||||
|
|
||||||
## Initial steps
|
|
||||||
|
|
||||||
Create a new empty directory for your project and navigate to it by running `mkdir new-project && cd new-project`. Initialize your project with
|
|
||||||
|
|
||||||
npm init
|
|
||||||
|
|
||||||
This will create a `package.json` file in your working directory. Add OpenLayers as dependency to your application with
|
|
||||||
|
|
||||||
npm install ol
|
|
||||||
|
|
||||||
At this point you can ask NPM to add required development dependencies by running
|
|
||||||
|
|
||||||
npm install --save-dev parcel-bundler
|
|
||||||
|
|
||||||
## Application code and index.html
|
|
||||||
|
|
||||||
Place your application code in `index.js`. Here is a simple starting point:
|
|
||||||
|
|
||||||
```js
|
|
||||||
import 'ol/ol.css';
|
|
||||||
import {Map, View} from 'ol';
|
|
||||||
import TileLayer from 'ol/layer/Tile';
|
|
||||||
import OSM from 'ol/source/OSM';
|
|
||||||
|
|
||||||
const map = new Map({
|
|
||||||
target: 'map',
|
|
||||||
layers: [
|
|
||||||
new TileLayer({
|
|
||||||
source: new OSM()
|
|
||||||
})
|
|
||||||
],
|
|
||||||
view: new View({
|
|
||||||
center: [0, 0],
|
|
||||||
zoom: 0
|
|
||||||
})
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
You will also need an `index.html` file that will use your bundle. Here is a simple example:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<!DOCTYPE html>
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta charset="utf-8">
|
|
||||||
<title>Using Parcel with OpenLayers</title>
|
|
||||||
<style>
|
|
||||||
#map {
|
|
||||||
width: 400px;
|
|
||||||
height: 250px;
|
|
||||||
}
|
|
||||||
</style>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<div id="map"></div>
|
|
||||||
<script src="./index.js"></script>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
```
|
|
||||||
|
|
||||||
## Creating a bundle
|
|
||||||
|
|
||||||
With two additional lines in `package.json` you can introduce the commands `npm run build` and `npm start` to manually build your bundle and watch for changes, respectively. The final `package.json` with the two additional commands `"start"` and `"build"` should look like this:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"name": "test",
|
|
||||||
"version": "1.0.0",
|
|
||||||
"description": "",
|
|
||||||
"main": "index.js",
|
|
||||||
"scripts": {
|
|
||||||
"test": "echo \"Error: no test specified\" && exit 1",
|
|
||||||
"start": "parcel index.html",
|
|
||||||
"build": "parcel build --public-url . index.html"
|
|
||||||
},
|
|
||||||
"author": "",
|
|
||||||
"license": "ISC"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
That's it. Now to run your application, enter
|
|
||||||
|
|
||||||
npm start
|
|
||||||
|
|
||||||
in your console. To test your application, open http://localhost:1234/ in your browser. Whenever you change something, the page will reload automatically to show the result of your changes.
|
|
||||||
|
|
||||||
Note that a single JavaScript file with all your application code and all dependencies used in your application has been created. From the OpenLayers package, it only contains the required components.
|
|
||||||
|
|
||||||
To create a production bundle of your application, simply type
|
|
||||||
|
|
||||||
npm run build
|
|
||||||
|
|
||||||
and copy the `dist/` folder to your production server.
|
|
||||||
305
doc/tutorials/closure.md
Normal file
305
doc/tutorials/closure.md
Normal file
@@ -0,0 +1,305 @@
|
|||||||
|
---
|
||||||
|
title: Compiling Application with Closure Compiler
|
||||||
|
layout: doc.hbs
|
||||||
|
---
|
||||||
|
|
||||||
|
# Compiling Application with Closure Compiler
|
||||||
|
|
||||||
|
**Note**: When building an application with dependencies that are available as [npm](https://npmjs.com/) packages, it will probably be easier to use the [ol](https://npmjs.com/package/ol) package and follow the instructions there.
|
||||||
|
|
||||||
|
The OpenLayers code uses the Closure Library, and it is compiled with the
|
||||||
|
Closure Compiler. Using OpenLayers in an application does not require using
|
||||||
|
Closure. But using Closure in an OpenLayers application is possible. And this
|
||||||
|
is what this tutorial is about.
|
||||||
|
|
||||||
|
When you want to include OpenLayers as separate script without bundling with your application, follow the [Creating custom builds](./custom-builds.html) tutorial instead.
|
||||||
|
|
||||||
|
This tutorial will teach you how to set up an OpenLayers application based on
|
||||||
|
the [`closure-util`](https://github.com/openlayers/closure-util) node package,
|
||||||
|
which provides utilities for working with Closure. Using `closure-util` is one
|
||||||
|
way to use Closure in a web application, but there are others. This tutorial
|
||||||
|
just covers the "`closure-util`" way.
|
||||||
|
|
||||||
|
The `closure-util` documentation is available on the [`closure-util` readme
|
||||||
|
page](https://github.com/openlayers/closure-util/blob/master/readme.md). You
|
||||||
|
don't need to read the `closure-util` documentation to follow this tutorial,
|
||||||
|
but it's available in `closure-util`'s [readme
|
||||||
|
file](https://github.com/openlayers/closure-util/blob/master/readme.md) if you
|
||||||
|
need it.
|
||||||
|
|
||||||
|
Also, the sample application built in this tutorial is
|
||||||
|
[available](https://github.com/openlayers/openlayers-closure-application) on
|
||||||
|
GitHub.
|
||||||
|
|
||||||
|
## Advantages of using Closure
|
||||||
|
|
||||||
|
This tutorial will show you how to use the Closure Compiler to compile an
|
||||||
|
application and OpenLayers together. Compiling the application code together
|
||||||
|
with the OpenLayers code has a number of advantages.
|
||||||
|
|
||||||
|
First of all, it allows you to only "pay" for the OpenLayers code your
|
||||||
|
application uses, as the compiler will exclude the OpenLayers code that the
|
||||||
|
application doesn't use. And there is no need to write and maintain a list of
|
||||||
|
"exports", which is necessary when creating custom builds of OpenLayers.
|
||||||
|
|
||||||
|
Also, compiling the application and OpenLayers together allows using
|
||||||
|
OpenLayers functions and objects that are not part of the official OpenLayers
|
||||||
|
3 API. Using non-API functions and objects may be risky, but it is mitigated by
|
||||||
|
the fact that the compiler will complain if you use functions or objects
|
||||||
|
that are not in OpenLayers anymore.
|
||||||
|
|
||||||
|
## Setting up the Application
|
||||||
|
|
||||||
|
First, create a directory for the application. We will name that directory
|
||||||
|
`openlayers-closure-application` in this tutorial.
|
||||||
|
|
||||||
|
$ mkdir openlayers-closure-application
|
||||||
|
|
||||||
|
Now change to that directory:
|
||||||
|
|
||||||
|
$ cd openlayers-closure-application
|
||||||
|
|
||||||
|
Our application will be a `node` application, and the `openlayers` and
|
||||||
|
`closure-util` node packages will be downloaded from the node package registry
|
||||||
|
using the `npm` command line tool.
|
||||||
|
|
||||||
|
So we're going to create a `package.json` file for the application, which every
|
||||||
|
node application includes. This file basically includes metadata for the
|
||||||
|
application.
|
||||||
|
|
||||||
|
Create the application's `package.json` file:
|
||||||
|
|
||||||
|
$ npm init
|
||||||
|
|
||||||
|
You can pretty much use the default answers to the questions `npm init` asks
|
||||||
|
you.
|
||||||
|
|
||||||
|
Now install OpenLayers using:
|
||||||
|
|
||||||
|
$ npm install openlayers --save
|
||||||
|
|
||||||
|
The `--save` flag persists the `openlayers` dependency in the application's
|
||||||
|
`package.json` file. You can edit `package.json` to verify that the dependency
|
||||||
|
was added.
|
||||||
|
|
||||||
|
`closure-util` is a dependency of the `openlayers` package, so it should have
|
||||||
|
been installed with `openlayers`. Use the following to verify that
|
||||||
|
`closure-util` is installed:
|
||||||
|
|
||||||
|
$ ./node_modules/openlayers/node_modules/.bin/closure-util
|
||||||
|
|
||||||
|
command argument is required
|
||||||
|
|
||||||
|
Usage: node closure-util <command> [options]
|
||||||
|
|
||||||
|
command
|
||||||
|
update-compiler Update the Compiler
|
||||||
|
update-library Update the Library
|
||||||
|
update Update both the Library and the Compiler
|
||||||
|
build Build with Closure Compiler
|
||||||
|
serve Start the development server
|
||||||
|
|
||||||
|
Options:
|
||||||
|
-l LEVEL, --loglevel LEVEL Log level [info]
|
||||||
|
|
||||||
|
|
||||||
|
## Create an OpenLayers map
|
||||||
|
|
||||||
|
You're now going to create a JavaScript file that creates an OpenLayers map.
|
||||||
|
This is the file that we will define the application's entry point.
|
||||||
|
|
||||||
|
First of all create an `src` directory at the root of the application:
|
||||||
|
|
||||||
|
$ mkdir src
|
||||||
|
|
||||||
|
Now add a file `main.js` to `src`, with the following content:
|
||||||
|
|
||||||
|
```js
|
||||||
|
goog.provide('app');
|
||||||
|
|
||||||
|
goog.require('ol.Map');
|
||||||
|
goog.require('ol.View');
|
||||||
|
goog.require('ol.layer.Tile');
|
||||||
|
goog.require('ol.source.OSM');
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @type {ol.PluggableMap}
|
||||||
|
*/
|
||||||
|
app.map = new ol.Map({
|
||||||
|
target: 'map',
|
||||||
|
layers: [
|
||||||
|
new ol.layer.Tile({
|
||||||
|
source: new ol.source.OSM()
|
||||||
|
})
|
||||||
|
],
|
||||||
|
view: new ol.View({
|
||||||
|
center: [0, 0],
|
||||||
|
zoom: 4
|
||||||
|
})
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
`goog.provide('app')` creates the namespace `app` for the application. The
|
||||||
|
`goog.require` statements that follow define the OpenLayers constructors and
|
||||||
|
namespaces that the application uses. The rest of the code just creates the
|
||||||
|
OpenLayers map as you would do in any OpenLayers application.
|
||||||
|
|
||||||
|
## Compiling the Application
|
||||||
|
|
||||||
|
We're now going to compile the application and OpenLayers together, using the
|
||||||
|
Closure Compiler and `closure-util`. For this we need to create a JSON config
|
||||||
|
file, that we will then pass as an input file to the `closure-util` command.
|
||||||
|
|
||||||
|
The minimum config file looks like this:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"lib": [
|
||||||
|
"node_modules/openlayers/src/**/*.js",
|
||||||
|
"node_modules/openlayers/build/ol.ext/**/*.js",
|
||||||
|
"src/**/*.js"
|
||||||
|
],
|
||||||
|
"compile": {
|
||||||
|
"closure_entry_point": "app",
|
||||||
|
"externs": [
|
||||||
|
"node_modules/openlayers/externs/bingmaps.js",
|
||||||
|
"node_modules/openlayers/externs/cartodb.js",
|
||||||
|
"node_modules/openlayers/externs/closure-compiler.js",
|
||||||
|
"node_modules/openlayers/externs/esrijson.js",
|
||||||
|
"node_modules/openlayers/externs/geojson.js",
|
||||||
|
"node_modules/openlayers/externs/proj4js.js",
|
||||||
|
"node_modules/openlayers/externs/tilejson.js",
|
||||||
|
"node_modules/openlayers/externs/topojson.js"
|
||||||
|
],
|
||||||
|
"define": [
|
||||||
|
"ol.ENABLE_WEBGL=false"
|
||||||
|
],
|
||||||
|
"js": [
|
||||||
|
"node_modules/openlayers/src/ol/typedefs.js",
|
||||||
|
"node_modules/openlayers/externs/olx.js",
|
||||||
|
"node_modules/openlayers/externs/oli.js"
|
||||||
|
],
|
||||||
|
"extra_annotation_name": [
|
||||||
|
"api", "observable"
|
||||||
|
],
|
||||||
|
"rewrite_polyfills": "false",
|
||||||
|
"compilation_level": "ADVANCED",
|
||||||
|
"warning_level": "VERBOSE",
|
||||||
|
"output_wrapper": "(function(){%output%})();",
|
||||||
|
"use_types_for_optimization": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Create a `config.json` file with the above content at the root of the
|
||||||
|
application directory.
|
||||||
|
|
||||||
|
We can now use `closure-util` to compile the code:
|
||||||
|
|
||||||
|
$ ./node_modules/openlayers/node_modules/.bin/closure-util build config.json app.js
|
||||||
|
|
||||||
|
The resulting `app.js` file, which you can view in your editor if you're
|
||||||
|
curious, includes a minified version of the application code (`main.js`), and
|
||||||
|
the OpenLayers code that the application code uses.
|
||||||
|
|
||||||
|
Here is a version of `config.json` with more compilation checks enabled:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"lib": [
|
||||||
|
"node_modules/openlayers/src/**/*.js",
|
||||||
|
"node_modules/openlayers/build/ol.ext/**/*.js",
|
||||||
|
"src/**/*.js"
|
||||||
|
],
|
||||||
|
"compile": {
|
||||||
|
"closure_entry_point": "app",
|
||||||
|
"externs": [
|
||||||
|
"node_modules/openlayers/externs/bingmaps.js",
|
||||||
|
"node_modules/openlayers/externs/cartodb.js",
|
||||||
|
"node_modules/openlayers/externs/closure-compiler.js",
|
||||||
|
"node_modules/openlayers/externs/esrijson.js",
|
||||||
|
"node_modules/openlayers/externs/geojson.js",
|
||||||
|
"node_modules/openlayers/externs/proj4js.js",
|
||||||
|
"node_modules/openlayers/externs/tilejson.js",
|
||||||
|
"node_modules/openlayers/externs/topojson.js"
|
||||||
|
],
|
||||||
|
"define": [
|
||||||
|
"ol.ENABLE_WEBGL=false"
|
||||||
|
],
|
||||||
|
"js": [
|
||||||
|
"node_modules/openlayers/src/ol/typedefs.js",
|
||||||
|
"node_modules/openlayers/externs/olx.js",
|
||||||
|
"node_modules/openlayers/externs/oli.js"
|
||||||
|
],
|
||||||
|
"jscomp_error": [
|
||||||
|
"*"
|
||||||
|
],
|
||||||
|
"jscomp_off": [
|
||||||
|
"unknownDefines",
|
||||||
|
"lintChecks",
|
||||||
|
"analyzerChecks"
|
||||||
|
],
|
||||||
|
"extra_annotation_name": [
|
||||||
|
"api", "observable"
|
||||||
|
],
|
||||||
|
"compilation_level": "ADVANCED",
|
||||||
|
"warning_level": "VERBOSE",
|
||||||
|
"output_wrapper": "(function(){%output%})();",
|
||||||
|
"use_types_for_optimization": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Create an HTML file for the Application
|
||||||
|
|
||||||
|
You can now go ahead and create a simple HTML for the application. Create
|
||||||
|
a `index.html` file with the following content at the root the application
|
||||||
|
directory:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
||||||
|
<meta name="viewport" content="initial-scale=1.0, user-scalable=no, width=device-width">
|
||||||
|
<link rel="stylesheet" href="node_modules/openlayers/css/ol.css" type="text/css">
|
||||||
|
<title>Simple example</title>
|
||||||
|
<style>
|
||||||
|
#map {
|
||||||
|
width: 600px;
|
||||||
|
height: 400px;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="map"></div>
|
||||||
|
<script src="app.js" type="text/javascript"></script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that the page includes a `script` tag referencing the `app.js` file,
|
||||||
|
which is the file resulting from the compilation.
|
||||||
|
|
||||||
|
You are done!
|
||||||
|
|
||||||
|
## Run Application in Debug Mode
|
||||||
|
|
||||||
|
As a bonus, we're going to show how to use `closure-util` to run the
|
||||||
|
application in "debug" mode, where the original application and OpenLayers
|
||||||
|
scripts are loaded one by one in the page.
|
||||||
|
|
||||||
|
Start the `closure-util` development server:
|
||||||
|
|
||||||
|
$ ./node_modules/openlayers/node_modules/.bin/closure-util serve config.json
|
||||||
|
|
||||||
|
Now change the `script` tag to the following in the `index.html` file:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<script src="@?main=src/main.js" type="text/javascript"></script>
|
||||||
|
```
|
||||||
|
|
||||||
|
Reload the page in your browser and you should see that scripts are now loaded
|
||||||
|
individually, making debugging much easier.
|
||||||
@@ -6,85 +6,68 @@ layout: doc.hbs
|
|||||||
# Basic Concepts
|
# Basic Concepts
|
||||||
|
|
||||||
## Map
|
## Map
|
||||||
|
The core component of OpenLayers is the map (`ol.Map`). It is rendered to a `target` container (e.g. a `div` element on the web page that contains the map). All map properties can either be configured at construction time, or by using setter methods, e.g. `setTarget()`.
|
||||||
The core component of OpenLayers is the map (`ol/Map`). It is rendered to a `target` container (e.g. a `div` element on the web page that contains the map). All map properties can either be configured at construction time, or by using setter methods, e.g. `setTarget()`.
|
|
||||||
|
|
||||||
The markup below could be used to create a `<div>` that contains your map.
|
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<div id="map" style="width: 100%, height: 400px"></div>
|
<div id="map" style="width: 100%, height: 400px"></div>
|
||||||
```
|
<script>
|
||||||
|
var map = new ol.Map({target: 'map'});
|
||||||
The script below constructs a map that is rendered in the `<div>` above, using the `map` id of the element as a selector.
|
</script>
|
||||||
|
|
||||||
```js
|
|
||||||
import Map from 'ol/Map';
|
|
||||||
|
|
||||||
var map = new Map({target: 'map'});
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## View
|
## View
|
||||||
|
`ol.Map` is not responsible for things like center, zoom level and projection of the map. Instead, these are properties of an `ol.View` instance.
|
||||||
The map is not responsible for things like center, zoom level and projection of the map. Instead, these are properties of a `ol/View` instance.
|
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import View from 'ol/View';
|
map.setView(new ol.View({
|
||||||
|
center: [0, 0],
|
||||||
map.setView(new View({
|
zoom: 2
|
||||||
center: [0, 0],
|
}));
|
||||||
zoom: 2
|
|
||||||
}));
|
|
||||||
```
|
```
|
||||||
|
|
||||||
A `View` also has a `projection`. The projection determines the coordinate system of the `center` and the units for map resolution calculations. If not specified (like in the above snippet), the default projection is Spherical Mercator (EPSG:3857), with meters as map units.
|
An `ol.View` also has a `projection`. The projection determines the coordinate system of the `center` and the units for map resolution calculations. If not specified (like in the above snippet), the default projection is Spherical Mercator (EPSG:3857), with meters as map units.
|
||||||
|
|
||||||
The `zoom` option is a convenient way to specify the map resolution. The available zoom levels are determined by `maxZoom` (default: 28), `zoomFactor` (default: 2) and `maxResolution` (default is calculated in such a way that the projection's validity extent fits in a 256x256 pixel tile). Starting at zoom level 0 with a resolution of `maxResolution` units per pixel, subsequent zoom levels are calculated by dividing the previous zoom level's resolution by `zoomFactor`, until zoom level `maxZoom` is reached.
|
The `zoom` option is a convenient way to specify the map resolution. The available zoom levels are determined by `maxZoom` (default: 28), `zoomFactor` (default: 2) and `maxResolution` (default is calculated in such a way that the projection's validity extent fits in a 256x256 pixel tile). Starting at zoom level 0 with a resolution of `maxResolution` units per pixel, subsequent zoom levels are calculated by dividing the previous zoom level's resolution by `zoomFactor`, until zoom level `maxZoom` is reached.
|
||||||
|
|
||||||
|
|
||||||
## Source
|
## Source
|
||||||
|
To get remote data for a layer, OpenLayers uses `ol.source.Source` subclasses. These are available for free and commercial map tile services like OpenStreetMap or Bing, for OGC sources like WMS or WMTS, and for vector data in formats like GeoJSON or KML.
|
||||||
To get remote data for a layer, OpenLayers uses `ol/source/Source` subclasses. These are available for free and commercial map tile services like OpenStreetMap or Bing, for OGC sources like WMS or WMTS, and for vector data in formats like GeoJSON or KML.
|
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import OSM from 'ol/source/OSM';
|
var osmSource = new ol.source.OSM();
|
||||||
|
|
||||||
var osmSource = OSM();
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Layer
|
## Layer
|
||||||
|
A layer is a visual representation of data from a `source`. OpenLayers has three basic types of layers: `ol.layer.Tile`, `ol.layer.Image` and `ol.layer.Vector`.
|
||||||
|
|
||||||
A layer is a visual representation of data from a `source`. OpenLayers has four basic types of layers:
|
`ol.layer.Tile` is for layer sources that provide pre-rendered, tiled images in grids that are organized by zoom levels for specific resolutions.
|
||||||
|
|
||||||
* `ol/layer/Tile` - Renders sources that provide tiled images in grids that are organized by zoom levels for specific resolutions.
|
`ol.layer.Image` is for server rendered images that are available for arbitrary extents and resolutions.
|
||||||
* `ol/layer/Image` - Renders sources that provide map images at arbitrary extents and resolutions.
|
|
||||||
* `ol/layer/Vector` - Renders vector data client-side.
|
`ol.layer.Vector` is for vector data that is rendered client-side.
|
||||||
* `ol/layer/VectorTile` - Renders data that is provided as vector tiles.
|
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import TileLayer from 'ol/layer/Tile';
|
var osmLayer = new ol.layer.Tile({source: osmSource});
|
||||||
|
map.addLayer(osmLayer);
|
||||||
var osmLayer = new TileLayer({source: osmSource});
|
|
||||||
map.addLayer(osmLayer);
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Putting it all together
|
## Putting it all together
|
||||||
|
|
||||||
The above snippets can be combined into a single script that renders a map with a single tile layer:
|
|
||||||
|
|
||||||
```js
|
The above snippets can be conflated to a self contained map configuration with view and layers:
|
||||||
import Map from 'ol/Map';
|
|
||||||
import View from 'ol/View';
|
|
||||||
import OSM from 'ol/source/OSM';
|
|
||||||
import TileLayer from 'ol/source/Tile';
|
|
||||||
|
|
||||||
new Map({
|
```xml
|
||||||
layers: [
|
<div id="map" style="width: 100%, height: 400px"></div>
|
||||||
new TileLayer({source: new OSM()})
|
<script>
|
||||||
],
|
new ol.Map({
|
||||||
view: new View({
|
layers: [
|
||||||
center: [0, 0],
|
new ol.layer.Tile({source: new ol.source.OSM()})
|
||||||
zoom: 2
|
],
|
||||||
}),
|
view: new ol.View({
|
||||||
target: 'map'
|
center: [0, 0],
|
||||||
});
|
zoom: 2
|
||||||
|
}),
|
||||||
|
target: 'map'
|
||||||
|
});
|
||||||
|
</script>
|
||||||
```
|
```
|
||||||
|
|||||||
237
doc/tutorials/custom-builds.md
Normal file
237
doc/tutorials/custom-builds.md
Normal file
@@ -0,0 +1,237 @@
|
|||||||
|
---
|
||||||
|
title: Custom builds
|
||||||
|
layout: doc.hbs
|
||||||
|
---
|
||||||
|
|
||||||
|
# Creating custom builds
|
||||||
|
|
||||||
|
OpenLayers is a big library providing a lot of functionality. So it is unlikely that an application will need and use all the functionality OpenLayers provides. This is why creating application-specific OpenLayers builds, with just the functionality your application needs, is often a good idea.
|
||||||
|
|
||||||
|
An alternative to creating custom builds is to compile your application code together with OpenLayers. See the [Compiling Application with Closure Compiler](closure.html) tutorial for more information.
|
||||||
|
|
||||||
|
This particular tutorial explains how to create custom builds of OpenLayers.
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
OpenLayers's build tools use Node and Java, so you need to have Node and Java installed on your machine. You can run `node --version` and `java -version` to test that Node and Java are installed, respectively. See [developing guide](https://github.com/openlayers/openlayers/blob/master/DEVELOPING.md) for minimum version numbers required.
|
||||||
|
|
||||||
|
## Download OpenLayers
|
||||||
|
|
||||||
|
Obviously, creating a custom build requires the OpenLayers source and specific build scripts.
|
||||||
|
|
||||||
|
To get the OpenLayers source and the build scripts you can clone the openlayers [repository](https://github.com/openlayers/openlayers), or you can download one of the release archives. You can also download the `openlayers` Node package from the Node package registry, using NPM (the Node Package Manager). This is the method we are going to use in this tutorial.
|
||||||
|
|
||||||
|
Create a directory:
|
||||||
|
|
||||||
|
$ mkdir openlayers
|
||||||
|
|
||||||
|
Download the OpenLayers distribution using NPM:
|
||||||
|
|
||||||
|
$ npm install openlayers
|
||||||
|
|
||||||
|
This will download the latest stable version of OpenLayers, and install it under `node_modules`. You can list the content of `node_modules` to verify that it effectively contains a directory named "openlayers".
|
||||||
|
|
||||||
|
The Node packages onto which the `openlayers` package depends are installed under `node_modules/openlayers/node_modules`. That directory should, for example, include `closure-util`, which is the utility library OpenLayers uses for Closure.
|
||||||
|
|
||||||
|
You should now have everything you need to create custom builds of OpenLayers!
|
||||||
|
|
||||||
|
## Create a build configuration file
|
||||||
|
|
||||||
|
Creating a custom build requires writing a build configuration file. The format of build configuration files is JSON. Here is a simple example of a build configuration file:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"exports": [
|
||||||
|
"ol.Map",
|
||||||
|
"ol.View",
|
||||||
|
"ol.control.defaults",
|
||||||
|
"ol.layer.Tile",
|
||||||
|
"ol.source.OSM"
|
||||||
|
],
|
||||||
|
"compile": {
|
||||||
|
"externs": [
|
||||||
|
"externs/bingmaps.js",
|
||||||
|
"externs/cartodb.js",
|
||||||
|
"externs/closure-compiler.js",
|
||||||
|
"externs/esrijson.js",
|
||||||
|
"externs/geojson.js",
|
||||||
|
"externs/oli.js",
|
||||||
|
"externs/olx.js",
|
||||||
|
"externs/proj4js.js",
|
||||||
|
"externs/tilejson.js",
|
||||||
|
"externs/topojson.js"
|
||||||
|
],
|
||||||
|
"extra_annotation_name": [
|
||||||
|
"api", "observable"
|
||||||
|
],
|
||||||
|
"compilation_level": "ADVANCED",
|
||||||
|
"manage_closure_dependencies": true,
|
||||||
|
"rewrite_polyfills": false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Create a file named `ol-custom.json` with that content, and save it under the `node_modules/openlayers/build` directory. (You can save it to any location really.)
|
||||||
|
|
||||||
|
The most relevant part of this configuration object is the `"exports"` array. This array declares the functions/constructors you use in your JavaScript code. For example, the above configuration file is what you'd use for the following JavaScript code:
|
||||||
|
|
||||||
|
```js
|
||||||
|
var map = new ol.Map({
|
||||||
|
target: 'map',
|
||||||
|
layers: [
|
||||||
|
new ol.layer.Tile({
|
||||||
|
source: new ol.source.OSM()
|
||||||
|
})
|
||||||
|
],
|
||||||
|
controls: ol.control.defaults({
|
||||||
|
attributionOptions: {
|
||||||
|
collapsible: false
|
||||||
|
}
|
||||||
|
}),
|
||||||
|
view: new ol.View({
|
||||||
|
center: [0, 0],
|
||||||
|
zoom: 4
|
||||||
|
})
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that this JavaScript code corresponds to OpenLayers's [`simple`](https://openlayers.org/en/master/examples/simple.html) example.
|
||||||
|
|
||||||
|
You are now ready to create your first OpenLayers build. Use the following command to create the build:
|
||||||
|
|
||||||
|
$ cd node_modules/openlayers
|
||||||
|
$ node tasks/build.js build/ol-custom.json build/ol-custom.js
|
||||||
|
|
||||||
|
The build command may take some time, but it should end with an output in the console such as the following:
|
||||||
|
|
||||||
|
info ol Parsing dependencies
|
||||||
|
info ol Compiling 364 sources
|
||||||
|
|
||||||
|
The build command should have created an `ol-custom.js` file in the `node_modules/openlayers/build` directory. You can verify that the file was created. You can even open it in your editor if you're curious.
|
||||||
|
|
||||||
|
As a test, you can use the following HTML file to verify that your custom build works as expected:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<title>OpenLayers example</title>
|
||||||
|
<link rel="stylesheet" href="node_modules/openlayers/css/ol.css" />
|
||||||
|
<style>
|
||||||
|
#map {
|
||||||
|
width: 600px;
|
||||||
|
height: 400px;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="map"></div>
|
||||||
|
<script src="node_modules/openlayers/build/ol-custom.js"></script>
|
||||||
|
<script>
|
||||||
|
var map = new ol.Map({
|
||||||
|
target: 'map',
|
||||||
|
layers: [
|
||||||
|
new ol.layer.Tile({
|
||||||
|
source: new ol.source.OSM()
|
||||||
|
})
|
||||||
|
],
|
||||||
|
view: new ol.View({
|
||||||
|
center: [0, 0],
|
||||||
|
zoom: 4
|
||||||
|
})
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
## More on the config file
|
||||||
|
|
||||||
|
### `define`'s
|
||||||
|
|
||||||
|
Closure allows you to define constants that can be set at compile time. The OpenLayers code defines several such values.
|
||||||
|
|
||||||
|
Setting some of these to `false` means that the portions of the code relating to this setting become "dead", i.e. are never executed. As Closure Compiler's `ADVANCED` mode removes dead code, this makes the size of the advanced compiled file smaller.
|
||||||
|
|
||||||
|
You might have noticed that the build file you've just created is considerably smaller than the full build, but it can be reduced further. This is because both renderers and other optional code are included by default. We only need one renderer, and we do not use the optional code, so can exclude what we don't use by setting properties with `define`s. So add a define section to the config above:
|
||||||
|
```
|
||||||
|
"define": [
|
||||||
|
"ol.ENABLE_WEBGL=false",
|
||||||
|
"ol.ENABLE_PROJ4JS=false",
|
||||||
|
"ol.ENABLE_RASTER_REPROJECTION=false"
|
||||||
|
],
|
||||||
|
```
|
||||||
|
|
||||||
|
and re-run the build script. The build size should now be smaller.
|
||||||
|
|
||||||
|
### Externs
|
||||||
|
|
||||||
|
The Closure documentation explains that "externs" are for external names used in the code being compiled. The compiler includes externs for built-ins such as `document`. The `externs` directory of the OpenLayers code includes files for all those used in some part of the library. For example, if you use Bing Maps, you should include the Bing externs file in the `externs` section of the config file.
|
||||||
|
|
||||||
|
`oli.js` and `olx.js` are externs files for the OpenLayers API. For example `olx.js` includes extern definitions for OpenLayers's constructor options. `closure-compiler.js` fixes any issues that may arise with a specific compiler version. You should always use these three files as externs when creating custom builds.
|
||||||
|
|
||||||
|
### Other compiler options
|
||||||
|
|
||||||
|
There are a couple of other compiler options in the config file above. `manage_closure_dependencies` and `rewrite_polyfills` should always be used.
|
||||||
|
|
||||||
|
You can specify any of the other compiler options here as needed, such as the renaming reports, output manifest, or source maps. There is a full list of available options in [closure-util](https://github.com/openlayers/closure-util/blob/master/compiler-options.txt).
|
||||||
|
|
||||||
|
Note that `build.js` currently requires you to enter an output file and will write the output from the compiler to it; it does not use the `js_output_file` compiler option. If you specify this in the config file, there will be no compiler output, so `build.js`'s output file will be empty.
|
||||||
|
|
||||||
|
## A more complicated example
|
||||||
|
|
||||||
|
Now let's try a more complicated example: [`heatmaps-earthquakes`](https://openlayers.org/en/master/examples/heatmap-earthquakes.html). The build configuration file looks like this:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"exports": [
|
||||||
|
"ol.layer.Heatmap",
|
||||||
|
"ol.source.Vector",
|
||||||
|
"ol.format.KML",
|
||||||
|
"ol.layer.Heatmap#getSource",
|
||||||
|
"ol.source.Vector#on",
|
||||||
|
"ol.source.Vector.Event#feature",
|
||||||
|
"ol.Feature#get",
|
||||||
|
"ol.Feature#set",
|
||||||
|
"ol.layer.Tile",
|
||||||
|
"ol.source.Stamen",
|
||||||
|
"ol.Map",
|
||||||
|
"ol.View",
|
||||||
|
"ol.layer.Heatmap#setRadius",
|
||||||
|
"ol.layer.Heatmap#setBlur"
|
||||||
|
],
|
||||||
|
"compile": {
|
||||||
|
"externs": [
|
||||||
|
"externs/bingmaps.js",
|
||||||
|
"externs/cartodb.js",
|
||||||
|
"externs/closure-compiler.js",
|
||||||
|
"externs/esrijson.js",
|
||||||
|
"externs/geojson.js",
|
||||||
|
"externs/olx.js",
|
||||||
|
"externs/oli.js",
|
||||||
|
"externs/proj4js.js",
|
||||||
|
"externs/tilejson.js",
|
||||||
|
"externs/topojson.js"
|
||||||
|
],
|
||||||
|
"define": [
|
||||||
|
"ol.ENABLE_WEBGL=false",
|
||||||
|
"ol.ENABLE_PROJ4JS=false",
|
||||||
|
"ol.ENABLE_RASTER_REPROJECTION=false"
|
||||||
|
],
|
||||||
|
"compilation_level": "ADVANCED",
|
||||||
|
"manage_closure_dependencies": true,
|
||||||
|
"rewrite_polyfills": false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The exports are given here in the order in which they occur in the `heatmaps-earthquakes` example's JavaScript code. In this example we not only use the `ol.` functions and constructors, but also `prototype` methods where the `ol` namespace is not directly used. In the code, we have for example `vector.getSource().on()`. This means we are using the `getSource` method of `layer.Heatmap` and the `on` method of `source.KML`, so this is what has to be exported. Similarly, `event.feature.get()` means we are using the `feature` property of `source.Vector.Event` and the `get` method of `Feature`. If any of these names are left out, the compile will complete successfully, but the missing names will be obfuscated and you will get a 'property undefined' error when you try and run the script.
|
||||||
|
|
||||||
|
## Maintaining the code
|
||||||
|
|
||||||
|
If you installed OpenLayers from the Node package, you can use `npm` to upgrade to the latest version. If you cloned the Github repo, simply pulling in the latest code may not be enough, as some of the packages used, for example, the compiler, may need upgrading too. Do this by using `npm install` rather than `npm update`.
|
||||||
|
|
||||||
|
## Conclusion
|
||||||
|
|
||||||
|
This tutorial should have given you the information you need to create custom builds, i.e. builds tailored to your application. See the [tasks readme](https://github.com/openlayers/openlayers/tree/master/tasks/readme.md) for more information on the build scripts and the properties you can use in the build configuration file.
|
||||||
@@ -5,7 +5,9 @@ layout: doc.hbs
|
|||||||
|
|
||||||
# Tutorials
|
# Tutorials
|
||||||
|
|
||||||
* [Building an OpenLayers Application](bundle.html)
|
* [Introduction to OpenLayers](introduction.html)
|
||||||
* [Basic Concepts](concepts.html)
|
* [Basic Concepts](concepts.html)
|
||||||
* [Some Background on OpenLayers](background.html)
|
* [Create Custom Builds](custom-builds.html)
|
||||||
|
* [Bundle Application and OpenLayers using Browserify](browserify.html)
|
||||||
|
* [Compile Application and OpenLayers together](closure.html)
|
||||||
* [Raster Reprojection](raster-reprojection.html)
|
* [Raster Reprojection](raster-reprojection.html)
|
||||||
|
|||||||
42
doc/tutorials/introduction.md
Normal file
42
doc/tutorials/introduction.md
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
---
|
||||||
|
title: Introduction
|
||||||
|
layout: doc.hbs
|
||||||
|
---
|
||||||
|
|
||||||
|
# Introduction
|
||||||
|
|
||||||
|
## Objectives
|
||||||
|
With version 3, the OpenLayers web mapping library was fundamentally redesigned. The widely used version 2 dates from the early days of Javascript development, and was increasingly showing its age. So it has been rewritten from the ground up to use modern design patterns.
|
||||||
|
|
||||||
|
The initial release aims to support much of the functionality provided by version 2, with support for a wide range of commercial and free tile sources, and the most popular open-source vector data formats. As with version 2, data can be in any projection. The initial release also adds some additional functionality, such as the ability to easily rotate or animate maps.
|
||||||
|
|
||||||
|
It is also designed such that major new features, such as displaying 3D maps, or using WebGL to quickly display large vector data sets, can be added in later releases.
|
||||||
|
|
||||||
|
## Google Closure
|
||||||
|
OpenLayers was written in a way so it can be compiled with [__Closure Compiler__](https://developers.google.com/closure/compiler/). Its 'advanced' compilation mode offers a level of compression that exceeds anything else available.
|
||||||
|
|
||||||
|
## Public API
|
||||||
|
Using the advanced optimizations of the Closure Compiler means that properties and methods are renamed – `longMeaningfulName` might become `xB` – and so are effectively unusable in applications using the library. To be usable, they have to be explicitly `exported`. This means the exported names, those not renamed, effectively become the public API of the library. These __exportable__ properties and methods are marked in the source, and documented in the [API docs](../../apidoc). This is the officially supported API of the library. A build containing all these exportable names is known as a __full build__. A hosted version of this is available, which can be used by any application.
|
||||||
|
|
||||||
|
## Custom Builds
|
||||||
|
Unlike in, say, Node, where a module's exports are fixed in the source, with Closure Compiler, exports can be defined at compile time. This makes it easy to create builds that are customized to the needs of a particular site or application: a __custom build__ only exports those properties and methods needed by the site or application. As the full build is large, and will probably become larger as new features are added to the API, it's recommended that sites create a custom build for production software.
|
||||||
|
|
||||||
|
## Renderers and Browser Support
|
||||||
|
The library currently includes two renderers: Canvas and WebGL. Both of them support both raster data from tile/image servers, and vector data; WebGL however does not support labels. Clearly only those browsers that [support Canvas](http://caniuse.com/canvas) can use the Canvas renderer. Equally, the WebGL renderer can only be used on those devices and [browsers](http://caniuse.com/webgl) that support WebGL.
|
||||||
|
|
||||||
|
OpenLayers runs on all modern browsers that support [HTML5](https://html.spec.whatwg.org/multipage/) and [ECMAScript 5](http://www.ecma-international.org/ecma-262/5.1/). This includes Chrome, Firefox, Safari and Edge. For older browsers and platforms like Internet Explorer (down to version 9) and Android 4.x, [polyfills](http://polyfill.io) for `requestAnimationFrame` and `Element.prototype.classList` are required, and using the KML format requires a polyfill for `URL`.
|
||||||
|
|
||||||
|
The library is intended for use on both desktop/laptop and mobile devices.
|
||||||
|
|
||||||
|
## Objects and Naming Conventions
|
||||||
|
The top-level namespace is `ol` (basically, `var ol = {};`). Subdivisions of this are:
|
||||||
|
|
||||||
|
* further namespaces, such as `ol.layer`; these have a lower-case initial
|
||||||
|
* simple objects containing static properties and methods, such as `ol.easing`; these also have a lower-case initial
|
||||||
|
* types, which have an upper-case initial. These are mainly 'classes', which here means a constructor function with prototypal inheritance, such as `ol.Map` or `ol.layer.Vector` (the Vector class within the layer namespace). There are however other, simpler, types, such as `ol.Extent`, which is an array.
|
||||||
|
|
||||||
|
Class namespaces, such as `ol.layer` have a base class type with the same name, such as `ol.layer.Layer`. These are mainly abstract classes, from which the other subclasses inherit.
|
||||||
|
|
||||||
|
Source files are similarly organised, with a directory for each class namespace. Names are however all lower-case, for example, `ol/layer/vector.js`.
|
||||||
|
|
||||||
|
OpenLayers follows the convention that the names of private properties and methods, that is, those that are not part of the API, end in an underscore. In general, instance properties are private and accessed using accessors.
|
||||||
@@ -10,22 +10,18 @@ Transformation of the map projections of the image happens directly in a web bro
|
|||||||
The view in any Proj4js supported coordinate reference system is possible and previously incompatible layers can now be combined and overlaid.
|
The view in any Proj4js supported coordinate reference system is possible and previously incompatible layers can now be combined and overlaid.
|
||||||
|
|
||||||
# Usage
|
# Usage
|
||||||
The API usage is very simple. Just specify proper projection (e.g. using [EPSG](https://epsg.io) code) on `ol/View`:
|
The API usage is very simple. Just specify proper projection (using [EPSG](https://epsg.io) code) on `ol.View`:
|
||||||
```js
|
``` javascript
|
||||||
import {Map, View} from 'ol';
|
var map = new ol.Map({
|
||||||
import TileLayer from 'ol/layer/Tile';
|
|
||||||
import TileWMS from 'ol/source/TileWMS';
|
|
||||||
|
|
||||||
var map = new Map({
|
|
||||||
target: 'map',
|
target: 'map',
|
||||||
view: new View({
|
view: new ol.View({
|
||||||
projection: 'EPSG:3857', //HERE IS THE VIEW PROJECTION
|
projection: 'EPSG:3857', //HERE IS THE VIEW PROJECTION
|
||||||
center: [0, 0],
|
center: [0, 0],
|
||||||
zoom: 2
|
zoom: 2
|
||||||
}),
|
}),
|
||||||
layers: [
|
layers: [
|
||||||
new TileLayer({
|
new ol.layer.Tile({
|
||||||
source: new TileWMS({
|
source: new ol.source.TileWMS({
|
||||||
projection: 'EPSG:4326', //HERE IS THE DATA SOURCE PROJECTION
|
projection: 'EPSG:4326', //HERE IS THE DATA SOURCE PROJECTION
|
||||||
url: 'http://demo.boundlessgeo.com/geoserver/wms',
|
url: 'http://demo.boundlessgeo.com/geoserver/wms',
|
||||||
params: {
|
params: {
|
||||||
@@ -36,7 +32,7 @@ var map = new Map({
|
|||||||
]
|
]
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
If a source (based on `ol/source/TileImage` or `ol/source/Image`) has a projection different from the current `ol/View`’s projection then the reprojection happens automatically under the hood.
|
If a source (based on `ol.source.TileImage` or `ol.source.Image`) has a projection different from the current `ol.View`’s projection then the reprojection happens automatically under the hood.
|
||||||
|
|
||||||
### Examples
|
### Examples
|
||||||
- [Raster reprojection demo](https://openlayers.org/en/master/examples/reprojection.html)
|
- [Raster reprojection demo](https://openlayers.org/en/master/examples/reprojection.html)
|
||||||
@@ -45,29 +41,26 @@ If a source (based on `ol/source/TileImage` or `ol/source/Image`) has a projecti
|
|||||||
- [Image reprojection](https://openlayers.org/en/master/examples/reprojection-image.html)
|
- [Image reprojection](https://openlayers.org/en/master/examples/reprojection-image.html)
|
||||||
|
|
||||||
### Custom projection
|
### Custom projection
|
||||||
The easiest way to use a custom projection is to add the [Proj4js](http://proj4js.org/) library to your project and then define the projection using a proj4 definition string. It can be installed with
|
The easiest way to use a custom projection is to add the [Proj4js](http://proj4js.org/) library to your project and then define the projection using a proj4 definition string.
|
||||||
|
|
||||||
npm install proj4
|
|
||||||
|
|
||||||
Following example shows definition of a [British National Grid](https://epsg.io/27700):
|
Following example shows definition of a [British National Grid](https://epsg.io/27700):
|
||||||
|
|
||||||
```js
|
``` html
|
||||||
import proj4 from 'proj4';
|
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/proj4js/2.4.4/proj4.js"></script>
|
||||||
import {get as getProjection, register} from 'ol/proj';
|
```
|
||||||
|
|
||||||
|
``` javascript
|
||||||
proj4.defs('EPSG:27700', '+proj=tmerc +lat_0=49 +lon_0=-2 +k=0.9996012717 ' +
|
proj4.defs('EPSG:27700', '+proj=tmerc +lat_0=49 +lon_0=-2 +k=0.9996012717 ' +
|
||||||
'+x_0=400000 +y_0=-100000 +ellps=airy ' +
|
'+x_0=400000 +y_0=-100000 +ellps=airy ' +
|
||||||
'+towgs84=446.448,-125.157,542.06,0.15,0.247,0.842,-20.489 ' +
|
'+towgs84=446.448,-125.157,542.06,0.15,0.247,0.842,-20.489 ' +
|
||||||
'+units=m +no_defs');
|
'+units=m +no_defs');
|
||||||
register(proj4);
|
var proj27700 = ol.proj.get('EPSG:27700');
|
||||||
var proj27700 = getProjection('EPSG:27700');
|
|
||||||
proj27700.setExtent([0, 0, 700000, 1300000]);
|
proj27700.setExtent([0, 0, 700000, 1300000]);
|
||||||
```
|
```
|
||||||
|
|
||||||
### Change of the view projection
|
### Change of the view projection
|
||||||
To switch the projection used to display the map you have to set a new `ol/View` with selected projection on the `ol/Map`:
|
To switch the projection used to display the map you have to set a new `ol.View` with selected projection on the `ol.Map`:
|
||||||
``` javascript
|
``` javascript
|
||||||
map.setView(new View({
|
map.setView(new ol.View({
|
||||||
projection: 'EPSG:27700',
|
projection: 'EPSG:27700',
|
||||||
center: [400000, 650000],
|
center: [400000, 650000],
|
||||||
zoom: 4
|
zoom: 4
|
||||||
@@ -76,16 +69,16 @@ map.setView(new View({
|
|||||||
|
|
||||||
## TileGrid and Extents
|
## TileGrid and Extents
|
||||||
When reprojection is needed, new tiles (in the target projection) are under the hood created from the original source tiles.
|
When reprojection is needed, new tiles (in the target projection) are under the hood created from the original source tiles.
|
||||||
The TileGrid of the reprojected tiles is by default internally constructed using `ol/tilegrid~getForProjection(projection)`.
|
The TileGrid of the reprojected tiles is by default internally constructed using `ol.tilegrid.getForProjection(projection)`.
|
||||||
The projection should have extent defined (see above) for this to work properly.
|
The projection should have extent defined (see above) for this to work properly.
|
||||||
|
|
||||||
Alternatively, a custom target TileGrid can be constructed manually and set on the source instance using `ol/source/TileImage~setTileGridForProjection(projection, tilegrid)`.
|
Alternatively, a custom target TileGrid can be constructed manually and set on the source instance using `ol.source.TileImage#setTileGridForProjection(projection, tilegrid)`.
|
||||||
This TileGrid will then be used when reprojecting to the specified projection instead of creating the default one.
|
This TileGrid will then be used when reprojecting to the specified projection instead of creating the default one.
|
||||||
In certain cases, this can be used to optimize performance (by tweaking tile sizes) or visual quality (by specifying resolutions).
|
In certain cases, this can be used to optimize performance (by tweaking tile sizes) or visual quality (by specifying resolutions).
|
||||||
|
|
||||||
# How it works
|
# How it works
|
||||||
|
|
||||||
The reprojection process is based on triangles -- the target raster is divided into a limited number of triangles with vertices transformed using `ol/proj` capabilities ([proj4js](http://proj4js.org/) is usually utilized to define custom transformations).
|
The reprojection process is based on triangles -- the target raster is divided into a limited number of triangles with vertices transformed using `ol.proj` capabilities ([proj4js](http://proj4js.org/) is usually utilized to define custom transformations).
|
||||||
The reprojection of pixels inside the triangle is approximated with an affine transformation (with rendering hardware-accelerated by the canvas 2d context):
|
The reprojection of pixels inside the triangle is approximated with an affine transformation (with rendering hardware-accelerated by the canvas 2d context):
|
||||||
|
|
||||||
<img src="raster-reprojection-resources/how-it-works.jpg" alt="How it works" width="600" />
|
<img src="raster-reprojection-resources/how-it-works.jpg" alt="How it works" width="600" />
|
||||||
@@ -109,8 +102,12 @@ For debugging, rendering of the reprojection edges can be enabled by `ol.source.
|
|||||||
|
|
||||||
# Advanced
|
# Advanced
|
||||||
|
|
||||||
|
### Disabling reprojection
|
||||||
|
In case you are creating a custom build of OpenLayers and do not need the reprojection code, you can reduce the build size by setting `ol.ENABLE_RASTER_REPROJECTION` to `false`, which completely disables the reprojection support.
|
||||||
|
See [Custom builds](custom-builds.html#defines) tutorial on how to do this.
|
||||||
|
|
||||||
### Triangulation precision threshold
|
### Triangulation precision threshold
|
||||||
The default [triangulation error threshold](#dynamic-triangulation) in pixels is given by `ERROR_THRESHOLD` (0.5 pixel).
|
The default [triangulation error threshold](#dynamic-triangulation) in pixels is given by `ol.DEFAULT_RASTER_REPROJECTION_ERROR_THRESHOLD` (0.5 pixel).
|
||||||
In case a different threshold needs to be defined for different sources, the `reprojectionErrorThreshold` option can be passed when constructing the tile image source.
|
In case a different threshold needs to be defined for different sources, the `reprojectionErrorThreshold` option can be passed when constructing the tile image source.
|
||||||
|
|
||||||
###Limiting visibility of reprojected map by extent
|
###Limiting visibility of reprojected map by extent
|
||||||
@@ -129,7 +126,7 @@ Setting such a limit is demonstrated in the [reprojection demo example](https://
|
|||||||
|
|
||||||
### Resolution calculation
|
### Resolution calculation
|
||||||
When determining source tiles to load, the ideal source resolution needs to be calculated.
|
When determining source tiles to load, the ideal source resolution needs to be calculated.
|
||||||
The `ol/reproj~calculateSourceResolution(sourceProj, targetProj, targetCenter, targetResolution)` function calculates the ideal value in order to achieve pixel mapping as close as possible to 1:1 during reprojection, which is then used to select proper zoom level from the source.
|
The `ol.reproj.calculateSourceResolution(sourceProj, targetProj, targetCenter, targetResolution)` function calculates the ideal value in order to achieve pixel mapping as close as possible to 1:1 during reprojection, which is then used to select proper zoom level from the source.
|
||||||
|
|
||||||
It is, however, generally not practical to use the same source zoom level for the whole target zoom level -- different projections can have significantly different resolutions in different parts of the world (e.g. polar regions in EPSG:3857 vs EPSG:4326) and enforcing a single resolution for the whole zoom level would result in some tiles being scaled up/down, possibly requiring a huge number of source tiles to be loaded.
|
It is, however, generally not practical to use the same source zoom level for the whole target zoom level -- different projections can have significantly different resolutions in different parts of the world (e.g. polar regions in EPSG:3857 vs EPSG:4326) and enforcing a single resolution for the whole zoom level would result in some tiles being scaled up/down, possibly requiring a huge number of source tiles to be loaded.
|
||||||
Therefore, the resolution mapping is calculated separately for each reprojected tile (in the middle of the tile extent).
|
Therefore, the resolution mapping is calculated separately for each reprojected tile (in the middle of the tile extent).
|
||||||
|
|||||||
@@ -9,7 +9,6 @@
|
|||||||
"GyroNorm": false,
|
"GyroNorm": false,
|
||||||
"jsPDF": false,
|
"jsPDF": false,
|
||||||
"jsts": false,
|
"jsts": false,
|
||||||
"mapboxgl": false,
|
|
||||||
"saveAs": false,
|
"saveAs": false,
|
||||||
"toastr": false,
|
"toastr": false,
|
||||||
"topojson": false,
|
"topojson": false,
|
||||||
|
|||||||
@@ -1,10 +1,3 @@
|
|||||||
/*
|
|
||||||
* Jugl.js -- JavaScript Template Library
|
|
||||||
*
|
|
||||||
* Copyright 2007-2010 Tim Schaub
|
|
||||||
* Released under the MIT license. Please see
|
|
||||||
* http://github.com/tschaub/jugl/blob/master/license.txt for the full license.
|
|
||||||
*/
|
|
||||||
/*
|
/*
|
||||||
* Jugl.js -- JavaScript Template Library
|
* Jugl.js -- JavaScript Template Library
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -1,30 +1,36 @@
|
|||||||
import Map from '../src/ol/Map.js';
|
goog.require('ol.Map');
|
||||||
import View from '../src/ol/View.js';
|
goog.require('ol.View');
|
||||||
import TileLayer from '../src/ol/layer/Tile.js';
|
goog.require('ol.control');
|
||||||
import OSM from '../src/ol/source/OSM.js';
|
goog.require('ol.layer.Tile');
|
||||||
|
goog.require('ol.source.OSM');
|
||||||
|
|
||||||
|
|
||||||
const map = new Map({
|
var map = new ol.Map({
|
||||||
layers: [
|
layers: [
|
||||||
new TileLayer({
|
new ol.layer.Tile({
|
||||||
source: new OSM()
|
source: new ol.source.OSM()
|
||||||
})
|
})
|
||||||
],
|
],
|
||||||
target: 'map',
|
target: 'map',
|
||||||
view: new View({
|
controls: ol.control.defaults({
|
||||||
|
attributionOptions: {
|
||||||
|
collapsible: false
|
||||||
|
}
|
||||||
|
}),
|
||||||
|
view: new ol.View({
|
||||||
center: [0, 0],
|
center: [0, 0],
|
||||||
zoom: 2
|
zoom: 2
|
||||||
})
|
})
|
||||||
});
|
});
|
||||||
|
|
||||||
document.getElementById('zoom-out').onclick = function() {
|
document.getElementById('zoom-out').onclick = function() {
|
||||||
const view = map.getView();
|
var view = map.getView();
|
||||||
const zoom = view.getZoom();
|
var zoom = view.getZoom();
|
||||||
view.setZoom(zoom - 1);
|
view.setZoom(zoom - 1);
|
||||||
};
|
};
|
||||||
|
|
||||||
document.getElementById('zoom-in').onclick = function() {
|
document.getElementById('zoom-in').onclick = function() {
|
||||||
const view = map.getView();
|
var view = map.getView();
|
||||||
const zoom = view.getZoom();
|
var zoom = view.getZoom();
|
||||||
view.setZoom(zoom + 1);
|
view.setZoom(zoom + 1);
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -1,37 +1,38 @@
|
|||||||
import Map from '../src/ol/Map.js';
|
goog.require('ol.Map');
|
||||||
import View from '../src/ol/View.js';
|
goog.require('ol.View');
|
||||||
import {easeIn, easeOut} from '../src/ol/easing.js';
|
goog.require('ol.easing');
|
||||||
import TileLayer from '../src/ol/layer/Tile.js';
|
goog.require('ol.layer.Tile');
|
||||||
import {fromLonLat} from '../src/ol/proj.js';
|
goog.require('ol.proj');
|
||||||
import OSM from '../src/ol/source/OSM.js';
|
goog.require('ol.source.OSM');
|
||||||
|
|
||||||
const london = fromLonLat([-0.12755, 51.507222]);
|
var london = ol.proj.fromLonLat([-0.12755, 51.507222]);
|
||||||
const moscow = fromLonLat([37.6178, 55.7517]);
|
var moscow = ol.proj.fromLonLat([37.6178, 55.7517]);
|
||||||
const istanbul = fromLonLat([28.9744, 41.0128]);
|
var istanbul = ol.proj.fromLonLat([28.9744, 41.0128]);
|
||||||
const rome = fromLonLat([12.5, 41.9]);
|
var rome = ol.proj.fromLonLat([12.5, 41.9]);
|
||||||
const bern = fromLonLat([7.4458, 46.95]);
|
var bern = ol.proj.fromLonLat([7.4458, 46.95]);
|
||||||
|
|
||||||
const view = new View({
|
var view = new ol.View({
|
||||||
center: istanbul,
|
center: istanbul,
|
||||||
zoom: 6
|
zoom: 6
|
||||||
});
|
});
|
||||||
|
|
||||||
const map = new Map({
|
var map = new ol.Map({
|
||||||
target: 'map',
|
target: 'map',
|
||||||
layers: [
|
layers: [
|
||||||
new TileLayer({
|
new ol.layer.Tile({
|
||||||
preload: 4,
|
preload: 4,
|
||||||
source: new OSM()
|
source: new ol.source.OSM()
|
||||||
})
|
})
|
||||||
],
|
],
|
||||||
|
// Improve user experience by loading tiles while animating. Will make
|
||||||
|
// animations stutter on mobile or slow devices.
|
||||||
|
loadTilesWhileAnimating: true,
|
||||||
view: view
|
view: view
|
||||||
});
|
});
|
||||||
|
|
||||||
// A bounce easing method (from https://github.com/DmitryBaranovskiy/raphael).
|
// A bounce easing method (from https://github.com/DmitryBaranovskiy/raphael).
|
||||||
function bounce(t) {
|
function bounce(t) {
|
||||||
const s = 7.5625;
|
var s = 7.5625, p = 2.75, l;
|
||||||
const p = 2.75;
|
|
||||||
let l;
|
|
||||||
if (t < (1 / p)) {
|
if (t < (1 / p)) {
|
||||||
l = s * t * t;
|
l = s * t * t;
|
||||||
} else {
|
} else {
|
||||||
@@ -74,15 +75,15 @@ onClick('rotate-right', function() {
|
|||||||
|
|
||||||
onClick('rotate-around-rome', function() {
|
onClick('rotate-around-rome', function() {
|
||||||
// Rotation animation takes the shortest arc, so animate in two parts
|
// Rotation animation takes the shortest arc, so animate in two parts
|
||||||
const rotation = view.getRotation();
|
var rotation = view.getRotation();
|
||||||
view.animate({
|
view.animate({
|
||||||
rotation: rotation + Math.PI,
|
rotation: rotation + Math.PI,
|
||||||
anchor: rome,
|
anchor: rome,
|
||||||
easing: easeIn
|
easing: ol.easing.easeIn
|
||||||
}, {
|
}, {
|
||||||
rotation: rotation + 2 * Math.PI,
|
rotation: rotation + 2 * Math.PI,
|
||||||
anchor: rome,
|
anchor: rome,
|
||||||
easing: easeOut
|
easing: ol.easing.easeOut
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -111,26 +112,26 @@ onClick('bounce-to-istanbul', function() {
|
|||||||
|
|
||||||
onClick('spin-to-rome', function() {
|
onClick('spin-to-rome', function() {
|
||||||
// Rotation animation takes the shortest arc, so animate in two parts
|
// Rotation animation takes the shortest arc, so animate in two parts
|
||||||
const center = view.getCenter();
|
var center = view.getCenter();
|
||||||
view.animate({
|
view.animate({
|
||||||
center: [
|
center: [
|
||||||
center[0] + (rome[0] - center[0]) / 2,
|
center[0] + (rome[0] - center[0]) / 2,
|
||||||
center[1] + (rome[1] - center[1]) / 2
|
center[1] + (rome[1] - center[1]) / 2
|
||||||
],
|
],
|
||||||
rotation: Math.PI,
|
rotation: Math.PI,
|
||||||
easing: easeIn
|
easing: ol.easing.easeIn
|
||||||
}, {
|
}, {
|
||||||
center: rome,
|
center: rome,
|
||||||
rotation: 2 * Math.PI,
|
rotation: 2 * Math.PI,
|
||||||
easing: easeOut
|
easing: ol.easing.easeOut
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
function flyTo(location, done) {
|
function flyTo(location, done) {
|
||||||
const duration = 2000;
|
var duration = 2000;
|
||||||
const zoom = view.getZoom();
|
var zoom = view.getZoom();
|
||||||
let parts = 2;
|
var parts = 2;
|
||||||
let called = false;
|
var called = false;
|
||||||
function callback(complete) {
|
function callback(complete) {
|
||||||
--parts;
|
--parts;
|
||||||
if (called) {
|
if (called) {
|
||||||
@@ -159,13 +160,13 @@ onClick('fly-to-bern', function() {
|
|||||||
});
|
});
|
||||||
|
|
||||||
function tour() {
|
function tour() {
|
||||||
const locations = [london, bern, rome, moscow, istanbul];
|
var locations = [london, bern, rome, moscow, istanbul];
|
||||||
let index = -1;
|
var index = -1;
|
||||||
function next(more) {
|
function next(more) {
|
||||||
if (more) {
|
if (more) {
|
||||||
++index;
|
++index;
|
||||||
if (index < locations.length) {
|
if (index < locations.length) {
|
||||||
const delay = index === 0 ? 0 : 750;
|
var delay = index === 0 ? 0 : 750;
|
||||||
setTimeout(function() {
|
setTimeout(function() {
|
||||||
flyTo(locations[index], next);
|
flyTo(locations[index], next);
|
||||||
}, delay);
|
}, delay);
|
||||||
|
|||||||
@@ -1,27 +1,29 @@
|
|||||||
import Map from '../src/ol/Map.js';
|
goog.require('ol.Map');
|
||||||
import View from '../src/ol/View.js';
|
goog.require('ol.View');
|
||||||
import {Tile as TileLayer, Image as ImageLayer} from '../src/ol/layer.js';
|
goog.require('ol.layer.Tile');
|
||||||
import {OSM, ImageArcGISRest} from '../src/ol/source.js';
|
goog.require('ol.layer.Image');
|
||||||
|
goog.require('ol.source.OSM');
|
||||||
|
goog.require('ol.source.ImageArcGISRest');
|
||||||
|
|
||||||
const url = 'https://sampleserver1.arcgisonline.com/ArcGIS/rest/services/' +
|
var url = 'https://sampleserver1.arcgisonline.com/ArcGIS/rest/services/' +
|
||||||
'Specialty/ESRI_StateCityHighway_USA/MapServer';
|
'Specialty/ESRI_StateCityHighway_USA/MapServer';
|
||||||
|
|
||||||
const layers = [
|
var layers = [
|
||||||
new TileLayer({
|
new ol.layer.Tile({
|
||||||
source: new OSM()
|
source: new ol.source.OSM()
|
||||||
}),
|
}),
|
||||||
new ImageLayer({
|
new ol.layer.Image({
|
||||||
source: new ImageArcGISRest({
|
source: new ol.source.ImageArcGISRest({
|
||||||
ratio: 1,
|
ratio: 1,
|
||||||
params: {},
|
params: {},
|
||||||
url: url
|
url: url
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
];
|
];
|
||||||
const map = new Map({
|
var map = new ol.Map({
|
||||||
layers: layers,
|
layers: layers,
|
||||||
target: 'map',
|
target: 'map',
|
||||||
view: new View({
|
view: new ol.View({
|
||||||
center: [-10997148, 4569099],
|
center: [-10997148, 4569099],
|
||||||
zoom: 4
|
zoom: 4
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ docs: >
|
|||||||
This example shows how to use an ArcGIS REST MapService as tiles.
|
This example shows how to use an ArcGIS REST MapService as tiles.
|
||||||
This source type supports Map and Image Services. For cached ArcGIS
|
This source type supports Map and Image Services. For cached ArcGIS
|
||||||
services, better performance is available by using
|
services, better performance is available by using
|
||||||
<code>ol/source/XYZ</code> instead.
|
<code>ol.source.XYZ</code> instead.
|
||||||
tags: arcgis, tile, tilelayer"
|
tags: arcgis, tile, tilelayer"
|
||||||
---
|
---
|
||||||
<div id="map" class="map"></div>
|
<div id="map" class="map"></div>
|
||||||
|
|||||||
@@ -1,26 +1,27 @@
|
|||||||
import Map from '../src/ol/Map.js';
|
goog.require('ol.Map');
|
||||||
import View from '../src/ol/View.js';
|
goog.require('ol.View');
|
||||||
import TileLayer from '../src/ol/layer/Tile.js';
|
goog.require('ol.layer.Tile');
|
||||||
import {OSM, TileArcGISRest} from '../src/ol/source.js';
|
goog.require('ol.source.OSM');
|
||||||
|
goog.require('ol.source.TileArcGISRest');
|
||||||
|
|
||||||
const url = 'https://sampleserver1.arcgisonline.com/ArcGIS/rest/services/' +
|
var url = 'https://sampleserver1.arcgisonline.com/ArcGIS/rest/services/' +
|
||||||
'Specialty/ESRI_StateCityHighway_USA/MapServer';
|
'Specialty/ESRI_StateCityHighway_USA/MapServer';
|
||||||
|
|
||||||
const layers = [
|
var layers = [
|
||||||
new TileLayer({
|
new ol.layer.Tile({
|
||||||
source: new OSM()
|
source: new ol.source.OSM()
|
||||||
}),
|
}),
|
||||||
new TileLayer({
|
new ol.layer.Tile({
|
||||||
extent: [-13884991, 2870341, -7455066, 6338219],
|
extent: [-13884991, 2870341, -7455066, 6338219],
|
||||||
source: new TileArcGISRest({
|
source: new ol.source.TileArcGISRest({
|
||||||
url: url
|
url: url
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
];
|
];
|
||||||
const map = new Map({
|
var map = new ol.Map({
|
||||||
layers: layers,
|
layers: layers,
|
||||||
target: 'map',
|
target: 'map',
|
||||||
view: new View({
|
view: new ol.View({
|
||||||
center: [-10997148, 4569099],
|
center: [-10997148, 4569099],
|
||||||
zoom: 4
|
zoom: 4
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -1,28 +1,29 @@
|
|||||||
import Map from '../src/ol/Map.js';
|
goog.require('ol.Map');
|
||||||
import View from '../src/ol/View.js';
|
goog.require('ol.View');
|
||||||
import {defaults as defaultControls, Attribution} from '../src/ol/control.js';
|
goog.require('ol.control');
|
||||||
import TileLayer from '../src/ol/layer/Tile.js';
|
goog.require('ol.control.Attribution');
|
||||||
import OSM from '../src/ol/source/OSM.js';
|
goog.require('ol.layer.Tile');
|
||||||
|
goog.require('ol.source.OSM');
|
||||||
|
|
||||||
const attribution = new Attribution({
|
var attribution = new ol.control.Attribution({
|
||||||
collapsible: false
|
collapsible: false
|
||||||
});
|
});
|
||||||
const map = new Map({
|
var map = new ol.Map({
|
||||||
layers: [
|
layers: [
|
||||||
new TileLayer({
|
new ol.layer.Tile({
|
||||||
source: new OSM()
|
source: new ol.source.OSM()
|
||||||
})
|
})
|
||||||
],
|
],
|
||||||
controls: defaultControls({attribution: false}).extend([attribution]),
|
controls: ol.control.defaults({attribution: false}).extend([attribution]),
|
||||||
target: 'map',
|
target: 'map',
|
||||||
view: new View({
|
view: new ol.View({
|
||||||
center: [0, 0],
|
center: [0, 0],
|
||||||
zoom: 2
|
zoom: 2
|
||||||
})
|
})
|
||||||
});
|
});
|
||||||
|
|
||||||
function checkSize() {
|
function checkSize() {
|
||||||
const small = map.getSize()[0] < 600;
|
var small = map.getSize()[0] < 600;
|
||||||
attribution.setCollapsible(small);
|
attribution.setCollapsible(small);
|
||||||
attribution.setCollapsed(small);
|
attribution.setCollapsed(small);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,17 +3,17 @@ layout: example.html
|
|||||||
title: Bing Maps
|
title: Bing Maps
|
||||||
shortdesc: Example of a Bing Maps layer.
|
shortdesc: Example of a Bing Maps layer.
|
||||||
docs: >
|
docs: >
|
||||||
<p>When the Bing Maps tile service doesn't have tiles for a given resolution and region it returns "placeholder" tiles indicating that. Zoom the map beyond level 19 to see the "placeholder" tiles. If you want OpenLayers to display stretched tiles in place of "placeholder" tiles beyond zoom level 19 then set <code>maxZoom</code> to <code>19</code> in the options passed to <code>ol/source/BingMaps</code>.</p>
|
<p>When the Bing Maps tile service doesn't have tiles for a given resolution and region it returns "placeholder" tiles indicating that. Zoom the map beyond level 19 to see the "placeholder" tiles. If you want OpenLayers to display stretched tiles in place of "placeholder" tiles beyond zoom level 19 then set <code>maxZoom</code> to <code>19</code> in the options passed to <code>ol.source.BingMaps</code>.</p>
|
||||||
tags: "bing, bing-maps"
|
tags: "bing, bing-maps"
|
||||||
cloak:
|
cloak:
|
||||||
- key: As1HiMj1PvLPlqc_gtM7AqZfBL8ZL3VrjaS3zIb22Uvb9WKhuJObROC-qUpa81U5
|
As1HiMj1PvLPlqc_gtM7AqZfBL8ZL3VrjaS3zIb22Uvb9WKhuJObROC-qUpa81U5: Your Bing Maps Key from http://www.bingmapsportal.com/ here
|
||||||
value: Your Bing Maps Key from http://www.bingmapsportal.com/ here
|
|
||||||
---
|
---
|
||||||
<div id="map" class="map"></div>
|
<div id="map" class="map"></div>
|
||||||
<select id="layer-select">
|
<select id="layer-select">
|
||||||
<option value="Aerial">Aerial</option>
|
<option value="Aerial">Aerial</option>
|
||||||
<option value="AerialWithLabelsOnDemand" selected>Aerial with labels</option>
|
<option value="AerialWithLabels" selected>Aerial with labels</option>
|
||||||
<option value="RoadOnDemand">Road</option>
|
<option value="Road">Road (static)</option>
|
||||||
<option value="CanvasDark">Road dark</option>
|
<option value="RoadOnDemand">Road (dynamic)</option>
|
||||||
<option value="OrdnanceSurvey">Ordnance Survey</option>
|
<option value="collinsBart">Collins Bart</option>
|
||||||
|
<option value="ordnanceSurvey">Ordnance Survey</option>
|
||||||
</select>
|
</select>
|
||||||
|
|||||||
@@ -1,23 +1,24 @@
|
|||||||
import Map from '../src/ol/Map.js';
|
goog.require('ol.Map');
|
||||||
import View from '../src/ol/View.js';
|
goog.require('ol.View');
|
||||||
import TileLayer from '../src/ol/layer/Tile.js';
|
goog.require('ol.layer.Tile');
|
||||||
import BingMaps from '../src/ol/source/BingMaps.js';
|
goog.require('ol.source.BingMaps');
|
||||||
|
|
||||||
|
|
||||||
const styles = [
|
var styles = [
|
||||||
|
'Road',
|
||||||
'RoadOnDemand',
|
'RoadOnDemand',
|
||||||
'Aerial',
|
'Aerial',
|
||||||
'AerialWithLabelsOnDemand',
|
'AerialWithLabels',
|
||||||
'CanvasDark',
|
'collinsBart',
|
||||||
'OrdnanceSurvey'
|
'ordnanceSurvey'
|
||||||
];
|
];
|
||||||
const layers = [];
|
var layers = [];
|
||||||
let i, ii;
|
var i, ii;
|
||||||
for (i = 0, ii = styles.length; i < ii; ++i) {
|
for (i = 0, ii = styles.length; i < ii; ++i) {
|
||||||
layers.push(new TileLayer({
|
layers.push(new ol.layer.Tile({
|
||||||
visible: false,
|
visible: false,
|
||||||
preload: Infinity,
|
preload: Infinity,
|
||||||
source: new BingMaps({
|
source: new ol.source.BingMaps({
|
||||||
key: 'As1HiMj1PvLPlqc_gtM7AqZfBL8ZL3VrjaS3zIb22Uvb9WKhuJObROC-qUpa81U5',
|
key: 'As1HiMj1PvLPlqc_gtM7AqZfBL8ZL3VrjaS3zIb22Uvb9WKhuJObROC-qUpa81U5',
|
||||||
imagerySet: styles[i]
|
imagerySet: styles[i]
|
||||||
// use maxZoom 19 to see stretched tiles instead of the BingMaps
|
// use maxZoom 19 to see stretched tiles instead of the BingMaps
|
||||||
@@ -26,19 +27,22 @@ for (i = 0, ii = styles.length; i < ii; ++i) {
|
|||||||
})
|
})
|
||||||
}));
|
}));
|
||||||
}
|
}
|
||||||
const map = new Map({
|
var map = new ol.Map({
|
||||||
layers: layers,
|
layers: layers,
|
||||||
|
// Improve user experience by loading tiles while dragging/zooming. Will make
|
||||||
|
// zooming choppy on mobile or slow devices.
|
||||||
|
loadTilesWhileInteracting: true,
|
||||||
target: 'map',
|
target: 'map',
|
||||||
view: new View({
|
view: new ol.View({
|
||||||
center: [-6655.5402445057125, 6709968.258934638],
|
center: [-6655.5402445057125, 6709968.258934638],
|
||||||
zoom: 13
|
zoom: 13
|
||||||
})
|
})
|
||||||
});
|
});
|
||||||
|
|
||||||
const select = document.getElementById('layer-select');
|
var select = document.getElementById('layer-select');
|
||||||
function onChange() {
|
function onChange() {
|
||||||
const style = select.value;
|
var style = select.value;
|
||||||
for (let i = 0, ii = layers.length; i < ii; ++i) {
|
for (var i = 0, ii = layers.length; i < ii; ++i) {
|
||||||
layers[i].setVisible(styles[i] === style);
|
layers[i].setVisible(styles[i] === style);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
4
examples/blend-modes.css
Normal file
4
examples/blend-modes.css
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
.map{
|
||||||
|
background-repeat: repeat;
|
||||||
|
background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAN1wAADdcBQiibeAAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAApSURBVBiVY7x///5/BjSgqKjIiC7GhC6ACwygQgxHMzAwMGDz4FDwDAD5/wevjSk4mwAAAABJRU5ErkJggg==);
|
||||||
|
}
|
||||||
68
examples/blend-modes.html
Normal file
68
examples/blend-modes.html
Normal file
@@ -0,0 +1,68 @@
|
|||||||
|
---
|
||||||
|
layout: example.html
|
||||||
|
title: Blend Modes
|
||||||
|
shortdesc: Shows how to change the canvas compositing / blending mode in post- and precompose eventhandlers.
|
||||||
|
docs: >
|
||||||
|
<p>This example shows how to change the canvas compositing / blending mode in
|
||||||
|
post- and precompose event handlers. The Canvas 2D API provides the property
|
||||||
|
<code>globalCompositeOperation</code> with which one can influence which
|
||||||
|
composition operation will be used when drawing on the canvas. The various
|
||||||
|
options are well described on the <a href="https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/globalCompositeOperation">MDN
|
||||||
|
documentation page</a>.</p>
|
||||||
|
|
||||||
|
<p>In this example three circles on the corners of an equilateral triangle are
|
||||||
|
drawn with red, green or blue styles respectively. By setting the
|
||||||
|
<code>globalCompositeOperation</code> you can change how these colors turn out
|
||||||
|
when they are combined on the map.</p>
|
||||||
|
|
||||||
|
<p>You can select an operation in the select-field and you can also control
|
||||||
|
which layers will be affected by the chosen operation through the layer
|
||||||
|
checkboxes.</p>
|
||||||
|
tags: "blendmode, blend-mode, blend mode, blendingmode, blending-mode, blending mode, composition, compositing, canvas, vector"
|
||||||
|
---
|
||||||
|
<div id="map" class="map"></div>
|
||||||
|
<form class="form-horizontal">
|
||||||
|
<label>
|
||||||
|
<select id="blend-mode" class="form-control">
|
||||||
|
<option value="source-over">source-over (default)</option>
|
||||||
|
<option>source-in</option>
|
||||||
|
<option>source-out</option>
|
||||||
|
<option>source-atop</option>
|
||||||
|
<option>destination-over</option>
|
||||||
|
<option>destination-in</option>
|
||||||
|
<option>destination-out</option>
|
||||||
|
<option>destination-atop</option>
|
||||||
|
<option>lighter</option>
|
||||||
|
<option>copy</option>
|
||||||
|
<option>xor</option>
|
||||||
|
<option>multiply</option>
|
||||||
|
<option>screen</option>
|
||||||
|
<option>overlay</option>
|
||||||
|
<option>darken</option>
|
||||||
|
<option>lighten</option>
|
||||||
|
<option>color-dodge</option>
|
||||||
|
<option>color-burn</option>
|
||||||
|
<option>hard-light</option>
|
||||||
|
<option>soft-light</option>
|
||||||
|
<option selected>difference</option>
|
||||||
|
<option>exclusion</option>
|
||||||
|
<option>hue</option>
|
||||||
|
<option>saturation</option>
|
||||||
|
<option>color</option>
|
||||||
|
<option>luminosity</option>
|
||||||
|
</select>
|
||||||
|
Canvas compositing / blending mode
|
||||||
|
</label>
|
||||||
|
<label>
|
||||||
|
<input type="checkbox" id="affect-red" checked>
|
||||||
|
Red circle affected
|
||||||
|
</label>
|
||||||
|
<label>
|
||||||
|
<input type="checkbox" id="affect-green" checked>
|
||||||
|
Green circle affected
|
||||||
|
</label>
|
||||||
|
<label>
|
||||||
|
<input type="checkbox" id="affect-blue" checked>
|
||||||
|
Blue circle affected
|
||||||
|
</label>
|
||||||
|
</form>
|
||||||
176
examples/blend-modes.js
Normal file
176
examples/blend-modes.js
Normal file
@@ -0,0 +1,176 @@
|
|||||||
|
goog.require('ol.Feature');
|
||||||
|
goog.require('ol.Map');
|
||||||
|
goog.require('ol.View');
|
||||||
|
goog.require('ol.geom.Point');
|
||||||
|
goog.require('ol.layer.Vector');
|
||||||
|
goog.require('ol.source.Vector');
|
||||||
|
goog.require('ol.style.Circle');
|
||||||
|
goog.require('ol.style.Fill');
|
||||||
|
goog.require('ol.style.Stroke');
|
||||||
|
goog.require('ol.style.Style');
|
||||||
|
|
||||||
|
|
||||||
|
// Create separate layers for red, green an blue circles.
|
||||||
|
//
|
||||||
|
// Every layer has one feature that is styled with a circle, together the
|
||||||
|
// features form the corners of an equilateral triangle and their styles overlap
|
||||||
|
var redLayer = new ol.layer.Vector({
|
||||||
|
source: new ol.source.Vector({
|
||||||
|
features: [new ol.Feature(new ol.geom.Point([0, 0]))]
|
||||||
|
}),
|
||||||
|
style: new ol.style.Style({
|
||||||
|
image: new ol.style.Circle({
|
||||||
|
fill: new ol.style.Fill({
|
||||||
|
color: 'rgba(255,0,0,0.8)'
|
||||||
|
}),
|
||||||
|
stroke: new ol.style.Stroke({
|
||||||
|
color: 'rgb(255,0,0)',
|
||||||
|
width: 15
|
||||||
|
}),
|
||||||
|
radius: 120
|
||||||
|
})
|
||||||
|
})
|
||||||
|
});
|
||||||
|
var greenLayer = new ol.layer.Vector({
|
||||||
|
source: new ol.source.Vector({
|
||||||
|
// 433.013 is roughly 250 * Math.sqrt(3)
|
||||||
|
features: [new ol.Feature(new ol.geom.Point([250, 433.013]))]
|
||||||
|
}),
|
||||||
|
style: new ol.style.Style({
|
||||||
|
image: new ol.style.Circle({
|
||||||
|
fill: new ol.style.Fill({
|
||||||
|
color: 'rgba(0,255,0,0.8)'
|
||||||
|
}),
|
||||||
|
stroke: new ol.style.Stroke({
|
||||||
|
color: 'rgb(0,255,0)',
|
||||||
|
width: 15
|
||||||
|
}),
|
||||||
|
radius: 120
|
||||||
|
})
|
||||||
|
})
|
||||||
|
});
|
||||||
|
var blueLayer = new ol.layer.Vector({
|
||||||
|
source: new ol.source.Vector({
|
||||||
|
features: [new ol.Feature(new ol.geom.Point([500, 0]))]
|
||||||
|
}),
|
||||||
|
style: new ol.style.Style({
|
||||||
|
image: new ol.style.Circle({
|
||||||
|
fill: new ol.style.Fill({
|
||||||
|
color: 'rgba(0,0,255,0.8)'
|
||||||
|
}),
|
||||||
|
stroke: new ol.style.Stroke({
|
||||||
|
color: 'rgb(0,0,255)',
|
||||||
|
width: 15
|
||||||
|
}),
|
||||||
|
radius: 120
|
||||||
|
})
|
||||||
|
})
|
||||||
|
});
|
||||||
|
|
||||||
|
// Create the map, the view is centered on the triangle. Zooming and panning is
|
||||||
|
// restricted to a sane area
|
||||||
|
var map = new ol.Map({
|
||||||
|
layers: [
|
||||||
|
redLayer,
|
||||||
|
greenLayer,
|
||||||
|
blueLayer
|
||||||
|
],
|
||||||
|
target: 'map',
|
||||||
|
view: new ol.View({
|
||||||
|
center: [250, 220],
|
||||||
|
extent: [0, 0, 500, 500],
|
||||||
|
resolution: 4,
|
||||||
|
minResolution: 2,
|
||||||
|
maxResolution: 32
|
||||||
|
})
|
||||||
|
});
|
||||||
|
|
||||||
|
// Get the form elements and bind the listeners
|
||||||
|
var select = document.getElementById('blend-mode');
|
||||||
|
var affectRed = document.getElementById('affect-red');
|
||||||
|
var affectGreen = document.getElementById('affect-green');
|
||||||
|
var affectBlue = document.getElementById('affect-blue');
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method sets the globalCompositeOperation to the value of the select
|
||||||
|
* field and it is bound to the precompose event of the layers.
|
||||||
|
*
|
||||||
|
* @param {ol.render.Event} evt The render event.
|
||||||
|
*/
|
||||||
|
var setBlendModeFromSelect = function(evt) {
|
||||||
|
evt.context.globalCompositeOperation = select.value;
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method resets the globalCompositeOperation to the default value of
|
||||||
|
* 'source-over' and it is bound to the postcompose event of the layers.
|
||||||
|
*
|
||||||
|
* @param {ol.render.Event} evt The render event.
|
||||||
|
*/
|
||||||
|
var resetBlendModeFromSelect = function(evt) {
|
||||||
|
evt.context.globalCompositeOperation = 'source-over';
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Bind the pre- and postcompose handlers to the passed layer.
|
||||||
|
*
|
||||||
|
* @param {ol.layer.Vector} layer The layer to bind the handlers to.
|
||||||
|
*/
|
||||||
|
var bindLayerListeners = function(layer) {
|
||||||
|
layer.on('precompose', setBlendModeFromSelect);
|
||||||
|
layer.on('postcompose', resetBlendModeFromSelect);
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Unind the pre- and postcompose handlers to the passed layers.
|
||||||
|
*
|
||||||
|
* @param {ol.layer.Vector} layer The layer to unbind the handlers from.
|
||||||
|
*/
|
||||||
|
var unbindLayerListeners = function(layer) {
|
||||||
|
layer.un('precompose', setBlendModeFromSelect);
|
||||||
|
layer.un('postcompose', resetBlendModeFromSelect);
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handler for the click event of the 'affect-XXX' checkboxes.
|
||||||
|
*
|
||||||
|
* @this {HTMLInputElement}
|
||||||
|
*/
|
||||||
|
var affectLayerClicked = function() {
|
||||||
|
var layer;
|
||||||
|
if (this.id == 'affect-red') {
|
||||||
|
layer = redLayer;
|
||||||
|
} else if (this.id == 'affect-green') {
|
||||||
|
layer = greenLayer;
|
||||||
|
} else {
|
||||||
|
layer = blueLayer;
|
||||||
|
}
|
||||||
|
if (this.checked) {
|
||||||
|
bindLayerListeners(layer);
|
||||||
|
} else {
|
||||||
|
unbindLayerListeners(layer);
|
||||||
|
}
|
||||||
|
map.render();
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
// Rerender map when blend mode changes
|
||||||
|
select.addEventListener('change', function() {
|
||||||
|
map.render();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Unbind / bind listeners depending on the checked state when the checkboxes
|
||||||
|
// are clicked
|
||||||
|
affectRed.addEventListener('click', affectLayerClicked);
|
||||||
|
affectGreen.addEventListener('click', affectLayerClicked);
|
||||||
|
affectBlue.addEventListener('click', affectLayerClicked);
|
||||||
|
|
||||||
|
// Initially bind listeners
|
||||||
|
bindLayerListeners(redLayer);
|
||||||
|
bindLayerListeners(greenLayer);
|
||||||
|
bindLayerListeners(blueLayer);
|
||||||
@@ -4,7 +4,7 @@ title: Box Selection
|
|||||||
shortdesc: Using a DragBox interaction to select features.
|
shortdesc: Using a DragBox interaction to select features.
|
||||||
docs: >
|
docs: >
|
||||||
<p>This example shows how to use a <code>DragBox</code> interaction to select features. Selected features are added
|
<p>This example shows how to use a <code>DragBox</code> interaction to select features. Selected features are added
|
||||||
to the feature overlay of a select interaction (<code>ol/interaction/Select</code>) for highlighting.</p>
|
to the feature overlay of a select interaction (<code>ol.interaction.Select</code>) for highlighting.</p>
|
||||||
<p>Use <code>Ctrl+Drag</code> (<code>Command+Drag</code> on Mac) to draw boxes.</p>
|
<p>Use <code>Ctrl+Drag</code> (<code>Command+Drag</code> on Mac) to draw boxes.</p>
|
||||||
tags: "DragBox, feature, selection, box"
|
tags: "DragBox, feature, selection, box"
|
||||||
---
|
---
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user